Skip to content

Commit b2551c6

Browse files
icapurroicapurro
committed
Unit tests for cli/commands/image (except build and tag)
Signed-off-by: Ignacio Capurro <[email protected]>
1 parent 0e9148b commit b2551c6

58 files changed

Lines changed: 1445 additions & 123 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎cli/command/cli.go‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,9 @@ type Cli interface {
3939
Out() *OutStream
4040
Err() io.Writer
4141
In() *InStream
42+
SetIn(in *InStream)
4243
ConfigFile() *configfile.ConfigFile
44+
CredentialsStore(serverAddress string) credentials.Store
4345
}
4446

4547
// DockerCli is an instance the docker command line client.
@@ -75,6 +77,11 @@ func (cli *DockerCli) Err() io.Writer {
7577
return cli.err
7678
}
7779

80+
// SetIn sets the reader used for stdin
81+
func (cli *DockerCli) SetIn(in *InStream) {
82+
cli.in = in
83+
}
84+
7885
// In returns the reader used for stdin
7986
func (cli *DockerCli) In() *InStream {
8087
return cli.in

‎cli/command/container/exec_test.go‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,21 +13,21 @@ type arguments struct {
1313

1414
func TestParseExec(t *testing.T) {
1515
valids := map[*arguments]*types.ExecConfig{
16-
&arguments{
16+
{
1717
execCmd: []string{"command"},
1818
}: {
1919
Cmd: []string{"command"},
2020
AttachStdout: true,
2121
AttachStderr: true,
2222
},
23-
&arguments{
23+
{
2424
execCmd: []string{"command1", "command2"},
2525
}: {
2626
Cmd: []string{"command1", "command2"},
2727
AttachStdout: true,
2828
AttachStderr: true,
2929
},
30-
&arguments{
30+
{
3131
options: execOptions{
3232
interactive: true,
3333
tty: true,
@@ -42,7 +42,7 @@ func TestParseExec(t *testing.T) {
4242
Tty: true,
4343
Cmd: []string{"command"},
4444
},
45-
&arguments{
45+
{
4646
options: execOptions{
4747
detach: true,
4848
},
@@ -54,7 +54,7 @@ func TestParseExec(t *testing.T) {
5454
Detach: true,
5555
Cmd: []string{"command"},
5656
},
57-
&arguments{
57+
{
5858
options: execOptions{
5959
tty: true,
6060
interactive: true,

‎cli/command/image/client_test.go‎

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
package image
2+
3+
import (
4+
"io"
5+
"io/ioutil"
6+
"strings"
7+
"time"
8+
9+
"github.com/docker/docker/api/types"
10+
"github.com/docker/docker/api/types/filters"
11+
"github.com/docker/docker/api/types/image"
12+
"github.com/docker/docker/client"
13+
"golang.org/x/net/context"
14+
)
15+
16+
type fakeClient struct {
17+
client.Client
18+
imageTagFunc func(string, string) error
19+
imageSaveFunc func(images []string) (io.ReadCloser, error)
20+
imageRemoveFunc func(image string, options types.ImageRemoveOptions) ([]types.ImageDeleteResponseItem, error)
21+
imagePushFunc func(ref string, options types.ImagePushOptions) (io.ReadCloser, error)
22+
infoFunc func() (types.Info, error)
23+
imagePullFunc func(ref string, options types.ImagePullOptions) (io.ReadCloser, error)
24+
imagesPruneFunc func(pruneFilter filters.Args) (types.ImagesPruneReport, error)
25+
imageLoadFunc func(input io.Reader, quiet bool) (types.ImageLoadResponse, error)
26+
imageListFunc func(options types.ImageListOptions) ([]types.ImageSummary, error)
27+
imageInspectFunc func(image string) (types.ImageInspect, []byte, error)
28+
imageImportFunc func(source types.ImageImportSource, ref string, options types.ImageImportOptions) (io.ReadCloser, error)
29+
imageHistoryFunc func(image string) ([]image.HistoryResponseItem, error)
30+
}
31+
32+
func (cli *fakeClient) ImageTag(_ context.Context, image, ref string) error {
33+
if cli.imageTagFunc != nil {
34+
return cli.imageTagFunc(image, ref)
35+
}
36+
return nil
37+
}
38+
39+
func (cli *fakeClient) ImageSave(_ context.Context, images []string) (io.ReadCloser, error) {
40+
if cli.imageSaveFunc != nil {
41+
return cli.imageSaveFunc(images)
42+
}
43+
return ioutil.NopCloser(strings.NewReader("")), nil
44+
}
45+
46+
func (cli *fakeClient) ImageRemove(_ context.Context, image string,
47+
options types.ImageRemoveOptions) ([]types.ImageDeleteResponseItem, error) {
48+
if cli.imageRemoveFunc != nil {
49+
return cli.imageRemoveFunc(image, options)
50+
}
51+
return []types.ImageDeleteResponseItem{}, nil
52+
}
53+
54+
func (cli *fakeClient) ImagePush(_ context.Context, ref string, options types.ImagePushOptions) (io.ReadCloser, error) {
55+
if cli.imagePushFunc != nil {
56+
return cli.imagePushFunc(ref, options)
57+
}
58+
return ioutil.NopCloser(strings.NewReader("")), nil
59+
}
60+
61+
func (cli *fakeClient) Info(_ context.Context) (types.Info, error) {
62+
if cli.infoFunc != nil {
63+
return cli.infoFunc()
64+
}
65+
return types.Info{}, nil
66+
}
67+
68+
func (cli *fakeClient) ImagePull(_ context.Context, ref string, options types.ImagePullOptions) (io.ReadCloser, error) {
69+
if cli.imagePullFunc != nil {
70+
cli.imagePullFunc(ref, options)
71+
}
72+
return ioutil.NopCloser(strings.NewReader("")), nil
73+
}
74+
75+
func (cli *fakeClient) ImagesPrune(_ context.Context, pruneFilter filters.Args) (types.ImagesPruneReport, error) {
76+
if cli.imagesPruneFunc != nil {
77+
return cli.imagesPruneFunc(pruneFilter)
78+
}
79+
return types.ImagesPruneReport{}, nil
80+
}
81+
82+
func (cli *fakeClient) ImageLoad(_ context.Context, input io.Reader, quiet bool) (types.ImageLoadResponse, error) {
83+
if cli.imageLoadFunc != nil {
84+
return cli.imageLoadFunc(input, quiet)
85+
}
86+
return types.ImageLoadResponse{}, nil
87+
}
88+
89+
func (cli *fakeClient) ImageList(ctx context.Context, options types.ImageListOptions) ([]types.ImageSummary, error) {
90+
if cli.imageListFunc != nil {
91+
return cli.imageListFunc(options)
92+
}
93+
return []types.ImageSummary{{}}, nil
94+
}
95+
96+
func (cli *fakeClient) ImageInspectWithRaw(_ context.Context, image string) (types.ImageInspect, []byte, error) {
97+
if cli.imageInspectFunc != nil {
98+
return cli.imageInspectFunc(image)
99+
}
100+
return types.ImageInspect{}, nil, nil
101+
}
102+
103+
func (cli *fakeClient) ImageImport(_ context.Context, source types.ImageImportSource, ref string,
104+
options types.ImageImportOptions) (io.ReadCloser, error) {
105+
if cli.imageImportFunc != nil {
106+
return cli.imageImportFunc(source, ref, options)
107+
}
108+
return ioutil.NopCloser(strings.NewReader("")), nil
109+
}
110+
111+
func (cli *fakeClient) ImageHistory(_ context.Context, img string) ([]image.HistoryResponseItem, error) {
112+
if cli.imageHistoryFunc != nil {
113+
return cli.imageHistoryFunc(img)
114+
}
115+
return []image.HistoryResponseItem{{ID: img, Created: time.Now().Unix()}}, nil
116+
}

‎cli/command/image/history.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ type historyOptions struct {
1919
}
2020

2121
// NewHistoryCommand creates a new `docker history` command
22-
func NewHistoryCommand(dockerCli *command.DockerCli) *cobra.Command {
22+
func NewHistoryCommand(dockerCli command.Cli) *cobra.Command {
2323
var opts historyOptions
2424

2525
cmd := &cobra.Command{
@@ -42,7 +42,7 @@ func NewHistoryCommand(dockerCli *command.DockerCli) *cobra.Command {
4242
return cmd
4343
}
4444

45-
func runHistory(dockerCli *command.DockerCli, opts historyOptions) error {
45+
func runHistory(dockerCli command.Cli, opts historyOptions) error {
4646
ctx := context.Background()
4747

4848
history, err := dockerCli.Client().ImageHistory(ctx, opts.image)

‎cli/command/image/history_test.go‎

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
package image
2+
3+
import (
4+
"bytes"
5+
"fmt"
6+
"io/ioutil"
7+
"regexp"
8+
"testing"
9+
"time"
10+
11+
"github.com/docker/docker/api/types/image"
12+
"github.com/docker/docker/cli/internal/test"
13+
"github.com/docker/docker/pkg/testutil"
14+
"github.com/docker/docker/pkg/testutil/golden"
15+
"github.com/pkg/errors"
16+
"github.com/stretchr/testify/assert"
17+
)
18+
19+
func TestNewHistoryCommandErrors(t *testing.T) {
20+
testCases := []struct {
21+
name string
22+
args []string
23+
expectedError string
24+
imageHistoryFunc func(img string) ([]image.HistoryResponseItem, error)
25+
}{
26+
{
27+
name: "wrong-args",
28+
args: []string{},
29+
expectedError: "requires exactly 1 argument(s).",
30+
},
31+
{
32+
name: "client-error",
33+
args: []string{"image:tag"},
34+
expectedError: "something went wrong",
35+
imageHistoryFunc: func(img string) ([]image.HistoryResponseItem, error) {
36+
return []image.HistoryResponseItem{{}}, errors.Errorf("something went wrong")
37+
},
38+
},
39+
}
40+
for _, tc := range testCases {
41+
buf := new(bytes.Buffer)
42+
cmd := NewHistoryCommand(test.NewFakeCli(&fakeClient{imageHistoryFunc: tc.imageHistoryFunc}, buf))
43+
cmd.SetOutput(ioutil.Discard)
44+
cmd.SetArgs(tc.args)
45+
testutil.ErrorContains(t, cmd.Execute(), tc.expectedError)
46+
}
47+
}
48+
49+
func TestNewHistoryCommandSuccess(t *testing.T) {
50+
testCases := []struct {
51+
name string
52+
args []string
53+
outputRegex string
54+
imageHistoryFunc func(img string) ([]image.HistoryResponseItem, error)
55+
}{
56+
{
57+
name: "simple",
58+
args: []string{"image:tag"},
59+
imageHistoryFunc: func(img string) ([]image.HistoryResponseItem, error) {
60+
return []image.HistoryResponseItem{{
61+
ID: "1234567890123456789",
62+
Created: time.Now().Unix(),
63+
}}, nil
64+
},
65+
},
66+
{
67+
name: "quiet",
68+
args: []string{"--quiet", "image:tag"},
69+
},
70+
// TODO: This test is failing since the output does not contain an RFC3339 date
71+
//{
72+
// name: "non-human",
73+
// args: []string{"--human=false", "image:tag"},
74+
// outputRegex: "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}", // RFC3339 date format match
75+
//},
76+
{
77+
name: "non-human-header",
78+
args: []string{"--human=false", "image:tag"},
79+
outputRegex: "CREATED\\sAT",
80+
},
81+
{
82+
name: "quiet-no-trunc",
83+
args: []string{"--quiet", "--no-trunc", "image:tag"},
84+
imageHistoryFunc: func(img string) ([]image.HistoryResponseItem, error) {
85+
return []image.HistoryResponseItem{{
86+
ID: "1234567890123456789",
87+
Created: time.Now().Unix(),
88+
}}, nil
89+
},
90+
},
91+
}
92+
for _, tc := range testCases {
93+
buf := new(bytes.Buffer)
94+
cmd := NewHistoryCommand(test.NewFakeCli(&fakeClient{imageHistoryFunc: tc.imageHistoryFunc}, buf))
95+
cmd.SetOutput(ioutil.Discard)
96+
cmd.SetArgs(tc.args)
97+
err := cmd.Execute()
98+
assert.NoError(t, err)
99+
actual := buf.String()
100+
if tc.outputRegex == "" {
101+
expected := string(golden.Get(t, []byte(actual), fmt.Sprintf("history-command-success.%s.golden", tc.name))[:])
102+
testutil.EqualNormalizedString(t, testutil.RemoveSpace, actual, expected)
103+
} else {
104+
match, _ := regexp.MatchString(tc.outputRegex, actual)
105+
assert.Equal(t, match, true)
106+
}
107+
}
108+
}

‎cli/command/image/import.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ type importOptions struct {
2323
}
2424

2525
// NewImportCommand creates a new `docker import` command
26-
func NewImportCommand(dockerCli *command.DockerCli) *cobra.Command {
26+
func NewImportCommand(dockerCli command.Cli) *cobra.Command {
2727
var opts importOptions
2828

2929
cmd := &cobra.Command{
@@ -48,7 +48,7 @@ func NewImportCommand(dockerCli *command.DockerCli) *cobra.Command {
4848
return cmd
4949
}
5050

51-
func runImport(dockerCli *command.DockerCli, opts importOptions) error {
51+
func runImport(dockerCli command.Cli, opts importOptions) error {
5252
var (
5353
in io.Reader
5454
srcName = opts.source

0 commit comments

Comments
 (0)