DockerCLI/cli/command/system
Sebastiaan van Stijn bca2090061
cli: make cli.StatusError slightly prettier
This error didn't do a great job at formatting. If a StatusError was
produced without a Status message, it would print a very non-informative
error, with information missing.

Let's update the output:

- If a status-message is provided; print just that (after all the
  status code is something that can be found from the shell, e.g.
  through `echo $?` in Bash).
- If no status-message is provided: print a message more similar to
  Go's `exec.ExecError`, which uses `os.rocessState.String()` (see [1]).

Before this patch, an error without custom status would print:

    Status: , Code: 2

After this patch:

    exit status 2

In situations where a custom error-message is provided, the error-message
is print as-is, whereas before this patch, the message got combined with
the `Status:` and `Code:`, which resulted in some odd output.

Before this patch:

    docker volume --no-such-flag
    Status: unknown flag: --no-such-flag
    See 'docker volume --help'.

    Usage:  docker volume COMMAND

    Manage volumes

    Commands:
      create      Create a volume
      inspect     Display detailed information on one or more volumes
      ls          List volumes
      prune       Remove unused local volumes
      rm          Remove one or more volumes
      update      Update a volume (cluster volumes only)

    Run 'docker volume COMMAND --help' for more information on a command.
    , Code: 125

With this patch, the error is shown as-is;

    docker volume --no-such-flag
    unknown flag: --no-such-flag
    See 'docker volume --help'.

    Usage:  docker volume COMMAND

    Manage volumes

    Commands:
      create      Create a volume
      inspect     Display detailed information on one or more volumes
      ls          List volumes
      prune       Remove unused local volumes
      rm          Remove one or more volumes
      update      Update a volume (cluster volumes only)

    Run 'docker volume COMMAND --help' for more information on a command.

While the exit-code is no longer printed, it's still properly handled;

    echo $?
    125

[1]: 82c14346d8/src/os/exec_posix.go (L107-L135)

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2024-07-04 22:08:18 +02:00
..
testdata info: remove printServerWarningsLegacy 2024-01-20 20:45:59 +01:00
client_test.go vendor: github.com/docker/docker a736d0701c41 (master, v27.0.0-dev) 2024-06-10 17:41:09 +02:00
cmd.go Revert "Disable `docker system dial-stdio` on Windows" 2019-03-12 14:57:52 +00:00
df.go Plumb contexts through commands 2023-12-12 22:30:16 +01:00
dial_stdio.go Plumb contexts through commands 2023-12-12 22:30:16 +01:00
events.go vendor: github.com/docker/docker a736d0701c41 (master, v27.0.0-dev) 2024-06-10 17:41:09 +02:00
events_test.go vendor: github.com/docker/docker a736d0701c41 (master, v27.0.0-dev) 2024-06-10 17:41:09 +02:00
info.go Update go:build comments to go1.21 2024-06-18 12:17:13 +02:00
info_test.go cli: make cli.StatusError slightly prettier 2024-07-04 22:08:18 +02:00
inspect.go Update go:build comments to go1.21 2024-06-18 12:17:13 +02:00
prune.go linting: fmt.Errorf can be replaced with errors.New (perfsprint) 2024-06-10 21:19:31 +02:00
prune_test.go test spring-cleaning 2024-07-04 01:35:12 +02:00
version.go Plumb contexts through commands 2023-12-12 22:30:16 +01:00
version_test.go test spring-cleaning 2024-07-04 01:35:12 +02:00