# Testing Standards in RKE2 Go testing in RKE2 comes in 4 forms: - [Unit](#unit-tests) - [Integration](#integration-tests) - [Smoke](#installer-tests) - [End-to-End (E2E)](#end-to-end-e2e-tests) This document will explain *when* each test should be written and *how* each test should be generated, formatted, and run. Note: all shell commands given are relative to the root RKE2 repo directory. ___ ## Unit Tests Unit tests should be written when a component or function of a package needs testing. Unit tests should be used for "white box" testing. ### Framework All unit tests in RKE2 follow a [Table Driven Test](https://github.com/golang/go/wiki/TableDrivenTests) style. Specifically, RKE2 unit tests are automatically generated using the [gotests](https://github.com/cweill/gotests) tool. This is built into the Go vscode extension, has documented integrations for other popular editors, or can be run via command line. Additionally, a set of custom templates are provided to extend the generated test's functionality. To use these templates, call: ```bash gotests --template_dir=/contrib/gotests_templates ``` Or in vscode, edit the Go extension setting `Go: Generate Tests Flags` and add `--template_dir=/contrib/gotests_templates` as an item. ### Format All unit tests should be placed within the package of the file they test. All unit test files should be named: `_test.go`. All unit test functions should be named: `Test_Unit` or `Test_Unit_`. See the [service account unit test](https://github.com/rancher/rke2/blob/master/pkg/rke2/serviceaccount_test.go) as an example. ### Running ```bash go test ./pkg/... -run Unit ``` Note: As unit tests call functions directly, they are the primary drivers of RKE2's code coverage metric. ___ ## Integration Tests Integration tests should be used to test a specific functionality of RKE2 that exists across multiple Go packages, either via exported function calls, or more often, CLI commands. Integration tests should be used for "black box" testing. ### Framework All integration tests in RKE2 follow a [Behavior Driven Development (BDD)](https://en.wikipedia.org/wiki/Behavior-driven_development) style. Specifically, RKE2 uses [Ginkgo](https://onsi.github.io/ginkgo/) and [Gomega](https://onsi.github.io/gomega/) to drive the tests. To generate an initial test, the command `ginkgo bootstrap` can be used. To facilitate RKE2 CLI testing, see `tests/util/cmd.go` helper functions. ### Format All integration tests should be places in `tests` directory. All integration test files should be named: `_int_test.go` All integration test functions should be named: `Test_Integration`. See the [etcd snapshot test](https://github.com/rancher/rke2/blob/master/tests/etcd_int_test.go) as an example. ### Running Integration tests must be with an existing single-node cluster, tests will skip if the server is not configured correctly. ```bash make dev-shell # Once in the dev-shell # Start rke2 server with appropriate flags ./bin/rke2 server ``` Open another terminal ```bash make dev-shell-enter # once in the dev-shell go test ./tests/ -run Integration ``` ___ ## Installer Tests Installer tests should be run anytime one makes a modification to the installer script(s). These can be run locally with Vagrant: - [CentOS 7](../tests/install/centos-7) (stand-in for RHEL 7) - [Rocky 8](../tests/install/rocky-8) (stand-in for RHEL 8) - [MicroOS](../tests/install/opensuse-microos) (stand-in for SLE-Micro) - [Ubuntu 20.04](../tests/install/ubuntu-focal) (Focal Fossa) When adding new installer test(s) please copy the prevalent style for the `Vagrantfile`. Ideally, the boxes used for additional assertions will support the default `virtualbox` provider which enables them to be used by our Github Actions Workflow(s). See [install.yaml](../.github/workflows/install.yaml). ### Framework If you are new to Vagrant, Hashicorp has written some pretty decent introductory tutorials and docs, see: - https://learn.hashicorp.com/collections/vagrant/getting-started - https://www.vagrantup.com/docs/installation #### Plugins and Providers The `libvirt` and `vmware_desktop` providers cannot be used without first [installing the relevant plugins](https://www.vagrantup.com/docs/cli/plugin#plugin-install) which are [`vagrant-libvirt`](https://github.com/vagrant-libvirt/vagrant-libvirt) and [`vagrant-vmware-desktop`](https://www.vagrantup.com/docs/providers/vmware/installation), respectively. Much like the default [`virtualbox` provider](https://www.vagrantup.com/docs/providers/virtualbox) these will do nothing useful without also installing the relevant server runtimes and/or client programs. #### Environment Variables These can be set on the CLI or exported before invoking Vagrant: - `TEST_INSTALL_SH` (default :arrow_right: `../../../../install.sh`) The location of the installer script to be uploaded to the guest by the [Vagrant File Provisioner](https://www.vagrantup.com/docs/provisioning/file) before being invoked at `/home/vagrant/install.sh`. - `TEST_VM_CPUS` (default :arrow_right: 2) The number of vCPU for the guest to use. - `TEST_VM_MEMORY` (default :arrow_right: 2048) The number of megabytes of memory for the guest to use. - `TEST_VM_BOOT_TIMEOUT` (default :arrow_right: 600) The time in seconds that Vagrant will wait for the machine to boot and be accessible. - `INSTALL_PACKAGES` A space-delimited string of package names (or locations accessible to the guest's native package manager) that will be installed prior to invoking the RKE2 install script. Useful for overriding the `rke2-selinux` RPM via URL pointing at a specific Github release artifact. - `INSTALL_RKE2_*`, `RKE2_*` All values (other than those mentioned below) are passed through to the guest for capture by the installer script: - `INSTALL_RKE2_TYPE=server` (hard-coded) - `RKE2_KUBECONFIG_MODE=0644` (hard-coded) - `RKE2_TOKEN=vagrant` (hard-coded) ___ ## End-to-End (E2E) Tests E2E tests cover multi-node RKE2 configuration and administration: bringup, update, teardown etc. across a wide range of operating systems. E2E tests are run nightly as part of RKE2 quality assurance (QA). ### Framework End-to-end tests utilize [Ginkgo](https://onsi.github.io/ginkgo/) and [Gomega](https://onsi.github.io/gomega/) like the integration tests, but rely on [Vagrant](https://www.vagrantup.com/) to provide the underlying cluster configuration. Currently tested operating systems are: - [Ubuntu 20.04](https://app.vagrantup.com/generic/boxes/ubuntu2004) - [Leap 15.3](https://app.vagrantup.com/opensuse/boxes/Leap-15.3.x86_64) (stand-in for SLE-Server) ### Format All E2E tests should be placed under `tests/e2e/`. All E2E test functions should be named: `Test_E2E`. A E2E test consists of two parts: 1. `Vagrantfile`: a vagrant file which describes and configures the VMs upon which the cluster and test will run 2. `.go`: A go test file which calls `vagrant up` and controls the actual testing of the cluster See the [validate cluster test](../tests/e2e/validatecluster/validatecluster_test.go) as an example. ### Running Generally, E2E tests are run as a nightly Jenkins job for QA. They can still be run locally but additional setup is required. By default, all E2E tests are designed with `libvirt` as the underlying VM provider. Instructions for installing libvirt and its associated vagrant plugin, `vagrant-libvirt` can be found [here.](https://github.com/vagrant-libvirt/vagrant-libvirt#installation) `VirtualBox` is also supported as a backup VM provider. Once setup is complete, all E2E tests can be run with: ```bash go test -timeout=15m ./tests/e2e/... -run E2E ``` Tests can be run individually with: ```bash go test -timeout=15m ./tests/e2e/validatecluster/... -run E2E #or go test -timeout=15m ./tests/e2e/... -run E2EClusterValidation ``` Additionally, to generate junit reporting for the tests, the Ginkgo CLI is used. Installation instructions can be found [here.](https://onsi.github.io/ginkgo/#getting-started) To run the all E2E tests and generate JUnit testing reports: ``` ginkgo --junit-report=result.xml ./tests/e2e/... ``` Note: The `go test` default timeout is 10 minutes, thus the `-timeout` flag should be used. The `ginkgo` default timeout is 1 hour, no timeout flag is needed. ___ ## Contributing New Or Updated Tests ___ If you wish to create a new test or update an existing test, please submit a PR with a title that includes the words ` (Created/Updated)`.