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>
85 lines
2.3 KiB
Go
85 lines
2.3 KiB
Go
package network
|
|
|
|
import (
|
|
"context"
|
|
"io"
|
|
"testing"
|
|
|
|
"github.com/docker/cli/internal/test"
|
|
"github.com/docker/docker/api/types/network"
|
|
"github.com/pkg/errors"
|
|
"gotest.tools/v3/assert"
|
|
is "gotest.tools/v3/assert/cmp"
|
|
)
|
|
|
|
func TestNetworkConnectErrors(t *testing.T) {
|
|
testCases := []struct {
|
|
args []string
|
|
networkConnectFunc func(ctx context.Context, networkID, container string, config *network.EndpointSettings) error
|
|
expectedError string
|
|
}{
|
|
{
|
|
expectedError: "requires 2 arguments",
|
|
},
|
|
{
|
|
args: []string{"toto", "titi"},
|
|
networkConnectFunc: func(ctx context.Context, networkID, container string, config *network.EndpointSettings) error {
|
|
return errors.Errorf("error connecting network")
|
|
},
|
|
expectedError: "error connecting network",
|
|
},
|
|
}
|
|
|
|
for _, tc := range testCases {
|
|
cmd := newConnectCommand(
|
|
test.NewFakeCli(&fakeClient{
|
|
networkConnectFunc: tc.networkConnectFunc,
|
|
}),
|
|
)
|
|
cmd.SetArgs(tc.args)
|
|
cmd.SetOut(io.Discard)
|
|
cmd.SetErr(io.Discard)
|
|
assert.ErrorContains(t, cmd.Execute(), tc.expectedError)
|
|
}
|
|
}
|
|
|
|
func TestNetworkConnectWithFlags(t *testing.T) {
|
|
expectedConfig := &network.EndpointSettings{
|
|
IPAMConfig: &network.EndpointIPAMConfig{
|
|
IPv4Address: "192.168.4.1",
|
|
IPv6Address: "fdef:f401:8da0:1234::5678",
|
|
LinkLocalIPs: []string{"169.254.42.42"},
|
|
},
|
|
Links: []string{"otherctr"},
|
|
Aliases: []string{"poor-yorick"},
|
|
DriverOpts: map[string]string{
|
|
"driveropt1": "optval1,optval2",
|
|
"driveropt2": "optval4",
|
|
},
|
|
}
|
|
cli := test.NewFakeCli(&fakeClient{
|
|
networkConnectFunc: func(ctx context.Context, networkID, container string, config *network.EndpointSettings) error {
|
|
assert.Check(t, is.DeepEqual(expectedConfig, config))
|
|
return nil
|
|
},
|
|
})
|
|
args := []string{"mynet", "myctr"}
|
|
cmd := newConnectCommand(cli)
|
|
|
|
cmd.SetArgs(args)
|
|
for _, opt := range []struct{ name, value string }{
|
|
{"alias", "poor-yorick"},
|
|
{"driver-opt", "\"driveropt1=optval1,optval2\""},
|
|
{"driver-opt", "driveropt2=optval3"},
|
|
{"driver-opt", "driveropt2=optval4"}, // replaces value
|
|
{"ip", "192.168.4.1"},
|
|
{"ip6", "fdef:f401:8da0:1234::5678"},
|
|
{"link", "otherctr"},
|
|
{"link-local-ip", "169.254.42.42"},
|
|
} {
|
|
err := cmd.Flags().Set(opt.name, opt.value)
|
|
assert.Check(t, err)
|
|
}
|
|
assert.NilError(t, cmd.Execute())
|
|
}
|