Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

dev-docs: Add smoke tests docs to TESTING.md #8545

Merged
merged 3 commits into from
Jul 12, 2022
Merged

dev-docs: Add smoke tests docs to TESTING.md #8545

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e0299bd
dev-docs: Add smoke tests docs to `TESTING.md`
marclop Jul 6, 2022
9b13c28
Merge branch 'main' into f/add-smoke-testing-brief-documentation
marclop Jul 8, 2022
5e05043
Merge branch 'main' into f/add-smoke-testing-brief-documentation
marclop Jul 12, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions TESTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down