e2e

README

e2e tests for FDB Kubernetes operator

Those test must be running on a Kubernetes cluster that has amd64 Linux nodes as FoundationDB currently has no builds for arm64. Every test suite has a head in the *_test.go file that describes the test cases and the targeted scenarios.

Running the e2e tests

The following command will run all the operator related tests with the default values:

make -kj -C e2e run

You can also run a specific test suite by providing the name of the test suite:

make -C e2e test_operator.run

Every test suite will create at least one namespace, HA cluster tests will create all the required namespaces.

Reusing an existing test cluster

A test cluster can be reused if wanted, e.g. for test cases that load a large amount of data into the cluster. This requires to specify the CLUSTER_NAME and the NAMESPACE, if those values are not specified the test suite will use randomized values. NOTE The limitation of this approach is that the test suite will not update the existing FoundationDBCluster in the creation step. So if you're modifying the FoundationDBCluster spec, you have to recreate the cluster.

CLEANUP=false CLUSTER_NAME=dev-cluster-1 NAMESPACE=dev make -kj -C e2e run

StorageClass selection

The e2e tests assume that at least one StorageClass is present in the target Kubernetes cluster. You can provide the targeted StorageClass as an environment variable:

STORAGE_CLASS='my-fancy-storage' make -kj -C e2e test_operator.run

If the STORAGE_CLASS is not set, the operator will take the default StorageClass in this cluster. The default StorageClass will be identified based on the annotation: "storageclass.kubernetes.io/is-default-class=true.

The e2e test suite has some tests, that will test a migration from one StorageClass to another. To prevent potential issues, the e2e test suite will only select StorageClasses that have the label foundationdb.org/operator-testing=true. If the test suite is not able to get at least 2 different StorageClasses the migration test will be skipped.

Customize the e2e test runs

The Makefile provides different options to customize a test run, e.g. with FDB_VERSION a user can specify the used FDB version for a test run:

FDB_VERSION=7.1.33 make -C e2e -kj test_operator.run

If those tests are running on a cluster that has no chaos-mesh installed, you can set ENABLE_CHAOS_TESTS=false to disable all test that uses chaos-mesh.

Running the e2e tests with the unified image

NOTE The unified image is currently experimental and there are no pre-build images.

The source can be found in the FoundationDB repository. You have to make sure that the image foundationdb/fdb-kubernetes-monitor is built and available in the Kubernetes cluster.

FDB_IMAGE=foundationdb/fdb-kubernetes-monitor:7.3.38 \
SIDECAR_IMAGE=foundationdb/fdb-kubernetes-monitor:7.3.38 \
FEATURE_UNIFIED_IMAGE=true \
UPGRADE_VERSIONS="" \
FDB_VERSION="7.3.38" \
make -C e2e test_operator.run

Running e2e tests in kind

NOTE This setup is currently not used by our CI.

kind provides an easy way to run a local Kubernetes cluster. For running tests on a kind cluster you should set the CLOUD_PROVIDER=kind environment variable to make sure the test framework is creating clusters with smaller resource requirements. The following steps assume that kind and helm are already installed.

make -C e2e kind-setup

This will call the setup_e2e.sh script to setup kind and install chaos-mesh. After testing you can run the following command to remove the kind cluster:

make -C e2e kind-destroy

If you want to iterate over different builds of the operator, you don't have to recreate the kind cluster multiple times. You just can rebuild the operator image and push the new image inside the kind cluster:

CLOUD_PROVIDER=kind make -C e2e kind-update-operator

NOTE: This setup is currently not tested in our CI and requires a Kind cluster that runs with amd64 nodes.

What is tested

The following section will cover additional details about the test suites.

Test running for PRs

The following tests will be running for each PR:

• test_operator
• test_operator_upgrades

Those are all test suites labeled with the pr label. You can run those test suites with: make -kj -C e2e pr-tests

Tests running regularly

The following tests will be running on a nightly base:

• test_operator
• test_operator_upgrades
• test_operator_ha_upgrades
• test_operator_velocity

Those are all test suites labeled with the pr or the nightly label. You can run those test suites with: make -kj -C e2e nightly-tests

Tests that are not run regularly

Those tests will not be running automatically:

• test_operator_creation_velocity
• test_operator_stress

e.g. these tests will be used to qualify a new release. You can run all tests with make -kj -C e2e run

How to debug failed PR tests

All tests will be logging to the logs folder in the root of this repository. If you want to see the current state of a running test you can use tail, e.g. tail -f ./logs/test_operator.log, to see the progress of the operator tests, the command assumes you are running it from the project directory. All tests that are started by our CI pipelines will report in the PR with the test status.