DockerCLI/cli/command/image/list_test.go

package image

import (
	"fmt"
	"io"
	"testing"

	"github.com/docker/cli/cli/config/configfile"
	"github.com/docker/cli/internal/test"
	"github.com/docker/docker/api/types/image"
	"github.com/pkg/errors"
	"gotest.tools/v3/assert"
	is "gotest.tools/v3/assert/cmp"
	"gotest.tools/v3/golden"
)

func TestNewImagesCommandErrors(t *testing.T) {
	testCases := []struct {
		name          string
		args          []string
		expectedError string
		imageListFunc func(options image.ListOptions) ([]image.Summary, error)
	}{
		{
			name:          "wrong-args",
			args:          []string{"arg1", "arg2"},
			expectedError: "requires at most 1 argument",
		},
		{
			name:          "failed-list",
			expectedError: "something went wrong",
			imageListFunc: func(options image.ListOptions) ([]image.Summary, error) {
				return []image.Summary{}, errors.Errorf("something went wrong")
			},
		},
	}
	for _, tc := range testCases {
		tc := tc
		t.Run(tc.name, func(t *testing.T) {
			cmd := NewImagesCommand(test.NewFakeCli(&fakeClient{imageListFunc: tc.imageListFunc}))
			cmd.SetOut(io.Discard)
			cmd.SetErr(io.Discard)
			cmd.SetArgs(tc.args)
			assert.ErrorContains(t, cmd.Execute(), tc.expectedError)
		})
	}
}

func TestNewImagesCommandSuccess(t *testing.T) {
	testCases := []struct {
		name          string
		args          []string
		imageFormat   string
		imageListFunc func(options image.ListOptions) ([]image.Summary, error)
	}{
		{
			name: "simple",
		},
		{
			name:        "format",
			imageFormat: "raw",
		},
		{
			name:        "quiet-format",
			args:        []string{"-q"},
			imageFormat: "table",
		},
		{
			name: "match-name",
			args: []string{"image"},
			imageListFunc: func(options image.ListOptions) ([]image.Summary, error) {
				assert.Check(t, is.Equal("image", options.Filters.Get("reference")[0]))
				return []image.Summary{}, nil
			},
		},
		{
			name: "filters",
			args: []string{"--filter", "name=value"},
			imageListFunc: func(options image.ListOptions) ([]image.Summary, error) {
				assert.Check(t, is.Equal("value", options.Filters.Get("name")[0]))
				return []image.Summary{}, nil
			},
		},
	}
	for _, tc := range testCases {
		tc := tc
		t.Run(tc.name, func(t *testing.T) {
			cli := test.NewFakeCli(&fakeClient{imageListFunc: tc.imageListFunc})
			cli.SetConfigFile(&configfile.ConfigFile{ImagesFormat: tc.imageFormat})
			cmd := NewImagesCommand(cli)
			cmd.SetOut(io.Discard)
			cmd.SetErr(io.Discard)
			cmd.SetArgs(tc.args)
			err := cmd.Execute()
			assert.NilError(t, err)
			golden.Assert(t, cli.OutBuffer().String(), fmt.Sprintf("list-command-success.%s.golden", tc.name))
		})
	}
}

func TestNewListCommandAlias(t *testing.T) {
	cmd := newListCommand(test.NewFakeCli(&fakeClient{}))
	assert.Check(t, cmd.HasAlias("list"))
	assert.Check(t, !cmd.HasAlias("other"))
}

func TestNewListCommandAmbiguous(t *testing.T) {
	cli := test.NewFakeCli(&fakeClient{})
	cmd := NewImagesCommand(cli)
	cmd.SetOut(io.Discard)

	// Set the Use field to mimic that the command was called as "docker images",
	// not "docker image ls".
	cmd.Use = "images"
	cmd.SetArgs([]string{"ls"})
	err := cmd.Execute()
	assert.NilError(t, err)
	golden.Assert(t, cli.ErrBuffer().String(), "list-command-ambiguous.golden")
}