Since 'api/' and 'client/' are separate Go modules, tests need to be run
separately in each module. Commit 900a0516d changed the hack/test/unit
script to account for that.
But since that commit, if that script is invoked with TESTDIRS set, it
will try every module instead of locating the one containing TESTDIRS.
When trying to run tests that are within one of the modules (`api`, `client`),
Go may find the test while listing (`go -C api list ./pkg/...`);
go -C api list ./pkg/...
github.com/moby/moby/api/pkg/progress
github.com/moby/moby/api/pkg/stdcopy
github.com/moby/moby/api/pkg/streamformatter
But when running tests from outside the module directory, it may use the
vendor directory, and find no tests to run;
go test -count 1 -run TestValidateRestartPolicy github.com/moby/moby/api/types/container
? github.com/moby/moby/api/types/container [no test files]
To fix this, there's two options; we can first change to the respective
module's directory so that `go test` is run from within the module's context;
go -C api test -count 1 -run TestValidateRestartPolicy github.com/moby/moby/api/types/container
ok github.com/moby/moby/api/types/container 0.003s
Or, to avoid having to change the directory, we can use `-mod=readonly` or
`-mod=mod`. From the Go documentation https://golang.org/ref/mod:
> - `-mod=mod` tells the go command to ignore the vendor directory and to
> automatically update `go.mod`, for example, when an imported package
> is not provided by any known module.
> - `-mod=readonly` tells the go command to ignore the vendor directory
> and to report an error if `go.mod` needs to be updated.
With that option set, the tests are run;
go test -mod=readonly -count 1 -run TestValidateRestartPolicy github.com/moby/moby/api/types/container
ok github.com/moby/moby/api/types/container 0.003s
Signed-off-by: Albin Kerouanton <albinker@gmail.com>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
About
This directory contains a collection of scripts used to build and manage this repository. If there are any issues regarding the intention of a particular script (or even part of a certain script), please reach out to us. It may help us either refine our current scripts, or add on new ones that are appropriate for a given use case.
DinD (dind.sh)
DinD is a wrapper script which allows Docker to be run inside a Docker container. DinD requires the container to be run with privileged mode enabled.
Generate Authors (generate-authors.sh)
Generates AUTHORS; a file with all the names and corresponding emails of individual contributors. AUTHORS can be found in the home directory of this repository.
Make
There are two make files, each with different extensions. Neither are supposed
to be called directly; only invoke make. Both scripts run inside a Docker
container.
make.ps1
- The Windows native build script that uses PowerShell semantics; it is limited
unlike
hack\make.shsince it does not provide support for the full set of operations provided by the Linux counterpart,make.sh. However,make.ps1does provide support for local Windows development and Windows to Windows CI. More information is found withinmake.ps1by the author, @jhowardmsft
make.sh
- Referenced via
make testwhen running tests on a local machine, or directly referenced when running tests inside a Docker development container. - When running on a local machine,
make testto run all tests found intest,test-unit,test-integration, andtest-docker-pyon your local machine. The default timeout is set inmake.shto 60 minutes (${TIMEOUT:=60m}), since it currently takes up to an hour to run all of the tests. - When running inside a Docker development container,
hack/make.shdoes not have a single target that runs all the tests. You need to provide a single command line with multiple targets that performs the same thing. An example referenced from Run targets inside a development container:root@5f8630b873fe:/go/src/github.com/moby/moby# hack/make.sh dynbinary binary test-unit test-integration test-docker-py - For more information related to testing outside the scope of this README, refer to Run tests and test documentation
Vendor (vendor.sh)
A shell script that is a wrapper around go mod vendor.