doc-detective 1.3.1 → 2.9.0-dev.0

package/samples/config.json

@@ -0,0 +1,89 @@
+{
+  "envVariables": "./samples/variables.env",
+  "input": ".",
+  "output": ".",
+  "recursive": true,
+  "logLevel": "debug",
+  "runTests": {
+    "input": "./samples/doc-content.md",
+    "output": ".",
+    "setup": "",
+    "cleanup": "",
+    "recursive": true,
+    "mediaDirectory": ".",
+    "downloadDirectory": ".",
+    "contexts": [
+      {
+        "app": {
+          "name": "firefox",
+          "options": {
+            "width": 1200,
+            "height": 800,
+            "headless": false
+          }
+        },
+        "platforms": ["linux", "mac", "windows"]
+      }
+    ]
+  },
+  "runCoverage": {
+    "recursive": true,
+    "input": ".",
+    "output": ".",
+    "markup": []
+  },
+  "suggestTests": {
+    "recursive": true,
+    "input": ".",
+    "output": ".",
+    "markup": []
+  },
+  "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"
+              }
+            }
+          ]
+        }
+      ]
+    }
+  ],
+  "integrations": {},
+  "telemetry": {
+    "send": false,
+    "userId": "Doc Detective"
+  }
+}

package/samples/doc-content-inline-tests.md

@@ -0,0 +1,28 @@
+# Doc Detective documentation overview
+
+[comment]: # (test start {"id":"search-kittens", "detectSteps":false})
+
+[Doc Detective documentation](http://doc-detective.com) is split into a few key sections:
+
+[comment]: # (step {"action":"checkLink", "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/get-started.html) covers how to quickly get up and running with Doc Detective.
+
+    [comment]: # (step {"action":"checkLink", "url":"https://doc-detective.com/get-started.html"})
+
+-   The [references](https://doc-detective.com/reference/) detail the various JSON objects that Doc Detective expects for [configs](https://doc-detective.com/reference/schemas/config.html), [test specifications](https://doc-detective.com/reference/schemas/specification.html), [tests](https://doc-detective.com/reference/schemas/test), actions, and more. Open [typeKeys](https://doc-detective.com/reference/schemas/typeKeys.html)--or any other schema--and you'll find three sections: **Description**, **Fields**, and **Examples**.
+
+    [comment]: # (step {"action":"checkLink", "url":"https://doc-detective.com/reference/"})
+    [comment]: # (step {"action":"checkLink", "url":"https://doc-detective.com/reference/schemas/config.html"})
+    [comment]: # (step {"action":"checkLink", "url":"https://doc-detective.com/reference/schemas/specification.html"})
+    [comment]: # (step {"action":"checkLink", "url":"https://doc-detective.com/reference/schemas/test.html"})
+    [comment]: # (step {"action":"goTo", "url":"https://doc-detective.com/reference/schemas/typeKeys.html"})
+    [comment]: # (step {"action":"find", "selector":"h2#description", "matchText":"Description"})
+    [comment]: # (step {"action":"find", "selector":"h2#fields", "matchText":"Fields"})
+    [comment]: # (step {"action":"find", "selector":"h2#examples", "matchText":"Examples"})
+
+![](reference.png)
+[comment]: # (step {"action":"saveScreenshot", "path":"reference.png", "directory":"samples", "maxVariation":5, "overwrite":"byVariation"})
+
+[comment]: # (test end)

package/samples/doc-content.md

@@ -0,0 +1,9 @@
+# Doc Detective documentation overview
+
+[Doc Detective documentation](https://doc-detective.com) is split into a few key sections:
+
+-   The landing page discusses what Doc Detective is, what it does, and who might find it useful.
+-   [Get started](https://doc-detective.com/get-started.html) covers how to quickly get up and running with Doc Detective.
+-   The [references](https://doc-detective.com/reference/) detail the various JSON objects that Doc Detective expects for [configs](https://doc-detective.com/reference/schemas/config.html), [test specifications](https://doc-detective.com/reference/schemas/specification.html), [tests](https://doc-detective.com/reference/schemas/test), actions, and more. Open [typeKeys](https://doc-detective.com/reference/schemas/typeKeys.html)--or any other schema--and you'll find three sections: **Description**, **Fields**, and **Examples**.
+
+![](reference.png)

package/samples/tests.spec.json

@@ -0,0 +1,70 @@
+{
+  "id": "Do all the things! - Spec",
+  "contexts": [
+    {
+      "app": {
+        "name": "firefox"
+      },
+      "platforms": ["windows", "mac", "linux"]
+    }
+  ],
+  "tests": [
+    {
+      "id": "Do all the things! - Test",
+      "description": "This test includes nearly every property across all actions.",
+      "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": "find",
+          "selector": "[title=Search]",
+          "timeout": 10000,
+          "moveTo": true,
+          "click": true,
+          "typeKeys": {
+            "keys": ["shorthair cat", "$ENTER$"]
+          }
+        },
+        {
+          "action": "wait"
+        },
+        {
+          "action": "saveScreenshot",
+          "path": "screenshot.png",
+          "directory": "samples",
+          "maxVariation": 5,
+          "overwrite": "byVariation"
+        }
+      ]
+    }
+  ]
+}

package/samples/variables.env

@@ -0,0 +1,5 @@
+USERNAME=foo
+PASSWORD=bar
+SHORTHAIR_CAT_SEARCH=american shorthair cats
+URL=www.google.com
+TEXT=I'm Feeling Lucky

package/src/index.js

@@ -0,0 +1,44 @@
+#!/usr/bin/env node
+
+const { runTests, runCoverage } = require("doc-detective-core");
+const { setArgs, setConfig, outputResults } = require("./utils");
+const { argv } = require("node:process");
+const path = require("path");
+
+main(argv);
+
+// Run tests
+async function main(argv) {
+  // Find index of `doc-detective` or `run` in argv
+  console.log(argv);
+  let index = argv.indexOf("doc-detective");
+  if (index === -1) {
+    index = argv.findIndex((arg) => arg.endsWith("index.js"));
+  }
+  // `command` is the next argument after `doc-detective` or `src/index.js`
+  const command = argv[index + 1];
+  // Set args and config
+  argv = setArgs(argv);
+  const config = setConfig({}, argv);
+  // Run command
+  let results = {};
+  let outputDir;
+  let outputReportType;
+  if (command === "runCoverage") {
+    outputDir = config.runCoverage.output || config.output;
+    outputReportType = "coverageResults";
+    results = await runCoverage(config);
+  } else if (command === "runTests") {
+    outputDir = config.runTests.output || config.output;
+    outputReportType = "testResults";
+    results = await runTests(config);
+  } else {
+    throw new Error(`Command ${command} not found`);
+  }
+  // Output results
+  const outputPath = path.resolve(
+    outputDir,
+    `${outputReportType}-${Date.now()}.json`
+  );
+  await outputResults(config, outputPath, results);
+}