Skip to content

Commit 6ba0325

Browse files
ricardogsilvaricardogsilva
authored
Merge pull request #38 from ricardogsilva/29-add-suite-ids-to-docs
Added suite identifiers page to docs.
2 parents cae846a + 072163b commit 6ba0325

File tree

3 files changed

+165
-22
lines changed

3 files changed

+165
-22
lines changed

‎docs/ogc-test-suites.md‎

Lines changed: 154 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,46 +3,112 @@ hide:
33
- navigation
44
---
55

6-
# Test suites which are known to work
6+
# Known test suite parameters
7+
8+
The following table lists known suite identifiers and input parameters which can be used with cite-runner.
9+
Consult each suite's documentation page for more information. Also, feel free to [open an issue] for filling in
10+
missing information or suggesting the addition of new suites.
11+
12+
The official [OGC TEAM Engine documentation] also provides a list of test suites.
713

814
<table>
915
<thead>
1016
<tr>
1117
<th>test suite identifier</th>
18+
<th>description</th>
1219
<th>arguments</th>
1320
</tr>
1421
</thead>
1522
<tbody>
1623
<tr>
17-
<td>ogcapi-features-1.0</td>
18-
<td>
24+
<td>cat30</td>
25+
<td><a href="https://cite.opengeospatial.org/teamengine/about/cat30/3.0.0/site/" target="blank_">OGC Catalogue 3.0 Conformance Test Suite</a></td>
26+
<td></td>
27+
</tr>
28+
<tr>
29+
<td>cdb10</td>
30+
<td><a href="https://cite.opengeospatial.org/teamengine/about/cdb10/1.0/site/" target="blank_">OGC CDB 1.0 Executable Conformance Test Suite</a></td>
31+
<td></td>
32+
</tr>
33+
<tr>
34+
<td>eo-geojson10</td>
35+
<td><a href="https://cite.opengeospatial.org/teamengine/about/eo-geojson10/1.0/site/" target="blank_">EO GeoJSON 1.0 Conformance Test Suite</a></td>
36+
<td></td>
37+
</tr>
38+
<tr>
39+
<td>geopose10</td>
40+
<td>GeoPose 1.0 Conformance Test Suite</td>
41+
<td></td>
42+
</tr>
43+
<tr>
44+
<td>georss10</td>
45+
<td>GeoRSS 1.0 Conformance Test Suite</td>
46+
<td></td>
47+
</tr>
48+
<tr>
49+
<td>geotiff11</td>
50+
<td>GeoTIFF 1.1 Conformance Test Suite</td>
51+
<td></td>
52+
</tr>
53+
<tr>
54+
<td>gml32</td>
55+
<td>GML 3.2 (ISO 19136:2007) Conformance Test Suite</td>
56+
<td></td>
57+
</tr>
58+
<tr>
59+
<td>gmljpx20</td>
60+
<td>GML in JPEG 2000 Conformance Test Suite</td>
61+
<td></td>
62+
</tr>
63+
<tr>
64+
<td>gpkg10</td>
65+
<td>GeoPackage 1.0 Conformance Test Suite</td>
66+
<td></td>
67+
</tr>
68+
<tr>
69+
<td>gpkg12</td>
70+
<td>GeoPackage 1.2 Conformance Test Suite</td>
71+
<td></td>
72+
</tr>
73+
<tr>
74+
<td>kml22</td>
75+
<td>KML 2.2 Conformance Test Suite</td>
76+
<td></td>
77+
</tr>
78+
<tr>
79+
<td>ogcapi-edr10</td>
80+
<td><a href="https://cite.opengeospatial.org/teamengine/about/ogcapi-edr10/1.0/site/" target="blank_">OGC API - Environmental Data Retrieval 1.0 Conformance Test Suite</a></td>
81+
<td>
1982
<ul>
2083
<li>iut</li>
21-
<li>noofcollections</li>
84+
<li>apiDefinition</li>
2285
</ul>
23-
</td>
86+
</td>
2487
</tr>
2588
<tr>
26-
<td>ogcapi-processes-1.0</td>
27-
<td>
89+
<td>ogcapi-features-1.0</td>
90+
<td><a href="https://cite.opengeospatial.org/teamengine/about/ogcapi-features-1.0/1.0/site/" target="blank_">OGC API-Features 1.0 Conformance Test Suite</a></td>
91+
<td>
2892
<ul>
2993
<li>iut</li>
3094
<li>noofcollections</li>
3195
</ul>
32-
</td>
96+
</td>
3397
</tr>
3498
<tr>
35-
<td>ogcapi-edr10</td>
36-
<td>
99+
<td>ogcapi-processes-1.0</td>
100+
<td><a href="https://cite.opengeospatial.org/teamengine/about/ogcapi-processes-1.0/1.0/site/" target="blank_">OGC API-Processes 1.0 Conformance Test Suite</a></td>
101+
<td>
37102
<ul>
38103
<li>iut</li>
39-
<li>apiDefinition</li>
104+
<li>noofcollections</li>
40105
</ul>
41-
</td>
106+
</td>
42107
</tr>
43108
<tr>
44-
<td>ogcapi-tiles10</td>
45-
<td>
109+
<td>ogcapi-tiles-1.0</td>
110+
<td><a href="https://cite.opengeospatial.org/teamengine/about/ogcapi-tiles-1.0/1.0/site/" target="blank_">OGC API-tiles 1.0 Conformance Test Suite</a></td>
111+
<td>
46112
<ul>
47113
<li>iut</li>
48114
<li>tilematrixsetdefnitionuri</li>
@@ -53,7 +119,80 @@ hide:
53119
<li>mintilecol</li>
54120
<li>maxtilecol</li>
55121
</ul>
56-
</td>
122+
</td>
123+
</tr>
124+
<tr>
125+
<td>omxml20</td>
126+
<td>Observations and Measurements - XML Implementation (OMXML)</td>
127+
<td></td>
128+
</tr>
129+
<tr>
130+
<td>sensorml20</td>
131+
<td>Sensor Model Language (SensorML)</td>
132+
<td></td>
133+
</tr>
134+
<tr>
135+
<td>sos20</td>
136+
<td>OGC Sensor Observation Service 2.0.0 - Executable Test Suite</td>
137+
<td></td>
138+
</tr>
139+
<tr>
140+
<td>sta10</td>
141+
<td><a href="https://cite.opengeospatial.org/teamengine/about/sta10/1.0/site/" target="blank_">SensorThings API (STA)<a></td>
142+
<td></td>
143+
</tr>
144+
<tr>
145+
<td>swecommon20</td>
146+
<td>Sensor Web Enablement (SWE) Common Data Model Encoding Standard</td>
147+
<td></td>
148+
</tr>
149+
<tr>
150+
<td>wcs</td>
151+
<td>OGC Web Coverage Service 2.0.1 - Executable Test Suite</td>
152+
<td></td>
153+
</tr>
154+
<tr>
155+
<td>wcs11</td>
156+
<td>OGC Web Coverage Service 1.1.1 - Executable Test Suite</td>
157+
<td></td>
158+
</tr>
159+
<tr>
160+
<td>wfs</td>
161+
<td>Web Feature Service 1.1.0</td>
162+
<td></td>
163+
</tr>
164+
<tr>
165+
<td>wfs10</td>
166+
<td>Conformance Test Suite - OGC Web Feature Service 1.0.0</td>
167+
<td></td>
168+
</tr>
169+
<tr>
170+
<td>wfs20</td>
171+
<td>WFS 2.0 (ISO 19142:2010) Conformance Test Suite</td>
172+
<td></td>
173+
</tr>
174+
<tr>
175+
<td>wms11</td>
176+
<td>Conformance Test Suite - OGC Web Map Service 1.1</td>
177+
<td></td>
178+
</tr>
179+
<tr>
180+
<td>wms13</td>
181+
<td>Conformance Test Suite - OGC Web Map Service 1.3.0</td>
182+
<td></td>
183+
</tr>
184+
<tr>
185+
<td>wmts</td>
186+
<td>OGC Web Map Tile Service 1.0.0 - Executable Test Suite</td>
187+
<td></td>
188+
</tr>
189+
<tr>
190+
<td>wps20</td>
191+
<td>WPS 2.0 Conformance Test Suite</td>
192+
<td></td>
57193
</tr>
58194
</tbody>
59195
</table>
196+
197+
[OGC TEAM Engine documentation]: https://cite.opengeospatial.org/teamengine/
198+
[open an issue]: https://github.com/OSGeo/cite-runner/issues

