cli/command: ctx cancel should not print or produce a non zero exit code

Benehiko · Benehiko · commit a20d0c8212a1 · 2024-12-05T13:48:40.000+01:00
The user might kill the CLI through a SIGINT/SIGTERM
which cancels the main context we pass around.

Currently the context cancel error is printed
alongside any other wrapped error with a generic
exit code (125).

This patch improves on this behavior and prevents
any error from being printed when they match
`context.Cancelled`.

The `cli.StatusError` error would wrap errors but
not provide a way to unwrap them. This would lead
to situations where `errors.Is` would not match the
underlying error.

Signed-off-by: Alano Terblanche &lt;18033717+Benehiko@users.noreply.github.com&gt;
diff --git a/cli/cobra.go b/cli/cobra.go
@@ -93,7 +93,7 @@ func FlagErrorFunc(cmd *cobra.Command, err error) error {
 	}
 
 	return StatusError{
-		Status:     fmt.Sprintf("%s\n\nUsage:  %s\n\nRun '%s --help' for more information", err, cmd.UseLine(), cmd.CommandPath()),
+		Cause:      fmt.Errorf("%w\n\nUsage:  %s\n\nRun '%s --help' for more information", err, cmd.UseLine(), cmd.CommandPath()),
 		StatusCode: 125,
 	}
 }
diff --git a/cli/command/config/inspect.go b/cli/command/config/inspect.go
@@ -67,7 +67,7 @@ func RunConfigInspect(ctx context.Context, dockerCli command.Cli, opts InspectOp
 	}
 
 	if err := InspectFormatWrite(configCtx, opts.Names, getRef); err != nil {
-		return cli.StatusError{StatusCode: 1, Status: err.Error()}
+		return cli.StatusError{StatusCode: 1, Cause: err}
 	}
 	return nil
 }
