Add additional unit tests and fixed bugs

Author: kevinwang5658

codify-schemas/package-lock.json

@@ -2,9 +2,11 @@
   "name": "codify-schemas",
   "version": "1.0.0",
   "description": "",
-  "main": "index.js",
+  "main": "dist/index.js",
+  "typings": "dist/index.d.ts",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "tsc": "tsc"
   },
   "keywords": [],
   "author": "",

codify-schemas/package.json

@@ -2,4 +2,11 @@ export { default as ConfigFileSchema } from './config-file-schema.json';
 export { default as ProjectSchema } from './project-schema.json';
 export { default as ResourceMetaSchema } from './resource-meta-schema.json';
 export { default as ResourceSchema } from './resource-schema.json';
-export { default as IpcMessageSchema } from './ipc-message-schema.json';
+export { default as IpcMessageSchema } from './ipc-message-schema.json';
+export { default as ApplyRequestDataSchema } from './messages/apply-request-data-schema.json';
+export { default as ErrorResponseDataSchema } from './messages/error-response-data-schema.json';
+export { default as PlanRequestDataSchema } from './messages/plan-request-data-schema.json';
+export { default as PlanResponseDataSchema } from './messages/plan-response-data-schema.json';
+export { default as ValidateRequestDataSchema } from './messages/validate-request-data-schema.json';
+export { default as ValidateResponseDataSchema } from './messages/validate-response-data-schema.json';
+export * from './types';

codify-schemas/src/index.ts

@@ -4,7 +4,7 @@
   "title": "IPC Message Schema",
   "type": "object",
   "properties": {
-    "msg": {
+    "cmd": {
       "description": "The uri for the message. Like an http url",
       "type": "string"
     },
@@ -17,5 +17,5 @@
       "description": "The data of the message."
     }
   },
-  "required": ["msg", "data"]
-}
+  "required": ["cmd", "data"]
+}

codify-schemas/src/ipc-message-schema.json

@@ -12,26 +12,26 @@ describe("Ipc message schema tests", () => {
     ajv.compile(schema);
   })
 
-  it("requires a msg field to be specified", () => {
+  it("requires a cmd field to be specified", () => {
     const validate = ajv.compile(schema);
-    assert.equal(validate({ msg: "doSomething", data: "data" }), true)
+    assert.equal(validate({ cmd: "doSomething", data: "data" }), true)
     assert.equal(validate({ data: "data" }), false)
   })
 
   it("has an optional status field for responses", () => {
     const validate = ajv.compile(schema);
-    assert.equal(validate({ msg: "doSomething", status: "success", data: "data" }), true)
-    assert.equal(validate({ msg: "doSomething", status: "error", data: "data" }), true)
-    assert.equal(validate({ msg: "doSomething", status: "other", data: "data" }), false)
-    assert.equal(validate({ msg: "doSomething", data: "data" }), true)
+    assert.equal(validate({ cmd: "doSomething", status: "success", data: "data" }), true)
+    assert.equal(validate({ cmd: "doSomething", status: "error", data: "data" }), true)
+    assert.equal(validate({ cmd: "doSomething", status: "other", data: "data" }), false)
+    assert.equal(validate({ cmd: "doSomething", data: "data" }), true)
   })
 
   it ("accepts data or null", () => {
     const validate = ajv.compile(schema);
-    assert.equal(validate({ msg: "doSomething", data: "data" }), true)
-    assert.equal(validate({ msg: "doSomething", data: null }), true)
-    assert.equal(validate({ msg: "doSomething" }), false)
-    assert.equal(validate({ msg: "doSomething", data: {} }), true)
+    assert.equal(validate({ cmd: "doSomething", data: "data" }), true)
+    assert.equal(validate({ cmd: "doSomething", data: null }), true)
+    assert.equal(validate({ cmd: "doSomething" }), false)
+    assert.equal(validate({ cmd: "doSomething", data: {} }), true)
   });
 
-});
+});

codify-schemas/src/ipc-message-schema.test.ts

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$id": "https://www.codify.com/plan-response-data-schema.json",
-  "title": "Plan Response Schema Data",
+  "$id": "https://www.codify.com/apply-request-data-schema.json",
+  "title": "Apply Request Schema Data",
   "description": "Apply the previously generated plan. The plan must already be generated in order for apply to work.",
   "type": "object",
   "properties": {
@@ -13,4 +13,4 @@
   },
   "required": ["planId"],
   "additionalProperties": false
-}
+}

codify-schemas/src/messages/apply-request-data-schema.json

@@ -2,5 +2,5 @@
   "$schema": "https://json-schema.org/draft/2020-12/schema",
   "$id": "https://www.codify.com/plan-request-data-schema.json",
   "title": "Plan Request Schema Data",
-  "$ref": "../resource-schema.json"
-}
+  "$ref": "resource-schema.json"
+}

codify-schemas/src/messages/plan-request-data-schema.json

@@ -0,0 +1,34 @@
+import Ajv2020 from "ajv/dist/2020";
+import schema from './plan-request-data-schema.json';
+import resourceSchema from '../resource-schema.json'
+import {it} from "mocha";
+import assert from "node:assert";
+
+const ajv = new Ajv2020({
+  strict: true,
+})
+ajv.addSchema(resourceSchema);
+
+describe('Plan request data schema', () => {
+  it('compiles', () => {
+    ajv.compile(schema);
+  })
+
+  it("requires a type field to be specified", () => {
+    const validate = ajv.compile(schema);
+    assert.equal(validate({ type: "type" }), true)
+    assert.equal(validate({}), false)
+  })
+
+  it ("name and type are alpha-numeric and follow variable naming conventions", () => {
+    const validate = ajv.compile(schema);
+    assert.equal(validate({ type: "a234abcDEF_-"}), true)
+    assert.equal(validate({ type: "234"}), false);
+    assert.equal(validate({ type: "ABCDEF$"}), false);
+
+    assert.equal(validate({ type: "type", name: "a234abcDEF_-"}), true)
+    assert.equal(validate({ type: "type", name: "234"}), false);
+    assert.equal(validate({ type: "type", name: "ABCDEF$"}), false);
+  });
+
+})

codify-schemas/src/messages/plan-request-data-schema.test.ts

@@ -2,8 +2,15 @@
   "$schema": "https://json-schema.org/draft/2020-12/schema",
   "$id": "https://www.codify.com/validate-request-data-schema.json",
   "title": "Validate Request Schema Data",
-  "type": "array",
-  "items": {
-    "$ref": "../resource-schema.json"
-  }
-}
+  "type": "object",
+  "properties": {
+    "configs": {
+      "type": "array",
+      "items": {
+        "$ref": "resource-schema.json"
+      }
+    }
+  },
+  "required": [],
+  "additionalProperties": false
+}

codify-schemas/src/messages/validate-request-data-schema.json

@@ -2,25 +2,5 @@
   "$schema": "https://json-schema.org/draft/2020-12/schema",
   "$id": "https://www.codify.com/validate-response-data-schema.json",
   "title": "Validate Response Schema Data",
-  "type": "object",
-  "properties": {
-    "type": {
-      "description": "The resource type",
-      "type": "string",
-      "pattern": "^[a-zA-Z-_][\\w-]+$"
-    },
-    "name": {
-      "description": "Optional name. Useful for specifying multiple resources of the same type",
-      "type": "string",
-      "pattern": "^[a-zA-Z-_][\\w-]+$"
-    },
-    "dependsOn": {
-      "type": "array",
-      "items": {
-        "type": "string"
-      },
-      "uniqueItems": true
-    }
-  },
-  "required": ["type"]
-}
+  "type": "null"
+}