DRIVERS-1767: test all json files with a schemaVersion against their corresponding schema (#1127)

Author: nbbeeken

.github/workflows/check_schema_version.sh

@@ -0,0 +1,33 @@
+#! /usr/bin/env bash
+
+# Collect error codes so we can see all the invalid json files in one run
+exitCode=0
+
+# $1 - takes a single argument of the path to the JSON file containing a schemaVersion key at the top level.
+function get_schema_version() {
+  node << EOF
+    const { readFileSync } = require('fs')
+    const { load } = require('js-yaml')
+    console.log(load(readFileSync("./$1", { encoding: 'utf-8' })).schemaVersion)
+EOF
+}
+
+function get_all_schemaVersion_defining_files () {
+  # look for all yaml files with "schemaVersion: ["'][1-9]"
+  grep --include=*.{yml,yaml} --files-with-matches --recursive --word-regexp --regexp="schemaVersion: [\"'][1-9]" source | \
+  # Remove the known invalid test files from 'unified-test-format/tests/invalid'
+  grep --word-regexp --invert-match 'unified-test-format/tests/invalid' | \
+  # sort the result!
+  sort
+}
+
+for testFile in $(get_all_schemaVersion_defining_files)
+do
+    schemaVersion=$(get_schema_version "$testFile")
+    if ! ajvCheck=$(ajv -s "source/unified-test-format/schema-$schemaVersion.json" -d "$testFile"); then
+      exitCode=1
+    fi
+    echo "$ajvCheck using schema v$schemaVersion"
+done
+
+exit $exitCode

.github/workflows/unified-test-format-schema-check.yml

@@ -13,16 +13,19 @@ jobs:
     steps:
       - uses: actions/checkout@v2
       - name: Set up Python
-        uses: actions/setup-python@v1
+        uses: actions/setup-python@v2
         with:
-          python-version: 3.7
+          python-version: 3.x
       - name: Set up npm
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v2
         with:
-          node-version: 12
+          node-version: lts/*
       - name: Install dependencies
         run: |
           npm install -g ajv-cli
+          npm install js-yaml
       - name: Check unified format test files against schema
-        run: |
-          cd source/unified-test-format/tests && make
+        working-directory: source/unified-test-format/tests
+        run: make
+      - name: Check all unified tests schema version is valid
+        run: bash .github/workflows/check_schema_version.sh

source/load-balancers/tests/cursors.json

@@ -1,6 +1,6 @@
 {
   "description": "cursors are correctly pinned to connections for load-balanced clusters",
-  "schemaVersion": "1.3",
+  "schemaVersion": "1.4",
   "runOnRequirements": [
     {
       "topologies": [

source/load-balancers/tests/cursors.yml

@@ -1,6 +1,6 @@
 description: cursors are correctly pinned to connections for load-balanced clusters
 
-schemaVersion: '1.3'
+schemaVersion: '1.4'
 
 runOnRequirements:
   - topologies: [ load-balanced ]

source/load-balancers/tests/sdam-error-handling.json

@@ -1,6 +1,6 @@
 {
   "description": "state change errors are correctly handled",
-  "schemaVersion": "1.3",
+  "schemaVersion": "1.4",
   "runOnRequirements": [
     {
       "topologies": [

source/load-balancers/tests/sdam-error-handling.yml

@@ -1,6 +1,6 @@
 description: state change errors are correctly handled
 
-schemaVersion: '1.3'
+schemaVersion: '1.4'
 
 runOnRequirements:
   - topologies: [ load-balanced ]

source/load-balancers/tests/transactions.json

@@ -1,6 +1,6 @@
 {
   "description": "transactions are correctly pinned to connections for load-balanced clusters",
-  "schemaVersion": "1.3",
+  "schemaVersion": "1.4",
   "runOnRequirements": [
     {
       "topologies": [

source/load-balancers/tests/transactions.yml

@@ -1,6 +1,6 @@
 description: transactions are correctly pinned to connections for load-balanced clusters
 
-schemaVersion: '1.3'
+schemaVersion: '1.4'
 
 runOnRequirements:
   - topologies: [ load-balanced ]