DEVELOPMENT.md

Development

The Asset Relocation Tool for Kubernetes is built preferably with Golang 1.18, although 1.17 is also supported.

Running tests

There are three types of tests, unit tests, feature tests and external tests.

Unit tests exercise the internals of the code. They can be run with:

make test-units

Feature tests exercise the tool from outside in by building and executing it as CLI. They can be run with:

make test-features

External tests are similar to feature tests except that they execute tests directly against external resources. They can report false negatives if that resource is offline or if access to that resource is limited in some way. However, they can also assure that the tool is correctly integrating with that resource.

They can be run with:

make test-external

External tests require credentials to talk to the internal VMware Harbor registry, ask Pete if you need access.

All local tests can be run with:

make test

Those are safe to run always, even without credentials setup.

To run all tests, including test-external do:

make test-all

Releasing

Releases are cut manually like this:

VERSION=X.Y.Z && git tag "v${VERSION}" && git push origin "v${VERSION}"

The X.Y.Z version must be a semver compliant version string. Once the tag is pushed, a GitHub Action will produce the corresponding release using goreleaser.