Merge pull request #92 from stac-utils/pv/validate-response-matches-aoi

add aoi result validation

Author: philvarner

CHANGELOG.md

@@ -11,6 +11,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Validation that using the `ids` parameter does not override all other parameters, as was the behavior
   prior to v1.0.0-beta.1.
+- Add validation that the footprint of each Item returned from Item Search intersects the AOI provided
+  through the intersect parameter
+- Add validation that Collection has items link relation
 
 ### Changed
 

README.md

@@ -94,18 +94,31 @@ Options:
   --root-url TEXT                 STAC API Root / Landing Page URL  [required]
   --post / --no-post              Test all validations with POST method for
                                   requests in addition to GET
+  --collection TEXT               The name of the collection to use for some
+                                  tests.
+  --geometry TEXT                 The geometry to use for intersection tests.
   --conformance [core|browseable|item-search|features|collections|children]
                                   Conformance class URIs to validate
                                   [required]
   --help                          Show this message and exit.
 ```
 
+Conformance classes item-search, features, and collections require the `--collection` parameter with the id of a
+collection to run some tests on.
+
+Conformance class `item-search` requires `--geometry` with a GeoJSON geometry that returns some items for
+the specified collection.
+
 Example:
 
 ```
 stac-api-validator \
-    --root-url https://cmr.earthdata.nasa.gov/stac/LARC_ASDC \
-    --conformance core --conformance item-search --conformance features
+    --root-url https://planetarycomputer.microsoft.com/api/stac/v1/ \
+    --conformance core \
+    --conformance item-search \
+    --conformance features \
+    --collection sentinel-2-l2a \
+    --geometry '{"type": "Polygon", "coordinates": [[[100.0, 0.0], [101.0, 0.0], [101.0, 1.0], [100.0, 1.0], [100.0, 0.0]]]}'
 ```
 
 Example output:

poetry.lock

@@ -23,6 +23,7 @@ requests = "^2.28.1"
 pystac = {extras = ["orjson"], version = "^1.6.1"}
 jsonschema = "^4.16.0"
 PyYAML = "6.0"
+Shapely = "1.8.4"
 
 [tool.poetry.dev-dependencies]
 Pygments = ">=2.10.0"
@@ -77,6 +78,11 @@ pretty = true
 show_column_numbers = true
 show_error_codes = true
 show_error_context = true
+#ignore_missing_imports = true
+
+[[tool.mypy.overrides]]
+module = ["shapely.geometry"]
+ignore_missing_imports = true
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]

pyproject.toml

@@ -3,6 +3,7 @@
 import sys
 import traceback
 from typing import List
+from typing import Optional
 
 import click
 
@@ -28,9 +29,12 @@
 )
 @click.option(
     "--collection",
-    required=True,
     help="The name of the collection to use for some tests.",
 )
+@click.option(
+    "--geometry",
+    help="The geometry to use for intersection tests.",
+)
 @click.option(
     "--conformance",
     "conformance_classes",
@@ -54,7 +58,8 @@ def main(
     root_url: str,
     post: bool,
     conformance_classes: List[str],
-    collection: str,
+    collection: Optional[str],
+    geometry: Optional[str],
 ) -> int:
     """STAC API Validator."""
 
@@ -64,7 +69,11 @@ def main(
 
     try:
         (warnings, errors) = validate_api(
-            root_url, post, conformance_classes, collection
+            root_url=root_url,
+            post=post,
+            conformance_classes=conformance_classes,
+            collection=collection,
+            geometry=geometry,
         )
     except Exception as e:
         print(f"Failed.\nError {root_url}: {type(e)} {str(e)}")