ARO-RP/docs/testing.md

Testing

Unit tests

To run RP unit tests:

make test-go

In case of MacOS, the go-diff module creates issue making the test fail. Until a new release of the module with the fix is available, an easy workaround to mitigate the issue is to install diffutils using brew install diffutils

To Run Go tests with coverage:

# first navigate to your directory with the code you'd like to see coverage on
t="/tmp/go-cover.$$.tmp" 
go test -coverprofile=$t $@ && go tool cover -html=$t && unlink $t

To run python client and az aro CLI tests:

make test-python

To run Go linting tasks (requires golanglint-ci to be installed):

make lint-go

For faster feedback, you may want to set up golanglint-ci's editor integration.

E2e tests

E2e tests can be run in CI with the /azp run e2e command in your GitHub PR.

E2e tests can also be run locally as follows:

• Make sure that you meet the requirements from Prepare the database and run the rp (do not create the database yet)
• Source the helper script to set the proper ENV variables. If you run the tests locally, run export LOCAL_E2E=true env before sourcing the helper file.
• Run the rp
• Validate the RP is running properly by hitting the /healthz route
• Register a subscription where to run the e2e
• Create an openshift cluster
• Run the make test-e2e target
• Delete the openshift cluster, if applicable
• Delete the cosmos database, if applicable

You can also modify the flags passed to the e2e.test run by setting the E2E_FLAGS environment variable before running make test-e2e.

These steps can be acheived using commands below. Look at the e2e helper file to understand each of the bash functions below.

Run a specific test

End to end tests are run using ginkgo. You can run subsets of tests or ignore some tests by following the ginkgo documentation

# source your environment file
. ./secrets/env

# set the CLUSTER and LOCAL_E2E env if you are testing locally
export CLUSTER=<cluster-name>
export LOCAL_E2E="true"

# source the e2e helper file
. ./hack/e2e/run-rp-and-e2e.sh

# Deploy a new DB if it does not exist yet
deploy_e2e_db

# build the rp binary
make aro

# run the RP as background process
run_rp

# validate if the RP is ready to receive requests
validate_rp_running

# create an openshift cluster if it does not exist yet
go run ./hack/cluster create

# Register the sub you are using to run e2e
register_sub

# Run e2e
make test-e2e

# delete the openshift cluster if applicable
go run ./hack/cluster delete

# Stop the local RP
kill_rp

# Delete the DB
clean_e2e_db