From 13c4d9e26da7d13bd3fe1c867362a6b0397db1f7 Mon Sep 17 00:00:00 2001
From: Stefan Bueringer <buringerst@vmware.com>
Date: Wed, 25 Aug 2021 12:34:19 +0200
Subject: [PATCH] book: add tips on how to speed up test execution
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Stefan Büringer buringerst@vmware.com
---
 docs/book/src/developer/testing.md | 16 +++++++++++++++-
 1 file changed, 15 insertions(+), 1 deletion(-)

diff --git a/docs/book/src/developer/testing.md b/docs/book/src/developer/testing.md
index 59d12c49b189..e1b6b2c8b5ed 100644
--- a/docs/book/src/developer/testing.md
+++ b/docs/book/src/developer/testing.md
@@ -37,7 +37,21 @@ a fake infrastructure provider to allow test coverage for testing the interactio
 
 ## Running unit and integration tests
 
-Using the `test` target through `make` will run all of the unit and integration tests.
+Run `make test` to execute all unit and integration tests.
+
+<aside class="note">
+
+<h1>Tips</h1>
+
+When testing individual packages, you can speed up the test execution by running the tests with a local kind cluster.
+This avoids spinning up a testenv with each test execution. It also makes it easier to debug, because it's straightforward
+to access a kind cluster with kubectl during test execution. For further instructions, run: `./hack/setup-envtest-with-kind.sh`.
+
+When running individual tests, it could happen that a testenv is started if this is required by the `suite_test.go` file.
+However, if the tests you are running don't require testenv (i.e. they are only using fake client), you can skip the testenv
+creation by setting the environment variable `CAPI_DISABLE_TEST_ENV` (to any non-empty value).
+
+</aside>
 
 ## End-to-end tests