Skip to content

Commit

Permalink
update the README
Browse files Browse the repository at this point in the history
  • Loading branch information
masci committed Oct 14, 2024
1 parent 0152509 commit 7425bf7
Showing 1 changed file with 23 additions and 3 deletions.
26 changes: 23 additions & 3 deletions e2e_tests/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,28 @@

E2E tests are run in the `e2e-tests` workflow in `.github/workflows/e2e-tests.yml`.

They are written such that a `run.sh` script can be executed to run some number of tests locally.
Each folder in this directory contains a Python package representing a set of tests for a simple scenario.

Each folder in this directory represents a set of tests for simple scenarios.
When new folders are added, they will be executed automatically in the CI/CD pipeline by `pytest`.

When new folders are added, they will be executed automatically in the CI/CD pipeline, assuming the `run.sh` script runs successfully.
To run all the tests:

```sh
$ poetry run pytest -m"e2e"
```
or
```sh
$ poetry run pytest ./e2e_tests
```

To run a specific scenario:

```sh
$ poetry run pytest e2e_tests/basic_streaming
```

If you want to see the output of the different services running, pass the `-s` flag to pytest:

```sh
$ poetry run pytest e2e_tests/basic_streaming -s
```

0 comments on commit 7425bf7

Please sign in to comment.