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>
151 lines
4.2 KiB
Go
151 lines
4.2 KiB
Go
package config
|
|
|
|
import (
|
|
"context"
|
|
"io"
|
|
"os"
|
|
"path/filepath"
|
|
"reflect"
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/docker/cli/internal/test"
|
|
"github.com/docker/docker/api/types"
|
|
"github.com/docker/docker/api/types/swarm"
|
|
"github.com/pkg/errors"
|
|
"gotest.tools/v3/assert"
|
|
is "gotest.tools/v3/assert/cmp"
|
|
"gotest.tools/v3/golden"
|
|
)
|
|
|
|
const configDataFile = "config-create-with-name.golden"
|
|
|
|
func TestConfigCreateErrors(t *testing.T) {
|
|
testCases := []struct {
|
|
args []string
|
|
configCreateFunc func(context.Context, swarm.ConfigSpec) (types.ConfigCreateResponse, error)
|
|
expectedError string
|
|
}{
|
|
{
|
|
args: []string{"too_few"},
|
|
expectedError: "requires 2 arguments",
|
|
},
|
|
{
|
|
args: []string{"too", "many", "arguments"},
|
|
expectedError: "requires 2 arguments",
|
|
},
|
|
{
|
|
args: []string{"name", filepath.Join("testdata", configDataFile)},
|
|
configCreateFunc: func(_ context.Context, configSpec swarm.ConfigSpec) (types.ConfigCreateResponse, error) {
|
|
return types.ConfigCreateResponse{}, errors.Errorf("error creating config")
|
|
},
|
|
expectedError: "error creating config",
|
|
},
|
|
}
|
|
for _, tc := range testCases {
|
|
tc := tc
|
|
t.Run(tc.expectedError, func(t *testing.T) {
|
|
cmd := newConfigCreateCommand(
|
|
test.NewFakeCli(&fakeClient{
|
|
configCreateFunc: tc.configCreateFunc,
|
|
}),
|
|
)
|
|
cmd.SetArgs(tc.args)
|
|
cmd.SetOut(io.Discard)
|
|
cmd.SetErr(io.Discard)
|
|
assert.ErrorContains(t, cmd.Execute(), tc.expectedError)
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestConfigCreateWithName(t *testing.T) {
|
|
name := "foo"
|
|
var actual []byte
|
|
cli := test.NewFakeCli(&fakeClient{
|
|
configCreateFunc: func(_ context.Context, spec swarm.ConfigSpec) (types.ConfigCreateResponse, error) {
|
|
if spec.Name != name {
|
|
return types.ConfigCreateResponse{}, errors.Errorf("expected name %q, got %q", name, spec.Name)
|
|
}
|
|
|
|
actual = spec.Data
|
|
|
|
return types.ConfigCreateResponse{
|
|
ID: "ID-" + spec.Name,
|
|
}, nil
|
|
},
|
|
})
|
|
|
|
cmd := newConfigCreateCommand(cli)
|
|
cmd.SetArgs([]string{name, filepath.Join("testdata", configDataFile)})
|
|
assert.NilError(t, cmd.Execute())
|
|
golden.Assert(t, string(actual), configDataFile)
|
|
assert.Check(t, is.Equal("ID-"+name, strings.TrimSpace(cli.OutBuffer().String())))
|
|
}
|
|
|
|
func TestConfigCreateWithLabels(t *testing.T) {
|
|
expectedLabels := map[string]string{
|
|
"lbl1": "Label-foo",
|
|
"lbl2": "Label-bar",
|
|
}
|
|
name := "foo"
|
|
|
|
data, err := os.ReadFile(filepath.Join("testdata", configDataFile))
|
|
assert.NilError(t, err)
|
|
|
|
expected := swarm.ConfigSpec{
|
|
Annotations: swarm.Annotations{
|
|
Name: name,
|
|
Labels: expectedLabels,
|
|
},
|
|
Data: data,
|
|
}
|
|
|
|
cli := test.NewFakeCli(&fakeClient{
|
|
configCreateFunc: func(_ context.Context, spec swarm.ConfigSpec) (types.ConfigCreateResponse, error) {
|
|
if !reflect.DeepEqual(spec, expected) {
|
|
return types.ConfigCreateResponse{}, errors.Errorf("expected %+v, got %+v", expected, spec)
|
|
}
|
|
|
|
return types.ConfigCreateResponse{
|
|
ID: "ID-" + spec.Name,
|
|
}, nil
|
|
},
|
|
})
|
|
|
|
cmd := newConfigCreateCommand(cli)
|
|
cmd.SetArgs([]string{name, filepath.Join("testdata", configDataFile)})
|
|
cmd.Flags().Set("label", "lbl1=Label-foo")
|
|
cmd.Flags().Set("label", "lbl2=Label-bar")
|
|
assert.NilError(t, cmd.Execute())
|
|
assert.Check(t, is.Equal("ID-"+name, strings.TrimSpace(cli.OutBuffer().String())))
|
|
}
|
|
|
|
func TestConfigCreateWithTemplatingDriver(t *testing.T) {
|
|
expectedDriver := &swarm.Driver{
|
|
Name: "template-driver",
|
|
}
|
|
name := "foo"
|
|
|
|
cli := test.NewFakeCli(&fakeClient{
|
|
configCreateFunc: func(_ context.Context, spec swarm.ConfigSpec) (types.ConfigCreateResponse, error) {
|
|
if spec.Name != name {
|
|
return types.ConfigCreateResponse{}, errors.Errorf("expected name %q, got %q", name, spec.Name)
|
|
}
|
|
|
|
if spec.Templating.Name != expectedDriver.Name {
|
|
return types.ConfigCreateResponse{}, errors.Errorf("expected driver %v, got %v", expectedDriver, spec.Labels)
|
|
}
|
|
|
|
return types.ConfigCreateResponse{
|
|
ID: "ID-" + spec.Name,
|
|
}, nil
|
|
},
|
|
})
|
|
|
|
cmd := newConfigCreateCommand(cli)
|
|
cmd.SetArgs([]string{name, filepath.Join("testdata", configDataFile)})
|
|
cmd.Flags().Set("template-driver", expectedDriver.Name)
|
|
assert.NilError(t, cmd.Execute())
|
|
assert.Check(t, is.Equal("ID-"+name, strings.TrimSpace(cli.OutBuffer().String())))
|
|
}
|