Guest24897
/
DockerCLI
mirror of https://github.com/docker/cli.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Parametrized existing completion tests 

Signed-off-by: Harald Albers <github@albersweb.de>
This commit is contained in:
Harald Albers 2024-10-22 07:15:57 +00:00
parent 3517b1bf87
commit e03af58525
1 changed files with 72 additions and 86 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

158
cli/command/system/completion_test.go
View File

@ -3,6 +3,7 @@ package system
import ( import (
"context" "context"
"errors" "errors"
"fmt"
"testing" "testing"
"github.com/docker/docker/api/types/system" "github.com/docker/docker/api/types/system"
@ -16,98 +17,83 @@ import (
"gotest.tools/v3/assert" "gotest.tools/v3/assert"
) )
// Successful completion lists all container names, prefixed with "container=". func TestCompleteEventFilter(t *testing.T) {
// Filtering the completions by the current word is delegated to the completion script. tests := []struct {
func TestCompleteEventFilterContainer(t *testing.T) { client *fakeClient
cli := test.NewFakeCli(&fakeClient{ toComplete string
containerListFunc: func(_ context.Context, _ container.ListOptions) ([]container.Summary, error) { expected []string
return []container.Summary{ }{
*builders.Container("c1"), {
*builders.Container("c2"), client: &fakeClient{
}, nil containerListFunc: func(_ context.Context, _ container.ListOptions) ([]container.Summary, error) {
return []container.Summary{
*builders.Container("c1"),
*builders.Container("c2"),
}, nil
},
},
toComplete: "container=",
expected: []string{"container=c1", "container=c2"},
}, },
}) {
client: &fakeClient{
completions, directive := completeFilters(cli)(NewEventsCommand(cli), nil, "container=") containerListFunc: func(_ context.Context, _ container.ListOptions) ([]container.Summary, error) {
return nil, errors.New("API error")
assert.DeepEqual(t, completions, []string{"container=c1", "container=c2"}) },
assert.Equal(t, directive, cobra.ShellCompDirectiveNoFileComp) },
} toComplete: "container=",
expected: []string{},
// In case of API errors, no completions are returned.
func TestCompleteEventFilterContainerAPIError(t *testing.T) {
cli := test.NewFakeCli(&fakeClient{
containerListFunc: func(_ context.Context, _ container.ListOptions) ([]container.Summary, error) {
return nil, errors.New("API error")
}, },
}) {
client: &fakeClient{
completions, directive := completeFilters(cli)(NewEventsCommand(cli), nil, "container=") infoFunc: func(ctx context.Context) (system.Info, error) {
return system.Info{
assert.DeepEqual(t, completions, []string{}) ID: "daemon-id",
assert.Equal(t, directive, cobra.ShellCompDirectiveNoFileComp) Name: "daemon-name",
} }, nil
},
// Successful completion lists the name and id of the current Docker daemon, prefixed with "daemon=". },
// Filtering the completions by the current word is delegated to the completion script. toComplete: "daemon=",
func TestCompleteEventFilterDaemon(t *testing.T) { expected: []string{"daemon=daemon-name", "daemon=daemon-id"},
cli := test.NewFakeCli(&fakeClient{
infoFunc: func(ctx context.Context) (system.Info, error) {
return system.Info{
ID: "daemon-id",
Name: "daemon-name",
}, nil
}, },
}) {
client: &fakeClient{
completions, directive := completeFilters(cli)(NewEventsCommand(cli), nil, "daemon=") infoFunc: func(ctx context.Context) (system.Info, error) {
return system.Info{}, errors.New("API error")
assert.DeepEqual(t, completions, []string{"daemon=daemon-name", "daemon=daemon-id"}) },
assert.Equal(t, directive, cobra.ShellCompDirectiveNoFileComp) },
} toComplete: "daemon=",
expected: []string{},
// In case of API errors, no completions are returned.
func TestCompleteEventFilterDaemonAPIError(t *testing.T) {
cli := test.NewFakeCli(&fakeClient{
infoFunc: func(ctx context.Context) (system.Info, error) {
return system.Info{}, errors.New("API error")
}, },
}) {
client: &fakeClient{
completions, directive := completeFilters(cli)(NewEventsCommand(cli), nil, "daemon=") networkListFunc: func(_ context.Context, _ network.ListOptions) ([]network.Summary, error) {
return []network.Summary{
assert.DeepEqual(t, completions, []string{}) *builders.NetworkResource(builders.NetworkResourceName("nw1")),
assert.Equal(t, directive, cobra.ShellCompDirectiveNoFileComp) *builders.NetworkResource(builders.NetworkResourceName("nw2")),
} }, nil
},
// Successful completion lists all network names, prefixed with "network=". },
// Filtering the completions by the current word is delegated to the completion script. toComplete: "network=",
func TestCompleteEventFilterNetwork(t *testing.T) { expected: []string{"network=nw1", "network=nw2"},
cli := test.NewFakeCli(&fakeClient{
networkListFunc: func(_ context.Context, _ network.ListOptions) ([]network.Summary, error) {
return []network.Summary{
*builders.NetworkResource(builders.NetworkResourceName("nw1")),
*builders.NetworkResource(builders.NetworkResourceName("nw2")),
}, nil
}, },
}) {
client: &fakeClient{
completions, directive := completeFilters(cli)(NewEventsCommand(cli), nil, "network=") networkListFunc: func(_ context.Context, _ network.ListOptions) ([]network.Summary, error) {
return nil, errors.New("API error")
assert.DeepEqual(t, completions, []string{"network=nw1", "network=nw2"}) },
assert.Equal(t, directive, cobra.ShellCompDirectiveNoFileComp) },
} toComplete: "network=",
expected: []string{},
// In case of API errors, no completions are returned.
func TestCompleteEventFilterNetworkAPIError(t *testing.T) {
cli := test.NewFakeCli(&fakeClient{
networkListFunc: func(_ context.Context, _ network.ListOptions) ([]network.Summary, error) {
return nil, errors.New("API error")
}, },
}) }
completions, directive := completeFilters(cli)(NewEventsCommand(cli), nil, "network=") for _, tc := range tests {
cli := test.NewFakeCli(tc.client)
assert.DeepEqual(t, completions, []string{}) completions, directive := completeFilters(cli)(NewEventsCommand(cli), nil, tc.toComplete)
assert.Equal(t, directive, cobra.ShellCompDirectiveNoFileComp)
assert.DeepEqual(t, completions, tc.expected)
assert.Equal(t, directive, cobra.ShellCompDirectiveNoFileComp, fmt.Sprintf("wrong directive in completion for '%s'", tc.toComplete))
}
} }