The Rook Test Framework is used to run end to end and integration tests on Rook. The framework depends on a running instance of kubernetes. The framework also provides scripts for starting kubernetes using kubeadm or minikube so users can quickly spin up a kubernetes cluster.The Test framework is designed to install Rook, run tests, and uninstall Rook.

Requirements

Docker version => 1.2 && < 17.0
Ubuntu 16 (the framework has only been tested on this version)
Kubernetes with kubectl configured
Rook

Instructions

Setup

Install Kubernetes

You can choose any kubernetes flavor of your choice. The test framework only depends on kubectl being configured. The framework also provides scripts to install Kubernetes. There are two scripts to start the cluster:

Minikube: Run minikube.sh to setup a single-node Minikube kubernetes. Minikube 0.21.0 and higher is supported. Older minikube versions do not have cephfs or rbd tools installed.(recommended for MacOS)
Kubeadm : run kubeadm.sh to setup a single-node K8s cluster using kubeadm (recommended for ubuntu)

These start-up scripts are designed to start any version of kubernetes, Based on KUBE_VERSION environment variable By default they start kubernetes version v1.7.4.(except minikube which starts kubernetes v1.7.2) e.g. To kubernetes version v1.6.7

export KUBE_VERSION=v1.6.7
tests/scripts/kubeadm.sh up

To stop the cluster : ./kubeadm.sh clean or ./miniube.sh clean

All of the above scripts are designed to start kubernetes, make sure rbd is working, and copy the latest rook and toolbox images to the kubernetes containers.

Run Tests

From the root do the following:

Build rook: make build
Start kubernetes using one of the following:
- kubeadm-dind.sh up
- minikube.sh up
- kubeadm.sh up
Run integration tests: make test-integration

Test parameters

The following parameters are available while running tests

Parameter	Description	Possible values	Default
rook_platform	platform rook needs to be installed on	kubernetes	kubernetes
k8s_version	version of Kubernetes to be installed	v1.5,v1.6,v1.7	v1.7
rook_image	rook image name to be installed	valid image name	rook/rook
toolbox_image	toolbox image name to be installed	valid image name	rook/toolbox
skip_install_rook	skips installing rook (if already installed)	true or false	false
load_parallel_runs	performs concurrent operations (optional used for load test)	any number	20

If the install_rook flag is set to false, then all the other flags are ignored and tests are run without rook being installed and setup. Use this flag to run tests against a pre-installed/configured rook.

Running Tests with parameters.

To run all integration tests run

make test-integration

To run all integration Tests on a specific suite (uses regex)

make test-integration SUITE=SmokeSuite

To run all tests in a package:

go test github.com/rook/rook/e2e/tests/smoke

runs all tests under /tests/smoke folder.

To run specific tests:

go test -run SmokeSuite github.com/rook/rook/tests/smoke

which runs all tests that match regex SmokeSuite in /tests/smoke folder

To run specific without installing rook:

go test -run SmokeSuite github.com/rook/rook/tests/smoke --skip_install_rook=true

If the skip_install_rook flag is set to true, then rook is not uninstalled either.

Run Longhaul Tests

Using the go test -count n option, any tests can be repeated n number of times to simulate load or longhaul test. Although any test can be converted to a longhaul test, it's ideal to run integration tests under load for an extended period. Also a new custom test flag load_parallel_runs is added to control the number of concurrent operations being performed. For example look at the block long haul test

To run a longhaul test you can run any integration test with -count and --load_parallel_runs options e.g.

go test -run TestK8sBlockLongHaul github.com/rook/rook/tests/longhaul --load_parallel_runs=20 -count=1000

The Longhaul test just like other test is going to install rook if it's not already installed, but it is not going to clean up test data or uninstall rook after the run. Longhaul test is designed to run multiple times on the same setup and installation of rook to tests its stability. Test Data and rook should be cleaned up manually after the test.

Prerequisites :

Go installed and GO_PATH set
Glide installed
when running tests locally, make sure kubectl is accessible globally as the test framework uses kubectl

Cleanup

The test framework is designed to uninstall rook after every test. If you using the --skip_install_rook flag you will need to clean up rook manually.

To stop kubernetes run kubeadm.sh clean or minikube.sh clean.