The Docker CLI
Go to file
Sebastiaan van Stijn ca9636a1c3
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>
(cherry picked from commit ab230240ad)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2024-07-19 13:37:27 +02:00
.github gha: check-pr-branch: verify major version only 2024-07-19 12:48:22 +02:00
cli test spring-cleaning 2024-07-19 13:37:27 +02:00
cli-plugins cli: make initializing the global meter- and tracing providers optional 2024-06-24 15:44:20 +02:00
cmd/docker cmd/docker: fix completion for --context 2024-07-19 01:56:24 +02:00
contrib/completion Removed all mentions of "please" from docs and messages 2024-06-11 16:53:40 +02:00
dockerfiles Merge pull request #5265 from thaJeztah/27.1_backport_bump_buildx_compose 2024-07-19 12:55:55 +02:00
docs docs: fix typos and version for cli-docs-tool scripts 2024-07-19 02:04:44 +02:00
e2e test: e2e SIGTERM attached container on `docker run` 2024-07-12 15:04:38 +02:00
experimental deprecate experimental graphdriver plugins 2024-06-18 16:47:00 +02:00
hack/otel OTEL collector/prometheus/aspire-dashboard stack for testing purposes 2024-04-30 12:25:19 +00:00
internal/test cli: Wrap Err stream 2024-06-11 17:59:48 +02:00
man Additional typo corrections 2024-06-20 12:18:43 +02:00
opts test spring-cleaning 2024-07-19 13:37:27 +02:00
scripts docs: fix typos and version for cli-docs-tool scripts 2024-07-19 02:04:44 +02:00
service/logs service/logs: use strings.Cut 2022-12-29 15:19:31 +01:00
templates Update go:build comments to go1.21 2024-06-18 12:17:13 +02:00
vendor vendor: github.com/docker/cli-docs-tool v0.8.0 2024-07-19 02:04:44 +02:00
.dockerignore validate manpages target 2022-02-25 17:11:17 +01:00
.gitattributes fix linguist with .gitattributes 2021-12-16 21:16:02 +01:00
.gitignore Removed all mentions of "please" from docs and messages 2024-06-11 16:53:40 +02:00
.golangci.yml update golangci-lint to .v1.59.0 2024-06-10 21:19:32 +02:00
.mailmap update mailmap and AUTHORS 2024-06-20 13:22:11 +02:00
AUTHORS update mailmap and AUTHORS 2024-06-20 13:22:11 +02:00
CONTRIBUTING.md Removed all mentions of "please" from docs and messages 2024-06-11 16:53:40 +02:00
Dockerfile Dockerfile: update compose to v2.29.0 2024-07-19 02:46:00 +02:00
LICENSE Add project files 2017-04-17 17:49:33 -04:00
MAINTAINERS not actually a maintainer 2023-11-10 21:35:15 +01:00
Makefile Makefile: add completion target 2024-07-19 01:55:36 +02:00
NOTICE Removed all mentions of "please" from docs and messages 2024-06-11 16:53:40 +02:00
README.md Removed all mentions of "please" from docs and messages 2024-06-11 16:53:40 +02:00
TESTING.md tweak description of login/logout 2022-04-04 10:44:11 +02:00
VERSION bump version to v27.0.1-dev 2024-06-18 13:29:00 +02:00
codecov.yml Drop support for (archived) Compose-on-Kubernetes 2022-02-22 13:47:34 +01:00
docker-bake.hcl update to go1.21.12 2024-07-03 12:16:54 +02:00
docker.Makefile Cleanup of dockerfiles, compose files and env vars 2024-02-13 13:32:45 +00:00
vendor.mod vendor: github.com/docker/cli-docs-tool v0.8.0 2024-07-19 02:04:44 +02:00
vendor.sum vendor: github.com/docker/cli-docs-tool v0.8.0 2024-07-19 02:04:44 +02:00

README.md

Docker CLI

PkgGoDev Build Status Test Status Go Report Card Codecov

About

This repository is the home of the Docker CLI.

Development

docker/cli is developed using Docker.

Build CLI from source:

docker buildx bake

Build binaries for all supported platforms:

docker buildx bake cross

Build for a specific platform:

docker buildx bake --set binary.platform=linux/arm64 

Build dynamic binary for glibc or musl:

USE_GLIBC=1 docker buildx bake dynbinary 

Run all linting:

docker buildx bake lint shellcheck

Run test:

docker buildx bake test

List all the available targets:

make help

In-container development environment

Start an interactive development environment:

make -f docker.Makefile shell

Brought to you courtesy of our legal counsel. For more context, see the NOTICE document in this repo.

Use and transfer of Docker may be subject to certain restrictions by the United States and other governments.

It is your responsibility to ensure that your use and/or transfer does not violate applicable laws.

For more information, see https://www.bis.doc.gov

Licensing

docker/cli is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.