Skip to content

Commit

Permalink
Fine-tune readme regarding some command line options
Browse files Browse the repository at this point in the history
  • Loading branch information
soxofaan committed Feb 7, 2024
1 parent 4b9b8f0 commit e410173
Showing 1 changed file with 15 additions and 7 deletions.
22 changes: 15 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,17 +46,13 @@ focussing on a specific API aspect to test or verify
failures in these tests should be looked into and fixed.
- Non-functional tests concern descriptions and other metadata of processes that have no impact on the actual behavior of the process,
failures in these tests should be taken as warnings, but don't necessarily need to be fixed. These can be skipped by adding
'-m "not optional"' to the pytest command.
`-m "not optional"` to the pytest command.
- Usage example for running these tests against a desired openEO backend URL:
```bash
pytest src/openeo_test_suite/tests/processes/metadata \
--html=reports/process-metadata.html \
--openeo-backend-url=openeo.example \
--tb=no \
-vv
-U openeo.example \
--html=reports/process-metadata.html
```
It is recommended to run these tests with the `--tb=no` option to avoid excessive output of no substance.
and the `-vv` option to get more detailed output.
- **WP4 General openEO API compliance validation** (lead implementation partner: EODC)
- TODO: [Open-EO/openeo-test-suite#20](https://github.com/Open-EO/openeo-test-suite/issues/20)
- **WP5 Individual process testing** (lead implementation partner: M. Mohr)
Expand Down Expand Up @@ -197,6 +193,18 @@ If both are specified, the union of both will be considered.
kept irrespective of this option.
### Recommended `pytest` options
pytest provides a [lot of command-line options](https://docs.pytest.org/en/8.0.x/reference/reference.html#command-line-flags)
to fine-tune how the test suite is executed (test selection, reporting, ...).
Some recommended options to use in practice:
- `-vv`: increase verbosity while running the test,
e.g. to have a better idea of the progress of slow tests.
- `--tb=no`: avoid output of full stack traces,
which give little to no added value for some test modules.
### Authentication of the basic `connection` fixture
The test suite provides a basic `connection` fixture
Expand Down

0 comments on commit e410173

Please sign in to comment.