assertions-mate 0.1.0__tar.gz → 0.2.0__tar.gz

{assertions_mate-0.1.0 → assertions_mate-0.2.0}/.github/workflows/docs.yaml

@@ -33,11 +33,11 @@ jobs:
       - name: Checkout master
         uses: actions/checkout@v4
 
-      - name: Set up Python 3.x
+      - name: Set up Python 3.12
         uses: actions/setup-python@v5
         with:
-          python-version: 3.x
-      - run: pip install mkdocs-material mkdocs-mermaid2-plugin mkdocs-jupyter legacy-cgi pdocs
-      - run: pip install .
-      - run: pdocs as_markdown --output_dir ./docs/api/latest --exclude_source --overwrite assertions_mate
+          python-version: 3.12
+      - run: pip install "mkdocs<=2.0.0" mkdocs-material mkdocs-mermaid2-plugin mkdocs-jupyter legacy-cgi pdocs mkdocs-build-plantuml-plugin
+      #- run: pip install .
+      #- run: pdocs as_markdown --output_dir ./docs/api/latest --exclude_source --overwrite assertions_mate
       - run: mkdocs gh-deploy --force

assertions_mate-0.2.0/.github/workflows/package.yaml

@@ -0,0 +1,97 @@
+# Copyright 2026 Terradue
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+name: package
+
+on:
+  push:
+    branches:
+    - feature
+    - feature/**
+    - develop
+    - main
+    tags:
+    - v*.*.*
+  pull_request:
+    branches:
+    - feature
+    - feature/**
+    - develop
+    - main
+
+permissions:
+  contents: read
+
+jobs:
+  ci:
+    if: github.event_name == 'pull_request' || startsWith(github.ref, 'refs/heads/')
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.12'
+        cache: pip
+
+    - name: Install tooling
+      run: pip install hatch ruff
+
+    - name: Ruff Check
+      run: ruff check .
+
+    - name: Ruff Lint
+      run: ruff format --check .
+
+    - name: Run tests
+      run: hatch run test:test-q
+
+  publish:
+    if: startsWith(github.ref, 'refs/tags/v')
+    runs-on: ubuntu-latest
+    environment: release
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.12'
+        cache: pip
+
+    - name: Install Hatch
+      run: pip install hatch
+
+    - name: Verify tag matches project version
+      run: |
+        TAG_VERSION="${GITHUB_REF_NAME#v}"
+        PROJECT_VERSION="$(hatch version)"
+
+        echo "Tag version: ${TAG_VERSION}"
+        echo "Project version: ${PROJECT_VERSION}"
+
+        if [ "${TAG_VERSION}" != "${PROJECT_VERSION}" ]; then
+          echo "Tag ${GITHUB_REF_NAME} does not match project version ${PROJECT_VERSION}"
+          exit 1
+        fi
+
+    - name: Build package
+      run: hatch build
+
+    - name: Publish package distributions to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1

assertions_mate-0.2.0/PKG-INFO

@@ -0,0 +1,147 @@
+Metadata-Version: 2.4
+Name: assertions-mate
+Version: 0.2.0
+Project-URL: Documentation, https://github.com/Terradue/assertions-mate#README.md
+Project-URL: Issues, https://github.com/Terradue/assertions-mate/issues
+Project-URL: Source, https://github.com/Terradue/assertions-mate
+Author-email: Terradue srl <info@terradue.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.10
+Requires-Dist: click
+Requires-Dist: cwl-utils
+Requires-Dist: cwl2ogc>=0.10.0
+Requires-Dist: jsonschema
+Requires-Dist: loguru
+Requires-Dist: pydantic
+Requires-Dist: pygeofilter
+Requires-Dist: pygeofilter[backend-native]
+Requires-Dist: pystac-client
+Requires-Dist: regopy==0.4.6
+Requires-Dist: shapely
+Description-Content-Type: text/markdown
+
+# Assertions Mate
+
+`assertions-mate` validates CWL workflow inputs against assertion hints embedded in the workflow definition.
+
+It adds policy and rule checks on top of CWL typing by supporting:
+- JSON Schema validation
+- Rego policy validation (OPA)
+- CQL2 expression validation
+
+Documentation site: https://terradue.github.io/assertions-mate/
+
+## Why Use It
+
+When a CWL workflow needs stricter runtime checks (business rules, policy constraints, geospatial conditions), `assertions-mate` lets you define them as workflow hints and evaluate them against an input payload before execution.
+
+## Installation
+
+### From source (recommended for development)
+
+```bash
+git clone https://github.com/Terradue/assertions-mate.git
+cd assertions-mate
+pip install -e .
+```
+
+### Runtime requirements
+
+- Python `>= 3.10`
+- Dependencies are managed in `pyproject.toml`
+
+## Command Line Usage
+
+After installation, run:
+
+```bash
+assertions-mate path/to/workflow.cwl --inputs path/to/inputs.yaml
+```
+
+What happens:
+1. The CWL document is loaded.
+2. Assertion hints are discovered from `workflow.hints`.
+3. Matching validators are built and executed against the input mapping.
+4. Validation issues are reported with pointer and detail messages.
+
+## Supported Assertion Hints
+
+The tool maps `eoap:` hint classes to internal validators:
+
+- `eoap:JSONSchemaHint`
+- `eoap:RegoPolicyHint`
+- `eoap:Cql2FilterHint`
+
+### Example `hints` snippet
+
+```yaml
+hints:
+  - class: eoap:JSONSchemaHint
+    json_schema:
+      type: object
+      required: [count]
+      properties:
+        count:
+          type: integer
+          minimum: 1
+
+  - class: eoap:RegoPolicyHint
+    module: |
+      package workflow
+      deny contains "count must be <= 10" if {
+        input.count > 10
+      }
+    queries:
+      - data.workflow.deny[_]
+
+  - class: eoap:Cql2FilterHint
+    queries:
+      - id: cql-rule-1
+        cql2: "count > 0"
+        message: "count must be greater than zero"
+```
+
+## Development
+
+This project uses Hatch environments and pytest.
+
+```bash
+# Run tests
+hatch run test:test-q
+
+# Run formatting check
+hatch run dev:lint
+
+# Run lint checks with fixes
+hatch run dev:check
+```
+
+If you use Taskfile:
+
+```bash
+task test
+task lint
+task check
+```
+
+## Project Layout
+
+- `src/assertions_mate/` core package and CLI
+- `tests/` unit tests
+- `schemas/` CWL hint schema definitions
+- `docs/` notebooks and documentation sources
+
+## License
+
+Apache License 2.0. See `LICENSE`.

assertions_mate-0.2.0/README.md

@@ -0,0 +1,114 @@
+# Assertions Mate
+
+`assertions-mate` validates CWL workflow inputs against assertion hints embedded in the workflow definition.
+
+It adds policy and rule checks on top of CWL typing by supporting:
+- JSON Schema validation
+- Rego policy validation (OPA)
+- CQL2 expression validation
+
+Documentation site: https://terradue.github.io/assertions-mate/
+
+## Why Use It
+
+When a CWL workflow needs stricter runtime checks (business rules, policy constraints, geospatial conditions), `assertions-mate` lets you define them as workflow hints and evaluate them against an input payload before execution.
+
+## Installation
+
+### From source (recommended for development)
+
+```bash
+git clone https://github.com/Terradue/assertions-mate.git
+cd assertions-mate
+pip install -e .
+```
+
+### Runtime requirements
+
+- Python `>= 3.10`
+- Dependencies are managed in `pyproject.toml`
+
+## Command Line Usage
+
+After installation, run:
+
+```bash
+assertions-mate path/to/workflow.cwl --inputs path/to/inputs.yaml
+```
+
+What happens:
+1. The CWL document is loaded.
+2. Assertion hints are discovered from `workflow.hints`.
+3. Matching validators are built and executed against the input mapping.
+4. Validation issues are reported with pointer and detail messages.
+
+## Supported Assertion Hints
+
+The tool maps `eoap:` hint classes to internal validators:
+
+- `eoap:JSONSchemaHint`
+- `eoap:RegoPolicyHint`
+- `eoap:Cql2FilterHint`
+
+### Example `hints` snippet
+
+```yaml
+hints:
+  - class: eoap:JSONSchemaHint
+    json_schema:
+      type: object
+      required: [count]
+      properties:
+        count:
+          type: integer
+          minimum: 1
+
+  - class: eoap:RegoPolicyHint
+    module: |
+      package workflow
+      deny contains "count must be <= 10" if {
+        input.count > 10
+      }
+    queries:
+      - data.workflow.deny[_]
+
+  - class: eoap:Cql2FilterHint
+    queries:
+      - id: cql-rule-1
+        cql2: "count > 0"
+        message: "count must be greater than zero"
+```
+
+## Development
+
+This project uses Hatch environments and pytest.
+
+```bash
+# Run tests
+hatch run test:test-q
+
+# Run formatting check
+hatch run dev:lint
+
+# Run lint checks with fixes
+hatch run dev:check
+```
+
+If you use Taskfile:
+
+```bash
+task test
+task lint
+task check
+```
+
+## Project Layout
+
+- `src/assertions_mate/` core package and CLI
+- `tests/` unit tests
+- `schemas/` CWL hint schema definitions
+- `docs/` notebooks and documentation sources
+
+## License
+
+Apache License 2.0. See `LICENSE`.

assertions_mate-0.2.0/Taskfile.yaml

@@ -0,0 +1,32 @@
+# Copyright 2026 Terradue
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+version: '3'
+
+tasks:
+
+  test:
+    desc: Run tests
+    cmds:
+    - hatch run test:test-show-setup
+
+  check:
+    desc: Run code quality checks
+    cmds:
+    - hatch run dev:check
+
+  lint:
+    desc: Run linters
+    cmds:
+    - hatch run dev:lint

assertions_mate-0.2.0/docs/index.md

@@ -0,0 +1,9 @@
+# Assertions Framework API
+
+This is small Python APIs set that enables different CWL inputs validation layers, such as:
+
+- [JSON Schema](https://json-schema.org/);
+- [OPA's policy language (Rego)](https://www.openpolicyagent.org/docs)
+- [Common Query Language (CQL2)](https://www.ogc.org/standards/cql2/).
+
+    This documentation is Work in Progress

{assertions_mate-0.1.0 → assertions_mate-0.2.0}/docs/jsonschema.ipynb

@@ -18,47 +18,22 @@
    "outputs": [],
    "source": [
     "schema = {\n",
-    "  \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n",
-    "  \"$id\": \"https://eoap.github.io/cwl2ogc/array-inputs/inputs.yaml\",\n",
-    "  \"description\": \"The schema to represent a array-inputs inputs definition\",\n",
-    "  \"type\": \"object\",\n",
-    "  \"required\": [\n",
-    "    \"filesA\",\n",
-    "    \"filesB\",\n",
-    "    \"filesC\"\n",
-    "  ],\n",
-    "  \"properties\": {\n",
-    "    \"filesA\": {\n",
-    "      \"$ref\": \"#/$defs/filesA\"\n",
+    "    \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n",
+    "    \"$id\": \"https://eoap.github.io/cwl2ogc/array-inputs/inputs.yaml\",\n",
+    "    \"description\": \"The schema to represent a array-inputs inputs definition\",\n",
+    "    \"type\": \"object\",\n",
+    "    \"required\": [\"filesA\", \"filesB\", \"filesC\"],\n",
+    "    \"properties\": {\n",
+    "        \"filesA\": {\"$ref\": \"#/$defs/filesA\"},\n",
+    "        \"filesB\": {\"$ref\": \"#/$defs/filesB\"},\n",
+    "        \"filesC\": {\"$ref\": \"#/$defs/filesC\"},\n",
     "    },\n",
-    "    \"filesB\": {\n",
-    "      \"$ref\": \"#/$defs/filesB\"\n",
+    "    \"additionalProperties\": False,\n",
+    "    \"$defs\": {\n",
+    "        \"filesA\": {\"type\": \"array\", \"items\": {\"type\": \"string\"}},\n",
+    "        \"filesB\": {\"type\": \"array\", \"items\": {\"type\": \"string\"}},\n",
+    "        \"filesC\": {\"type\": \"array\", \"items\": {\"type\": \"string\"}},\n",
     "    },\n",
-    "    \"filesC\": {\n",
-    "      \"$ref\": \"#/$defs/filesC\"\n",
-    "    }\n",
-    "  },\n",
-    "  \"additionalProperties\": False,\n",
-    "  \"$defs\": {\n",
-    "    \"filesA\": {\n",
-    "      \"type\": \"array\",\n",
-    "      \"items\": {\n",
-    "        \"type\": \"string\"\n",
-    "      }\n",
-    "    },\n",
-    "    \"filesB\": {\n",
-    "      \"type\": \"array\",\n",
-    "      \"items\": {\n",
-    "        \"type\": \"string\"\n",
-    "      }\n",
-    "    },\n",
-    "    \"filesC\": {\n",
-    "      \"type\": \"array\",\n",
-    "      \"items\": {\n",
-    "        \"type\": \"string\"\n",
-    "      }\n",
-    "    }\n",
-    "  }\n",
     "}"
    ]
   },
@@ -78,13 +53,9 @@
    "outputs": [],
    "source": [
     "from assertions_mate.jsonschema_validator import JSONSchemaValidator\n",
-    "from assertions_mate.error_models import (\n",
-    "    ErrorDetail,\n",
-    "    ServerError\n",
-    ")\n",
+    "from assertions_mate.error_models import ErrorDetail, ServerError\n",
     "from jsonschema.exceptions import SchemaError\n",
     "import json\n",
-    "import sys\n",
     "\n",
     "validator = None\n",
     "try:\n",
@@ -92,8 +63,7 @@
     "except SchemaError as schema_error:\n",
     "    print(\n",
     "        json.dumps(\n",
-    "            ServerError(errors=[ErrorDetail(detail=schema_error.message)]),\n",
-    "            indent=2\n",
+    "            ServerError(errors=[ErrorDetail(detail=schema_error.message)]), indent=2\n",
     "        )\n",
     "    )"
    ]
@@ -116,11 +86,11 @@
     "inputs = {\n",
     "    \"aoi\": \"-118.985,38.432,-118.183,38.938\",\n",
     "    \"filesB\": \"EPSG:4326\",\n",
-    "    \"bands\": [ \"green\", \"nir08\" ],\n",
+    "    \"bands\": [\"green\", \"nir08\"],\n",
     "    \"item\": {\n",
-    "        \"class\":\"https://raw.githubusercontent.com/eoap/schemas/main/url.yaml#URL\",\n",
-    "        \"value\":\"https://planetarycomputer.microsoft.com/api/stac/v1/collections/landsat-c2-l2/items/LC08_L2SP_042033_20231007_02_T1\"\n",
-    "    }\n",
+    "        \"class\": \"https://raw.githubusercontent.com/eoap/schemas/main/url.yaml#URL\",\n",
+    "        \"value\": \"https://planetarycomputer.microsoft.com/api/stac/v1/collections/landsat-c2-l2/items/LC08_L2SP_042033_20231007_02_T1\",\n",
+    "    },\n",
     "}"
    ]
   },

{assertions_mate-0.1.0 → assertions_mate-0.2.0}/docs/pygeofilter.ipynb

@@ -37,10 +37,10 @@
     "# 2) Search for two Sentinel-2 L2A items (Rome area, low clouds, example dates)\n",
     "search = client.search(\n",
     "    collections=[\"sentinel-2-l2a\"],\n",
-    "    bbox=[12.3, 41.7, 12.7, 42.0],          # Rome area\n",
-    "    datetime=\"2024-06-01/2024-06-30\",       # any window with data works\n",
+    "    bbox=[12.3, 41.7, 12.7, 42.0],  # Rome area\n",
+    "    datetime=\"2024-06-01/2024-06-30\",  # any window with data works\n",
     "    query={\"eo:cloud_cover\": {\"lt\": 30}},\n",
-    "    max_items=2\n",
+    "    max_items=2,\n",
     ")\n",
     "\n",
     "# 3) Get PySTAC Items (already parsed objects)\n",
@@ -49,14 +49,11 @@
     "print(f\"Fetched {len(items)} items\")\n",
     "\n",
     "request_body = {\n",
-    "    'inputs': {\n",
-    "      'item_1': items[0].to_dict(),\n",
-    "      'item_2': items[1].to_dict(),\n",
-    "      'aoi': {\n",
-    "        'crs': 'CRS84',\n",
-    "        'bbox': [12.3, 41.7, 12.7, 42.0]\n",
-    "      },\n",
-    "      'aoi2': '12.3, 41.7, 12.7, 42.0'\n",
+    "    \"inputs\": {\n",
+    "        \"item_1\": items[0].to_dict(),\n",
+    "        \"item_2\": items[1].to_dict(),\n",
+    "        \"aoi\": {\"crs\": \"CRS84\", \"bbox\": [12.3, 41.7, 12.7, 42.0]},\n",
+    "        \"aoi2\": \"12.3, 41.7, 12.7, 42.0\",\n",
     "    }\n",
     "}"
    ]
@@ -78,12 +75,7 @@
    "source": [
     "import json\n",
     "\n",
-    "print(\n",
-    "    json.dumps(\n",
-    "        request_body,\n",
-    "        indent=2\n",
-    "    )\n",
-    ")"
+    "print(json.dumps(request_body, indent=2))"
    ]
   },
   {
@@ -104,33 +96,30 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from assertions_mate import (\n",
-    "    Cql2FilterHint,\n",
-    "    Cql2Query\n",
-    ")\n",
+    "from assertions_mate import Cql2FilterHint, Cql2Query\n",
     "\n",
     "filter = Cql2FilterHint(\n",
     "    queries=[\n",
     "        Cql2Query(\n",
-    "            id='Items platforms are the same',\n",
-    "            cql2='inputs.item_1.properties.platform = inputs.item_2.properties.platform',\n",
-    "            message='It is expected that all items are part of the same platform'\n",
+    "            id=\"Items platforms are the same\",\n",
+    "            cql2=\"inputs.item_1.properties.platform = inputs.item_2.properties.platform\",\n",
+    "            message=\"It is expected that all items are part of the same platform\",\n",
     "        ),\n",
     "        Cql2Query(\n",
-    "            id='First item intersects AOI',\n",
-    "            cql2='s_intersects(inputs.item_1, ensure_bbox(inputs.aoi))',\n",
-    "            message='First item expected to intersect the AOI'\n",
+    "            id=\"First item intersects AOI\",\n",
+    "            cql2=\"s_intersects(inputs.item_1, ensure_bbox(inputs.aoi))\",\n",
+    "            message=\"First item expected to intersect the AOI\",\n",
     "        ),\n",
     "        Cql2Query(\n",
-    "            id='Second item intersects AOI',\n",
-    "            cql2='s_intersects(inputs.item_2, ensure_bbox(inputs.aoi2))',\n",
-    "            message='Second item expected to intersect the AOI'\n",
+    "            id=\"Second item intersects AOI\",\n",
+    "            cql2=\"s_intersects(inputs.item_2, ensure_bbox(inputs.aoi2))\",\n",
+    "            message=\"Second item expected to intersect the AOI\",\n",
     "        ),\n",
     "        Cql2Query(\n",
-    "            id='Items intersects each other',\n",
-    "            cql2='s_intersects(inputs.item_1, ensure_spatial(inputs.item_2))',\n",
-    "            message='Items do not intesect each other'\n",
-    "        )\n",
+    "            id=\"Items intersects each other\",\n",
+    "            cql2=\"s_intersects(inputs.item_1, ensure_spatial(inputs.item_2))\",\n",
+    "            message=\"Items do not intesect each other\",\n",
+    "        ),\n",
     "    ]\n",
     ")"
    ]

{assertions_mate-0.1.0 → assertions_mate-0.2.0}/docs/regopy.ipynb

@@ -17,7 +17,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "module = '''\n",
+    "module = \"\"\"\n",
     "package workflow\n",
     "\n",
     "# --- BBOX sanity checks ---\n",
@@ -55,7 +55,7 @@
     "# helper predicate for the allowed second band (disjunction via multiple rules)\n",
     "allowed_nir(x) { x == \"nir\" }\n",
     "allowed_nir(x) { x == \"nir08\" }\n",
-    "'''\n",
+    "\"\"\"\n",
     "\n",
     "# List the deny queries you want to collect messages from\n",
     "deny_queries = [\n",
@@ -114,18 +114,10 @@
    "outputs": [],
    "source": [
     "inputs = {\n",
-    "    \"aoi\": {\n",
-    "        \"bbox\": [\n",
-    "            -1181.985,\n",
-    "            38.432,\n",
-    "            -118.183,\n",
-    "            38.938\n",
-    "        ],\n",
-    "        \"crs\": \"CRS84\"\n",
-    "    },\n",
+    "    \"aoi\": {\"bbox\": [-1181.985, 38.432, -118.183, 38.938], \"crs\": \"CRS84\"},\n",
     "    \"filesB\": \"EPSG:4326\",\n",
-    "    \"bands\": [ \"green\", \"nir089\" ],\n",
-    "    \"item\": \"https://planetarycomputer.microsoft.com/api/stac/v1/collections/landsat-c2-l2/items/LC08_L2SP_042033_20231007_02_T1\"\n",
+    "    \"bands\": [\"green\", \"nir089\"],\n",
+    "    \"item\": \"https://planetarycomputer.microsoft.com/api/stac/v1/collections/landsat-c2-l2/items/LC08_L2SP_042033_20231007_02_T1\",\n",
     "}"
    ]
   },