Merge pull request #121 from bact/add-ajv-test

jsonschema: Add JSON Schema compatibility test

Author: bact

.github/workflows/coverage-generate.yaml

@@ -28,9 +28,15 @@ jobs:
         uses: actions/setup-python@65d7f2d534ac1bc67fcd62888c5f4f3d2cb2b236 # v4.7.1
         with:
           python-version: "3.11"
+      - name: Setup Node
+        uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
+        with:
+          node-version: 24
       - name: Install dependencies
         run: |
           sudo apt install -y build-essential doxygen graphviz
+          npm install -g jsonld-cli
+          npm --prefix scripts ci
       - name: Install package
         run: |
           pip install -e .[dev]

.github/workflows/test.yaml

@@ -39,6 +39,7 @@ jobs:
           python -m pip install --upgrade pip
           pip install build
           npm install -g jsonld-cli
+          npm --prefix scripts ci
       - name: Install Linux packages
         if: runner.os == 'Linux'
         run: |

.gitignore

@@ -1,3 +1,6 @@
+# Node
+node_modules/
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

scripts/ajv-compile.js

@@ -0,0 +1,76 @@
+#!/usr/bin/env node
+// SPDX-FileContributor: Arthit Suriyawongkul
+// SPDX-FileCopyrightText: 2026 Joshua Watt
+// SPDX-FileType: SOURCE
+// SPDX-License-Identifier: MIT
+//
+// Validate a JSON Schema file against its meta-schema using ajv v8.
+// Usage: ajv-compile.js <schema.json> [draft-version]
+// draft-version: 2020-12 or 2019-09 (default: inferred from "$schema")
+const fs = require("fs");
+
+const schemaFile = process.argv[2];
+const draftArg = process.argv[3];
+
+if (!schemaFile) {
+    console.error("Usage: ajv-compile.js <schema.json> [draft-version]");
+    process.exit(2);
+}
+
+const draftMap = {
+    "2020-12": "ajv/dist/2020",
+    "2019-09": "ajv/dist/2019",
+};
+
+const schemaUriMap = {
+    "https://json-schema.org/draft/2020-12/schema": "2020-12",
+    "http://json-schema.org/draft/2020-12/schema": "2020-12",
+    "https://json-schema.org/draft/2019-09/schema": "2019-09",
+    "http://json-schema.org/draft/2019-09/schema": "2019-09",
+};
+
+let schema;
+try {
+    schema = JSON.parse(fs.readFileSync(schemaFile, "utf8"));
+} catch (e) {
+    console.error(`Failed to read/parse "${schemaFile}": ${e.message}`);
+    process.exit(2);
+}
+
+let draft = draftArg;
+if (!draft) {
+    draft = schemaUriMap[schema.$schema?.replace(/#$/, "")];
+    if (!draft) {
+        console.error(
+            `Unable to infer draft version from "$schema": ${schema.$schema}. ` +
+                "Pass the draft version explicitly as the second argument.",
+        );
+        process.exit(2);
+    }
+}
+
+const ajvModule = draftMap[draft];
+if (!ajvModule) {
+    console.error(`Unsupported draft version: ${draft}. Supported: ${Object.keys(draftMap).join(", ")}`);
+    process.exit(2);
+}
+
+let Ajv;
+try {
+    Ajv = require(ajvModule);
+} catch (e) {
+    console.error(
+        `Failed to load "${ajvModule}": ${e.message}\n` +
+            'Run "npm --prefix scripts install" to install dependencies.',
+    );
+    process.exit(2);
+}
+
+const ajv = new Ajv();
+try {
+    ajv.compile(schema);
+    console.log("schema is valid");
+} catch (e) {
+    console.error("schema is invalid:", e.message);
+    process.exit(1);
+}

scripts/package-lock.json

@@ -0,0 +1,8 @@
+{
+    "name": "shacl2code-scripts",
+    "private": true,
+    "description": "Node dependencies for shacl2code test/build scripts",
+    "dependencies": {
+        "ajv": "8.20.0"
+    }
+}

scripts/package.json

@@ -1,6 +1,7 @@
-#
-# Copyright (c) 2024 Joshua Watt
-#
+# SPDX-FileContributor: Arthit Suriyawongkul
+# SPDX-FileContributor: Joshua Watt
+# SPDX-FileCopyrightText: 2024 Joshua Watt
+# SPDX-FileType: SOURCE
 # SPDX-License-Identifier: MIT
 
 import json
@@ -56,6 +57,33 @@ def test_output_syntax(self, args):
 
         json.loads(p.stdout)
 
+    def test_ajv_compile(self, tmp_path, args):
+        """
+        Validates the generated schema against the JSON Schema meta-schema using ajv
+        """
+        schema_file = tmp_path / "schema.json"
+        subprocess.run(
+            [
+                "shacl2code",
+                "generate",
+            ]
+            + args
+            + [
+                "jsonschema",
+                "--output",
+                schema_file,
+            ],
+            check=True,
+        )
+        subprocess.run(
+            [
+                "node",
+                THIS_DIR.parent / "scripts" / "ajv-compile.js",
+                str(schema_file),
+            ],
+            check=True,
+        )
+
     def test_trailing_whitespace(self, args):
         """
         Tests that the generated file does not have trailing whitespace