juice-json-schemas 0.0.1__py3-none-any.whl

juice_json_schemas/cli.py

@@ -0,0 +1,59 @@
+import argparse
+import logging
+import sys
+
+from juice_json_schemas.validation import ValidationError, validate_json
+
+logging.basicConfig(level=logging.INFO)
+logger = logging.getLogger(__name__)
+
+
+def parse(instance_file, schema_file_or_url):
+    try:
+        validate_json(instance_file, schema_file_or_url)
+    except ValidationError as e:
+        logger.exception(e.get_message())
+        sys.exit(1)
+
+    errors = validate_json(instance_file, schema_file_or_url)
+
+    if not errors:
+        logger.info("✅ JSON is valid according to the schema.")
+    else:
+        logger.error("❌ Found %d validation error(s):\n", len(errors))
+        for i, error in enumerate(errors, 1):
+            path = "/".join(map(str, error.path)) or "(root)"
+            logger.info("  %d. Path: %s", i, path)
+            logger.info("     Message: %s\n", error.message)
+        sys.exit(1)
+
+
+def main():
+    argparser = argparse.ArgumentParser()
+    argparser.description = "Validate a JSON file against a generic schema."
+    argparser.add_argument("json_file", help="Path to the JSON file to be validated")
+    argparser.add_argument("schema_file_or_url", help="Path to the schema file or URL")
+    args = argparser.parse_args()
+    parse(args.json_file, args.schema_file_or_url)
+
+
+def apl():
+    argparser = argparse.ArgumentParser()
+    argparser.description = "Validate a JSON file against the JUICE APL schema."
+    argparser.add_argument("json_file", help="Path to the APL file to be validated")
+    args = argparser.parse_args()
+    parse(
+        args.json_file,
+        "https://juicesoc.esac.esa.int/data/schemas/jsoc-apl-schema.json",
+    )
+
+
+def opl():
+    argparser = argparse.ArgumentParser()
+    argparser.description = "Validate a OPL file against the JUICE OPL schema."
+    argparser.add_argument("json_file", help="Path to the OPL file to be validated")
+    args = argparser.parse_args()
+    parse(
+        args.json_file,
+        "https://juicesoc.esac.esa.int/data/schemas/jsoc-opl-schema.json",
+    )

juice_json_schemas/validation.py

@@ -0,0 +1,72 @@
+import json
+from pathlib import Path
+from urllib.parse import urlparse
+from urllib.request import urlopen
+
+from jsonschema import Draft202012Validator
+from jsonschema.exceptions import SchemaError
+from referencing import Registry, Resource
+from referencing.exceptions import CannotDetermineSpecification
+
+
+class ValidationError(Exception):
+    def get_message(self):
+        return self.__str__()
+
+
+class JsonFileError(ValidationError):
+    def __init__(self, file_path):
+        super().__init__(f"JSON file error: {file_path}")
+
+
+class RemoteJsonFileError(ValidationError):
+    def __init__(self, url):
+        super().__init__(f"Remote JSON file error: {url}")
+
+
+class InvalidJsonError(ValidationError):
+    def __init__(self, path):
+        super().__init__(f"Invalid JSON: {path}")
+
+
+class InvalidSchemaError(ValidationError):
+    def __init__(self, path):
+        super().__init__(f"Invalid schema: {path}")
+
+
+def load_json_from_path_or_url(path_or_url):
+    """Load JSON either from a local file or from a URL."""
+    parsed = urlparse(path_or_url)
+
+    if parsed.scheme in ("http", "https"):
+        try:
+            with urlopen(path_or_url) as response:  # noqa: S310
+                return json.load(response)
+        except Exception as e:
+            raise RemoteJsonFileError(path_or_url) from e
+    try:
+        path = Path(path_or_url)
+        with path.open(encoding="utf-8") as f:
+            return json.load(f)
+    except FileNotFoundError as e:
+        raise JsonFileError(path_or_url) from e
+    except json.JSONDecodeError as e:
+        raise InvalidJsonError(path_or_url) from e
+
+
+def validate_json(instance_path, schema_path):
+    """Validate JSON instance against schema (local or remote), reporting all errors."""
+    instance = load_json_from_path_or_url(instance_path)
+    schema = load_json_from_path_or_url(schema_path)
+
+    try:
+        # Build a registry that knows where to find the root schema
+        registry = Registry().with_resource(schema_path, Resource.from_contents(schema))
+        validator = Draft202012Validator(schema, registry=registry)
+    except SchemaError as e:
+        raise InvalidSchemaError(schema_path) from e
+    except CannotDetermineSpecification as e:
+        raise InvalidSchemaError(schema_path) from e
+
+    # Return all errors sorted by their path
+    return sorted(validator.iter_errors(instance), key=lambda e: e.path)

juice_json_schemas-0.0.1.dist-info/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 JUICE SOC Team <juice_uplink@cosmos.esa.int>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

