doc-detective 2.16.0-dev.0 → 2.16.0

package/test/artifacts/env

@@ -1,3 +1,3 @@
-USER="John Doe"
-JOB="Software Engineer"
+USER="John Doe"
+JOB="Software Engineer"
 SECRET="YOUR_SECRET_KEY"

package/test/artifacts/httpRequest.spec.json

@@ -1,55 +1,55 @@
-{
-  "id": "http tests",
-  "description": "This is a test collection",
-  "tests": [
-    {
-      "id": "env variables test",
-      "description": "These tests will show off how using env files to set variables works in Doc Detective.",
-      "steps": [
-        {
-          "action": "setVariables",
-          "path": "test/artifacts/env"
-        },
-        {
-          "action": "httpRequest",
-          "url": "https://reqres.in/api/users",
-          "method": "post",
-          "requestData": {
-            "auth": "$SECRET",
-            "name": "$USER",
-            "job": "$JOB"
-          },
-          "responseData": {
-            "name": "John Doe",
-            "job": "Software Engineer"
-          },
-          "statusCodes": [200, 201]
-        },
-        {
-          "action": "httpRequest",
-          "url": "https://reqres.in/api/users",
-          "method": "get",
-          "envsFromResponseData": [
-            {
-              "name": "ID",
-              "jqFilter": ".data[0].id"
-            }
-          ],
-          "statusCodes": [200, 201]
-        },
-        {
-          "action": "httpRequest",
-          "url": "https://reqres.in/api/users/$ID",
-          "method": "get",
-          "responseData": {
-            "data": {
-              "first_name": "George",
-              "last_name": "Bluth"
-            }
-          },
-          "statusCodes": [200, 201]
-        }
-      ]
-    }
-  ]
-}
+{
+  "id": "http tests",
+  "description": "This is a test collection",
+  "tests": [
+    {
+      "id": "env variables test",
+      "description": "These tests will show off how using env files to set variables works in Doc Detective.",
+      "steps": [
+        {
+          "action": "setVariables",
+          "path": "env"
+        },
+        {
+          "action": "httpRequest",
+          "url": "https://reqres.in/api/users",
+          "method": "post",
+          "requestData": {
+            "auth": "$SECRET",
+            "name": "$USER",
+            "job": "$JOB"
+          },
+          "responseData": {
+            "name": "John Doe",
+            "job": "Software Engineer"
+          },
+          "statusCodes": [200, 201]
+        },
+        {
+          "action": "httpRequest",
+          "url": "https://reqres.in/api/users",
+          "method": "get",
+          "envsFromResponseData": [
+            {
+              "name": "ID",
+              "jqFilter": ".data[0].id"
+            }
+          ],
+          "statusCodes": [200, 201]
+        },
+        {
+          "action": "httpRequest",
+          "url": "https://reqres.in/api/users/$ID",
+          "method": "get",
+          "responseData": {
+            "data": {
+              "first_name": "George",
+              "last_name": "Bluth"
+            }
+          },
+          "statusCodes": [200, 201]
+        }
+      ]
+    }
+  ]
+}

package/test/artifacts/runShell.spec.json

@@ -1,29 +1,29 @@
-{
-  "id": "setup",
-  "tests": [
-    {
-      "steps": [
-        {
-          "action": "runShell",
-          "command": "echo",
-          "args": ["setup"],
-          "exitCodes": [0],
-          "output": "/.*?/",
-          "setVariables": [
-            {
-              "name": "TEST",
-              "regex": ".*"
-            }
-          ]
-        },
-        {
-          "action": "runShell",
-          "command": "echo",
-          "args": ["$TEST"],
-          "exitCodes": [0],
-          "output": "setup"
-        }
-      ]
-    }
-  ]
-}
+{
+  "id": "setup",
+  "tests": [
+    {
+      "steps": [
+        {
+          "action": "runShell",
+          "command": "echo",
+          "args": ["setup"],
+          "exitCodes": [0],
+          "output": "/.*?/",
+          "setVariables": [
+            {
+              "name": "TEST",
+              "regex": ".*"
+            }
+          ]
+        },
+        {
+          "action": "runShell",
+          "command": "echo",
+          "args": ["$TEST"],
+          "exitCodes": [0],
+          "output": "setup"
+        }
+      ]
+    }
+  ]
+}

package/test/artifacts/setup.spec.json

@@ -1,18 +1,18 @@
-{
-  "id": "setup",
-  "tests": [
-    {
-      "steps": [
-        {
-          "action": "setVariables",
-          "path": ".env"
-        },
-        {
-          "action": "runShell",
-          "command": "echo",
-          "args": ["setup"]
-        }
-      ]
-    }
-  ]
-}
+{
+  "id": "setup",
+  "tests": [
+    {
+      "steps": [
+        {
+          "action": "setVariables",
+          "path": ".env"
+        },
+        {
+          "action": "runShell",
+          "command": "echo",
+          "args": ["setup"]
+        }
+      ]
+    }
+  ]
+}

package/test/artifacts/test.spec.json

