doc-detective-common 1.21.0-openapi.9 → 1.21.1-dev.0

package/src/schemas/src_schemas/test_v2.schema.json

@@ -1,159 +1,199 @@
-{
-  "title": "test",
-  "type": "object",
-  "description": "A Doc Detective test.",
-  "properties": {
-    "id": {
-      "type": "string",
-      "description": "Unique identifier for the test."
-    },
-    "description": {
-      "type": "string",
-      "description": "Description of the test."
-    },
-    "file": {
-      "type": "string",
-      "description": "Path to the file that the test is associated with."
-    },
-    "detectSteps": {
-      "type": "boolean",
-      "description": "Whether or not to detect steps in input files based on markup regex. Defaults to `true`."
-    },
-    "contexts": {
-      "type": "array",
-      "description": "Application/platform sets to run the test in. Overrides `contexts` defined at the config-level and spec-level.",
-      "items": {
-        "oneOf": [
-          {
-            "$ref": "context_v2.schema.json#"
-          }
-        ]
-      }
-    },
-    "setup": {
-      "type": "string",
-      "description": "Path to a test specification to perform before this test, while maintaining this test's context. Useful for setting up testing environments. Only the `steps` property is used from the first test in the setup spec."
-    },
-    "cleanup": {
-      "type": "string",
-      "description": "Path to a test specification to perform after this test, while maintaining this test's context. Useful for cleaning up testing environments. Only the `steps` property is used from the first test in the cleanup spec."
-    },
-    "steps": {
-      "description": "Actions to perform as part of the test. Performed in the sequence defined. If one or more actions fail, the test fails.",
-      "type": "array",
-      "minItems": 1,
-      "items": {
-        "anyOf": [
-          { "$ref": "checkLink_v2.schema.json#" },
-          { "$ref": "goTo_v2.schema.json#" },
-          { "$ref": "httpRequest_v2.schema.json#" },
-          { "$ref": "runShell_v2.schema.json#" },
-          { "$ref": "saveScreenshot_v2.schema.json#" },
-          { "$ref": "setVariables_v2.schema.json#" },
-          { "$ref": "startRecording_v2.schema.json#" },
-          { "$ref": "stopRecording_v2.schema.json#" },
-          { "$ref": "typeKeys_v2.schema.json#" },
-          { "$ref": "find_v2.schema.json#" },
-          { "$ref": "wait_v2.schema.json#" }
-        ]
-      }
-    }
-  },
-  "dynamicDefaults": {
-    "id": "uuid"
-  },
-  "required": ["steps"],
-  "additionalProperties": false,
-  "examples": [
-    {
-      "steps": [
-        {
-          "action": "checkLink",
-          "url": "https://www.duckduckgo.com"
-        }
-      ]
-    },
-    {
-      "steps": [
-        {
-          "action": "goTo",
-          "url": "https://www.duckduckgo.com"
-        },
-        {
-          "action": "find",
-          "selector": "[title=Search]",
-          "click": true,
-          "typeKeys": {
-            "keys": ["shorthair cats", "$ENTER$"]
-          }
-        }
-      ]
-    },
-    {
-      "id": "Do all the things! - Test",
-      "description": "This test includes every property across all actions.",
-      "contexts": [
-        {
-          "app": {
-            "name": "firefox",
-            "path": "/usr/bin/firefox"
-          },
-          "platforms": ["linux"]
-        }
-      ],
-      "setup": "setup.json",
-      "cleanup": "cleanup.json",
-      "steps": [
-        {
-          "action": "setVariables",
-          "path": ".env"
-        },
-        {
-          "action": "runShell",
-          "command": "echo",
-          "args": ["$USER"]
-        },
-        {
-          "action": "checkLink",
-          "url": "https://www.duckduckgo.com"
-        },
-        {
-          "action": "httpRequest",
-          "url": "https://reqres.in/api/users",
-          "method": "post",
-          "requestData": {
-            "name": "morpheus",
-            "job": "leader"
-          },
-          "responseData": {
-            "name": "morpheus",
-            "job": "leader"
-          },
-          "statusCodes": [200, 201]
-        },
-        {
-          "action": "goTo",
-          "url": "https://www.duckduckgo.com"
-        },
-        {
-          "action": "find",
-          "selector": "[title=Search]",
-          "timeout": 10000,
-          "matchText": "Search",
-          "moveTo": true,
-          "click": true,
-          "typeKeys": {
-            "keys": ["shorthair cat"]
-          }
-        },
-        {
-          "action": "typeKeys",
-          "keys": ["$ENTER$"]
-        },
-        {
-          "action": "saveScreenshot"
-        }
-      ]
-    }
-  ]
-}
+{
+  "title": "test",
+  "type": "object",
+  "description": "A Doc Detective test.",
+  "properties": {
+    "id": {
+      "type": "string",
+      "description": "Unique identifier for the test."
+    },
+    "description": {
+      "type": "string",
+      "description": "Description of the test."
+    },
+    "file": {
+      "type": "string",
+      "description": "Path to the file that the test is associated with."
+    },
+    "detectSteps": {
+      "type": "boolean",
+      "description": "Whether or not to detect steps in input files based on markup regex. Defaults to `true`."
+    },
+    "contexts": {
+      "type": "array",
+      "description": "Application/platform sets to run the test in. Overrides `contexts` defined at the config-level and spec-level.",
+      "items": {
+        "oneOf": [
+          {
+            "$ref": "context_v2.schema.json#"
+          }
+        ]
+      }
+    },
+    "openApi": {
+      "type": "array",
+      "items": {
+        "allOf": [
+          {
+            "$ref": "openApi_v2.schema.json#"
+          },
+          {
+            "type": "object",
+            "properties": {
+              "operationId": {
+                "type": "null",
+                "$commment": "Only allow operationId at the step level."
+              }
+            },
+            "required": ["name", "descriptionPath"]
+          }
+        ]
+      }
+    },
+    "setup": {
+      "type": "string",
+      "description": "Path to a test specification to perform before this test, while maintaining this test's context. Useful for setting up testing environments. Only the `steps` property is used from the first test in the setup spec."
+    },
+    "cleanup": {
+      "type": "string",
+      "description": "Path to a test specification to perform after this test, while maintaining this test's context. Useful for cleaning up testing environments. Only the `steps` property is used from the first test in the cleanup spec."
+    },
+    "steps": {
+      "description": "Actions to perform as part of the test. Performed in the sequence defined. If one or more actions fail, the test fails.",
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "anyOf": [
+          { "$ref": "checkLink_v2.schema.json#" },
+          { "$ref": "goTo_v2.schema.json#" },
+          { "$ref": "httpRequest_v2.schema.json#" },
+          { "$ref": "runShell_v2.schema.json#" },
+          { "$ref": "saveScreenshot_v2.schema.json#" },
+          { "$ref": "setVariables_v2.schema.json#" },
+          { "$ref": "startRecording_v2.schema.json#" },
+          { "$ref": "stopRecording_v2.schema.json#" },
+          { "$ref": "typeKeys_v2.schema.json#" },
+          { "$ref": "find_v2.schema.json#" },
+          { "$ref": "wait_v2.schema.json#" }
+        ]
+      }
+    }
+  },
+  "dynamicDefaults": {
+    "id": "uuid"
+  },
+  "required": ["steps"],
+  "additionalProperties": false,
+  "examples": [
+    {
+      "steps": [
+        {
+          "action": "checkLink",
+          "url": "https://www.duckduckgo.com"
+        }
+      ]
+    },
+    {
+      "steps": [
+        {
+          "action": "goTo",
+          "url": "https://www.duckduckgo.com"
+        },
+        {
+          "action": "find",
+          "selector": "[title=Search]",
+          "click": true,
+          "typeKeys": {
+            "keys": ["shorthair cats", "$ENTER$"]
+          }
+        }
+      ]
+    },
+    {
+      "id": "Do all the things! - Test",
+      "description": "This test includes every property across all actions.",
+      "contexts": [
+        {
+          "app": {
+            "name": "firefox",
+            "path": "/usr/bin/firefox"
+          },
+          "platforms": ["linux"]
+        }
+      ],
+      "setup": "setup.json",
+      "cleanup": "cleanup.json",
+      "steps": [
+        {
+          "action": "setVariables",
+          "path": ".env"
+        },
+        {
+          "action": "runShell",
+          "command": "echo",
+          "args": ["$USER"]
+        },
+        {
+          "action": "checkLink",
+          "url": "https://www.duckduckgo.com"
+        },
+        {
+          "action": "httpRequest",
+          "url": "https://reqres.in/api/users",
+          "method": "post",
+          "requestData": {
+            "name": "morpheus",
+            "job": "leader"
+          },
+          "responseData": {
+            "name": "morpheus",
+            "job": "leader"
+          },
+          "statusCodes": [200, 201]
+        },
+        {
+          "action": "goTo",
+          "url": "https://www.duckduckgo.com"
+        },
+        {
+          "action": "find",
+          "selector": "[title=Search]",
+          "timeout": 10000,
+          "matchText": "Search",
+          "moveTo": true,
+          "click": true,
+          "typeKeys": {
+            "keys": ["shorthair cat"]
+          }
+        },
+        {
+          "action": "typeKeys",
+          "keys": ["$ENTER$"]
+        },
+        {
+          "action": "saveScreenshot"
+        }
+      ]
+    },
+    {
+      "openApi": [
+        {
+          "name": "Acme",
+          "descriptionPath": "https://www.acme.com/openapi.json",
+          "server": "https://api.acme.com"
+        }
+      ],
+      "steps": [
+        {
+          "action": "httpRequest",
+          "openApi": {
+            "operationId": "getUserById"
+          },
+          "requestParams": {
+            "id": 123
+          }
+        }
+      ]
+    }
+]
+}

