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>
108 lines
2.4 KiB
Go
108 lines
2.4 KiB
Go
package swarm
|
|
|
|
import (
|
|
"io"
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/docker/cli/internal/test"
|
|
"github.com/docker/docker/api/types/swarm"
|
|
"github.com/docker/docker/api/types/system"
|
|
"github.com/pkg/errors"
|
|
"gotest.tools/v3/assert"
|
|
is "gotest.tools/v3/assert/cmp"
|
|
)
|
|
|
|
func TestSwarmJoinErrors(t *testing.T) {
|
|
testCases := []struct {
|
|
name string
|
|
args []string
|
|
swarmJoinFunc func() error
|
|
infoFunc func() (system.Info, error)
|
|
expectedError string
|
|
}{
|
|
{
|
|
name: "not-enough-args",
|
|
expectedError: "requires 1 argument",
|
|
},
|
|
{
|
|
name: "too-many-args",
|
|
args: []string{"remote1", "remote2"},
|
|
expectedError: "requires 1 argument",
|
|
},
|
|
{
|
|
name: "join-failed",
|
|
args: []string{"remote"},
|
|
swarmJoinFunc: func() error {
|
|
return errors.Errorf("error joining the swarm")
|
|
},
|
|
expectedError: "error joining the swarm",
|
|
},
|
|
{
|
|
name: "join-failed-on-init",
|
|
args: []string{"remote"},
|
|
infoFunc: func() (system.Info, error) {
|
|
return system.Info{}, errors.Errorf("error asking for node info")
|
|
},
|
|
expectedError: "error asking for node info",
|
|
},
|
|
}
|
|
for _, tc := range testCases {
|
|
tc := tc
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
cmd := newJoinCommand(
|
|
test.NewFakeCli(&fakeClient{
|
|
swarmJoinFunc: tc.swarmJoinFunc,
|
|
infoFunc: tc.infoFunc,
|
|
}))
|
|
cmd.SetArgs(tc.args)
|
|
cmd.SetOut(io.Discard)
|
|
cmd.SetErr(io.Discard)
|
|
assert.ErrorContains(t, cmd.Execute(), tc.expectedError)
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestSwarmJoin(t *testing.T) {
|
|
testCases := []struct {
|
|
name string
|
|
infoFunc func() (system.Info, error)
|
|
expected string
|
|
}{
|
|
{
|
|
name: "join-as-manager",
|
|
infoFunc: func() (system.Info, error) {
|
|
return system.Info{
|
|
Swarm: swarm.Info{
|
|
ControlAvailable: true,
|
|
},
|
|
}, nil
|
|
},
|
|
expected: "This node joined a swarm as a manager.",
|
|
},
|
|
{
|
|
name: "join-as-worker",
|
|
infoFunc: func() (system.Info, error) {
|
|
return system.Info{
|
|
Swarm: swarm.Info{
|
|
ControlAvailable: false,
|
|
},
|
|
}, nil
|
|
},
|
|
expected: "This node joined a swarm as a worker.",
|
|
},
|
|
}
|
|
for _, tc := range testCases {
|
|
tc := tc
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
cli := test.NewFakeCli(&fakeClient{
|
|
infoFunc: tc.infoFunc,
|
|
})
|
|
cmd := newJoinCommand(cli)
|
|
cmd.SetArgs([]string{"remote"})
|
|
assert.NilError(t, cmd.Execute())
|
|
assert.Check(t, is.Equal(strings.TrimSpace(cli.OutBuffer().String()), tc.expected))
|
|
})
|
|
}
|
|
}
|