Skip to content

Commit bc4a1ca

Browse files
authored
Update test docs for OTel Demo (open-telemetry#3173)
1 parent 60c041b commit bc4a1ca

File tree

2 files changed

+18
-5
lines changed

2 files changed

+18
-5
lines changed

content/en/docs/demo/tests.md

+14-5
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,25 @@
11
---
22
title: Tests
3+
cSpell:ignore: Tracetest
34
---
45

56
Currently, the repository includes E2E tests for both the frontend and backend
67
services. For the Frontend we are using [Cypress](https://www.cypress.io/)
78
execute the different flows in the web store. While the backend services use
8-
[AVA](https://avajs.dev) as the main testing framework.
9+
[AVA](https://avajs.dev) as the main testing framework for integration tests and
10+
[Tracetest](https://tracetest.io/) for trace-based tests.
911

10-
To run the test you can simply run `make run-tests` at the root directory.
12+
To run all the tests, execute `make run-tests` from the root directory.
1113

12-
In case you need to run a specific suite of tests you can execute
13-
`docker compose run frontendTests`[^1] for the frontend tests or
14-
`docker compose run integrationTests`[^1] for the backend tests.
14+
Otherwise, if you want to run a specific suite of tests you can execute specific
15+
commands for each type of test[^1]:
16+
17+
- **Frontend tests**: `docker compose run frontendTests`
18+
- **Backend tests**:
19+
- Integration: `docker compose run integrationTests`
20+
- Trace-based: `docker compose run traceBasedTests`
21+
22+
To learn more about these tests, see
23+
[Service Testing](https://github.com/open-telemetry/opentelemetry-demo/tree/main/test).
1524

1625
[^1]: {{% _param notes.docker-compose-v2 %}}

static/refcache.json

+4
Original file line numberDiff line numberDiff line change
@@ -4471,6 +4471,10 @@
44714471
"StatusCode": 200,
44724472
"LastSeen": "2023-06-29T18:42:20.913106-04:00"
44734473
},
4474+
"https://tracetest.io/": {
4475+
"StatusCode": 206,
4476+
"LastSeen": "2023-08-14T12:06:16.100357-03:00"
4477+
},
44744478
"https://tracetest.io/blog/frontend-overhaul-opentelemetry-demo": {
44754479
"StatusCode": 206,
44764480
"LastSeen": "2023-06-29T18:51:50.19809-04:00"

0 commit comments

Comments
 (0)