diff --git a/cli/command/container/create.go b/cli/command/container/create.go
@@ -93,7 +93,7 @@ func NewCreateCommand(dockerCli command.Cli) *cobra.Command {
 func runCreate(ctx context.Context, dockerCli command.Cli, flags *pflag.FlagSet, options *createOptions, copts *containerOptions) error {
 	if err := validatePullOpt(options.pull); err != nil {
 		return cli.StatusError{
-			Status:     withHelp(err, "create").Error(),
+			Cause:      withHelp(err, "create"),
 			StatusCode: 125,
 		}
 	}
@@ -110,13 +110,13 @@ func runCreate(ctx context.Context, dockerCli command.Cli, flags *pflag.FlagSet,
 	containerCfg, err := parse(flags, copts, dockerCli.ServerInfo().OSType)
 	if err != nil {
 		return cli.StatusError{
-			Status:     withHelp(err, "create").Error(),
+			Cause:      withHelp(err, "create"),
 			StatusCode: 125,
 		}
 	}
 	if err = validateAPIVersion(containerCfg, dockerCli.Client().ClientVersion()); err != nil {
 		return cli.StatusError{
-			Status:     withHelp(err, "create").Error(),
+			Cause:      withHelp(err, "create"),
 			StatusCode: 125,
 		}
 	}
diff --git a/cli/command/container/run.go b/cli/command/container/run.go
@@ -85,7 +85,7 @@ func NewRunCommand(dockerCli command.Cli) *cobra.Command {
 func runRun(ctx context.Context, dockerCli command.Cli, flags *pflag.FlagSet, ropts *runOptions, copts *containerOptions) error {
 	if err := validatePullOpt(ropts.pull); err != nil {
 		return cli.StatusError{
-			Status:     withHelp(err, "run").Error(),
+			Cause:      withHelp(err, "run"),
 			StatusCode: 125,
 		}
 	}
@@ -103,13 +103,13 @@ func runRun(ctx context.Context, dockerCli command.Cli, flags *pflag.FlagSet, ro
 	// just in case the parse does not exit
 	if err != nil {
 		return cli.StatusError{
-			Status:     withHelp(err, "run").Error(),
+			Cause:      withHelp(err, "run"),
 			StatusCode: 125,
 		}
 	}
 	if err = validateAPIVersion(containerCfg, dockerCli.CurrentVersion()); err != nil {
 		return cli.StatusError{
-			Status:     withHelp(err, "run").Error(),
+			Cause:      withHelp(err, "run"),
 			StatusCode: 125,
 		}
 	}
@@ -315,20 +315,20 @@ func toStatusError(err error) error {
 
 	if strings.Contains(errMsg, "executable file not found") || strings.Contains(errMsg, "no such file or directory") || strings.Contains(errMsg, "system cannot find the file specified") {
 		return cli.StatusError{
-			Status:     withHelp(err, "run").Error(),
+			Cause:      withHelp(err, "run"),
 			StatusCode: 127,
 		}
 	}
 
 	if strings.Contains(errMsg, syscall.EACCES.Error()) || strings.Contains(errMsg, syscall.EISDIR.Error()) {
 		return cli.StatusError{
-			Status:     withHelp(err, "run").Error(),
+			Cause:      withHelp(err, "run"),
 			StatusCode: 126,
 		}
 	}
 
 	return cli.StatusError{
-		Status:     withHelp(err, "run").Error(),
+		Cause:      withHelp(err, "run"),
 		StatusCode: 125,
 	}
 }
diff --git a/cli/command/container/run_test.go b/cli/command/container/run_test.go
@@ -294,10 +294,10 @@ func TestRunPullTermination(t *testing.T) {
 
 	select {
 	case cmdErr := <-cmdErrC:
-		assert.Equal(t, cmdErr, cli.StatusError{
-			StatusCode: 125,
-			Status:     "docker: context canceled\n\nRun 'docker run --help' for more information",
-		})
+		assert.ErrorIs(t, cmdErr, context.Canceled)
+		v, ok := cmdErr.(cli.StatusError)
+		assert.Check(t, ok)
+		assert.Check(t, is.Equal(v.StatusCode, 125))
 	case <-time.After(10 * time.Second):
 		t.Fatal("cmd did not return before the timeout")
 	}
diff --git a/cli/command/image/build.go b/cli/command/image/build.go
@@ -371,7 +371,7 @@ func runBuild(ctx context.Context, dockerCli command.Cli, options buildOptions)
 			if options.quiet {
 				fmt.Fprintf(dockerCli.Err(), "%s%s", progBuff, buildBuff)
 			}
-			return cli.StatusError{Status: jerr.Message, StatusCode: jerr.Code}
+			return cli.StatusError{Cause: jerr, StatusCode: jerr.Code}
 		}
 		return err
 	}
diff --git a/cli/command/inspect/inspector.go b/cli/command/inspect/inspector.go
@@ -67,7 +67,7 @@ type GetRefFunc func(ref string) (any, []byte, error)
 func Inspect(out io.Writer, references []string, tmplStr string, getRef GetRefFunc) error {
 	inspector, err := NewTemplateInspectorFromString(out, tmplStr)
 	if err != nil {
-		return cli.StatusError{StatusCode: 64, Status: err.Error()}
+		return cli.StatusError{StatusCode: 64, Cause: err}
 	}
 
 	var inspectErrs []string
@@ -90,7 +90,7 @@ func Inspect(out io.Writer, references []string, tmplStr string, getRef GetRefFu
 	if len(inspectErrs) != 0 {
 		return cli.StatusError{
 			StatusCode: 1,
-			Status:     strings.Join(inspectErrs, "\n"),
+			Cause:      errors.New(strings.Join(inspectErrs, "\n")),
 		}
 	}
 	return nil
diff --git a/cli/command/node/inspect.go b/cli/command/node/inspect.go
@@ -69,7 +69,7 @@ func runInspect(ctx context.Context, dockerCli command.Cli, opts inspectOptions)
 	}
 
 	if err := InspectFormatWrite(nodeCtx, opts.nodeIds, getRef); err != nil {
-		return cli.StatusError{StatusCode: 1, Status: err.Error()}
+		return cli.StatusError{StatusCode: 1, Cause: err}
 	}
 	return nil
 }
diff --git a/cli/command/secret/inspect.go b/cli/command/secret/inspect.go
@@ -65,7 +65,7 @@ func runSecretInspect(ctx context.Context, dockerCli command.Cli, opts inspectOp
 	}
 
 	if err := InspectFormatWrite(secretCtx, opts.names, getRef); err != nil {
-		return cli.StatusError{StatusCode: 1, Status: err.Error()}
+		return cli.StatusError{StatusCode: 1, Cause: err}
 	}
 	return nil
 }
diff --git a/cli/command/service/inspect.go b/cli/command/service/inspect.go
@@ -94,7 +94,7 @@ func runInspect(ctx context.Context, dockerCli command.Cli, opts inspectOptions)
 	}
 
 	if err := InspectFormatWrite(serviceCtx, opts.refs, getRef, getNetwork); err != nil {
-		return cli.StatusError{StatusCode: 1, Status: err.Error()}
+		return cli.StatusError{StatusCode: 1, Cause: err}
 	}
 	return nil
 }
diff --git a/cli/command/system/events.go b/cli/command/system/events.go
@@ -60,7 +60,7 @@ func runEvents(ctx context.Context, dockerCli command.Cli, options *eventsOption
 	if err != nil {
 		return cli.StatusError{
 			StatusCode: 64,
-			Status:     "Error parsing format: " + err.Error(),
+			Cause:      fmt.Errorf("error parsing format: %w", err),
 		}
 	}
 	ctx, cancel := context.WithCancel(ctx)
diff --git a/cli/command/system/info.go b/cli/command/system/info.go
@@ -459,7 +459,7 @@ func formatInfo(output io.Writer, info dockerInfo, format string) error {
 	if err != nil {
 		return cli.StatusError{
 			StatusCode: 64,
-			Status:     "template parsing error: " + err.Error(),
+			Cause:      fmt.Errorf("template parsing error: %w", err),
 		}
 	}
 	err = tmpl.Execute(output, info)
diff --git a/cli/command/system/version.go b/cli/command/system/version.go
@@ -148,7 +148,7 @@ func runVersion(ctx context.Context, dockerCli command.Cli, opts *versionOptions
 	var err error
 	tmpl, err := newVersionTemplate(opts.format)
 	if err != nil {
-		return cli.StatusError{StatusCode: 64, Status: err.Error()}
+		return cli.StatusError{StatusCode: 64, Cause: err}
 	}
 
 	// TODO print error if kubernetes is used?
diff --git a/cli/error.go b/cli/error.go
@@ -6,16 +6,23 @@ import (
 
 // StatusError reports an unsuccessful exit by a command.
 type StatusError struct {
-	Status     string
+	Cause      error
 	StatusCode int
 }
 
 // Error formats the error for printing. If a custom Status is provided,
 // it is returned as-is, otherwise it generates a generic error-message
 // based on the StatusCode.
 func (e StatusError) Error() string {
-	if e.Status == "" {
+	if e.Cause == nil {
 		return "exit status " + strconv.Itoa(e.StatusCode)
 	}
-	return e.Status
+	return e.Cause.Error()
+}
+
+// Unwrap returns the wrapped error.
+//
+// This allows StatusError to be checked with errors.Is.
+func (e StatusError) Unwrap() error {
+	return e.Cause
 }

Original file line number	Diff line number	Diff line change
`@@ -93,7 +93,7 @@ func FlagErrorFunc(cmd *cobra.Command, err error) error {`
`93`	`93`	`}`
`94`	`94`
`95`	`95`	`return StatusError{`
`96`		`- Status: fmt.Sprintf("%s\n\nUsage: %s\n\nRun '%s --help' for more information", err, cmd.UseLine(), cmd.CommandPath()),`
	`96`	`+ Cause: fmt.Errorf("%w\n\nUsage: %s\n\nRun '%s --help' for more information", err, cmd.UseLine(), cmd.CommandPath()),`
`97`	`97`	`StatusCode: 125,`
`98`	`98`	`}`
`99`	`99`	`}`
Original file line number	Diff line number	Diff line change
`@@ -67,7 +67,7 @@ func RunConfigInspect(ctx context.Context, dockerCli command.Cli, opts InspectOp`
`67`	`67`	`}`
`68`	`68`
`69`	`69`	`if err := InspectFormatWrite(configCtx, opts.Names, getRef); err != nil {`
`70`		`- return cli.StatusError{StatusCode: 1, Status: err.Error()}`
	`70`	`+ return cli.StatusError{StatusCode: 1, Cause: err}`
`71`	`71`	`}`
`72`	`72`	`return nil`
`73`	`73`	`}`
Original file line number	Diff line number	Diff line change
`@@ -93,7 +93,7 @@ func NewCreateCommand(dockerCli command.Cli) *cobra.Command {`
`93`	`93`	`func runCreate(ctx context.Context, dockerCli command.Cli, flags pflag.FlagSet, options createOptions, copts *containerOptions) error {`
`94`	`94`	`if err := validatePullOpt(options.pull); err != nil {`
`95`	`95`	`return cli.StatusError{`
`96`		`- Status: withHelp(err, "create").Error(),`
	`96`	`+ Cause: withHelp(err, "create"),`
`97`	`97`	`StatusCode: 125,`
`98`	`98`	`}`
`99`	`99`	`}`
`@@ -110,13 +110,13 @@ func runCreate(ctx context.Context, dockerCli command.Cli, flags *pflag.FlagSet,`
`110`	`110`	`containerCfg, err := parse(flags, copts, dockerCli.ServerInfo().OSType)`
`111`	`111`	`if err != nil {`
`112`	`112`	`return cli.StatusError{`
`113`		`- Status: withHelp(err, "create").Error(),`
	`113`	`+ Cause: withHelp(err, "create"),`
`114`	`114`	`StatusCode: 125,`
`115`	`115`	`}`
`116`	`116`	`}`
`117`	`117`	`if err = validateAPIVersion(containerCfg, dockerCli.Client().ClientVersion()); err != nil {`
`118`	`118`	`return cli.StatusError{`
`119`		`- Status: withHelp(err, "create").Error(),`
	`119`	`+ Cause: withHelp(err, "create"),`
`120`	`120`	`StatusCode: 125,`
`121`	`121`	`}`
`122`	`122`	`}`
Original file line number	Diff line number	Diff line change
`@@ -85,7 +85,7 @@ func NewRunCommand(dockerCli command.Cli) *cobra.Command {`
`85`	`85`	`func runRun(ctx context.Context, dockerCli command.Cli, flags pflag.FlagSet, ropts runOptions, copts *containerOptions) error {`
`86`	`86`	`if err := validatePullOpt(ropts.pull); err != nil {`
`87`	`87`	`return cli.StatusError{`
`88`		`- Status: withHelp(err, "run").Error(),`
	`88`	`+ Cause: withHelp(err, "run"),`
`89`	`89`	`StatusCode: 125,`
`90`	`90`	`}`
`91`	`91`	`}`
`@@ -103,13 +103,13 @@ func runRun(ctx context.Context, dockerCli command.Cli, flags *pflag.FlagSet, ro`
`103`	`103`	`// just in case the parse does not exit`
`104`	`104`	`if err != nil {`
`105`	`105`	`return cli.StatusError{`
`106`		`- Status: withHelp(err, "run").Error(),`
	`106`	`+ Cause: withHelp(err, "run"),`
`107`	`107`	`StatusCode: 125,`
`108`	`108`	`}`
`109`	`109`	`}`
`110`	`110`	`if err = validateAPIVersion(containerCfg, dockerCli.CurrentVersion()); err != nil {`
`111`	`111`	`return cli.StatusError{`
`112`		`- Status: withHelp(err, "run").Error(),`
	`112`	`+ Cause: withHelp(err, "run"),`
`113`	`113`	`StatusCode: 125,`
`114`	`114`	`}`
`115`	`115`	`}`
`@@ -315,20 +315,20 @@ func toStatusError(err error) error {`
`315`	`315`
`316`	`316`	`if strings.Contains(errMsg, "executable file not found") \|\| strings.Contains(errMsg, "no such file or directory") \|\| strings.Contains(errMsg, "system cannot find the file specified") {`
`317`	`317`	`return cli.StatusError{`
`318`		`- Status: withHelp(err, "run").Error(),`
	`318`	`+ Cause: withHelp(err, "run"),`
`319`	`319`	`StatusCode: 127,`
`320`	`320`	`}`
`321`	`321`	`}`
`322`	`322`
`323`	`323`	`if strings.Contains(errMsg, syscall.EACCES.Error()) \|\| strings.Contains(errMsg, syscall.EISDIR.Error()) {`
`324`	`324`	`return cli.StatusError{`
`325`		`- Status: withHelp(err, "run").Error(),`
	`325`	`+ Cause: withHelp(err, "run"),`
`326`	`326`	`StatusCode: 126,`
`327`	`327`	`}`
`328`	`328`	`}`
`329`	`329`
`330`	`330`	`return cli.StatusError{`
`331`		`- Status: withHelp(err, "run").Error(),`
	`331`	`+ Cause: withHelp(err, "run"),`
`332`	`332`	`StatusCode: 125,`
`333`	`333`	`}`
`334`	`334`	`}`
Original file line number	Diff line number	Diff line change
`@@ -371,7 +371,7 @@ func runBuild(ctx context.Context, dockerCli command.Cli, options buildOptions)`
`371`	`371`	`if options.quiet {`
`372`	`372`	`fmt.Fprintf(dockerCli.Err(), "%s%s", progBuff, buildBuff)`
`373`	`373`	`}`
`374`		`- return cli.StatusError{Status: jerr.Message, StatusCode: jerr.Code}`
	`374`	`+ return cli.StatusError{Cause: jerr, StatusCode: jerr.Code}`
`375`	`375`	`}`
`376`	`376`	`return err`
`377`	`377`	`}`
Original file line number	Diff line number	Diff line change
`@@ -67,7 +67,7 @@ type GetRefFunc func(ref string) (any, []byte, error)`
`67`	`67`	`func Inspect(out io.Writer, references []string, tmplStr string, getRef GetRefFunc) error {`
`68`	`68`	`inspector, err := NewTemplateInspectorFromString(out, tmplStr)`
`69`	`69`	`if err != nil {`
`70`		`- return cli.StatusError{StatusCode: 64, Status: err.Error()}`
	`70`	`+ return cli.StatusError{StatusCode: 64, Cause: err}`
`71`	`71`	`}`
`72`	`72`
`73`	`73`	`var inspectErrs []string`
`@@ -90,7 +90,7 @@ func Inspect(out io.Writer, references []string, tmplStr string, getRef GetRefFu`
`90`	`90`	`if len(inspectErrs) != 0 {`
`91`	`91`	`return cli.StatusError{`
`92`	`92`	`StatusCode: 1,`
`93`		`- Status: strings.Join(inspectErrs, "\n"),`
	`93`	`+ Cause: errors.New(strings.Join(inspectErrs, "\n")),`
`94`	`94`	`}`
`95`	`95`	`}`
`96`	`96`	`return nil`
Original file line number	Diff line number	Diff line change
`@@ -69,7 +69,7 @@ func runInspect(ctx context.Context, dockerCli command.Cli, opts inspectOptions)`
`69`	`69`	`}`
`70`	`70`
`71`	`71`	`if err := InspectFormatWrite(nodeCtx, opts.nodeIds, getRef); err != nil {`
`72`		`- return cli.StatusError{StatusCode: 1, Status: err.Error()}`
	`72`	`+ return cli.StatusError{StatusCode: 1, Cause: err}`
`73`	`73`	`}`
`74`	`74`	`return nil`
`75`	`75`	`}`
Original file line number	Diff line number	Diff line change
`@@ -65,7 +65,7 @@ func runSecretInspect(ctx context.Context, dockerCli command.Cli, opts inspectOp`
`65`	`65`	`}`
`66`	`66`
`67`	`67`	`if err := InspectFormatWrite(secretCtx, opts.names, getRef); err != nil {`
`68`		`- return cli.StatusError{StatusCode: 1, Status: err.Error()}`
	`68`	`+ return cli.StatusError{StatusCode: 1, Cause: err}`
`69`	`69`	`}`
`70`	`70`	`return nil`
`71`	`71`	`}`
Original file line number	Diff line number	Diff line change
`@@ -94,7 +94,7 @@ func runInspect(ctx context.Context, dockerCli command.Cli, opts inspectOptions)`
`94`	`94`	`}`
`95`	`95`
`96`	`96`	`if err := InspectFormatWrite(serviceCtx, opts.refs, getRef, getNetwork); err != nil {`
`97`		`- return cli.StatusError{StatusCode: 1, Status: err.Error()}`
	`97`	`+ return cli.StatusError{StatusCode: 1, Cause: err}`
`98`	`98`	`}`
`99`	`99`	`return nil`
`100`	`100`	`}`