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>
134 lines
4.0 KiB
Go
134 lines
4.0 KiB
Go
package system
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"io"
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/docker/cli/internal/test"
|
|
"github.com/docker/docker/api/types"
|
|
"gotest.tools/v3/assert"
|
|
is "gotest.tools/v3/assert/cmp"
|
|
"gotest.tools/v3/golden"
|
|
)
|
|
|
|
func TestVersionWithoutServer(t *testing.T) {
|
|
cli := test.NewFakeCli(&fakeClient{
|
|
serverVersion: func(ctx context.Context) (types.Version, error) {
|
|
return types.Version{}, errors.New("no server")
|
|
},
|
|
})
|
|
cmd := NewVersionCommand(cli)
|
|
cmd.SetArgs([]string{})
|
|
cmd.SetOut(cli.Err())
|
|
cmd.SetErr(io.Discard)
|
|
assert.ErrorContains(t, cmd.Execute(), "no server")
|
|
out := cli.OutBuffer().String()
|
|
// TODO: use an assertion like e2e/image/build_test.go:assertBuildOutput()
|
|
// instead of contains/not contains
|
|
assert.Check(t, is.Contains(out, "Client:"))
|
|
assert.Assert(t, !strings.Contains(out, "Server:"), "actual: %s", out)
|
|
}
|
|
|
|
func TestVersionFormat(t *testing.T) {
|
|
vi := versionInfo{
|
|
Client: clientVersion{
|
|
Version: "18.99.5-ce",
|
|
APIVersion: "1.38",
|
|
DefaultAPIVersion: "1.38",
|
|
GitCommit: "deadbeef",
|
|
GoVersion: "go1.10.2",
|
|
Os: "linux",
|
|
Arch: "amd64",
|
|
BuildTime: "Wed May 30 22:21:05 2018",
|
|
Context: "my-context",
|
|
},
|
|
Server: &types.Version{},
|
|
}
|
|
|
|
vi.Server.Platform.Name = "Docker Enterprise Edition (EE) 2.0"
|
|
|
|
vi.Server.Components = append(vi.Server.Components, types.ComponentVersion{
|
|
Name: "Engine",
|
|
Version: "17.06.2-ee-15",
|
|
Details: map[string]string{
|
|
"ApiVersion": "1.30",
|
|
"MinAPIVersion": "1.12",
|
|
"GitCommit": "64ddfa6",
|
|
"GoVersion": "go1.8.7",
|
|
"Os": "linux",
|
|
"Arch": "amd64",
|
|
"BuildTime": "Mon Jul 9 23:38:38 2018",
|
|
"Experimental": "false",
|
|
},
|
|
})
|
|
|
|
vi.Server.Components = append(vi.Server.Components, types.ComponentVersion{
|
|
Name: "Universal Control Plane",
|
|
Version: "17.06.2-ee-15",
|
|
Details: map[string]string{
|
|
"Version": "3.0.3-tp2",
|
|
"ApiVersion": "1.30",
|
|
"Arch": "amd64",
|
|
"BuildTime": "Mon Jul 2 21:24:07 UTC 2018",
|
|
"GitCommit": "4513922",
|
|
"GoVersion": "go1.9.4",
|
|
"MinApiVersion": "1.20",
|
|
"Os": "linux",
|
|
},
|
|
})
|
|
|
|
vi.Server.Components = append(vi.Server.Components, types.ComponentVersion{
|
|
Name: "Kubernetes",
|
|
Version: "1.8+",
|
|
Details: map[string]string{
|
|
"buildDate": "2018-04-26T16:51:21Z",
|
|
"compiler": "gc",
|
|
"gitCommit": "8d637aedf46b9c21dde723e29c645b9f27106fa5",
|
|
"gitTreeState": "clean",
|
|
"gitVersion": "v1.8.11-docker-8d637ae",
|
|
"goVersion": "go1.8.3",
|
|
"major": "1",
|
|
"minor": "8+",
|
|
"platform": "linux/amd64",
|
|
},
|
|
})
|
|
|
|
vi.Server.Components = append(vi.Server.Components, types.ComponentVersion{
|
|
Name: "Calico",
|
|
Version: "v3.0.8",
|
|
Details: map[string]string{
|
|
"cni": "v2.0.6",
|
|
"kube-controllers": "v2.0.5",
|
|
"node": "v3.0.8",
|
|
},
|
|
})
|
|
|
|
t.Run("default", func(t *testing.T) {
|
|
cli := test.NewFakeCli(&fakeClient{})
|
|
tmpl, err := newVersionTemplate("")
|
|
assert.NilError(t, err)
|
|
assert.NilError(t, prettyPrintVersion(cli, vi, tmpl))
|
|
assert.Check(t, golden.String(cli.OutBuffer().String(), "docker-client-version.golden"))
|
|
assert.Check(t, is.Equal("", cli.ErrBuffer().String()))
|
|
})
|
|
t.Run("json", func(t *testing.T) {
|
|
cli := test.NewFakeCli(&fakeClient{})
|
|
tmpl, err := newVersionTemplate("json")
|
|
assert.NilError(t, err)
|
|
assert.NilError(t, prettyPrintVersion(cli, vi, tmpl))
|
|
assert.Check(t, golden.String(cli.OutBuffer().String(), "docker-client-version.json.golden"))
|
|
assert.Check(t, is.Equal("", cli.ErrBuffer().String()))
|
|
})
|
|
t.Run("json template", func(t *testing.T) {
|
|
cli := test.NewFakeCli(&fakeClient{})
|
|
tmpl, err := newVersionTemplate("{{json .}}")
|
|
assert.NilError(t, err)
|
|
assert.NilError(t, prettyPrintVersion(cli, vi, tmpl))
|
|
assert.Check(t, golden.String(cli.OutBuffer().String(), "docker-client-version.json.golden"))
|
|
assert.Check(t, is.Equal("", cli.ErrBuffer().String()))
|
|
})
|
|
}
|