c60b360c33
Improve the output for these validation errors:
- Removes the short command description from the output. This information
does not provide much useful help, and distracts from the error message.
- Reduces punctuation, and
- Prefixes the error message with the binary / root-command name
(usually `docker:`) to be consistent with other similar errors.
- Adds an empty line between the error-message and the "call to action"
(`Run 'docker volume --help'...` in the example below). This helps
separating the error message and "usage" from the call-to-action.
Before this patch:
$ docker volume ls one two three
"docker volume ls" accepts no arguments.
See 'docker volume ls --help'.
Usage: docker volume ls [OPTIONS]
List volumes
$ docker volume create one two three
"docker volume create" requires at most 1 argument.
See 'docker volume create --help'.
Usage: docker volume create [OPTIONS] [VOLUME]
Create a volume
With this patch:
$ docker volume ls one two three
docker: 'docker volume ls' accepts no arguments
Usage: docker volume ls [OPTIONS]
Run 'docker volume ls --help' for more information
$ docker voludocker volume create one two three
docker: 'docker volume create' requires at most 1 argument
Usage: docker volume create [OPTIONS] [VOLUME]
SRun 'docker volume create --help' for more information
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
96 lines
2.5 KiB
Go
96 lines
2.5 KiB
Go
package image
|
|
|
|
import (
|
|
"fmt"
|
|
"io"
|
|
"testing"
|
|
|
|
"github.com/docker/cli/internal/test"
|
|
"github.com/docker/docker/api/types/image"
|
|
"gotest.tools/v3/assert"
|
|
is "gotest.tools/v3/assert/cmp"
|
|
"gotest.tools/v3/golden"
|
|
)
|
|
|
|
func TestNewInspectCommandErrors(t *testing.T) {
|
|
testCases := []struct {
|
|
name string
|
|
args []string
|
|
expectedError string
|
|
}{
|
|
{
|
|
name: "wrong-args",
|
|
args: []string{},
|
|
expectedError: "requires at least 1 argument",
|
|
},
|
|
}
|
|
for _, tc := range testCases {
|
|
tc := tc
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
cmd := newInspectCommand(test.NewFakeCli(&fakeClient{}))
|
|
cmd.SetOut(io.Discard)
|
|
cmd.SetErr(io.Discard)
|
|
cmd.SetArgs(tc.args)
|
|
assert.ErrorContains(t, cmd.Execute(), tc.expectedError)
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestNewInspectCommandSuccess(t *testing.T) {
|
|
imageInspectInvocationCount := 0
|
|
testCases := []struct {
|
|
name string
|
|
args []string
|
|
imageCount int
|
|
imageInspectFunc func(img string) (image.InspectResponse, []byte, error)
|
|
}{
|
|
{
|
|
name: "simple",
|
|
args: []string{"image"},
|
|
imageCount: 1,
|
|
imageInspectFunc: func(img string) (image.InspectResponse, []byte, error) {
|
|
imageInspectInvocationCount++
|
|
assert.Check(t, is.Equal("image", img))
|
|
return image.InspectResponse{}, nil, nil
|
|
},
|
|
},
|
|
{
|
|
name: "format",
|
|
imageCount: 1,
|
|
args: []string{"--format='{{.ID}}'", "image"},
|
|
imageInspectFunc: func(img string) (image.InspectResponse, []byte, error) {
|
|
imageInspectInvocationCount++
|
|
return image.InspectResponse{ID: img}, nil, nil
|
|
},
|
|
},
|
|
{
|
|
name: "simple-many",
|
|
args: []string{"image1", "image2"},
|
|
imageCount: 2,
|
|
imageInspectFunc: func(img string) (image.InspectResponse, []byte, error) {
|
|
imageInspectInvocationCount++
|
|
if imageInspectInvocationCount == 1 {
|
|
assert.Check(t, is.Equal("image1", img))
|
|
} else {
|
|
assert.Check(t, is.Equal("image2", img))
|
|
}
|
|
return image.InspectResponse{}, nil, nil
|
|
},
|
|
},
|
|
}
|
|
for _, tc := range testCases {
|
|
tc := tc
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
imageInspectInvocationCount = 0
|
|
cli := test.NewFakeCli(&fakeClient{imageInspectFunc: tc.imageInspectFunc})
|
|
cmd := newInspectCommand(cli)
|
|
cmd.SetOut(io.Discard)
|
|
cmd.SetArgs(tc.args)
|
|
err := cmd.Execute()
|
|
assert.NilError(t, err)
|
|
golden.Assert(t, cli.OutBuffer().String(), fmt.Sprintf("inspect-command-success.%s.golden", tc.name))
|
|
assert.Check(t, is.Equal(imageInspectInvocationCount, tc.imageCount))
|
|
})
|
|
}
|
|
}
|