doc-detective 2.19.1-dev.0 → 3.0.0

package/test/artifacts/cleanup.spec.json

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

package/test/artifacts/config.json

@@ -1,44 +1,44 @@
-{
-  "envVariables": "",
-  "input": ".",
-  "output": ".",
-  "recursive": true,
-  "relativePathBase": "file",
-  "logLevel": "debug",
-  "runTests": {
-    "input": "test.spec.json",
-    "output": ".",
-    "setup": "",
-    "cleanup": "",
-    "recursive": true,
-    "detectSteps": false,
-    "mediaDirectory": ".",
-    "downloadDirectory": ".",
-    "contexts": [
-      {
-        "app": { "name": "chrome", "options": { "headless": false } },
-        "platforms": ["mac", "linux"]
-      },
-      {
-        "app": { "name": "chrome", "options": { "headless": true } },
-        "platforms": ["windows"]
-      }
-
-    ]
-  },
-  "runCoverage": {
-    "recursive": true,
-    "input": ".dev/",
-    "output": ".",
-    "markup": []
-  },
-  "suggestTests": {
-    "recursive": true,
-    "input": ".",
-    "output": ".",
-    "markup": []
-  },
-  "telemetry": {
-    "send": false
-  }
-}
+{
+  "envVariables": "",
+  "input": ".",
+  "output": ".",
+  "recursive": true,
+  "relativePathBase": "file",
+  "logLevel": "debug",
+  "runTests": {
+    "input": "test.spec.json",
+    "output": ".",
+    "setup": "",
+    "cleanup": "",
+    "recursive": true,
+    "detectSteps": false,
+    "mediaDirectory": ".",
+    "downloadDirectory": ".",
+    "contexts": [
+      {
+        "app": { "name": "chrome", "options": { "headless": false } },
+        "platforms": ["mac", "linux"]
+      },
+      {
+        "app": { "name": "chrome", "options": { "headless": true } },
+        "platforms": ["windows"]
+      }
+
+    ]
+  },
+  "runCoverage": {
+    "recursive": true,
+    "input": ".dev/",
+    "output": ".",
+    "markup": []
+  },
+  "suggestTests": {
+    "recursive": true,
+    "input": ".",
+    "output": ".",
+    "markup": []
+  },
+  "telemetry": {
+    "send": false
+  }
+}

package/test/artifacts/doc-content.md

@@ -1,16 +1,16 @@
-# Doc Detective documentation overview
-
-[comment]: # (test start {"id":"search-kittens"})
-
-[Doc Detective documentation](http://doc-detective.com) is split into a few key sections:
-[comment]: # (step {"action":"goTo", "url":"https://doc-detective.com"})
-
--   The landing page discusses what Doc Detective is, what it does, and who might find it useful.
--   [Get started](https://doc-detective.com/docs/get-started/intro) covers how to quickly get up and running with Doc Detective.
-    [comment]: # (step {"action":"goTo", "url":"https://doc-detective.com/docs/get-started/intro"})
--   The [references](https://doc-detective.com/docs/references/schemas/typeKeys) detail the various JSON objects that Doc Detective expects for configs, test specifications, tests, actions, and more. Each object schema includes an object description, field definitions, and examples.
-    [comment]: # (step {"action":"goTo", "url":"https://doc-detective.com/docs/references/schemas/typeKeys"})
-    [comment]: # (step {"action":"find", "selector":"h2#fields", "matchText":"Fields"})
-    [comment]: # (step {"action":"find", "selector":"h2#examples", "matchText":"Examples"})
-
+# Doc Detective documentation overview
+
+[comment]: # (test start {"id":"search-kittens"})
+
+[Doc Detective documentation](http://doc-detective.com) is split into a few key sections:
+[comment]: # (step {"action":"goTo", "url":"https://doc-detective.com"})
+
+-   The landing page discusses what Doc Detective is, what it does, and who might find it useful.
+-   [Get started](https://doc-detective.com/docs/get-started/intro) covers how to quickly get up and running with Doc Detective.
+    [comment]: # (step {"action":"goTo", "url":"https://doc-detective.com/docs/get-started/intro"})
+-   The [references](https://doc-detective.com/docs/references/schemas/typeKeys) detail the various JSON objects that Doc Detective expects for configs, test specifications, tests, actions, and more. Each object schema includes an object description, field definitions, and examples.
+    [comment]: # (step {"action":"goTo", "url":"https://doc-detective.com/docs/references/schemas/typeKeys"})
+    [comment]: # (step {"action":"find", "selector":"h2#fields", "matchText":"Fields"})
+    [comment]: # (step {"action":"find", "selector":"h2#examples", "matchText":"Examples"})
+
 [comment]: # (test end)

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": "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/runTests.test.js

@@ -1,22 +1,22 @@
-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}`
-    );
-    // Wait until the file is written
-    while (!fs.existsSync(outputFile)) {}
-    const result = require(outputFile);
-    console.log(JSON.stringify(result, null, 2));
-    fs.unlinkSync(outputFile);
-    assert.equal(result.summary.specs.fail, 0);
-  });
-});
+const path = require("path");
+const { spawnCommand } = require("../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 successfully", function () {
+  // Set indefinite timeout
+  this.timeout(0);
+  it("All specs pass", async () => {
+    await spawnCommand(
+      `node ./src/index.js -c ${artifactPath}/config.json -i ${artifactPath} -o ${outputFile}`
+    );
+    // Wait until the file is written
+    while (!fs.existsSync(outputFile)) {}
+    const result = require(outputFile);
+    console.log(JSON.stringify(result, null, 2));
+    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
+  }
 }