Validate schemas and fix them accordingly

Add validation of jsonschemas to our CI. The links and embeddedlinks schemas where invalid, as well as the references to them from the event schemas, so fixing all those to let CI pass. Switch to ajv for example validation, which allows for validation of both JSON documents as well as schemas. ajv let users load references schemas from files into the tool offline databases, which enables offline validation of unpublished schemas. Since ajv is javascript, update the GitHub action workflow to javascript. Fixes: #208 Fixes: #211 Signed-off-by: Andrea Frittoli <andrea.frittoli@gmail.com>
cdevents · May 10, 2024 · 3c0100b · 3c0100b
1 parent b462f84
commit 3c0100b
Show file tree

Hide file tree

Showing 55 changed files with 678 additions and 353 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -4,7 +4,7 @@ name: CDEvents
 on:
   # Triggers the workflow on push or pull request events but only for the main branch
   pull_request:
-    branches: [ main ]
+    branches: [ main, spec-v* ]
 
 ###############
 # Set the Job #
@@ -33,20 +33,24 @@ jobs:
           VALIDATE_MARKDOWN: true
 
   jsonschema:
-    name: Validate Examples
+    name: Validate Schemas and Examples
     runs-on: ubuntu-latest
 
     steps:
       - name: Checkout Code
-        uses: actions/checkout@v3
-
-      - name: Set up Go
-        uses: actions/setup-go@v3
+        uses: actions/checkout@v4
+      - name: Set up Node
+        uses: actions/setup-node@v4
         with:
-          go-version: 1.19
-
-      - name: Validate Examples
-        run: ./tools/verify-examples.sh
+          node-version: 20
+          cache: npm
+          cache-dependency-path: tools/package-lock.json
+      - name: Install dependencies
+        run: |
+          cd tools
+          npm install -g --no-fund ajv-cli ajv-formats
+      - name: Run Validate
+        run: ./tools/validate.sh
 
   spellcheck:
     name: Spellcheck (en_US)

diff --git a/.gitignore b/.gitignore
@@ -4,3 +4,6 @@
 
 # Mac
 .DS_Store
+
+# JS
+tools/node_modules
diff --git a/schemas/artifactdeleted.json b/schemas/artifactdeleted.json
@@ -38,7 +38,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "/schema/links/embeddedlinksarray.json"
+          "$ref": "links/embeddedlinksarray"
         }
       },
       "additionalProperties": false,

diff --git a/schemas/artifactdownloaded.json b/schemas/artifactdownloaded.json
@@ -38,7 +38,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "/schema/links/embeddedlinksarray.json"
+          "$ref": "links/embeddedlinksarray"
         }
       },
       "additionalProperties": false,

diff --git a/schemas/artifactpackaged.json b/schemas/artifactpackaged.json
@@ -38,7 +38,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "/schema/links/embeddedlinksarray.json"
+          "$ref": "links/embeddedlinksarray"
         }
       },
       "additionalProperties": false,

diff --git a/schemas/artifactpublished.json b/schemas/artifactpublished.json
@@ -38,7 +38,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "/schema/links/embeddedlinksarray.json"
+          "$ref": "links/embeddedlinksarray"
         }
       },
       "additionalProperties": false,

diff --git a/schemas/artifactsigned.json b/schemas/artifactsigned.json
@@ -38,7 +38,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "/schema/links/embeddedlinksarray.json"
+          "$ref": "links/embeddedlinksarray"
         }
       },
       "additionalProperties": false,

diff --git a/schemas/branchcreated.json b/schemas/branchcreated.json
@@ -38,7 +38,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "/schema/links/embeddedlinksarray.json"
+          "$ref": "links/embeddedlinksarray"
         }
       },
       "additionalProperties": false,

diff --git a/schemas/branchdeleted.json b/schemas/branchdeleted.json
@@ -38,7 +38,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "/schema/links/embeddedlinksarray.json"
+          "$ref": "links/embeddedlinksarray"
         }
       },
       "additionalProperties": false,

