From f646cd2fed19f8ff607be3ef05afea48953f07cc Mon Sep 17 00:00:00 2001 From: Muhammad Adil Ghaffar Date: Fri, 3 Jan 2025 10:02:47 +0200 Subject: [PATCH] Improve e2e documentation Signed-off-by: Muhammad Adil Ghaffar --- docs/e2e-test.md | 29 ++++++++++++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) diff --git a/docs/e2e-test.md b/docs/e2e-test.md index 0d53f075aa..02dfe0cf17 100644 --- a/docs/e2e-test.md +++ b/docs/e2e-test.md @@ -36,9 +36,36 @@ tests, please refer to ## Running -Run e2e tests with +The whole e2e test suite is very big and it is not recommended to run whole +suite at a time. You can easily choose the test you want to run or skip by +using`GINKGO_FOCUS` and `GINKGO_SKIP`. +For example following will run integration test: ```sh +export GINKGO_FOCUS=integration +make test-e2e +``` + +Below are the tests that you can use with `GINKGO_FOCUS` and `GINKGO_SKIP` + +- features + - ip-reuse + - healthcheck + - remediation + - pivoting +- k8s-upgrade +- clusterctl-upgrade +- scalability +- integration +- basic + +You can combine both `GINKGO_FOCUS` and `GINKGO_SKIP` to run multiple tests +according to your requirements. For example following will run ip-reuse and +pivoting tests: + +```sh +export GINKGO_FOCUS=features +export GINKGO_SKIP=healthcheck remediation make test-e2e ```