Skip to content

Commit a7e8b5e

Browse files
committed
Some more fine-tuning of root README
1 parent 2b4ca72 commit a7e8b5e

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
Test suite for validation of openEO back-ends against the openEO API and related specifications.
55

6-
6+
Location: https://github.com/Open-EO/openeo-test-suite
77

88
## Project structure and modular design
99

@@ -42,23 +42,24 @@ focussing on a specific API aspect to test or verify
4242
- Main location: [`src/openeo_test_suite/tests/processes/metadata`](./src/openeo_test_suite/tests/processes/metadata)
4343
- Defines tests to validate openEO process metadata against specs
4444
defined in the [openeo-processes](https://github.com/Open-EO/openeo-processes) project
45-
- Functional tests concern actual values and behavior of processes (like parameters and return values),
46-
failures in these tests should be looked into and fixed.
47-
- Non-functional tests concern descriptions and other metadata of processes that have no impact on the actual behavior of the process,
48-
failures in these tests should be taken as warnings, but don't necessarily need to be fixed. These can be skipped by adding
49-
`-m "not optional"` to the pytest command.
45+
- Functional tests concern actual values and behavior of processes (like parameters and return values),
46+
failures in these tests should be looked into and fixed.
47+
- Non-functional tests concern descriptions and other metadata of processes that have no impact on the actual behavior of the process,
48+
failures in these tests should be taken as warnings, but don't necessarily need to be fixed. These can be skipped by adding
49+
`-m "not optional"` to the pytest command.
5050
- Usage example for running these tests against a desired openEO backend URL:
5151
```bash
5252
pytest src/openeo_test_suite/tests/processes/metadata \
53-
-U openeo.example \
53+
-U https://openeo.example \
54+
-m "not optional" \
5455
--html=reports/process-metadata.html
5556
```
5657
- **WP4 General openEO API compliance validation** (lead implementation partner: EODC)
5758
- Main location: [`src/openeo_test_suite/tests/general`](./src/openeo_test_suite/tests/general)
5859
- Provides tests to validate the general openEO API compliance of a back-end.
59-
- The backend is checked against the openeo API specification defined in the [openeo-api](https://github.com/Open-EO/openeo-api/).
60-
- There are some tests which might run for a long time (as they running process_graphs on the backends) these can be skippied by adding
61-
`-m "not longrunning"` to the pytest command.
60+
- The backend is checked against the openeo API specification defined in the [openeo-api](https://github.com/Open-EO/openeo-api/) project.
61+
- There are some tests which might run for a long time (as they execute actual process graphs on the backends)
62+
these can be skipped by adding `-m "not longrunning"` to the pytest command.
6263
- Usage example of just running these tests against a desired openEO backend URL:
6364
```bash
6465
pytest src/openeo_test_suite/tests/general \

0 commit comments

Comments
 (0)