diff --git a/schemas/buildfinished.json b/schemas/buildfinished.json
@@ -38,7 +38,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "/schema/links/embeddedlinksarray.json"
+          "$ref": "links/embeddedlinksarray"
         }
       },
       "additionalProperties": false,

diff --git a/schemas/buildqueued.json b/schemas/buildqueued.json
@@ -38,7 +38,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "/schema/links/embeddedlinksarray.json"
+          "$ref": "links/embeddedlinksarray"
         }
       },
       "additionalProperties": false,

diff --git a/schemas/buildstarted.json b/schemas/buildstarted.json
@@ -38,7 +38,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "/schema/links/embeddedlinksarray.json"
+          "$ref": "links/embeddedlinksarray"
         }
       },
       "additionalProperties": false,

diff --git a/schemas/changeabandoned.json b/schemas/changeabandoned.json
@@ -38,7 +38,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "/schema/links/embeddedlinksarray.json"
+          "$ref": "links/embeddedlinksarray"
         }
       },
       "additionalProperties": false,

diff --git a/schemas/changecreated.json b/schemas/changecreated.json
@@ -38,7 +38,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "/schema/links/embeddedlinksarray.json"
+          "$ref": "links/embeddedlinksarray"
         }
       },
       "additionalProperties": false,

diff --git a/schemas/changemerged.json b/schemas/changemerged.json
@@ -38,7 +38,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "/schema/links/embeddedlinksarray.json"
+          "$ref": "links/embeddedlinksarray"
         }
       },
       "additionalProperties": false,

diff --git a/schemas/changereviewed.json b/schemas/changereviewed.json
@@ -38,7 +38,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "/schema/links/embeddedlinksarray.json"
+          "$ref": "links/embeddedlinksarray"
         }
       },
       "additionalProperties": false,

diff --git a/schemas/changeupdated.json b/schemas/changeupdated.json
@@ -38,7 +38,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "/schema/links/embeddedlinksarray.json"
+          "$ref": "links/embeddedlinksarray"
         }
       },
       "additionalProperties": false,

diff --git a/schemas/environmentcreated.json b/schemas/environmentcreated.json
@@ -38,7 +38,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "/schema/links/embeddedlinksarray.json"
+          "$ref": "links/embeddedlinksarray"
         }
       },
       "additionalProperties": false,

diff --git a/schemas/environmentdeleted.json b/schemas/environmentdeleted.json
@@ -38,7 +38,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "/schema/links/embeddedlinksarray.json"
+          "$ref": "links/embeddedlinksarray"
         }
       },
       "additionalProperties": false,

diff --git a/schemas/environmentmodified.json b/schemas/environmentmodified.json
@@ -38,7 +38,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "/schema/links/embeddedlinksarray.json"
+          "$ref": "links/embeddedlinksarray"
         }
       },
       "additionalProperties": false,

diff --git a/schemas/incidentdetected.json b/schemas/incidentdetected.json
@@ -38,7 +38,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "/schema/links/embeddedlinksarray.json"
+          "$ref": "links/embeddedlinksarray"
         }
       },
       "additionalProperties": false,

diff --git a/schemas/incidentreported.json b/schemas/incidentreported.json
@@ -38,7 +38,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "/schema/links/embeddedlinksarray.json"
+          "$ref": "links/embeddedlinksarray"
         }
       },
       "additionalProperties": false,

diff --git a/schemas/incidentresolved.json b/schemas/incidentresolved.json
@@ -38,7 +38,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "/schema/links/embeddedlinksarray.json"
+          "$ref": "links/embeddedlinksarray"
         }
       },
       "additionalProperties": false,

