tests/

README

Rio testing

All commands run from root dir

• Unit Tests
• Integration Tests
• Validation Tests
• Full Suite
• Running in Docker

Unit Tests

go test -race -cover -tags=test ./...

Integration Tests

Integration tests live inside the /tests/integration dir. They require a working cluster with KUBECONFIG env var set, and rio already installed.

go test -v -race ./tests/integration/... -integration-tests

Every spec should be in the when x, it should y format.

Validation Tests

Validation tests live inside the /tests/validation dir. They require a working cluster with KUBECONFIG env var set, and rio already installed. In the future, rio will be installed as part of the tests.

go test -v -race ./tests/validation/... -validation-tests

These tests should not be used to block merging PRs. They are meant to run in other CI and run less regularly. They are also the place where more obscure tests that are useful for regression can be written.

Integration/Validation Dev Notes

• Logic lives in the testutil dir, test specs live in the integration or validation folder
• We are purposefully failing tests in the util code rather than returning errors in order to keep specs clean
  • Only fail tests in public methods
• To add a new suite, create a file and add it in the TestSuite list
• While writing use it.Focus or when.Focus to limit to your spec
• To help debug, try printing args in RioCmd to see what the tests are doing
• Most every It block spins up a new service which takes > 10 seconds. If you want to specify multiple assertions on a single service it will be much faster to use testify descriptions within a single block, example in run_test.go
• Ensure all Remove functions can be run on a never-instantiated object, you don't know what order will be in it.After.
• Make sure you use local variables when testing in parallel to avoid bugs.

Goland is useful for debugging, setup with:

• test kind: package
• package: github.com/rancher/rio/tests/integration
• environment: set your KUBECONFIG. DEBUG_TEST will print extra rio commands that were invoked.
• program arguments: --integration-tests

Full suite

make ci

Running in Docker

Integration and Validation tests can be run with docker:

1. Add a KUBECONFIG file to /path/to/rio/.kube/config
2. Make sure you have docker installed, then run the following in a terminal:

$ cd /path/to/rio
$ docker build -f "./tests/Dockerfile" -t rio-test .

# To run integration tests
$ docker run --rm -e test=integration rio-test:latest
# To run validation tests:
$ docker run --rm -e test=integration -e AWS_ACCESS_KEY_ID=[keyid] -e AWS_SECRET_ACCESS_KEY=[secret] -e RIO_ROUTE53_ZONEID=[zoneid] -e RIO_ROUTE53_ZONENAME=[your.zone.name] rio-test:latest

# To run with a specific version of RIO installed. Tests are always optimized for the latest version.
$ docker run --rm -e test=integration -e INSTALL_RIO_VERSION=v0.6.0-rc2 rio-test:latest