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>
109 lines
2.9 KiB
Go
109 lines
2.9 KiB
Go
package image
|
|
|
|
import (
|
|
"fmt"
|
|
"io"
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/docker/cli/internal/test"
|
|
"github.com/docker/docker/api/types/image"
|
|
"github.com/pkg/errors"
|
|
"gotest.tools/v3/assert"
|
|
"gotest.tools/v3/golden"
|
|
)
|
|
|
|
func TestNewLoadCommandErrors(t *testing.T) {
|
|
testCases := []struct {
|
|
name string
|
|
args []string
|
|
isTerminalIn bool
|
|
expectedError string
|
|
imageLoadFunc func(input io.Reader, quiet bool) (image.LoadResponse, error)
|
|
}{
|
|
{
|
|
name: "wrong-args",
|
|
args: []string{"arg"},
|
|
expectedError: "accepts no arguments",
|
|
},
|
|
{
|
|
name: "input-to-terminal",
|
|
isTerminalIn: true,
|
|
expectedError: "requested load from stdin, but stdin is empty",
|
|
},
|
|
{
|
|
name: "pull-error",
|
|
expectedError: "something went wrong",
|
|
imageLoadFunc: func(input io.Reader, quiet bool) (image.LoadResponse, error) {
|
|
return image.LoadResponse{}, errors.Errorf("something went wrong")
|
|
},
|
|
},
|
|
}
|
|
for _, tc := range testCases {
|
|
tc := tc
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
cli := test.NewFakeCli(&fakeClient{imageLoadFunc: tc.imageLoadFunc})
|
|
cli.In().SetIsTerminal(tc.isTerminalIn)
|
|
cmd := NewLoadCommand(cli)
|
|
cmd.SetOut(io.Discard)
|
|
cmd.SetErr(io.Discard)
|
|
cmd.SetArgs(tc.args)
|
|
assert.ErrorContains(t, cmd.Execute(), tc.expectedError)
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestNewLoadCommandInvalidInput(t *testing.T) {
|
|
expectedError := "open *"
|
|
cmd := NewLoadCommand(test.NewFakeCli(&fakeClient{}))
|
|
cmd.SetOut(io.Discard)
|
|
cmd.SetErr(io.Discard)
|
|
cmd.SetArgs([]string{"--input", "*"})
|
|
err := cmd.Execute()
|
|
assert.ErrorContains(t, err, expectedError)
|
|
}
|
|
|
|
func TestNewLoadCommandSuccess(t *testing.T) {
|
|
testCases := []struct {
|
|
name string
|
|
args []string
|
|
imageLoadFunc func(input io.Reader, quiet bool) (image.LoadResponse, error)
|
|
}{
|
|
{
|
|
name: "simple",
|
|
imageLoadFunc: func(input io.Reader, quiet bool) (image.LoadResponse, error) {
|
|
return image.LoadResponse{Body: io.NopCloser(strings.NewReader("Success"))}, nil
|
|
},
|
|
},
|
|
{
|
|
name: "json",
|
|
imageLoadFunc: func(input io.Reader, quiet bool) (image.LoadResponse, error) {
|
|
json := "{\"ID\": \"1\"}"
|
|
return image.LoadResponse{
|
|
Body: io.NopCloser(strings.NewReader(json)),
|
|
JSON: true,
|
|
}, nil
|
|
},
|
|
},
|
|
{
|
|
name: "input-file",
|
|
args: []string{"--input", "testdata/load-command-success.input.txt"},
|
|
imageLoadFunc: func(input io.Reader, quiet bool) (image.LoadResponse, error) {
|
|
return image.LoadResponse{Body: io.NopCloser(strings.NewReader("Success"))}, nil
|
|
},
|
|
},
|
|
}
|
|
for _, tc := range testCases {
|
|
tc := tc
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
cli := test.NewFakeCli(&fakeClient{imageLoadFunc: tc.imageLoadFunc})
|
|
cmd := NewLoadCommand(cli)
|
|
cmd.SetOut(io.Discard)
|
|
cmd.SetArgs(tc.args)
|
|
err := cmd.Execute()
|
|
assert.NilError(t, err)
|
|
golden.Assert(t, cli.OutBuffer().String(), fmt.Sprintf("load-command-success.%s.golden", tc.name))
|
|
})
|
|
}
|
|
}
|