docker-cli/cli/command/system/completion_test.go

package system

import (
	"context"
	"errors"
	"fmt"
	"testing"

	"github.com/docker/cli/internal/test"
	"github.com/docker/cli/internal/test/builders"
	"github.com/moby/moby/api/types/container"
	"github.com/moby/moby/api/types/image"
	"github.com/moby/moby/api/types/network"
	"github.com/moby/moby/api/types/swarm"
	"github.com/moby/moby/api/types/system"
	"github.com/moby/moby/api/types/volume"
	"github.com/moby/moby/client"
	"github.com/spf13/cobra"
	"gotest.tools/v3/assert"
)

func TestCompleteEventFilter(t *testing.T) {
	tests := []struct {
		client     *fakeClient
		toComplete string
		expected   []string
	}{
		{
			client: &fakeClient{
				containerListFunc: func(_ context.Context, _ client.ContainerListOptions) ([]container.Summary, error) {
					return []container.Summary{
						*builders.Container("c1"),
						*builders.Container("c2"),
					}, nil
				},
			},
			toComplete: "container=",
			expected:   []string{"container=c1", "container=c2"},
		},
		{
			client: &fakeClient{
				containerListFunc: func(_ context.Context, _ client.ContainerListOptions) ([]container.Summary, error) {
					return nil, errors.New("API error")
				},
			},
			toComplete: "container=",
			expected:   []string{},
		},
		{
			client: &fakeClient{
				infoFunc: func(_ context.Context, _ client.InfoOptions) (client.SystemInfoResult, error) {
					return client.SystemInfoResult{
						Info: system.Info{
							ID:   "daemon-id",
							Name: "daemon-name",
						},
					}, nil
				},
			},
			toComplete: "daemon=",
			expected:   []string{"daemon=daemon-name", "daemon=daemon-id"},
		},
		{
			client: &fakeClient{
				infoFunc: func(_ context.Context, _ client.InfoOptions) (client.SystemInfoResult, error) {
					return client.SystemInfoResult{}, errors.New("API error")
				},
			},
			toComplete: "daemon=",
			expected:   []string{},
		},
		{
			client: &fakeClient{
				imageListFunc: func(ctx context.Context, options client.ImageListOptions) (client.ImageListResult, error) {
					return client.ImageListResult{
						Items: []image.Summary{
							{RepoTags: []string{"img:1"}},
							{RepoTags: []string{"img:2"}},
						},
					}, nil
				},
			},
			toComplete: "image=",
			expected:   []string{"image=img:1", "image=img:2"},
		},
		{
			client: &fakeClient{
				imageListFunc: func(ctx context.Context, options client.ImageListOptions) (client.ImageListResult, error) {
					return client.ImageListResult{}, errors.New("API error")
				},
			},
			toComplete: "image=",
			expected:   []string{},
		},
		{
			client: &fakeClient{
				networkListFunc: func(ctx context.Context, options client.NetworkListOptions) (client.NetworkListResult, error) {
					return client.NetworkListResult{
						Items: []network.Summary{
							*builders.NetworkResource(builders.NetworkResourceName("nw1")),
							*builders.NetworkResource(builders.NetworkResourceName("nw2")),
						},
					}, nil
				},
			},
			toComplete: "network=",
			expected:   []string{"network=nw1", "network=nw2"},
		},
		{
			client: &fakeClient{
				networkListFunc: func(ctx context.Context, options client.NetworkListOptions) (client.NetworkListResult, error) {
					return client.NetworkListResult{}, errors.New("API error")
				},
			},
			toComplete: "network=",
			expected:   []string{},
		},
		{
			client: &fakeClient{
				nodeListFunc: func(ctx context.Context, options client.NodeListOptions) (client.NodeListResult, error) {
					return client.NodeListResult{
						Items: []swarm.Node{
							*builders.Node(builders.Hostname("n1")),
						},
					}, nil
				},
			},
			toComplete: "node=",
			expected:   []string{"node=n1"},
		},
		{
			client: &fakeClient{
				nodeListFunc: func(ctx context.Context, options client.NodeListOptions) (client.NodeListResult, error) {
					return client.NodeListResult{}, errors.New("API error")
				},
			},
			toComplete: "node=",
			expected:   []string{},
		},
		{
			client: &fakeClient{
				volumeListFunc: func(ctx context.Context, options client.VolumeListOptions) (client.VolumeListResult, error) {
					return client.VolumeListResult{
						Items: []volume.Volume{
							builders.Volume(builders.VolumeName("v1")),
							builders.Volume(builders.VolumeName("v2")),
						},
					}, nil
				},
			},
			toComplete: "volume=",
			expected:   []string{"volume=v1", "volume=v2"},
		},
		{
			client: &fakeClient{
				volumeListFunc: func(ctx context.Context, options client.VolumeListOptions) (client.VolumeListResult, error) {
					return client.VolumeListResult{}, errors.New("API error")
				},
			},
			toComplete: "volume=",
			expected:   []string{},
		},
	}

	for _, tc := range tests {
		cli := test.NewFakeCli(tc.client)

		completions, directive := completeEventFilters(cli)(newEventsCommand(cli), nil, tc.toComplete)

		assert.DeepEqual(t, completions, tc.expected)
		assert.Equal(t, directive, cobra.ShellCompDirectiveNoFileComp, fmt.Sprintf("wrong directive in completion for '%s'", tc.toComplete))
	}
}