assertions-mate 0.1.0__tar.gz

assertions_mate-0.1.0/.github/workflows/docs.yaml

@@ -0,0 +1,43 @@
+# Copyright 2025 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: docs
+on:
+  push:
+    branches:
+      - docs
+      - develop
+      - main
+    paths:
+      # Only rebuild website when docs have changed
+      - 'README.md'
+      - 'docs/**'
+      - 'mkdocs.yml'
+      - .github/**
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout master
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.x
+        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
+      - run: mkdocs gh-deploy --force

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

@@ -0,0 +1,74 @@
+# Copyright 2025 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: publish-to-pypi
+
+on:
+  push:
+    branches:
+    - develop
+    - main
+    paths:
+    - assertions-mate/**
+    - src/**
+    - .github/workflows/package.yaml
+  release:
+    types:
+    - published
+  pull_request:
+    branches:
+    - develop
+    - main
+    paths:
+    - src/**
+
+permissions:
+  contents: read
+  packages: write
+
+jobs:
+
+  deploy:
+    runs-on: ubuntu-latest
+    environment: release
+    permissions:
+      id-token: write # IMPORTANT: this permission is mandatory for trusted publishing
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.10'
+        cache: pip
+    - name: Install dependencies
+      run: |
+        # python -m pip install --upgrade pip
+        # python -m pip install --upgrade pip
+        pip install hatch
+    - name: Build package
+      run: "hatch build \n"
+    - name: Test package
+      run: |
+        # hatch test
+        echo "placeholder for tests"
+    - name: Publish package distributions to PyPI (main)
+      if: github.ref == 'refs/heads/main'
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        repository-url: https://upload.pypi.org/legacy/
+    - name: Publish package distributions to PyPI (develop)
+      if: github.ref != 'refs/heads/main'
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        repository-url: https://test.pypi.org/legacy/

assertions_mate-0.1.0/.gitignore

@@ -0,0 +1,9 @@
+.project
+.settings
+.pydevproject
+public
+docs/diagrams/out
+openapi_bundled.yaml
+*.pyc
+schema.yaml
+src/assertions_mate/__pycache__

assertions_mate-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

assertions_mate-0.1.0/NOTICE

@@ -0,0 +1,5 @@
+transpiler-mate
+Copyright 2025 Terradue.
+
+This product includes software developed at
+The Apache Software Foundation (http://www.apache.org/).

assertions_mate-0.1.0/PKG-INFO

@@ -0,0 +1,38 @@
+Metadata-Version: 2.4
+Name: assertions-mate
+Version: 0.1.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.8
+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 :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.8
+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 Framework API
+
+!!! note
+
+    This is Work in Progress

assertions_mate-0.1.0/README.md

@@ -0,0 +1,5 @@
+# Assertions Framework API
+
+!!! note
+
+    This is Work in Progress

assertions_mate-0.1.0/docs/diagrams/src/class.puml

@@ -0,0 +1,81 @@
+@startuml
+package models {
+    struct ErrorDetail {
+        +detail: str
+        +pointer: str
+        +parameter: str
+        +header: str
+        +code: str
+    }
+    
+    struct ProblemDetails {
+        +type: str
+        +status: int
+        +title: str
+        +detail: str
+        +instance: str
+        +code: str
+        +errors: List[ErrorDetail]
+    }
+
+    ErrorDetail o-r- ProblemDetails
+    /'
+    struct BusinessRuleViolation extends ProblemDetails
+    struct AlreadyExists extends ProblemDetails
+    struct BadRequest extends ProblemDetails
+    struct BusinessRuleViolation extends ProblemDetails
+    struct Forbidden extends ProblemDetails
+    struct InvalidBodyPropertyFormat extends ProblemDetails
+    struct InvalidBodyPropertyValue extends ProblemDetails
+    struct InvalidParameters extends ProblemDetails
+    struct InvalidRequestHeaderFormat extends ProblemDetails
+    struct InvalidRequestParameterFormat extends ProblemDetails
+    struct InvalidRequestParameterValue extends ProblemDetails
+    struct LicenseCancelled extends ProblemDetails
+    struct LicenseExpired extends ProblemDetails
+    struct MissingBodyProperty extends ProblemDetails
+    struct MissingRequestHeader extends ProblemDetails
+    struct MissingRequestParameter extends ProblemDetails
+    struct NotFound extends ProblemDetails
+    struct ServerError extends ProblemDetails
+    struct ServiceUnavailable extends ProblemDetails
+    struct Unauthorized extends ProblemDetails
+    struct ValidationError extends ProblemDetails
+    '/
+}
+
+abstract class BaseValidator {
+    +validate_inputs(data: Mapping[str, Any]) -> ProblemDetails | None
+}
+
+abstract class AssertionHint {
+  +validator() -> BaseValidator
+}
+
+class JSONSchemaHint extends AssertionHint {
+  +validator() -> BaseValidator
+}
+
+class RegoPolicyHint extends AssertionHint {
+  +validator() -> BaseValidator
+}
+
+class Cql2FilterHint extends AssertionHint {
+  +validator() -> BaseValidator
+}
+
+BaseValidator -u-> ProblemDetails
+AssertionHint -> BaseValidator
+
+class JSONSchemaValidator extends BaseValidator {
+    +validate_inputs(data: Mapping[str, Any]) -> ProblemDetails | None
+}
+
+class RegoValidator extends BaseValidator {
+    +validate_inputs(data: Mapping[str, Any]) -> ProblemDetails | None
+}
+
+class Cql2Validator extends BaseValidator {
+    +validate_inputs(data: Mapping[str, Any]) -> ProblemDetails | None
+}
+@enduml

assertions_mate-0.1.0/docs/diagrams/src/flow.puml

@@ -0,0 +1,35 @@
+@startuml
+start
+:Client sent the inputs set;
+:Retrieve the workflow;
+:Retrieve the inputs JSON Schema by annotation;
+:JSON Schema inputs validation;
+if (JSON Schema valid?) then (yes)
+  :Retrieve the inputs Rego Policy by annotation;
+  if (Rego Policy passed?) then (yes)
+      if (Are STAC Item(s) input(s) passed by value?) then (yes)
+      
+      else (no)
+        :Resolve STAC Item(s) input(s) by reference;
+      endif
+      
+      :Retrieve the inputs CQL2 filters by annotation;
+      
+      if (CQL2 filters passed?) then (yes)
+      
+      else (no)
+        :Return 400 Bad Request comforming to RFC9457;
+        stop
+      endif
+    else (no)
+      :Return 400 Bad Request comforming to RFC9457;
+      stop
+    endif
+else (no)
+  :Return 400 Bad Request comforming to RFC9457;
+  stop
+endif
+
+:Submit Worflow execution; 
+end
+@enduml

assertions_mate-0.1.0/docs/diagrams/src/overall.puml

@@ -0,0 +1,27 @@
+@startuml
+component "Assertions Framework APIs" as api {
+    component "JSON Schema validator" as v1
+    component "Rego validator" as v2
+    component "CQL2-text filter validator" as v3
+    
+    v1 -[hidden]- v2
+    v2 -[hidden]- v3
+}
+
+component "Assertions Framework CLI" as cli
+component "CWL2OGC" as cto
+component "CWL Utils" as cwlu
+
+cli -u-> api
+cli -d-> cto
+cli -d-> cwlu
+
+component "Execution MATE API" as exec
+component "FastAPI" as fastapi
+component "FastAPI Dependency" as dep
+
+exec -l-> api
+exec -d-> fastapi
+fastapi -r-> dep
+
+@enduml

assertions_mate-0.1.0/docs/diagrams/src/sequence.puml

@@ -0,0 +1,52 @@
+@startuml
+participant "Client" as client
+collections "OGC API - Processes\nKNatice Service" as exec
+participant "execute\nFastAPI Micro Service" as fams
+participant "JSON Schema validator" as json_schema
+participant "Rego Policy Validator" as rego_policy
+participant "CQL2-Text Validator" as cql2_filter
+
+activate client
+
+client -> exec ++ : POST /{namespace}/processes/{processId}/execution\n\n{\n  "inputs": {},\n  "outputs": {},\n  "subscriber": {},\n"  properties": { }\n}
+exec -> fams ++ : Forward
+
+fams -> json_schema ++ : Validate inputs
+
+alt Inputs valid according to JSON Schema
+    json_schema --> fams : No violations detected
+    
+    fams -> rego_policy ++ : Validate inputs
+    
+    alt Inputs valid according to Rego Policy
+        rego_policy --> fams : No violations detected
+        
+        fams -> cql2_filter ++ : Validate inputs
+        
+        alt Inputs valid according to CQL2-Text filters
+            cql2_filter --> fams : No violations detected
+        else CQL2-Text filters input validation failed
+            cql2_filter --> fams : return "Business Rule Violation"
+            deactivate cql2_filter
+    
+            fams --> exec : return "https://problems-registry.smartbear.com/business-rule-violation/"
+            exec --> client : 400 Bad Request\nContent-Type: application/problem+json\n\n{\n  "type": "https://problems-registry.smartbear.com/business-rule-violation",\n  "title": "Business Rule Violation",\n  "detail": "The request body is invalid and not meeting business rules.",\n  "status": 422\n}
+        end
+    else Rego Policy input validation failed
+        rego_policy --> fams : return "Business Rule Violation"
+        deactivate rego_policy
+    
+        fams --> exec : return "https://problems-registry.smartbear.com/business-rule-violation/"
+        exec --> client : 400 Bad Request\nContent-Type: application/problem+json\n\n{\n  "type": "https://problems-registry.smartbear.com/business-rule-violation",\n  "title": "Business Rule Violation",\n  "detail": "The request body is invalid and not meeting business rules.",\n  "status": 422\n}
+    end
+else JSON Schema input validation failed
+    json_schema --> fams : return "Invalid Body Property Format"
+    deactivate json_schema
+    
+    fams --> exec : return "https://problems-registry.smartbear.com/invalid-body-property-format/"
+    deactivate fams
+    
+    exec --> client : 400 Bad Request\nContent-Type: application/problem+json\n\n{\n  "type": "https://problems-registry.smartbear.com/invalid-body-property-format",\n  "title": "Invalid Body Property Format",\n  "detail": "The request body contains a malformed property.",\n  "status": 400\n}
+end
+
+@enduml

assertions_mate-0.1.0/docs/index.md

@@ -0,0 +1,5 @@
+# Assertions Framework API
+
+!!! note
+
+    This is Work in Progress