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>
89 lines
2.1 KiB
Go
89 lines
2.1 KiB
Go
package image
|
|
|
|
import (
|
|
"io"
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/docker/cli/internal/test"
|
|
"github.com/docker/docker/api/types/image"
|
|
"github.com/pkg/errors"
|
|
"gotest.tools/v3/assert"
|
|
)
|
|
|
|
func TestNewPushCommandErrors(t *testing.T) {
|
|
testCases := []struct {
|
|
name string
|
|
args []string
|
|
expectedError string
|
|
imagePushFunc func(ref string, options image.PushOptions) (io.ReadCloser, error)
|
|
}{
|
|
{
|
|
name: "wrong-args",
|
|
args: []string{},
|
|
expectedError: "requires 1 argument",
|
|
},
|
|
{
|
|
name: "invalid-name",
|
|
args: []string{"UPPERCASE_REPO"},
|
|
expectedError: "invalid reference format: repository name (library/UPPERCASE_REPO) must be lowercase",
|
|
},
|
|
{
|
|
name: "push-failed",
|
|
args: []string{"image:repo"},
|
|
expectedError: "Failed to push",
|
|
imagePushFunc: func(ref string, options image.PushOptions) (io.ReadCloser, error) {
|
|
return io.NopCloser(strings.NewReader("")), errors.Errorf("Failed to push")
|
|
},
|
|
},
|
|
}
|
|
for _, tc := range testCases {
|
|
tc := tc
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
cli := test.NewFakeCli(&fakeClient{imagePushFunc: tc.imagePushFunc})
|
|
cmd := NewPushCommand(cli)
|
|
cmd.SetOut(io.Discard)
|
|
cmd.SetErr(io.Discard)
|
|
cmd.SetArgs(tc.args)
|
|
assert.ErrorContains(t, cmd.Execute(), tc.expectedError)
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestNewPushCommandSuccess(t *testing.T) {
|
|
testCases := []struct {
|
|
name string
|
|
args []string
|
|
output string
|
|
}{
|
|
{
|
|
name: "push",
|
|
args: []string{"image:tag"},
|
|
},
|
|
{
|
|
name: "push quiet",
|
|
args: []string{"--quiet", "image:tag"},
|
|
output: `docker.io/library/image:tag
|
|
`,
|
|
},
|
|
}
|
|
for _, tc := range testCases {
|
|
tc := tc
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
cli := test.NewFakeCli(&fakeClient{
|
|
imagePushFunc: func(ref string, options image.PushOptions) (io.ReadCloser, error) {
|
|
return io.NopCloser(strings.NewReader("")), nil
|
|
},
|
|
})
|
|
cmd := NewPushCommand(cli)
|
|
cmd.SetOut(cli.OutBuffer())
|
|
cmd.SetErr(io.Discard)
|
|
cmd.SetArgs(tc.args)
|
|
assert.NilError(t, cmd.Execute())
|
|
if tc.output != "" {
|
|
assert.Equal(t, tc.output, cli.OutBuffer().String())
|
|
}
|
|
})
|
|
}
|
|
}
|