‎docs/running-as-github-action.md‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ When run as a github action, cite-runner expects the following inputs to be prov
4848

4949
- **required**: Yes
5050
- **description**: Identifier of the test suite to be executed. Test suite identifiers can be gotten from
51-
the documentation at <http://cite.opengeospatial.org/teamengine/>.
51+
the [OGC Test suites section](ogc-test-suites.md).
5252

5353
Example:
5454

@@ -85,9 +85,11 @@ When run as a github action, cite-runner expects the following inputs to be prov
8585
- **description**: URL of the teamengine instance to be used for running tests.
8686

8787
If this parameter is not specified then the action will spin up a local
88-
teamengine docker container and use it for testing. This can be used in
89-
conjunction with `teamengine_username` and `teamengine_password` in order
90-
to provide authentication credentials.
88+
teamengine docker container and use it for testing.
89+
90+
When providing a value for this option, it can be used in conjunction with
91+
the `teamengine_username` and `teamengine_password` in order to provide
92+
authentication credentials.
9193

9294
!!! note
9395
The value of `teamengine_url` must be the URL of the landing page of
@@ -96,7 +98,7 @@ When run as a github action, cite-runner expects the following inputs to be prov
9698
Examples:
9799

98100
- When you intend for the action to spin up a local docker instance there is
99-
no need to supply this argument
101+
no need to supply this argument. The action will run totally self-contained
100102

