Merge pull request #180 from jay-oswald/profile_validate

Add json validation to vehicle profiles

Author: meatpiHQ

.github/CODEOWNERS

@@ -4,3 +4,4 @@
 # @jay-oswald owns the vehicle_profiles JS + Action
 .vehicle_profiles/ @jay-oswald
 .github/workflows/vehicle_profiles.yml @jay-oswald
+.github/workflows/vehicle_profiles_validate.yml @jay-oswald

.github/workflows/vehicle_profiles_validate.yml

@@ -0,0 +1,17 @@
+name: Validate Vehicle Profiles
+
+on: [pull_request]
+
+jobs:
+  validate-vehicle-profiles:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+      - run: |
+          cd .vehicle_profiles
+          npm ci
+          npm run validate

.vehicle_profiles/package-lock.json

@@ -5,11 +5,13 @@
   "main": "merge.js",
   "scripts": {
     "build": "node merge.js",
+    "validate": "node validate.js",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "author": "jay-oswald",
   "type": "module",
   "dependencies": {
+    "ajv": "^8.17.1",
     "glob": "^11.0.0"
   }
 }

.vehicle_profiles/package.json

@@ -0,0 +1,53 @@
+{
+    "title": "WiCan Vehicle Profile",
+    "description": "Data about various models of cars and their settings",
+    "type": "object",
+    "properties": {
+        "car_model": {
+            "description": "Name of car model, should include Make and Model(s)",
+            "type": "string"
+        },
+        "init": {
+            "description": "Init String, don't forget the final ;",
+            "type": "string"
+        },
+        "pids": {
+            "description": "Array of PID's and their parameters",
+            "type": "array",
+            "minItems": 1,
+            "items": {
+                "type": "object",
+                "properties": {
+                    "pid": {
+                        "description": "The PID for this group of parameters",
+                        "type": "string"
+                    },
+                    "parameters": {
+                        "description": "Array of Parameters for this PID",
+                        "type": "array",
+                        "minItems": 1,
+                        "items": {
+                            "type": "object",
+                            "properties": {
+                                "name": {
+                                    "description": "Used in MQTT JSON, no spaces",
+                                    "type": "string"
+                                },
+                                "expression": {
+                                    "description": "Expression to calculate value",
+                                    "type": "string"
+                                },
+                                "unit": {
+                                    "description": "Unit for this  parameter",
+                                    "type": "string"
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        }
+    },
+    "additionalProperties": false,
+    "required": [ "car_model", "init", "pids"]
+}

.vehicle_profiles/schema.json

@@ -0,0 +1,34 @@
+import Ajv from "ajv"
+import { readFile } from 'fs/promises';
+import { glob } from 'glob'
+
+const ajv = new Ajv()
+const schema = JSON.parse(await readFile("schema.json", "utf-8"))
+const validate = ajv.compile(schema)
+
+const source_folder = '../vehicle_profiles';
+const files = await glob(source_folder + '/**/*.json')
+
+let errors = 0;
+
+async function validate_profile(path){
+    let file = await readFile(path, "utf-8");
+    let data = JSON.parse(file);
+    let valid = validate(data);
+    if(valid) return
+
+    console.log(path)
+    console.log(validate.errors)
+    errors++;
+}
+
+let promises = [];
+files.forEach(file => {
+    promises.push(validate_profile(file));
+});
+
+await Promise.all(promises);
+
+if(errors > 0){
+    throw new Error('Validation issues found, see log for details');
+}