From e0299bd6d66ab0c2d6f4f1cfd91543b04c646a30 Mon Sep 17 00:00:00 2001 From: Marc Lopez Rubio Date: Wed, 6 Jul 2022 15:11:08 +0800 Subject: [PATCH] dev-docs: Add smoke tests docs to `TESTING.md` Adds a section about "smoke testing" in the `TESTING.md`. Signed-off-by: Marc Lopez Rubio --- TESTING.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/TESTING.md b/TESTING.md index 2b0f918effd..9d87dd7c031 100644 --- a/TESTING.md +++ b/TESTING.md @@ -123,6 +123,19 @@ Usage of /var/folders/k9/z1yw8fsn0sjbl5yy7z2rsdpr0000gn/T/go-build4164012609/b00 apm-server URL (default http://localhost:8200) ``` +## Smoke testing + +Smoke tests verify are light end to end tests which ensure that the "happy path" of the APM Server works as +expected per the asserted scenarios. The idea is to automatically gauge if there are any critical problems in +the APM Server in a regular manner. + +These tests are currently using a Terraform module which manages the creation of deployments in ESS (could also +be configured to use an ECE installation) with some light bash scripting which is run in a variety of scenarios +and upgrades, but ensures there aren't any major problems with APM Server accepting and indexing events where +it should. + +The smoke tests can be found under [`testing/smoke`](./testing/smoke) + ## Manual testing Often, we need to manually test the integration between different features, PR testing or pre-release testing.