juice_json_schemas-0.0.1.dist-info/METADATA

@@ -0,0 +1,106 @@
+Metadata-Version: 2.1
+Name: juice-json-schemas
+Version: 0.0.1
+Summary: A short description of the project
+Home-page: https://.github.io/juice-json-schemas
+License: MIT
+Author: JUICE SOC Team
+Author-email: juice_uplink@cosmos.esa.int
+Requires-Python: >=3.9,<4.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Dist: jsonschema (>=4.25.1,<5.0.0)
+Project-URL: Documentation, https://.github.io/juice-json-schemas
+Project-URL: Repository, https://github.com//juice-json-schemas
+Description-Content-Type: text/markdown
+
+# juice-json-schemas
+
+[![PyPI](https://img.shields.io/pypi/v/juice-json-schemas?style=flat-square)](https://pypi.python.org/pypi/juice-json-schemas/)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/juice-json-schemas?style=flat-square)](https://pypi.python.org/pypi/juice-json-schemas/)
+[![PyPI - License](https://img.shields.io/pypi/l/juice-json-schemas?style=flat-square)](https://pypi.python.org/pypi/juice-json-schemas/)
+
+
+---
+
+**Documentation**: [https://juice-soc.io.esa.int/juice-uplink/spm/juice-json-schemas/](https://juice-soc.io.esa.int/juice-uplink/spm/juice-json-schemas/)
+
+**Source Code**: [https://gitlab.esa.int/juice-soc/juice-uplink/spm/juice-json-schemas.git](https://gitlab.esa.int/juice-soc/juice-uplink/spm/juice-json-schemas.git)
+
+**PyPI**: [https://pypi.org/project/juice-json-schemas/](https://pypi.org/project/juice-json-schemas/)
+
+---
+
+Library and utilities for validating JSON files against [JUICE mission](https://www.cosmos.esa.int/web/juice) data schemas or custom JSON Schemas.
+
+## Installation
+
+```sh
+pip install juice-json-schemas
+```
+
+## Development
+
+* Clone this repository
+* Requirements:
+  * [Poetry](https://python-poetry.org/)
+  * Python 3.9+
+* Create a virtual environment and install the dependencies
+
+```sh
+poetry install
+```
+
+* Activate the virtual environment
+
+```sh
+poetry shell
+```
+
+### Testing
+
+```sh
+pytest
+```
+
+### Documentation
+
+The documentation is automatically generated from the content of the [docs directory](https://github.com//juice-json-schemas/tree/master/docs) and from the docstrings
+ of the public signatures of the source code. The documentation is updated and published as a [Gitlab Pages page](https://pages.github.com/) automatically as part each release.
+
+### Pre-commit
+
+Pre-commit hooks run all the auto-formatting (`ruff format`), linters (e.g. `ruff`), and other quality
+ checks to make sure the changeset is in good shape before a commit/push happens.
+
+You can install the hooks with (runs for each commit):
+
+```sh
+pre-commit install
+```
+
+Or if you want them to run only for each push:
+
+```sh
+pre-commit install -t pre-push
+```
+
+Or if you want e.g. want to run all checks manually for all files:
+
+```sh
+pre-commit run --all-files
+```
+
+---
+

juice_json_schemas-0.0.1.dist-info/RECORD

@@ -0,0 +1,9 @@
+juice_json_schemas/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+juice_json_schemas/cli.py,sha256=HwETpZXVS3IMC44W-eX7Pno_YknEvy5NYu0NFjfRikw,2008
+juice_json_schemas/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+juice_json_schemas/validation.py,sha256=iEbg2Nx9xKOKkuqjAmY4_CZ8MNuxOL4u7qnWGJHNotU,2386
+juice_json_schemas-0.0.1.dist-info/LICENSE,sha256=xsT1xf3P0LmVw_7Z1CnJdLEJeT93puD72bAAddNkWXw,1111
+juice_json_schemas-0.0.1.dist-info/METADATA,sha256=3cSqml-qSvd9koLoWfGrtyJkCBGXw6aO7zS-8tAEYeU,3337
+juice_json_schemas-0.0.1.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+juice_json_schemas-0.0.1.dist-info/entry_points.txt,sha256=pQn6KZIdIH2cG_mNOO-DM3wA0-qAf3JbtuWIexPta7M,132
+juice_json_schemas-0.0.1.dist-info/RECORD,,

juice_json_schemas-0.0.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 1.9.0
+Root-Is-Purelib: true
+Tag: py3-none-any

juice_json_schemas-0.0.1.dist-info/entry_points.txt

@@ -0,0 +1,5 @@
+[console_scripts]
+apl-check=juice_json_schemas.cli:apl
+json-check=juice_json_schemas.cli:main
+opl-check=juice_json_schemas.cli:opl
+