Allow to provide HTTP headers, Configure whether to open URLs when validating assets

Author: vprivat-ads

CHANGELOG.md

@@ -6,6 +6,11 @@ The format is (loosely) based on [Keep a Changelog](http://keepachangelog.com/)
 
 ## Unreleased
 
+### Added
+
+- Allow to provide HTTP headers ([#114](https://github.com/stac-utils/stac-check/pull/114))
+- Configure whether to open URLs when validating assets ([#114](https://github.com/stac-utils/stac-check/pull/114))
+
 ### Changed
 
 - No longer use the deprecated pkg-resources package.

README.md

@@ -28,6 +28,10 @@ Options:
                            argument to get full recursion. Ignored if
                            `recursive == False`.
   -r, --recursive          Recursively validate all related stac objects.
+  --no-assets-urls         Disables the opening of href links when validating assets
+                           (enabled by default).
+  --header KEY VALUE       HTTP header to include in the requests. Can be used
+                           multiple times.
   --help                   Show this message and exit.               Show this message and exit.
 ```
 ---
@@ -62,7 +66,7 @@ stac-check: STAC spec validation and linting tool
 
 Please upgrade from version 0.9.0 to version 1.0.0!
 
-Validator: stac-validator 3.1.0
+Validator: stac-validator 3.5.0
 
 
 Recursive: Validate all assets in a collection or catalog
@@ -102,7 +106,7 @@ Error Message: Expecting value: line 1 column 1 (char 0)
 
 Please upgrade from version 0.9.0 to version 1.0.0!
 
-Validator: stac-validator 2.3.0
+Validator: stac-validator 3.5.0
 
 Valid ITEM: True
 
@@ -130,7 +134,7 @@ This object has 4 links
 
 Thanks for using STAC version 1.0.0!
 
-Validator: stac-validator 2.3.0
+Validator: stac-validator 3.5.0
 
 Valid ITEM: True
 
@@ -165,7 +169,7 @@ This object has 4 links
 
 Thanks for using STAC version 1.0.0!
 
-Validator: stac-validator 2.3.0
+Validator: stac-validator 3.5.0
 
 Valid ITEM: True
 
@@ -207,7 +211,7 @@ This object has 4 links
 
 Please upgrade from version 0.9.0 to version 1.0.0!
 
-Validator: stac-validator 2.3.0
+Validator: stac-validator 3.5.0
 
 Valid : False
 
@@ -224,6 +228,31 @@ Validation error message:
 
 This object has 5 links
 </pre>
+
+``` stac-check https://stac-catalog.eu/collections/sentinel-s2-l2a/items/item1 --assets --no-assets-urls --header x-api-key $MY_API_KEY --header foo bar```
+<pre>
+<b>stac-check: STAC spec validation and linting tool</b>
+
+Thanks for using STAC version 1.0.0!
+
+Validator: stac-validator 3.5.0
+
+Valid ITEM: True
+
+Schemas validated: 
+    https://stac-extensions.github.io/timestamps/v1.1.0/schema.json
+    https://schemas.stacspec.org/v1.0.0/item-spec/json-schema/item.json
+
+STAC Best Practices: 
+    A STAC collection should contain a summaries field
+    It is recommended to store information like eo:bands in summaries
+
+
+No ASSET format errors!
+
+No ASSET request errors!
+This object has 4 links
+</pre>
 ---
 ### Create local docs in the /docs folder
 `$ pdoc --html --output-dir pdoc stac_check --force`

stac_check/cli.py

@@ -178,12 +178,29 @@ def cli_message(linter: Linter) -> None:
 @click.option(
     "-l", "--links", is_flag=True, help="Validate links for format and response."
 )
+@click.option(
+    "--no-assets-urls",
+    is_flag=True,
+    help="Disables the opening of href links when validating assets (enabled by default).",
+)
+@click.option(
+    "--header",
+    type=(str, str),
+    multiple=True,
+    help="HTTP header to include in the requests. Can be used multiple times.",
+)
 @click.command()
 @click.argument("file")
 @click.version_option(version=importlib.metadata.distribution("stac-check").version)
-def main(file, recursive, max_depth, assets, links):
+def main(file, recursive, max_depth, assets, links, no_assets_urls, header):
     linter = Linter(
-        file, assets=assets, links=links, recursive=recursive, max_depth=max_depth
+        file,
+        assets=assets,
+        links=links,
+        recursive=recursive,
+        max_depth=max_depth,
+        assets_open_urls=not no_assets_urls,
+        headers=dict(header),
     )
     intro_message(linter)
     if recursive > 0:

stac_check/lint.py

@@ -2,7 +2,7 @@
 import importlib.resources
 import json
 import os
-from dataclasses import dataclass
+from dataclasses import dataclass, field
 from typing import Any, Dict, List, Optional, Union
 
 import requests
@@ -25,6 +25,8 @@ class Linter:
         links (bool, optional): A boolean value indicating whether to validate links. Defaults to False.
         recursive (bool, optional): A boolean value indicating whether to perform recursive validation. Defaults to False.
         max_depth (Optional[int], optional): An optional integer indicating the maximum depth to validate recursively. Defaults to None.
+        assets_open_urls (bool): Whether to open assets URLs when validating assets. Defaults to True.
+        headers (dict): HTTP headers to include in the requests.
 
     Attributes:
         data (dict): A dictionary representing the STAC JSON file.
@@ -126,6 +128,8 @@ def check_summaries(self) -> bool:
     links: bool = False
     recursive: bool = False
     max_depth: Optional[int] = None
+    assets_open_urls: bool = True
+    headers: dict = field(default_factory=dict)
 
     def __post_init__(self):
         self.data = self.load_data(self.item)
@@ -236,7 +240,7 @@ def load_data(self, file: Union[str, Dict]) -> Dict:
 
         if isinstance(file, str):
             if is_valid_url(file):
-                resp = requests.get(file)
+                resp = requests.get(file, headers=self.headers)
                 data = resp.json()
             else:
                 with open(file) as json_file:
@@ -260,10 +264,18 @@ def validate_file(self, file: Union[str, dict]) -> Dict[str, Any]:
             ValueError: If `file` is not a valid file path or STAC dictionary.
         """
         if isinstance(file, str):
-            stac = StacValidate(file, links=self.links, assets=self.assets)
+            stac = StacValidate(
+                file,
+                links=self.links,
+                assets=self.assets,
+                assets_open_urls=self.assets_open_urls,
+                headers=self.headers,
+            )
             stac.run()
         elif isinstance(file, dict):
-            stac = StacValidate()
+            stac = StacValidate(
+                assets_open_urls=self.assets_open_urls, headers=self.headers
+            )
             stac.validate_dict(file)
         else:
             raise ValueError("Input must be a file path or STAC dictionary.")
@@ -284,10 +296,21 @@ def recursive_validation(self, file: Union[str, Dict[str, Any]]) -> str:
         """
         if self.recursive:
             if isinstance(file, str):
-                stac = StacValidate(file, recursive=True, max_depth=self.max_depth)
+                stac = StacValidate(
+                    file,
+                    recursive=True,
+                    max_depth=self.max_depth,
+                    assets_open_urls=self.assets_open_urls,
+                    headers=self.headers,
+                )
                 stac.run()
             else:
-                stac = StacValidate(recursive=True, max_depth=self.max_depth)
+                stac = StacValidate(
+                    recursive=True,
+                    max_depth=self.max_depth,
+                    assets_open_urls=self.assets_open_urls,
+                    headers=self.headers,
+                )
                 stac.validate_dict(file)
             return stac.message
         else: