Tests are playing a primary role and we take them seriously. It is expected from PRs to add, modify or delete tests on case by case scenario. To contribute you need to be familiar with:
Make sure that the tool dependencies are already in place. The ginkgo
and mockgen
binaries that are required for testing will be installed as part of tool dependencies.
$ cd pkg/maintenance
$ ginkgo bootstrap
$ ginkgo generate maintenance.go
find .
./maintenance.go
./maintenance_suite_test.go
./maintenance_test.go
- You can run the tests using
make test
orgo test ./...
This project makes use of GoMock
to mock service interfaces. This comes with the mockgen
utility which can be used to generate or re-generate mock interfaces that can be used to simulate the behaviour of an external dependency.
Once installed, an interface can be mocked by running:
mockgen -s=/path/to/file_containing_interface.go > /path/to/output_mock_file.go
However, it is considered good practice to include a go generate directive above the interface which defines the specific mockgen
command that will generate your mocked interface.
Internal interfaces including pkg/maintenance/maintenance.go
and pkg/controller/upgradeconfig/cluster_upgrader.go
are mocked using this method. When making changes to these packages, you should re-generate the mocks to ensure they too are updated. This can be performed manually by running go generate /path/to/file.go
or for the whole project via make generate
.
- Mocks might need to be regenerated upon dependency updates, e.g. k8s/controller-runtime
To regenerate controller-runtime mock (cr-client.go), run
mockgen -package mocks -destination=util/mocks/cr-client.go sigs.k8s.io/controller-runtime/pkg/client Client,StatusWriter,Reader,Writer```