diff --git a/schemas/links/embeddedlinkend.json b/schemas/links/embeddedlinkend.json
@@ -1,26 +1,30 @@
 {
-  "link_type": {
-    "type": "string",
-    "enum": [
-      "END"
-    ]
-  },
-  "from": {
-    "description": "When consuming a CDEvent, you are consuming a parent event. So, when looking at the 'from' key, this is the parent's parent.",
-    "type": "object",
-    "properties": {
-      "context_id": {
-        "type": "string",
-        "minLength": 1
-      }
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://cdevents.dev/0.4.0/schema/links/embeddedlinkend",
+  "properties": {
+    "link_type": {
+      "type": "string",
+      "enum": [
+        "END"
+      ]
     },
-    "required": [
-      "context_id"
-    ]
-  },
-  "tags": {
-    "type": "object",
-    "additionalProperties": true
+    "from": {
+      "description": "When consuming a CDEvent, you are consuming a parent event. So, when looking at the 'from' key, this is the parent's parent.",
+      "type": "object",
+      "properties": {
+        "context_id": {
+          "type": "string",
+          "minLength": 1
+        }
+      },
+      "required": [
+        "context_id"
+      ]
+    },
+    "tags": {
+      "type": "object",
+      "additionalProperties": true
+    }
   },
   "additionalProperties": false,
   "type": "object",

diff --git a/schemas/links/embeddedlinkpath.json b/schemas/links/embeddedlinkpath.json
@@ -1,26 +1,30 @@
 {
-  "link_type": {
-    "type": "string",
-    "enum": [
-      "PATH"
-    ]
-  },
-  "from": {
-    "description": "When consuming a CDEvent, you are consuming a parent event. So, when looking at the 'from' key, this is the parent's parent.",
-    "type": "object",
-    "properties": {
-      "context_id": {
-        "type": "string",
-        "minLength": 1
-      }
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://cdevents.dev/0.4.0/schema/links/embeddedlinkpath",
+  "properties": {
+    "link_type": {
+      "type": "string",
+      "enum": [
+        "PATH"
+      ]
     },
-    "required": [
-      "context_id"
-    ]
-  },
-  "tags": {
-    "type": "object",
-    "additionalProperties": true
+    "from": {
+      "description": "When consuming a CDEvent, you are consuming a parent event. So, when looking at the 'from' key, this is the parent's parent.",
+      "type": "object",
+      "properties": {
+        "context_id": {
+          "type": "string",
+          "minLength": 1
+        }
+      },
+      "required": [
+        "context_id"
+      ]
+    },
+    "tags": {
+      "type": "object",
+      "additionalProperties": true
+    }
   },
   "additionalProperties": false,
   "type": "object",

diff --git a/schemas/links/embeddedlinkrelation.json b/schemas/links/embeddedlinkrelation.json
@@ -1,28 +1,32 @@
 {
-  "link_type": {
-    "type": "string",
-    "enum": [
-      "RELATION"
-    ]
-  },
-  "link_kind": {
-    "type": "string",
-    "minLength": 1
-  },
-  "target": {
-    "description": "",
-    "type": "object",
-    "properties": {
-      "context_id": {
-        "type": "string",
-        "minLength": 1
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://cdevents.dev/0.4.0/schema/links/embeddedlinkrelation",
+  "properties": {
+    "link_type": {
+      "type": "string",
+      "enum": [
+        "RELATION"
+      ]
+    },
+    "link_kind": {
+      "type": "string",
+      "minLength": 1
+    },
+    "target": {
+      "description": "",
+      "type": "object",
+      "properties": {
+        "context_id": {
+          "type": "string",
+          "minLength": 1
+        }
       }
+    },
+    "tags": {
+      "type": "object",
+      "additionalProperties": true
     }
   },
-  "tags": {
-    "type": "object",
-    "additionalProperties": true
-  },
   "additionalProperties": false,
   "type": "object",
   "required": [
-Original file line number
+Diff line change
@@ Expand Up / @@ -4,3 +4,6 @@ @@
     # Mac
     .DS_Store
+    # JS
+    tools/node_modules