2017-03-30 20:21:14 -04:00
|
|
|
package image
|
|
|
|
|
|
|
|
import (
|
|
|
|
"fmt"
|
2022-02-25 07:10:34 -05:00
|
|
|
"io"
|
2017-03-30 20:21:14 -04:00
|
|
|
"testing"
|
|
|
|
|
2017-08-21 16:30:09 -04:00
|
|
|
"github.com/docker/cli/internal/test"
|
2024-07-03 09:35:44 -04:00
|
|
|
"github.com/docker/docker/api/types/image"
|
2020-02-22 12:12:14 -05:00
|
|
|
"gotest.tools/v3/assert"
|
|
|
|
is "gotest.tools/v3/assert/cmp"
|
|
|
|
"gotest.tools/v3/golden"
|
2017-03-30 20:21:14 -04:00
|
|
|
)
|
|
|
|
|
|
|
|
func TestNewInspectCommandErrors(t *testing.T) {
|
|
|
|
testCases := []struct {
|
|
|
|
name string
|
|
|
|
args []string
|
|
|
|
expectedError string
|
|
|
|
}{
|
|
|
|
{
|
|
|
|
name: "wrong-args",
|
|
|
|
args: []string{},
|
2024-07-04 20:49:31 -04:00
|
|
|
expectedError: "requires at least 1 argument",
|
2017-03-30 20:21:14 -04:00
|
|
|
},
|
|
|
|
}
|
|
|
|
for _, tc := range testCases {
|
test spring-cleaning
This makes a quick pass through our tests;
Discard output/err
----------------------------------------------
Many tests were testing for error-conditions, but didn't discard output.
This produced a lot of noise when running the tests, and made it hard
to discover if there were actual failures, or if the output was expected.
For example:
=== RUN TestConfigCreateErrors
Error: "create" requires exactly 2 arguments.
See 'create --help'.
Usage: create [OPTIONS] CONFIG file|- [flags]
Create a config from a file or STDIN
Error: "create" requires exactly 2 arguments.
See 'create --help'.
Usage: create [OPTIONS] CONFIG file|- [flags]
Create a config from a file or STDIN
Error: error creating config
--- PASS: TestConfigCreateErrors (0.00s)
And after discarding output:
=== RUN TestConfigCreateErrors
--- PASS: TestConfigCreateErrors (0.00s)
Use sub-tests where possible
----------------------------------------------
Some tests were already set-up to use test-tables, and even had a usable
name (or in some cases "error" to check for). Change them to actual sub-
tests. Same test as above, but now with sub-tests and output discarded:
=== RUN TestConfigCreateErrors
=== RUN TestConfigCreateErrors/requires_exactly_2_arguments
=== RUN TestConfigCreateErrors/requires_exactly_2_arguments#01
=== RUN TestConfigCreateErrors/error_creating_config
--- PASS: TestConfigCreateErrors (0.00s)
--- PASS: TestConfigCreateErrors/requires_exactly_2_arguments (0.00s)
--- PASS: TestConfigCreateErrors/requires_exactly_2_arguments#01 (0.00s)
--- PASS: TestConfigCreateErrors/error_creating_config (0.00s)
PASS
It's not perfect in all cases (in the above, there's duplicate "expected"
errors, but Go conveniently adds "#01" for the duplicate). There's probably
also various tests I missed that could still use the same changes applied;
we can improve these in follow-ups.
Set cmd.Args to prevent test-failures
----------------------------------------------
When running tests from my IDE, it compiles the tests before running,
then executes the compiled binary to run the tests. Cobra doesn't like
that, because in that situation `os.Args` is taken as argument for the
command that's executed. The command that's tested now sees the test-
flags as arguments (`-test.v -test.run ..`), which causes various tests
to fail ("Command XYZ does not accept arguments").
# compile the tests:
go test -c -o foo.test
# execute the test:
./foo.test -test.v -test.run TestFoo
=== RUN TestFoo
Error: "foo" accepts no arguments.
The Cobra maintainers ran into the same situation, and for their own
use have added a special case to ignore `os.Args` in these cases;
https://github.com/spf13/cobra/blob/v1.8.1/command.go#L1078-L1083
args := c.args
// Workaround FAIL with "go test -v" or "cobra.test -test.v", see #155
if c.args == nil && filepath.Base(os.Args[0]) != "cobra.test" {
args = os.Args[1:]
}
Unfortunately, that exception is too specific (only checks for `cobra.test`),
so doesn't automatically fix the issue for other test-binaries. They did
provide a `cmd.SetArgs()` utility for this purpose
https://github.com/spf13/cobra/blob/v1.8.1/command.go#L276-L280
// SetArgs sets arguments for the command. It is set to os.Args[1:] by default, if desired, can be overridden
// particularly useful when testing.
func (c *Command) SetArgs(a []string) {
c.args = a
}
And the fix is to explicitly set the command's args to an empty slice to
prevent Cobra from falling back to using `os.Args[1:]` as arguments.
cmd := newSomeThingCommand()
cmd.SetArgs([]string{})
Some tests already take this issue into account, and I updated some tests
for this, but there's likely many other ones that can use the same treatment.
Perhaps the Cobra maintainers would accept a contribution to make their
condition less specific and to look for binaries ending with a `.test`
suffix (which is what compiled binaries usually are named as).
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2024-07-03 19:29:04 -04:00
|
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
|
|
cmd := newInspectCommand(test.NewFakeCli(&fakeClient{}))
|
|
|
|
cmd.SetOut(io.Discard)
|
|
|
|
cmd.SetErr(io.Discard)
|
|
|
|
cmd.SetArgs(tc.args)
|
|
|
|
assert.ErrorContains(t, cmd.Execute(), tc.expectedError)
|
|
|
|
})
|
2017-03-30 20:21:14 -04:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
func TestNewInspectCommandSuccess(t *testing.T) {
|
|
|
|
imageInspectInvocationCount := 0
|
|
|
|
testCases := []struct {
|
|
|
|
name string
|
|
|
|
args []string
|
|
|
|
imageCount int
|
2024-07-03 09:35:44 -04:00
|
|
|
imageInspectFunc func(img string) (image.InspectResponse, []byte, error)
|
2017-03-30 20:21:14 -04:00
|
|
|
}{
|
|
|
|
{
|
|
|
|
name: "simple",
|
|
|
|
args: []string{"image"},
|
|
|
|
imageCount: 1,
|
2024-07-03 09:35:44 -04:00
|
|
|
imageInspectFunc: func(img string) (image.InspectResponse, []byte, error) {
|
2017-03-30 20:21:14 -04:00
|
|
|
imageInspectInvocationCount++
|
2024-07-03 10:14:40 -04:00
|
|
|
assert.Check(t, is.Equal("image", img))
|
2024-07-03 09:35:44 -04:00
|
|
|
return image.InspectResponse{}, nil, nil
|
2017-03-30 20:21:14 -04:00
|
|
|
},
|
|
|
|
},
|
|
|
|
{
|
|
|
|
name: "format",
|
|
|
|
imageCount: 1,
|
|
|
|
args: []string{"--format='{{.ID}}'", "image"},
|
2024-07-03 09:35:44 -04:00
|
|
|
imageInspectFunc: func(img string) (image.InspectResponse, []byte, error) {
|
2017-03-30 20:21:14 -04:00
|
|
|
imageInspectInvocationCount++
|
2024-07-03 09:35:44 -04:00
|
|
|
return image.InspectResponse{ID: img}, nil, nil
|
2017-03-30 20:21:14 -04:00
|
|
|
},
|
|
|
|
},
|
|
|
|
{
|
|
|
|
name: "simple-many",
|
|
|
|
args: []string{"image1", "image2"},
|
|
|
|
imageCount: 2,
|
2024-07-03 09:35:44 -04:00
|
|
|
imageInspectFunc: func(img string) (image.InspectResponse, []byte, error) {
|
2017-03-30 20:21:14 -04:00
|
|
|
imageInspectInvocationCount++
|
|
|
|
if imageInspectInvocationCount == 1 {
|
2024-07-03 10:14:40 -04:00
|
|
|
assert.Check(t, is.Equal("image1", img))
|
2017-03-30 20:21:14 -04:00
|
|
|
} else {
|
2024-07-03 10:14:40 -04:00
|
|
|
assert.Check(t, is.Equal("image2", img))
|
2017-03-30 20:21:14 -04:00
|
|
|
}
|
2024-07-03 09:35:44 -04:00
|
|
|
return image.InspectResponse{}, nil, nil
|
2017-03-30 20:21:14 -04:00
|
|
|
},
|
|
|
|
},
|
|
|
|
}
|
|
|
|
for _, tc := range testCases {
|
2022-03-03 08:19:41 -05:00
|
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
|
|
imageInspectInvocationCount = 0
|
|
|
|
cli := test.NewFakeCli(&fakeClient{imageInspectFunc: tc.imageInspectFunc})
|
|
|
|
cmd := newInspectCommand(cli)
|
|
|
|
cmd.SetOut(io.Discard)
|
|
|
|
cmd.SetArgs(tc.args)
|
|
|
|
err := cmd.Execute()
|
|
|
|
assert.NilError(t, err)
|
|
|
|
golden.Assert(t, cli.OutBuffer().String(), fmt.Sprintf("inspect-command-success.%s.golden", tc.name))
|
|
|
|
assert.Check(t, is.Equal(imageInspectInvocationCount, tc.imageCount))
|
|
|
|
})
|
2017-03-30 20:21:14 -04:00
|
|
|
}
|
|
|
|
}
|