1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239
|
import json
import sys
from typing import Any, Dict, List, Optional, Tuple
import click # type: ignore
from .validate import StacValidate
def print_update_message(version: str) -> None:
"""Prints an update message for `stac-validator` based on the version of the
STAC file being validated.
Args:
version (str): The version of the STAC file being validated.
Returns:
None
"""
click.secho()
if version != "1.1.0":
click.secho(
f"Please upgrade from version {version} to version 1.1.0!", fg="red"
)
else:
click.secho("Thanks for using STAC version 1.1.0!", fg="green")
click.secho()
def item_collection_summary(message: List[Dict[str, Any]]) -> None:
"""Prints a summary of the validation results for an item collection response.
Args:
message (List[Dict[str, Any]]): The validation results for the item collection.
Returns:
None
"""
valid_count = 0
for item in message:
if "valid_stac" in item and item["valid_stac"] is True:
valid_count = valid_count + 1
click.secho()
click.secho("--item-collection summary", bold=True)
click.secho(f"items_validated: {len(message)}")
click.secho(f"valid_items: {valid_count}")
def collections_summary(message: List[Dict[str, Any]]) -> None:
"""Prints a summary of the validation results for an item collection response.
Args:
message (List[Dict[str, Any]]): The validation results for the item collection.
Returns:
None
"""
valid_count = 0
for collection in message:
if "valid_stac" in collection and collection["valid_stac"] is True:
valid_count = valid_count + 1
click.secho()
click.secho("--collections summary", bold=True)
click.secho(f"collections_validated: {len(message)}")
click.secho(f"valid_collections: {valid_count}")
@click.command()
@click.argument("stac_file")
@click.option(
"--core", is_flag=True, help="Validate core stac object only without extensions."
)
@click.option("--extensions", is_flag=True, help="Validate extensions only.")
@click.option(
"--links",
is_flag=True,
help="Additionally validate links. Only works with default mode.",
)
@click.option(
"--assets",
is_flag=True,
help="Additionally validate assets. Only works with default mode.",
)
@click.option(
"--custom",
"-c",
default="",
help="Validate against a custom schema (local filepath or remote schema).",
)
@click.option(
"--schema-map",
"-s",
type=(str, str),
multiple=True,
help="Schema path to replaced by (local) schema path during validation. Can be used multiple times.",
)
@click.option(
"--recursive",
"-r",
is_flag=True,
help="Recursively validate all related stac objects.",
)
@click.option(
"--max-depth",
"-m",
type=int,
help="Maximum depth to traverse when recursing. Omit this argument to get full recursion. Ignored if `recursive == False`.",
)
@click.option(
"--collections",
is_flag=True,
help="Validate /collections response.",
)
@click.option(
"--item-collection",
is_flag=True,
help="Validate item collection response. Can be combined with --pages. Defaults to one page.",
)
@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.option(
"--pages",
"-p",
type=int,
help="Maximum number of pages to validate via --item-collection. Defaults to one page.",
)
@click.option(
"-v", "--verbose", is_flag=True, help="Enables verbose output for recursive mode."
)
@click.option("--no_output", is_flag=True, help="Do not print output to console.")
@click.option(
"--log_file",
default="",
help="Save full recursive output to log file (local filepath).",
)
def main(
stac_file: str,
collections: bool,
item_collection: bool,
no_assets_urls: bool,
header: list,
pages: int,
recursive: bool,
max_depth: int,
core: bool,
extensions: bool,
links: bool,
assets: bool,
custom: str,
schema_map: List[Tuple],
verbose: bool,
no_output: bool,
log_file: str,
) -> None:
"""Main function for the `stac-validator` command line tool. Validates a STAC file
against the STAC specification and prints the validation results to the console as JSON.
Args:
stac_file (str): Path to the STAC file to be validated.
collections (bool): Validate response from /collections endpoint.
item_collection (bool): Whether to validate item collection responses.
no_assets_urls (bool): Whether to open href links when validating assets (enabled by default).
headers (dict): HTTP headers to include in the requests.
pages (int): Maximum number of pages to validate via `item_collection`.
recursive (bool): Whether to recursively validate all related STAC objects.
max_depth (int): Maximum depth to traverse when recursing.
core (bool): Whether to validate core STAC objects only.
extensions (bool): Whether to validate extensions only.
links (bool): Whether to additionally validate links. Only works with default mode.
assets (bool): Whether to additionally validate assets. Only works with default mode.
custom (str): Path to a custom schema file to validate against.
schema_map (list(tuple)): List of tuples each having two elememts. First element is the schema path to be replaced by the path in the second element.
verbose (bool): Whether to enable verbose output for recursive mode.
no_output (bool): Whether to print output to console.
log_file (str): Path to a log file to save full recursive output.
Returns:
None
Raises:
SystemExit: Exits the program with a status code of 0 if the STAC file is valid,
or 1 if it is invalid.
"""
valid = True
if schema_map == ():
schema_map_dict: Optional[Dict[str, str]] = None
else:
schema_map_dict = dict(schema_map)
stac = StacValidate(
stac_file=stac_file,
collections=collections,
item_collection=item_collection,
pages=pages,
recursive=recursive,
max_depth=max_depth,
core=core,
links=links,
assets=assets,
assets_open_urls=not no_assets_urls,
headers=dict(header),
extensions=extensions,
custom=custom,
schema_map=schema_map_dict,
verbose=verbose,
log=log_file,
)
if not item_collection and not collections:
valid = stac.run()
elif collections:
stac.validate_collections()
else:
stac.validate_item_collection()
message = stac.message
if "version" in message[0]:
print_update_message(message[0]["version"])
if no_output is False:
click.echo(json.dumps(message, indent=4))
if item_collection:
item_collection_summary(message)
elif collections:
collections_summary(message)
sys.exit(0 if valid else 1)
if __name__ == "__main__":
main()
|