Merge pull request #14 from scrthq/feat/add-schema-tests

Add tests mechanisms to schema structure

.github/workflows/run-tests.yml

@@ -0,0 +1,71 @@
+name: Run Tests
+
+on:
+  # Allows manual triggering of workflow
+  workflow_dispatch: {}
+  # Trigger on push to any branch
+  push:
+    branches:
+      - '*'
+  # Trigger on pull request to any branch
+  pull_request:
+    branches:
+      - '*'
+
+defaults:
+  run:
+    working-directory: 'tests'
+
+permissions:
+  contents: read
+  pull-requests: write
+  statuses: write
+  checks: write
+
+jobs:
+  test-scdex-schema:
+    name: Run SCDEX Schema Tests
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pull-requests: write
+      statuses: write
+      checks: write
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.12
+      - name: Install Poetry
+        run: |
+          curl -sSL https://install.python-poetry.org | python3 -
+      - name: Install dependencies
+        run: poetry install
+      - name: Run tests
+        run: poetry run pytest
+
+      # - name: Upload JUnitXML Test Results
+      #   uses: dorny/test-reporter@v1
+      #   if: ${{ !cancelled() }}
+      #   continue-on-error: true
+      #   with:
+      #     name: Test Results
+      #     path: 'tests/junit.xml'
+      #     reporter: java-junit
+      #     fail-on-error: true
+
+      - name: Publish Test Report
+        uses: mikepenz/[email protected]
+        if: ${{ !cancelled() }}
+        with:
+          report_paths: '**/junit.xml'
+          require_tests: true
+          fail_on_failure: true
+          check_name: 'SCDEX Schema Test Report'
+          job_summary: true
+          detailed_summary: true
+          flaky_summary: true
+          comment: true
+          updateComment: true
+          annotate_notice: true

examples/full/README.md

@@ -0,0 +1,17 @@
+# **Full Examples**
+
+This directory contains full examples of SC-DEX data structures, both valid and invalid.
+
+The examples in these directories are also used by the backing test suite to validate the SC-DEX schema as it evolves over time, ensuring no regressions are introduced that would break existing data structures.
+
+## **Valid Examples**
+
+Examples within the `valid` directory are considered valid SC-DEX data structures and should pass the schema validation tests.
+
+These examples are used to demonstrate how the SC-DEX schema can be used to represent real-world supply chain data in a standardized format.
+
+## **Invalid Examples**
+
+Examples within the `invalid` directory are considered invalid SC-DEX data structures and should fail with ValidationErrors in the test suite.
+
+These examples are used to ensure that the SC-DEX schema is robust and can catch errors in data structures that do not conform to the standard.

examples/full/invalid/mistyped-osid-location-identifier.json

@@ -0,0 +1,42 @@
+{
+  "$schema": "../../../schema/core-schema.json",
+  "locations": [
+    {
+      "guid": "82d39ac8-1a12-4801-835a-85d319927548",
+      "location-type": "factory",
+      "language": "en",
+      "products": [
+        "Accessories",
+        "Hats"
+      ],
+      "processing-types": [
+        "Final Product Assembly",
+        "Cutting",
+        "Embroidery",
+        "Finishing",
+        "Ironing",
+        "Knitting"
+      ],
+      "location-identifier": "os-id:CN2021250D1DTN7",
+      "name": "Huai An Yuan Tong Headwear Mfg. Co., Ltd.",
+      "coordinates": {
+        "latitude": 33.7862099,
+        "longitude": 119.2787399
+      },
+      "address": {
+        "street-name": "Yan Huang Avenue",
+        "building-number": "No.30 & 32 & 99",
+        "town-name": "Huaian",
+        "country-sub-division": "Jiangsu",
+        "country": "CN",
+        "address-line": [
+          "No.30 & 32 & 99 Yan Huang Avenue",
+          "Lian Shui Economic Developmental District",
+          "Huaian, Jiangsu - China"
+        ]
+      }
+    }
+  ],
+  "organizations": [],
+  "affiliations": []
+}

schema/core-schema-example.json → examples/full/valid/core-schema-example.json

@@ -1,4 +1,5 @@
 {
+  "$schema": "../../../schema/core-schema.json",
   "locations": [
     {
       "guid": "82d39ac8-1a12-4801-835a-85d319927548",
@@ -16,7 +17,7 @@
         "Ironing",
         "Knitting"
       ],
-      "location-identifier": "os-id:CN2021250D1DTN7",
+      "location-identifier": "osid:CN2021250D1DTN7",
       "name": "Huai An Yuan Tong Headwear Mfg. Co., Ltd.",
       "coordinates": {
         "latitude": 33.7862099,

schema/README.md

@@ -2,9 +2,9 @@
 
 The SC-DEX schema can support different supply chain arrangements, including multiple locations, organizations, and their various affiliations to each other to represent data assets.
 
-- The JSON Schema of the core SC-DEX can be found [here](https://github.com/opensupplyhub/supplychaindata.exchange/blob/main/schema/core-schema.json)
-- The core schema description can be found [here](https://github.com/opensupplyhub/supplychaindata.exchange/blob/main/schema/schema.md)
-- An SC-DEX Example can be found [here](https://github.com/opensupplyhub/supplychaindata.exchange/blob/main/schema/core-schema-example.json)
+- The JSON Schema of the core SC-DEX can be found [here](./core-schema.json)
+- The core schema description can be found [here](./schema.md)
+- An SC-DEX Example can be found [here](../examples/full/valid/core-schema-example.json)
 
 Below are three examples of entity-relationship diagrams showing how locations, organizations, and affiliations interact in various supply chain scenarios.
 

schema/core-schema.json

@@ -27,16 +27,12 @@
                         "description": "Accepted location identifier, which can be a single string (e.g., 'osid:XXXXXXXX', 'gfid:XXXXXXXX') or an array of such strings (osid stands for open supply hub ID, and gfid for Global Field ID)",
                         "anyOf": [
                             {
-                                "type": "string",
-                                "pattern": "^(osid|gfid):[A-Za-z0-9]+$",
-                                "description": "A single location identifier string with a specific prefix (e.g., 'osid:' or 'gf-id:')"
+                                "$ref": "#/definitions/location-identifier"
                             },
                             {
                                 "type": "array",
                                 "items": {
-                                    "type": "string",
-                                    "pattern": "^(osid|gf-id):[A-Za-z0-9]+$",
-                                    "description": "Each item in the array must be a location identifier string with a specific prefix"
+                                    "$ref": "#/definitions/location-identifier"
                                 },
                                 "minItems": 1,
                                 "description": "An array of location identifier strings"
@@ -259,5 +255,12 @@
     },
     "required": [
         "locations"
-    ]
+    ],
+    "definitions": {
+        "location-identifier": {
+            "type": "string",
+            "pattern": "^(osid|gfid):[A-Za-z0-9]+$",
+            "description": "A location identifier string with a specific prefix (e.g., 'osid:', 'gfid:')"
+        }
+    }
 }

tests/.gitignore

@@ -0,0 +1,167 @@
+# Test artifacts
+junit.xml
+report.html
+
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/