package/src/schemas/src_schemas/typeKeys_v2.schema.json

@@ -1,63 +1,63 @@
-{
-  "title": "typeKeys",
-  "type": "object",
-  "description": "Type keys. To type special keys, begin and end the string with `$` and use the special key's enum. For example, to type the Escape key, enter `$ESCAPE$`.",
-  "properties": {
-    "id": {
-      "type": "string",
-      "description": "ID of the step."
-    },
-    "description": {
-      "type": "string",
-      "description": "Description of the step."
-    },
-    "action": {
-      "type": "string",
-      "const": "typeKeys",
-      "description": "The action to perform."
-    },
-    "keys": {
-      "description": "String of keys to enter.",
-      "anyOf": [
-        {
-          "type": "string"
-        },
-        {
-          "type": "array",
-          "items": {
-            "oneOf": [
-              {
-                "type": "string"
-              }
-            ]
-          }
-        }
-      ]
-    },
-    "delay": {
-      "type": "number",
-      "description": "Delay in milliseconds between each key press. Only valid during a recording.",
-      "default": 100
-    }
-  },
-  "dynamicDefaults": {
-    "id": "uuid"
-  },
-  "required": ["action", "keys"],
-  "additionalProperties": false,
-  "examples": [
-    {
-      "action": "typeKeys",
-      "keys": "kittens"
-    },
-    {
-      "action": "typeKeys",
-      "keys": ["$ENTER$"]
-    },
-    {
-      "action": "typeKeys",
-      "keys": ["kittens","$ENTER$"],
-      "delay": 500
-    }
-  ]
-}
+{
+  "title": "typeKeys",
+  "type": "object",
+  "description": "Type keys. To type special keys, begin and end the string with `$` and use the special key's enum. For example, to type the Escape key, enter `$ESCAPE$`.",
+  "properties": {
+    "id": {
+      "type": "string",
+      "description": "ID of the step."
+    },
+    "description": {
+      "type": "string",
+      "description": "Description of the step."
+    },
+    "action": {
+      "type": "string",
+      "const": "typeKeys",
+      "description": "The action to perform."
+    },
+    "keys": {
+      "description": "String of keys to enter.",
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "array",
+          "items": {
+            "oneOf": [
+              {
+                "type": "string"
+              }
+            ]
+          }
+        }
+      ]
+    },
+    "delay": {
+      "type": "number",
+      "description": "Delay in milliseconds between each key press. Only valid during a recording.",
+      "default": 100
+    }
+  },
+  "dynamicDefaults": {
+    "id": "uuid"
+  },
+  "required": ["action", "keys"],
+  "additionalProperties": false,
+  "examples": [
+    {
+      "action": "typeKeys",
+      "keys": "kittens"
+    },
+    {
+      "action": "typeKeys",
+      "keys": ["$ENTER$"]
+    },
+    {
+      "action": "typeKeys",
+      "keys": ["kittens","$ENTER$"],
+      "delay": 500
+    }
+  ]
+}