101103
- When using the remote teamengine instance located at `https://my-server`
102104
with a pre-existing user `myself` and a password of `something`:

‎docs/running-as-standalone-cli.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,8 @@ cite runner execute-test-suite [OPTIONS] TEAMENGINE_BASE_URL TEST_SUITE_IDENTIFI
106106
##### Arguments
107107

108108
- `TEAMENGINE_BASE_URL` - Base URL of the teamengine service. Example: `http://localhost:8080/teamengine`
109-
- `TEST_SUITE_IDENTIFIER` - Identifier of the test suite as known to teamengine. Example: `ogcapi-features-1.0`
109+
- `TEST_SUITE_IDENTIFIER` - Identifier of the test suite as known to teamengine. Look up known identifiers in the
110+
[section on OGC test suites](ogc-test-suites.md). Example: `ogcapi-features-1.0`
110111

111112

112113
##### Options
@@ -147,7 +148,7 @@ cite runner execute-test-suite [OPTIONS] TEAMENGINE_BASE_URL TEST_SUITE_IDENTIFI
147148
```shell
148149
cite-runner execute-test-suite \
149150
http://localhost:8080/teamengine \
150-
ogcapi-processes-1.0 \
151+
ogcapi-features-1.0 \
151152
--test-suite-input iut https://demo.pygeoapi.io/stable \
152153
--test-suite-input noofcollections -1 \
153154
--include-passed-detail \
@@ -164,6 +165,7 @@ cite runner execute-test-suite [OPTIONS] TEAMENGINE_BASE_URL TEST_SUITE_IDENTIFI
164165
--test-suite-input iut http://localhost:5000 \
165166
--test-suite-input noofcollections -1 \
166167
--include-passed-detail \
168+
--output-format json
167169
| jq '.passed'
168170
```
169171

0 commit comments

Comments
 (0)