Skip to content

Commit

Permalink
Update test docs for OTel Demo (#3173)
Browse files Browse the repository at this point in the history
  • Loading branch information
danielbdias authored Aug 15, 2023
1 parent 60c041b commit bc4a1ca
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 5 deletions.
19 changes: 14 additions & 5 deletions content/en/docs/demo/tests.md
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 %}}
4 changes: 4 additions & 0 deletions static/refcache.json
Original file line number Diff line number Diff line change
Expand Up @@ -4471,6 +4471,10 @@
"StatusCode": 200,
"LastSeen": "2023-06-29T18:42:20.913106-04:00"
},
"https://tracetest.io/": {
"StatusCode": 206,
"LastSeen": "2023-08-14T12:06:16.100357-03:00"
},
"https://tracetest.io/blog/frontend-overhaul-opentelemetry-demo": {
"StatusCode": 206,
"LastSeen": "2023-06-29T18:51:50.19809-04:00"
Expand Down

0 comments on commit bc4a1ca

Please sign in to comment.