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>
109 lines
3.4 KiB
Go
109 lines
3.4 KiB
Go
package service
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"io"
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/docker/cli/internal/test"
|
|
"github.com/docker/docker/api/types"
|
|
"github.com/docker/docker/api/types/swarm"
|
|
"gotest.tools/v3/assert"
|
|
is "gotest.tools/v3/assert/cmp"
|
|
)
|
|
|
|
func TestRollback(t *testing.T) {
|
|
testCases := []struct {
|
|
name string
|
|
args []string
|
|
serviceUpdateFunc func(ctx context.Context, serviceID string, version swarm.Version, service swarm.ServiceSpec, options types.ServiceUpdateOptions) (swarm.ServiceUpdateResponse, error)
|
|
expectedDockerCliErr string
|
|
}{
|
|
{
|
|
name: "rollback-service",
|
|
args: []string{"service-id"},
|
|
},
|
|
{
|
|
name: "rollback-service-with-warnings",
|
|
args: []string{"service-id"},
|
|
serviceUpdateFunc: func(ctx context.Context, serviceID string, version swarm.Version, service swarm.ServiceSpec, options types.ServiceUpdateOptions) (swarm.ServiceUpdateResponse, error) {
|
|
response := swarm.ServiceUpdateResponse{}
|
|
|
|
response.Warnings = []string{
|
|
"- warning 1",
|
|
"- warning 2",
|
|
}
|
|
|
|
return response, nil
|
|
},
|
|
expectedDockerCliErr: "- warning 1\n- warning 2",
|
|
},
|
|
}
|
|
|
|
for _, tc := range testCases {
|
|
cli := test.NewFakeCli(&fakeClient{
|
|
serviceUpdateFunc: tc.serviceUpdateFunc,
|
|
})
|
|
cmd := newRollbackCommand(cli)
|
|
cmd.SetArgs(tc.args)
|
|
cmd.Flags().Set("quiet", "true")
|
|
cmd.SetOut(io.Discard)
|
|
assert.NilError(t, cmd.Execute())
|
|
assert.Check(t, is.Equal(strings.TrimSpace(cli.ErrBuffer().String()), tc.expectedDockerCliErr))
|
|
}
|
|
}
|
|
|
|
func TestRollbackWithErrors(t *testing.T) {
|
|
testCases := []struct {
|
|
name string
|
|
args []string
|
|
serviceInspectWithRawFunc func(ctx context.Context, serviceID string, options types.ServiceInspectOptions) (swarm.Service, []byte, error)
|
|
serviceUpdateFunc func(ctx context.Context, serviceID string, version swarm.Version, service swarm.ServiceSpec, options types.ServiceUpdateOptions) (swarm.ServiceUpdateResponse, error)
|
|
expectedError string
|
|
}{
|
|
{
|
|
name: "not-enough-args",
|
|
expectedError: "requires 1 argument",
|
|
},
|
|
{
|
|
name: "too-many-args",
|
|
args: []string{"service-id-1", "service-id-2"},
|
|
expectedError: "requires 1 argument",
|
|
},
|
|
{
|
|
name: "service-does-not-exists",
|
|
args: []string{"service-id"},
|
|
serviceInspectWithRawFunc: func(ctx context.Context, serviceID string, options types.ServiceInspectOptions) (swarm.Service, []byte, error) {
|
|
return swarm.Service{}, []byte{}, fmt.Errorf("no such services: %s", serviceID)
|
|
},
|
|
expectedError: "no such services: service-id",
|
|
},
|
|
{
|
|
name: "service-update-failed",
|
|
args: []string{"service-id"},
|
|
serviceUpdateFunc: func(ctx context.Context, serviceID string, version swarm.Version, service swarm.ServiceSpec, options types.ServiceUpdateOptions) (swarm.ServiceUpdateResponse, error) {
|
|
return swarm.ServiceUpdateResponse{}, fmt.Errorf("no such services: %s", serviceID)
|
|
},
|
|
expectedError: "no such services: service-id",
|
|
},
|
|
}
|
|
|
|
for _, tc := range testCases {
|
|
tc := tc
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
cmd := newRollbackCommand(
|
|
test.NewFakeCli(&fakeClient{
|
|
serviceInspectWithRawFunc: tc.serviceInspectWithRawFunc,
|
|
serviceUpdateFunc: tc.serviceUpdateFunc,
|
|
}))
|
|
cmd.SetArgs(tc.args)
|
|
cmd.Flags().Set("quiet", "true")
|
|
cmd.SetOut(io.Discard)
|
|
cmd.SetErr(io.Discard)
|
|
assert.ErrorContains(t, cmd.Execute(), tc.expectedError)
|
|
})
|
|
}
|
|
}
|