-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update test docs for OTel Demo (#3173)
- Loading branch information
1 parent
60c041b
commit bc4a1ca
Showing
2 changed files
with
18 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,16 +1,25 @@ | ||
--- | ||
title: Tests | ||
cSpell:ignore: Tracetest | ||
--- | ||
|
||
Currently, the repository includes E2E tests for both the frontend and backend | ||
services. For the Frontend we are using [Cypress](https://www.cypress.io/) | ||
execute the different flows in the web store. While the backend services use | ||
[AVA](https://avajs.dev) as the main testing framework. | ||
[AVA](https://avajs.dev) as the main testing framework for integration tests and | ||
[Tracetest](https://tracetest.io/) for trace-based tests. | ||
|
||
To run the test you can simply run `make run-tests` at the root directory. | ||
To run all the tests, execute `make run-tests` from the root directory. | ||
|
||
In case you need to run a specific suite of tests you can execute | ||
`docker compose run frontendTests`[^1] for the frontend tests or | ||
`docker compose run integrationTests`[^1] for the backend tests. | ||
Otherwise, if you want to run a specific suite of tests you can execute specific | ||
commands for each type of test[^1]: | ||
|
||
- **Frontend tests**: `docker compose run frontendTests` | ||
- **Backend tests**: | ||
- Integration: `docker compose run integrationTests` | ||
- Trace-based: `docker compose run traceBasedTests` | ||
|
||
To learn more about these tests, see | ||
[Service Testing](https://github.com/open-telemetry/opentelemetry-demo/tree/main/test). | ||
|
||
[^1]: {{% _param notes.docker-compose-v2 %}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters