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>
170 lines
4.8 KiB
Go
170 lines
4.8 KiB
Go
package node
|
|
|
|
import (
|
|
"io"
|
|
"testing"
|
|
|
|
"github.com/docker/cli/internal/test"
|
|
"github.com/docker/cli/internal/test/builders"
|
|
"github.com/docker/docker/api/types/swarm"
|
|
"github.com/pkg/errors"
|
|
"gotest.tools/v3/assert"
|
|
)
|
|
|
|
func TestNodeUpdateErrors(t *testing.T) {
|
|
testCases := []struct {
|
|
args []string
|
|
flags map[string]string
|
|
nodeInspectFunc func() (swarm.Node, []byte, error)
|
|
nodeUpdateFunc func(nodeID string, version swarm.Version, node swarm.NodeSpec) error
|
|
expectedError string
|
|
}{
|
|
{
|
|
expectedError: "requires 1 argument",
|
|
},
|
|
{
|
|
args: []string{"node1", "node2"},
|
|
expectedError: "requires 1 argument",
|
|
},
|
|
{
|
|
args: []string{"nodeID"},
|
|
nodeInspectFunc: func() (swarm.Node, []byte, error) {
|
|
return swarm.Node{}, []byte{}, errors.Errorf("error inspecting the node")
|
|
},
|
|
expectedError: "error inspecting the node",
|
|
},
|
|
{
|
|
args: []string{"nodeID"},
|
|
nodeUpdateFunc: func(nodeID string, version swarm.Version, node swarm.NodeSpec) error {
|
|
return errors.Errorf("error updating the node")
|
|
},
|
|
expectedError: "error updating the node",
|
|
},
|
|
{
|
|
args: []string{"nodeID"},
|
|
nodeInspectFunc: func() (swarm.Node, []byte, error) {
|
|
return *builders.Node(builders.NodeLabels(map[string]string{
|
|
"key": "value",
|
|
})), []byte{}, nil
|
|
},
|
|
flags: map[string]string{
|
|
"label-rm": "notpresent",
|
|
},
|
|
expectedError: "key notpresent doesn't exist in node's labels",
|
|
},
|
|
}
|
|
for _, tc := range testCases {
|
|
cmd := newUpdateCommand(
|
|
test.NewFakeCli(&fakeClient{
|
|
nodeInspectFunc: tc.nodeInspectFunc,
|
|
nodeUpdateFunc: tc.nodeUpdateFunc,
|
|
}))
|
|
cmd.SetArgs(tc.args)
|
|
for key, value := range tc.flags {
|
|
assert.Check(t, cmd.Flags().Set(key, value))
|
|
}
|
|
cmd.SetOut(io.Discard)
|
|
cmd.SetErr(io.Discard)
|
|
assert.ErrorContains(t, cmd.Execute(), tc.expectedError)
|
|
}
|
|
}
|
|
|
|
func TestNodeUpdate(t *testing.T) {
|
|
testCases := []struct {
|
|
args []string
|
|
flags map[string]string
|
|
nodeInspectFunc func() (swarm.Node, []byte, error)
|
|
nodeUpdateFunc func(nodeID string, version swarm.Version, node swarm.NodeSpec) error
|
|
}{
|
|
{
|
|
args: []string{"nodeID"},
|
|
flags: map[string]string{
|
|
"role": "manager",
|
|
},
|
|
nodeInspectFunc: func() (swarm.Node, []byte, error) {
|
|
return *builders.Node(), []byte{}, nil
|
|
},
|
|
nodeUpdateFunc: func(nodeID string, version swarm.Version, node swarm.NodeSpec) error {
|
|
if node.Role != swarm.NodeRoleManager {
|
|
return errors.Errorf("expected role manager, got %s", node.Role)
|
|
}
|
|
return nil
|
|
},
|
|
},
|
|
{
|
|
args: []string{"nodeID"},
|
|
flags: map[string]string{
|
|
"availability": "drain",
|
|
},
|
|
nodeInspectFunc: func() (swarm.Node, []byte, error) {
|
|
return *builders.Node(), []byte{}, nil
|
|
},
|
|
nodeUpdateFunc: func(nodeID string, version swarm.Version, node swarm.NodeSpec) error {
|
|
if node.Availability != swarm.NodeAvailabilityDrain {
|
|
return errors.Errorf("expected drain availability, got %s", node.Availability)
|
|
}
|
|
return nil
|
|
},
|
|
},
|
|
{
|
|
args: []string{"nodeID"},
|
|
flags: map[string]string{
|
|
"label-add": "lbl",
|
|
},
|
|
nodeInspectFunc: func() (swarm.Node, []byte, error) {
|
|
return *builders.Node(), []byte{}, nil
|
|
},
|
|
nodeUpdateFunc: func(nodeID string, version swarm.Version, node swarm.NodeSpec) error {
|
|
if _, present := node.Annotations.Labels["lbl"]; !present {
|
|
return errors.Errorf("expected 'lbl' label, got %v", node.Annotations.Labels)
|
|
}
|
|
return nil
|
|
},
|
|
},
|
|
{
|
|
args: []string{"nodeID"},
|
|
flags: map[string]string{
|
|
"label-add": "key=value",
|
|
},
|
|
nodeInspectFunc: func() (swarm.Node, []byte, error) {
|
|
return *builders.Node(), []byte{}, nil
|
|
},
|
|
nodeUpdateFunc: func(nodeID string, version swarm.Version, node swarm.NodeSpec) error {
|
|
if value, present := node.Annotations.Labels["key"]; !present || value != "value" {
|
|
return errors.Errorf("expected 'key' label to be 'value', got %v", node.Annotations.Labels)
|
|
}
|
|
return nil
|
|
},
|
|
},
|
|
{
|
|
args: []string{"nodeID"},
|
|
flags: map[string]string{
|
|
"label-rm": "key",
|
|
},
|
|
nodeInspectFunc: func() (swarm.Node, []byte, error) {
|
|
return *builders.Node(builders.NodeLabels(map[string]string{
|
|
"key": "value",
|
|
})), []byte{}, nil
|
|
},
|
|
nodeUpdateFunc: func(nodeID string, version swarm.Version, node swarm.NodeSpec) error {
|
|
if len(node.Annotations.Labels) > 0 {
|
|
return errors.Errorf("expected no labels, got %v", node.Annotations.Labels)
|
|
}
|
|
return nil
|
|
},
|
|
},
|
|
}
|
|
for _, tc := range testCases {
|
|
cmd := newUpdateCommand(
|
|
test.NewFakeCli(&fakeClient{
|
|
nodeInspectFunc: tc.nodeInspectFunc,
|
|
nodeUpdateFunc: tc.nodeUpdateFunc,
|
|
}))
|
|
cmd.SetArgs(tc.args)
|
|
for key, value := range tc.flags {
|
|
assert.Check(t, cmd.Flags().Set(key, value))
|
|
}
|
|
assert.NilError(t, cmd.Execute())
|
|
}
|
|
}
|