package/test/files.test.js

@@ -0,0 +1,107 @@
+const sinon = require("sinon");
+const axios = require("axios");
+const fs = require("fs");
+const { readFile } = require("../src/files");
+
+(async () => {
+  const { expect } = await import("chai");
+
+  describe("readFile", function () {
+    let axiosGetStub;
+    let fsReadFileStub;
+
+    beforeEach(function () {
+      axiosGetStub = sinon.stub(axios, "get");
+      fsReadFileStub = sinon.stub(fs.promises, "readFile");
+    });
+
+    afterEach(function () {
+      sinon.restore();
+    });
+
+    it("should read a remote JSON file", async function () {
+      const fileURL = "http://example.com/file.json";
+      const fileContent = '{"key": "value"}';
+      axiosGetStub.resolves({ data: fileContent });
+
+      const result = await readFile(fileURL);
+
+      expect(result).to.deep.equal({ key: "value" });
+      expect(axiosGetStub.calledOnceWith(fileURL)).to.be.true;
+    });
+
+    it("should read a remote YAML file", async function () {
+      const fileURL = "http://example.com/file.yaml";
+      const fileContent = "key: value";
+      axiosGetStub.resolves({ data: fileContent });
+
+      const result = await readFile(fileURL);
+
+      expect(result).to.deep.equal({ key: "value" });
+      expect(axiosGetStub.calledOnceWith(fileURL)).to.be.true;
+    });
+
+    it("should read a local JSON file", async function () {
+      const filePath = "/path/to/file.json";
+      const fileContent = '{"key": "value"}';
+      fsReadFileStub.resolves(fileContent);
+
+      const result = await readFile(filePath);
+
+      expect(result).to.deep.equal({ key: "value" });
+      expect(fsReadFileStub.calledOnceWith(filePath, "utf8")).to.be.true;
+    });
+
+    it("should read a local YAML file", async function () {
+      const filePath = "/path/to/file.yaml";
+      const fileContent = "key: value";
+      fsReadFileStub.resolves(fileContent);
+
+      const result = await readFile(filePath);
+
+      expect(result).to.deep.equal({ key: "value" });
+      expect(fsReadFileStub.calledOnceWith(filePath, "utf8")).to.be.true;
+    });
+
+    it("should return raw content for non-JSON/YAML files", async function () {
+      const filePath = "/path/to/file.txt";
+      const fileContent = "plain text content";
+      fsReadFileStub.resolves(fileContent);
+
+      const result = await readFile(filePath);
+
+      expect(result).to.equal(fileContent);
+      expect(fsReadFileStub.calledOnceWith(filePath, "utf8")).to.be.true;
+    });
+
+    it("should return null if remote file cannot be read", async function () {
+      const fileURL = "http://example.com/file.json";
+      axiosGetStub.rejects(new Error("Network error"));
+
+      const result = await readFile(fileURL);
+
+      expect(result).to.be.null;
+      expect(axiosGetStub.calledOnceWith(fileURL)).to.be.true;
+    });
+
+    it("should return null if local file cannot be found", async function () {
+      const filePath = "/path/to/nonexistent.json";
+      fsReadFileStub.rejects({ code: "ENOENT" });
+
+      const result = await readFile(filePath);
+
+      expect(result).to.be.null;
+      expect(fsReadFileStub.calledOnceWith(filePath, "utf8")).to.be.true;
+    });
+
+    it("should return null if local file read error occurs", async function () {
+      const filePath = "/path/to/file.json";
+      fsReadFileStub.rejects(new Error("Read error"));
+
+      const result = await readFile(filePath);
+
+      expect(result).to.be.null;
+      expect(fsReadFileStub.calledOnceWith(filePath, "utf8")).to.be.true;
+    });
+  });
+})();

