make test # runs tests
make verify # runs static code checks and test
There is an additional command for analyzing the code coverage of the tests. Ginkgo will generate standard Golang cover profiles which will be translated into a HTML file by the Go Cover Tool. Another command helps you to clean up the filesystem from the temporary cover profile files and the HTML report:
sigs.k8s.io/controller-runtime env test
Some of the integration tests in Gardener are using the
It sets up a temporary control plane (etcd + kube-apiserver) against the integration tests can run.
test-cov rules in the
Makefile prepare this env test automatically by downloading the respective binaries (if not yet present) and set the necessary environment variables.
You can also run
go test or
ginkgo without the
In this case you have to set the
KUBEBUILDER_ASSETS environment variable to the path that contains the etcd + kube-apiserver binaries or you need to have the binaries pre-installed under
We are using go modules for depedency management.
In order to add a new package dependency to the project, you can perform
go get <PACKAGE>@<VERSION> or edit the
go.mod file and append the package along with the version you want to use.
Makefile contains a rule called
revendor which performs
go mod vendor and
go mod tidy.
go mod vendor resets the main module’s vendor directory to include all packages needed to build and test all the main module’s packages. It does not include test code for vendored packages.
go mod tidy makes sure
go.mod matches the source code in the module. It adds any missing modules necessary to build the current module’s packages and dependencies, and it removes unused modules that don’t provide any relevant packages.
The dependencies are installed into the
vendor folder which should be added to the VCS.