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>
82 lines
2.4 KiB
Go
82 lines
2.4 KiB
Go
package manifest
|
|
|
|
import (
|
|
"io"
|
|
"testing"
|
|
|
|
"github.com/docker/cli/cli/manifest/store"
|
|
"github.com/docker/cli/internal/test"
|
|
"gotest.tools/v3/assert"
|
|
is "gotest.tools/v3/assert/cmp"
|
|
"gotest.tools/v3/golden"
|
|
)
|
|
|
|
func TestManifestAnnotateError(t *testing.T) {
|
|
testCases := []struct {
|
|
args []string
|
|
expectedError string
|
|
}{
|
|
{
|
|
args: []string{"too-few-arguments"},
|
|
expectedError: "requires 2 arguments",
|
|
},
|
|
{
|
|
args: []string{"th!si'sa/fa!ke/li$t/name", "example.com/alpine:3.0"},
|
|
expectedError: "error parsing name for manifest list",
|
|
},
|
|
{
|
|
args: []string{"example.com/list:v1", "th!si'sa/fa!ke/im@ge/nam32"},
|
|
expectedError: "error parsing name for manifest",
|
|
},
|
|
}
|
|
|
|
for _, tc := range testCases {
|
|
cli := test.NewFakeCli(nil)
|
|
cmd := newAnnotateCommand(cli)
|
|
cmd.SetArgs(tc.args)
|
|
cmd.SetOut(io.Discard)
|
|
cmd.SetErr(io.Discard)
|
|
assert.ErrorContains(t, cmd.Execute(), tc.expectedError)
|
|
}
|
|
}
|
|
|
|
func TestManifestAnnotate(t *testing.T) {
|
|
manifestStore := store.NewStore(t.TempDir())
|
|
|
|
cli := test.NewFakeCli(nil)
|
|
cli.SetManifestStore(manifestStore)
|
|
namedRef := ref(t, "alpine:3.0")
|
|
imageManifest := fullImageManifest(t, namedRef)
|
|
err := manifestStore.Save(ref(t, "list:v1"), namedRef, imageManifest)
|
|
assert.NilError(t, err)
|
|
|
|
cmd := newAnnotateCommand(cli)
|
|
cmd.SetArgs([]string{"example.com/list:v1", "example.com/fake:0.0"})
|
|
cmd.SetOut(io.Discard)
|
|
cmd.SetErr(io.Discard)
|
|
expectedError := "manifest for image example.com/fake:0.0 does not exist"
|
|
assert.ErrorContains(t, cmd.Execute(), expectedError)
|
|
|
|
cmd.SetArgs([]string{"example.com/list:v1", "example.com/alpine:3.0"})
|
|
cmd.Flags().Set("os", "freebsd")
|
|
cmd.Flags().Set("arch", "fake")
|
|
cmd.Flags().Set("os-version", "1")
|
|
cmd.Flags().Set("os-features", "feature1")
|
|
cmd.Flags().Set("variant", "v7")
|
|
expectedError = "manifest entry for image has unsupported os/arch combination"
|
|
assert.ErrorContains(t, cmd.Execute(), expectedError)
|
|
|
|
cmd.Flags().Set("arch", "arm")
|
|
assert.NilError(t, cmd.Execute())
|
|
|
|
cmd = newInspectCommand(cli)
|
|
err = cmd.Flags().Set("verbose", "true")
|
|
assert.NilError(t, err)
|
|
cmd.SetArgs([]string{"example.com/list:v1", "example.com/alpine:3.0"})
|
|
cmd.SetErr(io.Discard)
|
|
assert.NilError(t, cmd.Execute())
|
|
actual := cli.OutBuffer()
|
|
expected := golden.Get(t, "inspect-annotate.golden")
|
|
assert.Check(t, is.Equal(string(expected), actual.String()))
|
|
}
|