doc-detective 1.0.7 → 1.0.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "doc-detective",
-  "version": "1.0.7",
+  "version": "1.0.9",
   "description": "Unit test documentation (and record videos of those tests).",
   "main": "src/index.js",
   "scripts": {

package/sample/results.json

@@ -2,65 +2,20 @@
   "tests": [
     {
       "id": "process-search-kittens",
-      "file": "/config/workspace/doc-detective/sample/doc-content.md",
       "actions": [
-        {
-          "action": "startRecording",
-          "overwrite": false,
-          "filename": "results.gif",
-          "fps": 15,
-          "line": 9,
-          "result": {
-            "status": "PASS",
-            "description": "Started recording: /config/workspace/doc-detective/sample/temp_results.mp4",
-            "video": "/config/workspace/doc-detective/sample/temp_results.mp4"
-          }
-        },
         {
           "action": "goTo",
           "uri": "www.google.com",
-          "line": 10,
           "result": {
             "status": "PASS",
             "description": "Opened URI."
           }
         },
-        {
-          "action": "moveMouse",
-          "css": "#gbqfbb",
-          "alignH": "center",
-          "alignV": "center",
-          "line": 14,
-          "result": {
-            "status": "PASS",
-            "description": "Moved mouse to element."
-          }
-        },
-        {
-          "action": "wait",
-          "duration": "5000",
-          "line": 15,
-          "result": {
-            "status": "PASS",
-            "description": "Wait complete."
-          }
-        },
-        {
-          "action": "moveMouse",
-          "css": "[title=Search]",
-          "alignV": "center",
-          "line": 16,
-          "result": {
-            "status": "PASS",
-            "description": "Moved mouse to element."
-          }
-        },
         {
           "action": "type",
           "css": "[title=Search]",
           "keys": "kittens",
           "trailingSpecialKey": "Enter",
-          "line": 17,
           "result": {
             "status": "PASS",
             "description": "Typed keys."
@@ -69,35 +24,16 @@
         {
           "action": "wait",
           "duration": "5000",
-          "line": 18,
           "result": {
             "status": "PASS",
             "description": "Wait complete."
           }
         },
-        {
-          "action": "scroll",
-          "y": 300,
-          "line": 19,
-          "result": {
-            "status": "PASS",
-            "description": "Scroll complete."
-          }
-        },
-        {
-          "action": "stopRecording",
-          "line": 20,
-          "result": {
-            "status": "PASS",
-            "description": "Stopped recording: /config/workspace/doc-detective/sample/results.gif"
-          }
-        },
         {
           "action": "screenshot",
           "filename": "results.png",
           "matchPrevious": false,
           "matchThreshold": 0.1,
-          "line": 21,
           "result": {
             "status": "PASS",
             "description": "Captured screenshot.",
@@ -109,12 +45,10 @@
     },
     {
       "id": "text-match-lucky",
-      "file": "/config/workspace/doc-detective/sample/doc-content.md",
       "actions": [
         {
           "action": "goTo",
           "uri": "www.google.com",
-          "line": 33,
           "result": {
             "status": "PASS",
             "description": "Opened URI."
@@ -124,7 +58,16 @@
           "action": "matchText",
           "css": "#gbqfbb",
           "text": "I'm Feeling Lucky",
-          "line": 34,
+          "result": {
+            "status": "PASS",
+            "description": "Element text matched expected text."
+          }
+        },
+        {
+          "action": "matchText",
+          "css": "#gbqfbb",
+          "text": "$TEXT",
+          "env": "./sample/variables.env",
           "result": {
             "status": "PASS",
             "description": "Element text matched expected text."
@@ -135,12 +78,11 @@
     },
     {
       "id": "process-lucky-shorthair",
-      "file": "/config/workspace/doc-detective/sample/doc-content.md",
       "actions": [
         {
           "action": "goTo",
-          "uri": "www.google.com",
-          "line": 38,
+          "uri": "$URL",
+          "env": "./sample/variables.env",
           "result": {
             "status": "PASS",
             "description": "Opened URI."
@@ -149,8 +91,7 @@
         {
           "action": "type",
           "css": "[title=Search]",
-          "keys": "american shorthair cats",
-          "line": 42,
+          "keys": "$SHORTHAIR_CAT_SEARCH",
           "result": {
             "status": "PASS",
             "description": "Typed keys."
@@ -159,7 +100,6 @@
         {
           "action": "click",
           "css": "#gbqfbb",
-          "line": 46,
           "result": {
             "status": "PASS",
             "description": "Clicked element."
@@ -167,6 +107,57 @@
         }
       ],
       "status": "PASS"
+    },
+    {
+      "id": "non-ui-tests",
+      "actions": [
+        {
+          "action": "runShell",
+          "command": "echo $USERNAME",
+          "env": "./sample/variables.env",
+          "result": {
+            "status": "PASS",
+            "description": "Executed command.",
+            "stdout": "foo",
+            "stderr": "",
+            "exitCode": 0
+          }
+        },
+        {
+          "action": "checkLink",
+          "uri": "https://www.google.com",
+          "statusCodes": [
+            200
+          ],
+          "result": {
+            "status": "PASS",
+            "description": "Returned 200"
+          }
+        },
+        {
+          "action": "checkLink",
+          "uri": "$URL",
+          "statusCodes": [
+            200
+          ],
+          "result": {
+            "status": "PASS",
+            "description": "Returned 200"
+          }
+        },
+        {
+          "action": "httpRequest",
+          "uri": "$URL",
+          "statusCodes": [
+            200
+          ],
+          "result": {
+            "status": "PASS",
+            "description": "Returned 200."
+          }
+        }
+      ],
+      "status": "PASS"
     }
   ]
 }

package/src/config.json

@@ -14,6 +14,7 @@
     ".json"
   ],
   "mediaDirectory": ".",
+  "downloadDirectory": ".",
   "saveFailedTestRecordings": true,
   "failedTestDirectory": ".",
   "fileTypes": [

package/src/lib/tests.js

@@ -92,6 +92,10 @@ async function runTests(config, tests) {
     config.debugRecording = {};
     // Instantiate page
     const page = await browser.newPage();
+    await page._client.send("Page.setDownloadBehavior", {
+      behavior: "allow",
+      downloadPath: config.downloadDirectory,
+    });
     if (
       test.saveFailedTestRecordings ||
       (config.saveFailedTestRecordings &&

package/src/lib/utils.js

@@ -82,6 +82,19 @@ function setArgs(args) {
       description: "Path to the media output directory.",
       type: "string",
     })
+    .option("downloadDir", {
+      description: "Path to the download directory.",
+      type: "string",
+    })
+    .option("saveFailedTestRecordings", {
+      description:
+        "Boolean. Whether to save recordings of failed tests. Defaults to true.",
+      type: "string",
+    })
+    .option("failedTestDir", {
+      description: "Path to the failed test directory.",
+      type: "string",
+    })
     .option("browserHeadless", {
       description:
         "Boolean. Whether to run the browser in headless mode. Defaults to true.",
@@ -300,6 +313,26 @@ function setMediaDirectory(config, argv) {
   return config;
 }
 
+function setDownloadDirectory(config, argv) {
+  config.downloadDirectory =
+    argv.downloadDir ||
+    process.env.DOC_MEDIA_DIRECTORY_PATH ||
+    config.downloadDirectory ||
+    defaultConfig.downloadDirectory;
+  config.downloadDirectory = path.resolve(config.downloadDirectory);
+  if (fs.existsSync(config.downloadDirectory)) {
+    log(config, "debug", `Download directory set: ${config.downloadDirectory}`);
+  } else {
+    config.downloadDirectory = path.resolve(defaultConfig.downloadDirectory);
+    log(
+      config,
+      "warning",
+      `Invalid download directory. Reverted to default: ${config.downloadDirectory}`
+    );
+  }
+  return config;
+}
+
 function setFailedTestRecording(config, argv) {
   config.saveFailedTestRecordings =
     argv.saveFailedTestRecordings ||
@@ -339,7 +372,7 @@ function setFailedTestRecording(config, argv) {
 
 function setFailedTestDirectory(config, argv) {
   config.failedTestDirectory =
-    argv.failedTestDirectory ||
+    argv.failedTestDir ||
     process.env.DOC_FAILED_TEST_DIRECTORY_PATH ||
     config.failedTestDirectory ||
     defaultConfig.failedTestDirectory;
@@ -652,6 +685,8 @@ function setConfig(config, argv) {
 
   config = setMediaDirectory(config, argv);
 
+  config = setDownloadDirectory(config, argv);
+
   config = setFailedTestRecording(config, argv);
 
   config = setFailedTestDirectory(config, argv);