doc-detective 2.11.4-dev.1 → 2.11.4-dev.2

package/test/test-results.json

@@ -1,125 +1,125 @@
-{
-  "summary": {
-    "specs": {
-      "pass": 1,
-      "fail": 0,
-      "warning": 0,
-      "skipped": 0
-    },
-    "tests": {
-      "pass": 1,
-      "fail": 0,
-      "warning": 0,
-      "skipped": 0
-    },
-    "contexts": {
-      "pass": 1,
-      "fail": 0,
-      "warning": 0,
-      "skipped": 0
-    },
-    "steps": {
-      "pass": 6,
-      "fail": 0,
-      "warning": 0,
-      "skipped": 0
-    }
-  },
-  "specs": [
-    {
-      "result": "PASS",
-      "id": "Do all the things! - Spec",
-      "tests": [
-        {
-          "result": "PASS",
-          "id": "Do all the things! - Test",
-          "contexts": [
-            {
-              "result": "PASS",
-              "app": "firefox",
-              "platform": "linux",
-              "steps": [
-                {
-                  "result": "PASS",
-                  "resultDescription": "Set variables.",
-                  "action": "setVariables",
-                  "path": ".env",
-                  "id": "2606bcf3-2f45-4c4d-82a1-61392f5e8917"
-                },
-                {
-                  "result": "PASS",
-                  "resultDescription": "Executed command.",
-                  "action": "runShell",
-                  "command": "echo",
-                  "args": [
-                    "hawkeyexl"
-                  ],
-                  "id": "a15d25e8-6fa3-49c5-be3d-ae5aca0715e5"
-                },
-                {
-                  "result": "PASS",
-                  "resultDescription": "Returned 200",
-                  "action": "checkLink",
-                  "url": "https://www.duckduckgo.com",
-                  "id": "a4c44478-9756-4227-a63b-aa2d49aa4511",
-                  "statusCodes": [
-                    200
-                  ]
-                },
-                {
-                  "result": "PASS",
-                  "resultDescription": "Returned 201. Expected response data was present in actual response data.",
-                  "action": "httpRequest",
-                  "url": "https://reqres.in/api/users",
-                  "method": "post",
-                  "requestData": {
-                    "name": "morpheus",
-                    "job": "leader"
-                  },
-                  "responseData": {
-                    "name": "morpheus",
-                    "job": "leader"
-                  },
-                  "statusCodes": [
-                    200,
-                    201
-                  ],
-                  "id": "fd520fd4-f32f-428b-a072-c2b2cffe3a3c",
-                  "requestHeaders": {},
-                  "responseHeaders": {},
-                  "requestParams": {},
-                  "responseParams": {},
-                  "envsFromResponseData": []
-                },
-                {
-                  "result": "PASS",
-                  "resultDescription": "Opened URL.",
-                  "action": "goTo",
-                  "url": "https://www.google.com",
-                  "id": "d6b47d3d-42db-45a7-8fde-3633adf30411"
-                },
-                {
-                  "result": "PASS",
-                  "resultDescription": "Found an element matching selector. Moved to element. Clicked element. Typed keys.",
-                  "action": "find",
-                  "selector": "[title=Search]",
-                  "timeout": 10000,
-                  "moveTo": true,
-                  "click": true,
-                  "typeKeys": {
-                    "keys": [
-                      "shorthair cat",
-                      "$ENTER$"
-                    ]
-                  },
-                  "id": "0d631a5b-6e96-4031-8d04-52d270f6e251"
-                }
-              ]
-            }
-          ],
-          "description": "This test includes nearly every property across all actions."
-        }
-      ]
-    }
-  ]
+{
+  "summary": {
+    "specs": {
+      "pass": 1,
+      "fail": 0,
+      "warning": 0,
+      "skipped": 0
+    },
+    "tests": {
+      "pass": 1,
+      "fail": 0,
+      "warning": 0,
+      "skipped": 0
+    },
+    "contexts": {
+      "pass": 1,
+      "fail": 0,
+      "warning": 0,
+      "skipped": 0
+    },
+    "steps": {
+      "pass": 6,
+      "fail": 0,
+      "warning": 0,
+      "skipped": 0
+    }
+  },
+  "specs": [
+    {
+      "result": "PASS",
+      "id": "Do all the things! - Spec",
+      "tests": [
+        {
+          "result": "PASS",
+          "id": "Do all the things! - Test",
+          "contexts": [
+            {
+              "result": "PASS",
+              "app": "firefox",
+              "platform": "linux",
+              "steps": [
+                {
+                  "result": "PASS",
+                  "resultDescription": "Set variables.",
+                  "action": "setVariables",
+                  "path": ".env",
+                  "id": "2606bcf3-2f45-4c4d-82a1-61392f5e8917"
+                },
+                {
+                  "result": "PASS",
+                  "resultDescription": "Executed command.",
+                  "action": "runShell",
+                  "command": "echo",
+                  "args": [
+                    "hawkeyexl"
+                  ],
+                  "id": "a15d25e8-6fa3-49c5-be3d-ae5aca0715e5"
+                },
+                {
+                  "result": "PASS",
+                  "resultDescription": "Returned 200",
+                  "action": "checkLink",
+                  "url": "https://www.duckduckgo.com",
+                  "id": "a4c44478-9756-4227-a63b-aa2d49aa4511",
+                  "statusCodes": [
+                    200
+                  ]
+                },
+                {
+                  "result": "PASS",
+                  "resultDescription": "Returned 201. Expected response data was present in actual response data.",
+                  "action": "httpRequest",
+                  "url": "https://reqres.in/api/users",
+                  "method": "post",
+                  "requestData": {
+                    "name": "morpheus",
+                    "job": "leader"
+                  },
+                  "responseData": {
+                    "name": "morpheus",
+                    "job": "leader"
+                  },
+                  "statusCodes": [
+                    200,
+                    201
+                  ],
+                  "id": "fd520fd4-f32f-428b-a072-c2b2cffe3a3c",
+                  "requestHeaders": {},
+                  "responseHeaders": {},
+                  "requestParams": {},
+                  "responseParams": {},
+                  "envsFromResponseData": []
+                },
+                {
+                  "result": "PASS",
+                  "resultDescription": "Opened URL.",
+                  "action": "goTo",
+                  "url": "https://www.google.com",
+                  "id": "d6b47d3d-42db-45a7-8fde-3633adf30411"
+                },
+                {
+                  "result": "PASS",
+                  "resultDescription": "Found an element matching selector. Moved to element. Clicked element. Typed keys.",
+                  "action": "find",
+                  "selector": "[title=Search]",
+                  "timeout": 10000,
+                  "moveTo": true,
+                  "click": true,
+                  "typeKeys": {
+                    "keys": [
+                      "shorthair cat",
+                      "$ENTER$"
+                    ]
+                  },
+                  "id": "0d631a5b-6e96-4031-8d04-52d270f6e251"
+                }
+              ]
+            }
+          ],
+          "description": "This test includes nearly every property across all actions."
+        }
+      ]
+    }
+  ]
 }

package/test/utils.test.js

@@ -1,204 +1,206 @@
-const { setArgs, setConfig, outputResults } = require("../src/utils");
-const path = require("path");
-const { expect, should, assert } = require("chai");
-const fs = require("fs");
-
-describe("Util tests", function () {
-  // Test that arguments are parsed correctly
-  it("Yargs parses arguments correctly", function () {
-    const argSets = [
-      {
-        args: ["node", "runTests.js", "--input", "input.spec.json"],
-        expected: { i: "input.spec.json" },
-      },
-      {
-        args: [
-          "node",
-          "runTests.js",
-          "--input",
-          "input.spec.json",
-          "--logLevel",
-          "debug",
-        ],
-        expected: { i: "input.spec.json", l: "debug" },
-      },
-      {
-        args: [
-          "node",
-          "runTests.js",
-          "--input",
-          "input.spec.json",
-          "--logLevel",
-          "debug",
-          "--config",
-          "config.json",
-        ],
-
-        expected: { i: "input.spec.json", l: "debug", c: "config.json" },
-      },
-      {
-        args: [
-          "node",
-          "runTests.js",
-          "--input",
-          "input.spec.json",
-          "--output",
-          ".",
-          "--logLevel",
-          "debug",
-          "--config",
-          "config.json",
-        ],
-        expected: {
-          i: "input.spec.json",
-          o: ".",
-          l: "debug",
-          c: "config.json",
-        },
-      },
-      {
-        args: [
-          "node",
-          "runTests.js",
-          "--input",
-          "input.spec.json",
-          "--output",
-          ".",
-          "--logLevel",
-          "debug",
-          "--config",
-          "config.json",
-          "--recursive",
-          "false",
-          "--setup",
-          "setup.spec.json",
-          "--cleanup",
-          "cleanup.spec.json",
-        ],
-        expected: {
-          i: "input.spec.json",
-          o: ".",
-          l: "debug",
-          c: "config.json",
-          r: "false",
-          setup: "setup.spec.json",
-          cleanup: "cleanup.spec.json",
-        },
-      },
-    ];
-    argSets.forEach((argSet) => {
-      expect(setArgs(argSet.args)).to.deep.include(argSet.expected);
-    });
-  });
-
-  // Test that config overrides are set correctly
-  it("Config overrides are set correctly", function () {
-    configSets = [
-      {
-        // Input override
-        args: ["node", "runTests.js", "--input", "input.spec.json"],
-        expected: { input: "input.spec.json" },
-      },
-      {
-        // Input and logLevel overrides
-        args: [
-          "node",
-          "runTests.js",
-          "--input",
-          "input.spec.json",
-          "--logLevel",
-          "debug",
-        ],
-        expected: { input: "input.spec.json", logLevel: "debug" },
-      },
-      {
-        // Input, logLevel, and setup overrides
-        args: [
-          "node",
-          "runTests.js",
-          "--input",
-          "input.spec.json",
-          "--logLevel",
-          "debug",
-          "--setup",
-          "setup.spec.json",
-        ],
-        expected: {
-          input: "input.spec.json",
-          logLevel: "debug",
-          runTests: { setup: "setup.spec.json" },
-        },
-      },
-      {
-        // Referenced config without overrides
-        args: ["node", "runTests.js", "--config", "./test/test-config.json"],
-        expected: {
-          input: ".",
-          output: ".",
-          logLevel: "silent",
-          recursive: true,
-          runTests: {
-            setup: ".",
-            cleanup: ".",
-          },
-        },
-      },
-      {
-        // Referenced config with overrides
-        args: [
-          "node",
-          "runTests.js",
-          "--config",
-          "./test/test-config.json",
-          "--input",
-          "input.spec.json",
-        ],
-        expected: {
-          input: "input.spec.json",
-          output: ".",
-          logLevel: "silent",
-          recursive: true,
-          runTests: {
-            setup: ".",
-            cleanup: ".",
-          },
-        },
-      },
-    ];
-
-    configSets.forEach((configSet) => {
-      const configResult = setConfig({}, setArgs(configSet.args));
-      deepObjectExpect(configResult, configSet.expected);
-    });
-  });
-
-  // Test that results output correctly.
-  it("Results output correctly", async () => {
-    // Output test-results.json, make sure it exists, and clean it up.
-    const inputResultsPath = path.resolve("./test/test-results.json");
-    const inputResultsJSON = require(inputResultsPath);
-    const outputResultsPath = path.resolve("./test/output-test-results.json");
-    // Output results
-    await outputResults(null, outputResultsPath, inputResultsJSON);
-    // Check that output file exists
-    expect(fs.existsSync(outputResultsPath)).to.equal(true);
-    // Clean up
-    fs.unlinkSync(outputResultsPath);
-  });
-});
-
-// Deeply compares two objects
-function deepObjectExpect(actual, expected) {
-  // Check that actual has all the keys of expected
-  Object.entries(expected).forEach(([key, value]) => {
-    // If value is an object, recursively check it
-    if (typeof value === "object") {
-      deepObjectExpect(actual[key], expected[key]);
-    } else {
-      // Otherwise, check that the value is correct
-      const expectedObject = {};
-      expectedObject[key] = value;
-      expect(actual).to.deep.include(expectedObject);
-    }
-  });
-}
+const { setArgs, setConfig, outputResults } = require("../src/utils");
+const path = require("path");
+const { expect, should, assert } = require("chai");
+const fs = require("fs");
+
+describe("Util tests", function () {
+  // Test that arguments are parsed correctly
+  it("Yargs parses arguments correctly", function () {
+    const argSets = [
+      {
+        args: ["node", "runTests.js", "--input", "input.spec.json"],
+        expected: { i: "input.spec.json" },
+      },
+      {
+        args: [
+          "node",
+          "runTests.js",
+          "--input",
+          "input.spec.json",
+          "--logLevel",
+          "debug",
+        ],
+        expected: { i: "input.spec.json", l: "debug" },
+      },
+      {
+        args: [
+          "node",
+          "runTests.js",
+          "--input",
+          "input.spec.json",
+          "--logLevel",
+          "debug",
+          "--config",
+          "config.json",
+        ],
+
+        expected: { i: "input.spec.json", l: "debug", c: "config.json" },
+      },
+      {
+        args: [
+          "node",
+          "runTests.js",
+          "--input",
+          "input.spec.json",
+          "--output",
+          ".",
+          "--logLevel",
+          "debug",
+          "--config",
+          "config.json",
+        ],
+        expected: {
+          i: "input.spec.json",
+          o: ".",
+          l: "debug",
+          c: "config.json",
+        },
+      },
+      {
+        args: [
+          "node",
+          "runTests.js",
+          "--input",
+          "input.spec.json",
+          "--output",
+          ".",
+          "--logLevel",
+          "debug",
+          "--config",
+          "config.json",
+          "--recursive",
+          "false",
+          "--setup",
+          "setup.spec.json",
+          "--cleanup",
+          "cleanup.spec.json",
+        ],
+        expected: {
+          i: "input.spec.json",
+          o: ".",
+          l: "debug",
+          c: "config.json",
+          r: "false",
+          setup: "setup.spec.json",
+          cleanup: "cleanup.spec.json",
+        },
+      },
+    ];
+    argSets.forEach((argSet) => {
+      expect(setArgs(argSet.args)).to.deep.include(argSet.expected);
+    });
+  });
+
+  // Test that config overrides are set correctly
+  it("Config overrides are set correctly", function () {
+    configSets = [
+      {
+        // Input override
+        args: ["node", "runTests.js", "--input", "input.spec.json"],
+        expected: { input: "input.spec.json" },
+      },
+      {
+        // Input and logLevel overrides
+        args: [
+          "node",
+          "runTests.js",
+          "--input",
+          "input.spec.json",
+          "--logLevel",
+          "debug",
+        ],
+        expected: { input: "input.spec.json", logLevel: "debug" },
+      },
+      {
+        // Input, logLevel, and setup overrides
+        args: [
+          "node",
+          "runTests.js",
+          "--input",
+          "input.spec.json",
+          "--logLevel",
+          "debug",
+          "--setup",
+          "setup.spec.json",
+        ],
+        expected: {
+          input: "input.spec.json",
+          logLevel: "debug",
+          runTests: { setup: "setup.spec.json" },
+        },
+      },
+      {
+        // Referenced config without overrides
+        args: ["node", "runTests.js", "--config", "./test/test-config.json"],
+        expected: {
+          input: ".",
+          output: ".",
+          logLevel: "silent",
+          recursive: true,
+          runTests: {
+            setup: ".",
+            cleanup: ".",
+          },
+        },
+      },
+      {
+        // Referenced config with overrides
+        args: [
+          "node",
+          "runTests.js",
+          "--config",
+          "./test/test-config.json",
+          "--input",
+          "input.spec.json",
+        ],
+        expected: {
+          input: "input.spec.json",
+          output: ".",
+          logLevel: "silent",
+          recursive: true,
+          runTests: {
+            setup: ".",
+            cleanup: ".",
+          },
+        },
+      },
+    ];
+
+    configSets.forEach((configSet) => {
+      const configResult = setConfig({}, setArgs(configSet.args));
+      deepObjectExpect(configResult, configSet.expected);
+    });
+  });
+
+  // Test that results output correctly.
+  it("Results output correctly", async () => {
+    // Output test-results.json, make sure it exists, and clean it up.
+    const inputResultsPath = path.resolve("./test/test-results.json");
+    const inputResultsJSON = require(inputResultsPath);
+    const outputResultsPath = path.resolve("./test/output-test-results.json");
+    // Check that input file exists
+    expect(fs.existsSync(inputResultsPath)).to.equal(true);
+    // Output results
+    await outputResults(null, outputResultsPath, inputResultsJSON);
+    // Check that output file exists
+    expect(fs.existsSync(outputResultsPath)).to.equal(true);
+    // Clean up
+    fs.unlinkSync(outputResultsPath);
+  });
+});
+
+// Deeply compares two objects
+function deepObjectExpect(actual, expected) {
+  // Check that actual has all the keys of expected
+  Object.entries(expected).forEach(([key, value]) => {
+    // If value is an object, recursively check it
+    if (typeof value === "object") {
+      deepObjectExpect(actual[key], expected[key]);
+    } else {
+      // Otherwise, check that the value is correct
+      const expectedObject = {};
+      expectedObject[key] = value;
+      expect(actual).to.deep.include(expectedObject);
+    }
+  });
+}