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>
170 lines
5.6 KiB
Go
170 lines
5.6 KiB
Go
package stack
|
|
|
|
import (
|
|
"errors"
|
|
"io"
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/docker/cli/internal/test"
|
|
"gotest.tools/v3/assert"
|
|
is "gotest.tools/v3/assert/cmp"
|
|
)
|
|
|
|
func fakeClientForRemoveStackTest(version string) *fakeClient {
|
|
allServices := []string{
|
|
objectName("foo", "service1"),
|
|
objectName("foo", "service2"),
|
|
objectName("bar", "service1"),
|
|
objectName("bar", "service2"),
|
|
}
|
|
allNetworks := []string{
|
|
objectName("foo", "network1"),
|
|
objectName("bar", "network1"),
|
|
}
|
|
allSecrets := []string{
|
|
objectName("foo", "secret1"),
|
|
objectName("foo", "secret2"),
|
|
objectName("bar", "secret1"),
|
|
}
|
|
allConfigs := []string{
|
|
objectName("foo", "config1"),
|
|
objectName("foo", "config2"),
|
|
objectName("bar", "config1"),
|
|
}
|
|
return &fakeClient{
|
|
version: version,
|
|
services: allServices,
|
|
networks: allNetworks,
|
|
secrets: allSecrets,
|
|
configs: allConfigs,
|
|
}
|
|
}
|
|
|
|
func TestRemoveWithEmptyName(t *testing.T) {
|
|
cmd := newRemoveCommand(test.NewFakeCli(&fakeClient{}))
|
|
cmd.SetArgs([]string{"good", "' '", "alsogood"})
|
|
cmd.SetOut(io.Discard)
|
|
cmd.SetErr(io.Discard)
|
|
|
|
assert.ErrorContains(t, cmd.Execute(), `invalid stack name: "' '"`)
|
|
}
|
|
|
|
func TestRemoveStackVersion124DoesNotRemoveConfigsOrSecrets(t *testing.T) {
|
|
client := fakeClientForRemoveStackTest("1.24")
|
|
cmd := newRemoveCommand(test.NewFakeCli(client))
|
|
cmd.SetArgs([]string{"foo", "bar"})
|
|
|
|
assert.NilError(t, cmd.Execute())
|
|
assert.Check(t, is.DeepEqual(buildObjectIDs(client.services), client.removedServices))
|
|
assert.Check(t, is.DeepEqual(buildObjectIDs(client.networks), client.removedNetworks))
|
|
assert.Check(t, is.Len(client.removedSecrets, 0))
|
|
assert.Check(t, is.Len(client.removedConfigs, 0))
|
|
}
|
|
|
|
func TestRemoveStackVersion125DoesNotRemoveConfigs(t *testing.T) {
|
|
client := fakeClientForRemoveStackTest("1.25")
|
|
cmd := newRemoveCommand(test.NewFakeCli(client))
|
|
cmd.SetArgs([]string{"foo", "bar"})
|
|
|
|
assert.NilError(t, cmd.Execute())
|
|
assert.Check(t, is.DeepEqual(buildObjectIDs(client.services), client.removedServices))
|
|
assert.Check(t, is.DeepEqual(buildObjectIDs(client.networks), client.removedNetworks))
|
|
assert.Check(t, is.DeepEqual(buildObjectIDs(client.secrets), client.removedSecrets))
|
|
assert.Check(t, is.Len(client.removedConfigs, 0))
|
|
}
|
|
|
|
func TestRemoveStackVersion130RemovesEverything(t *testing.T) {
|
|
client := fakeClientForRemoveStackTest("1.30")
|
|
cmd := newRemoveCommand(test.NewFakeCli(client))
|
|
cmd.SetArgs([]string{"foo", "bar"})
|
|
|
|
assert.NilError(t, cmd.Execute())
|
|
assert.Check(t, is.DeepEqual(buildObjectIDs(client.services), client.removedServices))
|
|
assert.Check(t, is.DeepEqual(buildObjectIDs(client.networks), client.removedNetworks))
|
|
assert.Check(t, is.DeepEqual(buildObjectIDs(client.secrets), client.removedSecrets))
|
|
assert.Check(t, is.DeepEqual(buildObjectIDs(client.configs), client.removedConfigs))
|
|
}
|
|
|
|
func TestRemoveStackSkipEmpty(t *testing.T) {
|
|
allServices := []string{objectName("bar", "service1"), objectName("bar", "service2")}
|
|
allServiceIDs := buildObjectIDs(allServices)
|
|
|
|
allNetworks := []string{objectName("bar", "network1")}
|
|
allNetworkIDs := buildObjectIDs(allNetworks)
|
|
|
|
allSecrets := []string{objectName("bar", "secret1")}
|
|
allSecretIDs := buildObjectIDs(allSecrets)
|
|
|
|
allConfigs := []string{objectName("bar", "config1")}
|
|
allConfigIDs := buildObjectIDs(allConfigs)
|
|
|
|
fakeClient := &fakeClient{
|
|
version: "1.30",
|
|
services: allServices,
|
|
networks: allNetworks,
|
|
secrets: allSecrets,
|
|
configs: allConfigs,
|
|
}
|
|
fakeCli := test.NewFakeCli(fakeClient)
|
|
cmd := newRemoveCommand(fakeCli)
|
|
cmd.SetArgs([]string{"foo", "bar"})
|
|
|
|
assert.NilError(t, cmd.Execute())
|
|
expectedList := []string{
|
|
"Removing service bar_service1",
|
|
"Removing service bar_service2",
|
|
"Removing secret bar_secret1",
|
|
"Removing config bar_config1",
|
|
"Removing network bar_network1\n",
|
|
}
|
|
assert.Check(t, is.Equal(strings.Join(expectedList, "\n"), fakeCli.OutBuffer().String()))
|
|
assert.Check(t, is.Contains(fakeCli.ErrBuffer().String(), "Nothing found in stack: foo\n"))
|
|
assert.Check(t, is.DeepEqual(allServiceIDs, fakeClient.removedServices))
|
|
assert.Check(t, is.DeepEqual(allNetworkIDs, fakeClient.removedNetworks))
|
|
assert.Check(t, is.DeepEqual(allSecretIDs, fakeClient.removedSecrets))
|
|
assert.Check(t, is.DeepEqual(allConfigIDs, fakeClient.removedConfigs))
|
|
}
|
|
|
|
func TestRemoveContinueAfterError(t *testing.T) {
|
|
allServices := []string{objectName("foo", "service1"), objectName("bar", "service1")}
|
|
allServiceIDs := buildObjectIDs(allServices)
|
|
|
|
allNetworks := []string{objectName("foo", "network1"), objectName("bar", "network1")}
|
|
allNetworkIDs := buildObjectIDs(allNetworks)
|
|
|
|
allSecrets := []string{objectName("foo", "secret1"), objectName("bar", "secret1")}
|
|
allSecretIDs := buildObjectIDs(allSecrets)
|
|
|
|
allConfigs := []string{objectName("foo", "config1"), objectName("bar", "config1")}
|
|
allConfigIDs := buildObjectIDs(allConfigs)
|
|
|
|
removedServices := []string{}
|
|
cli := &fakeClient{
|
|
version: "1.30",
|
|
services: allServices,
|
|
networks: allNetworks,
|
|
secrets: allSecrets,
|
|
configs: allConfigs,
|
|
|
|
serviceRemoveFunc: func(serviceID string) error {
|
|
removedServices = append(removedServices, serviceID)
|
|
|
|
if strings.Contains(serviceID, "foo") {
|
|
return errors.New("")
|
|
}
|
|
return nil
|
|
},
|
|
}
|
|
cmd := newRemoveCommand(test.NewFakeCli(cli))
|
|
cmd.SetOut(io.Discard)
|
|
cmd.SetErr(io.Discard)
|
|
cmd.SetArgs([]string{"foo", "bar"})
|
|
|
|
assert.Error(t, cmd.Execute(), "Failed to remove some resources from stack: foo")
|
|
assert.Check(t, is.DeepEqual(allServiceIDs, removedServices))
|
|
assert.Check(t, is.DeepEqual(allNetworkIDs, cli.removedNetworks))
|
|
assert.Check(t, is.DeepEqual(allSecretIDs, cli.removedSecrets))
|
|
assert.Check(t, is.DeepEqual(allConfigIDs, cli.removedConfigs))
|
|
}
|