doc-detective 2.13.0-dev.0 → 2.13.1

package/test/utils.test.js

@@ -1,204 +1,210 @@
-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 fs = require("fs");
+
+before(async function () {
+  const { expect } = await import("chai");
+  global.expect = expect;
+});
+
+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);
+    }
+  });
+}

package/.doc-detective.json

@@ -1,63 +0,0 @@
-{
-  "envVariables": "./samples/variables.env",
-  "input": ".",
-  "output": ".",
-  "recursive": true,
-  "logLevel": "info",
-  "runTests": {
-    "detectSteps": true,
-    "input": "./samples/doc-content.md",
-    "output": "./samples",
-    "recursive": true,
-    "mediaDirectory": "./samples",
-    "downloadDirectory": "./samples"
-  },
-  "fileTypes": [
-    {
-      "name": "Markdown",
-      "extensions": [".md"],
-      "testStartStatementOpen": "[comment]: # (test start",
-      "testStartStatementClose": ")",
-      "testIgnoreStatement": "[comment]: # (test ignore)",
-      "testEndStatement": "[comment]: # (test end)",
-      "stepStatementOpen": "[comment]: # (step",
-      "stepStatementClose": ")",
-      "markup": [
-        {
-          "name": "Hyperlink",
-          "regex": ["(?<=(?<!!)\\[[\\w\\s]+\\]\\().*?(?=\\))"],
-          "actions": ["checkLink"]
-        },
-        {
-          "name": "Navigation link",
-          "regex": ["(?<=([Oo]pen|[Cc]lick) (?<!!)\\[[\\w\\s]+\\]\\().*?(?=\\))"],
-          "actions": ["goTo"]
-        },
-        {
-          "name": "Onscreen text",
-          "regex": ["(?<=\\*\\*)[\\w\\s]+?(?=\\*\\*)"],
-          "actions": ["find"]
-        },
-        {
-          "name": "Image",
-          "regex": ["(?<=\\!\\[.*?\\]\\().*?(?=\\))"],
-          "actions": [
-            {
-              "name": "saveScreenshot",
-              "params": {
-                "directory": "samples",
-                "maxVariation": 5,
-                "overwrite": "byVariation"
-              }
-            }
-          ]
-        }
-      ]
-    }
-  ],
-  "telemetry": {
-    "send": true,
-    "userId": "Doc Detective Repo"
-  },
-  "defaultCommand": "runTests"
-}