Drop support for --no-summary in favor of --summary-mode=disabled (#5729)

* Remove legacy config path migration

* Drop support for --no-summary in favor of --summary-mode=disabled

---------

Co-authored-by: Jan Hildebrandt <jan.hildebrandt98@gmx.de>

Author: joanlopez

internal/cmd/run.go

@@ -497,10 +497,6 @@ func (c *cmdRun) run(cmd *cobra.Command, args []string) (err error) {
 }
 
 func getSummaryMode(runtimeOptions lib.RuntimeOptions) (summary.Mode, bool, error) {
-	if runtimeOptions.NoSummary.Bool {
-		return summary.ModeDisabled, false, nil
-	}
-
 	sm, err := summary.ValidateMode(runtimeOptions.SummaryMode.String)
 	if err != nil {
 		return summary.ModeDisabled, false, err

internal/cmd/runtime_options.go

@@ -31,11 +31,6 @@ extended: base + sets "global" as alias for "globalThis"
 	flags.StringP("type", "t", "", "override test type, \"js\" or \"archive\"")
 	flags.StringArrayP("env", "e", nil, "add/override environment variable with `VAR=value`")
 	flags.Bool("no-thresholds", false, "don't run thresholds")
-	// TODO(@joanlopez): remove by k6 v2.0, once we completely drop the support of the deprecated --no-summary flag.
-	flags.Bool("no-summary", false, "don't show the summary at the end of the test")
-	if err := flags.MarkDeprecated("no-summary", "use --summary-mode=disabled instead"); err != nil {
-		panic(err) // Should never happen
-	}
 	flags.String("summary-mode", summary.ModeCompact.String(), "determine the summary mode,"+
 		" \"compact\", \"full\" or \"disabled\"")
 	flags.String(
@@ -85,7 +80,6 @@ func runtimeOptionsFromFlags(flags *pflag.FlagSet) lib.RuntimeOptions {
 		IncludeSystemEnvVars:      getNullBool(flags, "include-system-env-vars"),
 		CompatibilityMode:         getNullString(flags, "compatibility-mode"),
 		NoThresholds:              getNullBool(flags, "no-thresholds"),
-		NoSummary:                 getNullBool(flags, "no-summary"),
 		SummaryMode:               getNullString(flags, "summary-mode"),
 		SummaryExport:             getNullString(flags, "summary-export"),
 		NewMachineReadableSummary: getNullBool(flags, "new-machine-readable-summary"),
@@ -119,10 +113,6 @@ func populateRuntimeOptionsFromEnv(opts lib.RuntimeOptions, environment map[stri
 		return opts, err
 	}
 
-	if err := saveBoolFromEnv(environment, "K6_NO_SUMMARY", &opts.NoSummary); err != nil {
-		return opts, err
-	}
-
 	if envVar, ok := environment["K6_SUMMARY_MODE"]; !opts.SummaryMode.Valid && ok {
 		opts.SummaryMode = null.StringFrom(envVar)
 	}

internal/cmd/runtime_options_test.go

@@ -383,13 +383,12 @@ func TestRuntimeOptions(t *testing.T) {
 		},
 		"summary and thresholds from env": {
 			useSysEnv: false,
-			systemEnv: map[string]string{"K6_NO_THRESHOLDS": "false", "K6_NO_SUMMARY": "0", "K6_SUMMARY_EXPORT": "foo"},
+			systemEnv: map[string]string{"K6_NO_THRESHOLDS": "false", "K6_SUMMARY_EXPORT": "foo"},
 			expRTOpts: lib.RuntimeOptions{
 				IncludeSystemEnvVars:      null.NewBool(false, false),
 				CompatibilityMode:         defaultCompatMode,
 				Env:                       map[string]string{},
 				NoThresholds:              null.NewBool(false, true),
-				NoSummary:                 null.NewBool(false, true),
 				SummaryExport:             null.NewString("foo", true),
 				TracesOutput:              defaultTracesOutput,
 				SummaryMode:               defaultSummaryMode,
@@ -398,14 +397,13 @@ func TestRuntimeOptions(t *testing.T) {
 		},
 		"summary and thresholds from env overwritten by CLI": {
 			useSysEnv: false,
-			systemEnv: map[string]string{"K6_NO_THRESHOLDS": "FALSE", "K6_NO_SUMMARY": "0", "K6_SUMMARY_EXPORT": "foo"},
-			cliFlags:  []string{"--no-thresholds", "true", "--no-summary", "true", "--summary-export", "bar"},
+			systemEnv: map[string]string{"K6_NO_THRESHOLDS": "FALSE", "K6_SUMMARY_EXPORT": "foo"},
+			cliFlags:  []string{"--no-thresholds", "true", "--summary-export", "bar"},
 			expRTOpts: lib.RuntimeOptions{
 				IncludeSystemEnvVars:      null.NewBool(false, false),
 				CompatibilityMode:         defaultCompatMode,
 				Env:                       map[string]string{},
 				NoThresholds:              null.NewBool(true, true),
-				NoSummary:                 null.NewBool(true, true),
 				SummaryExport:             null.NewString("bar", true),
 				TracesOutput:              defaultTracesOutput,
 				SummaryMode:               defaultSummaryMode,
@@ -418,12 +416,6 @@ func TestRuntimeOptions(t *testing.T) {
 			cliFlags:  []string{"--no-thresholds", "true"},
 			expErr:    true,
 		},
-		"env var error detected even when CLI flags overwrite 2": {
-			useSysEnv: false,
-			systemEnv: map[string]string{"K6_NO_SUMMARY": "hoo"},
-			cliFlags:  []string{"--no-summary", "true"},
-			expErr:    true,
-		},
 		"traces output default": {
 			useSysEnv: false,
 			expRTOpts: lib.RuntimeOptions{

internal/cmd/tests/cmd_run_test.go

@@ -154,41 +154,6 @@ func TestStdoutAndStderrAreEmptyWithQuietAndHandleSummary(t *testing.T) {
 func TestStdoutAndStderrAreEmptyWithQuietAndLogsForwarded(t *testing.T) {
 	t.Parallel()
 
-	// TODO(@joanlopez): remove by k6 v2.0, once we completely drop the support of the deprecated --no-summary flag.
-	t.Run("--no-summary", func(t *testing.T) {
-		t.Parallel()
-
-		ts := NewGlobalTestState(t)
-
-		// TODO: add a test with relative path
-		logFilePath := filepath.Join(ts.Cwd, "test.log")
-
-		ts.CmdArgs = []string{
-			"k6", "--quiet", "--log-output", "file=" + logFilePath,
-			"--log-format", "raw", "run", "--no-summary", "-",
-		}
-		ts.Stdin = bytes.NewBufferString(`
-		console.log('init');
-		export default function() { console.log('foo'); };
-	`)
-		cmd.ExecuteWithGlobalState(ts.GlobalState)
-
-		// The test state hook still catches this message
-		assert.True(t, testutils.LogContains(ts.LoggerHook.Drain(), logrus.InfoLevel, `foo`))
-
-		// But it's not shown on stderr or stdout
-		assert.Empty(t, ts.Stderr.Bytes())
-		assert.Equal(t,
-			"Flag --no-summary has been deprecated, use --summary-mode=disabled instead\n",
-			ts.Stdout.String(),
-		) // We don't expect it to be completely empty, but to contain the deprecation message for --no-summary.
-
-		// Instead, it should be in the log file
-		logContents, err := fsext.ReadFile(ts.FS, logFilePath)
-		require.NoError(t, err)
-		assert.Equal(t, "init\ninit\nfoo\n", string(logContents)) //nolint:dupword
-	})
-
 	t.Run("--summary-mode=disabled", func(t *testing.T) {
 		t.Parallel()
 

internal/lib/summary/summary.go

@@ -15,7 +15,7 @@ type Mode int
 const (
 	ModeCompact  = Mode(iota) // Compact mode that only displays the total results.
 	ModeFull                  // Extended mode that displays total and partial results.
-	ModeDisabled              // Disabled, formerly known as --no-summary.
+	ModeDisabled              // Disabled. Can be used with --summary-mode=disabled.
 )
 
 // ErrInvalidSummaryMode indicates the serialized summary mode is invalid.

lib/runtime_options.go

@@ -40,7 +40,6 @@ type RuntimeOptions struct {
 	Env map[string]string `json:"env"`
 
 	NoThresholds  null.Bool   `json:"noThresholds"`
-	NoSummary     null.Bool   `json:"noSummary"`
 	SummaryMode   null.String `json:"summaryMode"`
 	SummaryExport null.String `json:"summaryExport"`
 	KeyWriter     null.String `json:"-"`