package/test/schema.test.js

@@ -1,21 +1,31 @@
 const { validate, schemas } = require("../src/index");
+const assert = require("assert");
 
 // Loop through JSON schemas
 for (const [key, value] of Object.entries(schemas)) {
-  test(`${key} schema has one or more examples`, () => {
-    // Schema needs one or more examples
-    expect(value.examples).toBeTruthy();
-    expect(value.examples.length).toBeGreaterThanOrEqual(1);
-  });
-  // Loop through and validate schema examples
-  value.examples.forEach((example, index) => {
-    test(`${key} example with index ${index} passes validation`, () => {
-      const validityCheck = validate(key, example);
-      if (validityCheck.errors != "") {
-        console.log(key);
-        console.log(validityCheck.errors);
-      }
-      expect(validityCheck.valid).toBe(true);
+  describe(`${key} schema`, function () {
+    it("should have one or more examples", function () {
+      // Schema needs one or more examples
+      assert(value.examples);
+      assert(value.examples.length >= 1);
+    });
+
+    // Loop through and validate schema examples
+    value.examples.forEach((example, index) => {
+      it(`example with index ${index} passes validation`, function () {
+        try {
+          const validityCheck = validate(key, example);
+          assert.ok(
+            validityCheck.valid,
+            true,
+            `Validation failed for ${key}, example ${index}: ${validityCheck.errors}`
+          );
+        } catch (error) {
+          assert.fail(
+            `Unexpected error during validation of ${key}, example ${index}: ${error.message}`
+          );
+        }
+      });
     });
   });
 }