1berry/docker-cli
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

cli/command/system: TestEventsFormat: set cmd.Args to prevent test-failures

Browse Source 
When running the tests with options set, such as `-update` for updating
"golden" files, this test would pick up test arguments because no arguments
were set to invoke the command;

    go test . -update
    Error: unknown shorthand flag: 'u' in -update
    Usage:
      events [OPTIONS] [flags]

    Flags:
      -f, --filter filter   Filter output based on conditions provided
          --format string   Format output using a custom template:
                            'json':             Print in JSON format
                            'TEMPLATE':         Print output using the given Go template.
                            Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates
      -h, --help            help for events
          --since string    Show all events created since timestamp
          --until string    Stream events until this timestamp

    --- FAIL: TestEventsFormat (0.00s)
        --- FAIL: TestEventsFormat/default (0.00s)
            events_test.go:75: assertion failed: error is not nil: unknown shorthand flag: 'u' in -update
        --- FAIL: TestEventsFormat/json (0.00s)
            events_test.go:75: assertion failed: error is not nil: unknown shorthand flag: 'u' in -update
        --- FAIL: TestEventsFormat/json_template (0.00s)
            events_test.go:75: assertion failed: error is not nil: unknown shorthand flag: 'u' in -update
        --- FAIL: TestEventsFormat/json_action (0.00s)
            events_test.go:75: assertion failed: error is not nil: unknown shorthand flag: 'u' in -update

This patch:

- changes the test to use command-arguments instead of manually setting the
  flag options; this also adds test-coverage for parsing actual command arguments.
- discards stdout/stderr of the command to prevent noise in test output

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This commit is contained in:
Sebastiaan van Stijn 2024-12-14 13:46:53 +01:00
parent 91d097e70b
commit 73ff81b651
No known key found for this signature in database
GPG Key ID: 76698F39D527CE8C
1 changed files with 12 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
cli/command/system/events_test.go
View File

@ -33,22 +33,24 @@ func TestEventsFormat(t *testing.T) {
}) })
} }
tests := []struct { tests := []struct {
name, format string name string
args []string
}{ }{
{ {
name: "default", name: "default",
args: []string{},
}, },
{ {
name: "json", name: "json",
format: "json", args: []string{"--format", "json"},
}, },
{ {
name: "json template", name: "json template",
format: "{{ json . }}", args: []string{"--format", "{{ json . }}"},
}, },
{ {
name: "json action", name: "json action",
format: "{{ json .Action }}", args: []string{"--format", "{{ json .Action }}"},
}, },
} }
@ -69,9 +71,9 @@ func TestEventsFormat(t *testing.T) {
return messages, errs return messages, errs
}}) }})
cmd := NewEventsCommand(cli) cmd := NewEventsCommand(cli)
if tc.format != "" { cmd.SetArgs(tc.args)
cmd.Flags().Set("format", tc.format) cmd.SetOut(io.Discard)
} cmd.SetErr(io.Discard)
assert.Check(t, cmd.Execute()) assert.Check(t, cmd.Execute())
out := cli.OutBuffer().String() out := cli.OutBuffer().String()
assert.Check(t, golden.String(out, fmt.Sprintf("docker-events-%s.golden", strings.ReplaceAll(tc.name, " ", "-")))) assert.Check(t, golden.String(out, fmt.Sprintf("docker-events-%s.golden", strings.ReplaceAll(tc.name, " ", "-"))))