@@ -1,60 +1,60 @@
-{
-  "id": "Do all the things! - Spec",
-  "tests": [
-    {
-      "id": "Do all the things! - Test",
-      "description": "This test includes nearly every property across all actions.",
-      "setup": "setup.spec.json",
-      "cleanup": "cleanup.spec.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.google.com"
-        },
-        { 
-          "action": "startRecording"
-        },
-        {
-          "action": "find",
-          "selector": "[title=Search]",
-          "timeout": 10000,
-          "moveTo": true,
-          "click": true,
-          "typeKeys": {
-            "keys": ["shorthair cat", "$ENTER$"]
-          }
-        },
-        {
-          "action": "stopRecording"
-        }
-      ]
-    }
-  ]
-}
+{
+  "id": "Do all the things! - Spec",
+  "tests": [
+    {
+      "id": "Do all the things! - Test",
+      "description": "This test includes nearly every property across all actions.",
+      "setup": "setup.spec.json",
+      "cleanup": "cleanup.spec.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.google.com"
+        },
+        { 
+          "action": "startRecording"
+        },
+        {
+          "action": "find",
+          "selector": "[title=Search]",
+          "timeout": 10000,
+          "moveTo": true,
+          "click": true,
+          "typeKeys": {
+            "keys": ["shorthair cat", "$ENTER$"]
+          }
+        },
+        {
+          "action": "stopRecording"
+        }
+      ]
+    }
+  ]
+}

package/test/runCoverage.test.js

@@ -1,24 +1,20 @@
-const path = require("path");
-const { spawnCommand } = require(path.resolve(__dirname,"../src/utils"));
-const assert = require("assert").strict;
-const fs = require("fs");
-const artifactPath = path.resolve(__dirname,"./artifacts");
-
-describe("Perform coverage analysis successfully", function () {
-  // Set indefinite timeout
-  this.timeout(0);
-  it("Should have 6 covered and 0 uncovered", async () => {
-    const coverateResults = await spawnCommand(`node ./src/index.js runCoverage -c ${artifactPath}/config.json -i ${artifactPath}/doc-content.md -o ${artifactPath}`);
-    // Find output file
-    // console.log(coverateResults.stdout)
-    const outputFiles = coverateResults.stdout.split("See results at ");
-    const outputFile = outputFiles[outputFiles.length - 1].trim();
-    // If output file is not found, throw an error 
-    if (!outputFile) {
-      throw new Error(`Output file not found.\nOutput file: ${outputFile}\nCWD: ${process.cwd()}\nstdout: ${coverateResults.stdout}`);
-    }
-    const result = require(outputFile);
-    assert.equal(result.summary.covered, 6);
-    assert.equal(result.summary.uncovered, 0);
-  });
-});
+const path = require("path");
+const { spawnCommand } = require(path.resolve(__dirname, "../src/utils"));
+const assert = require("assert").strict;
+const fs = require("fs");
+const artifactPath = path.resolve(__dirname, "./artifacts");
+const outputFile = path.resolve(`${artifactPath}/coverageResults.json`);
+
+describe("Perform coverage analysis successfully", function () {
+  // Set indefinite timeout
+  this.timeout(0);
+  it("Should have 6 covered and 0 uncovered", async () => {
+    await spawnCommand(
+      `node ./src/index.js runCoverage -c ${artifactPath}/config.json -i ${artifactPath}/doc-content.md -o ${outputFile}`
+    );
+    const result = require(outputFile);
+    fs.unlinkSync(outputFile);
+    assert.equal(result.summary.covered, 6);
+    assert.equal(result.summary.uncovered, 0);
+  });
+});

package/test/runTests.test.js

@@ -1,29 +1,19 @@
-const path = require("path");
-const { spawnCommand } = require(path.resolve(__dirname,"../src/utils"));
-const assert = require("assert").strict;
-const fs = require("fs");
-const artifactPath = path.resolve(__dirname,"./artifacts");
-
-describe("Run tests sucessfully", function () {
-  // Set indefinite timeout
-  this.timeout(0);
-  it("All specs pass", async () => {
-    const runTests = await spawnCommand(
-      `node ./src/index.js runTests -c ${artifactPath}/config.json -i ${artifactPath} -o ${artifactPath}`
-    );
-    // Find output file
-    console.log(runTests.stdout)
-    const outputFiles = runTests.stdout.split("See results at ");
-    const outputFile = outputFiles[outputFiles.length - 1].trim();
-    console.log(outputFile);
-    console.log(fs.existsSync(outputFile));
-    // If output file is not found, throw an error
-    if (!outputFile) {
-      throw new Error(`Output file not found.\nOutput file: ${outputFile}\nCWD: ${process.cwd()}\nstdout: ${runTests.stdout}`);
-    }
-    const result = JSON.parse(
-      fs.readFileSync(outputFile, { encoding: "utf8" })
-    );
-    assert.equal(result.summary.specs.fail, 0);
-  });
-});
+const path = require("path");
+const { spawnCommand } = require(path.resolve(__dirname, "../src/utils"));
+const assert = require("assert").strict;
+const fs = require("fs");
+const artifactPath = path.resolve(__dirname, "./artifacts");
+const outputFile = path.resolve(`${artifactPath}/testResults.json`);
+
+describe("Run tests sucessfully", function () {
+  // Set indefinite timeout
+  this.timeout(0);
+  it("All specs pass", async () => {
+    await spawnCommand(
+      `node ./src/index.js runTests -c ${artifactPath}/config.json -i ${artifactPath} -o ${outputFile}`
+    );
+    const result = require(outputFile);
+    fs.unlinkSync(outputFile);
+    assert.equal(result.summary.specs.fail, 0);
+  });
+});

package/test/test-config.json

@@ -1,13 +1,13 @@
-{
-  "input": ".",
-  "output": ".",
-  "logLevel": "silent",
-  "recursive": true,
-  "runTests": {
-    "setup": ".",
-    "cleanup": "."
-  },
-  "telemetry": {
-    "send": false
-  }
+{
+  "input": ".",
+  "output": ".",
+  "logLevel": "silent",
+  "recursive": true,
+  "runTests": {
+    "setup": ".",
+    "cleanup": "."
+  },
+  "telemetry": {
+    "send": false
+  }
 }