doc-detective 3.0.0 → 3.0.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "doc-detective",
-  "version": "3.0.0",
+  "version": "3.0.2",
   "description": "Treat doc content as testable assertions to validate doc accuracy and product UX.",
   "bin": {
     "doc-detective": "src/index.js"
@@ -33,12 +33,12 @@
   "homepage": "https://github.com/doc-detective/doc-detective#readme",
   "dependencies": {
     "@ffmpeg-installer/ffmpeg": "^1.1.0",
-    "doc-detective-common": "^3.0.0",
-    "doc-detective-core": "^3.0.0",
+    "doc-detective-common": "^3.0.2",
+    "doc-detective-core": "^3.0.4",
     "yargs": "^17.7.2"
   },
   "devDependencies": {
     "chai": "^5.2.0",
-    "mocha": "^11.1.0"
+    "mocha": "^11.2.2"
   }
 }

package/src/utils.js

@@ -77,12 +77,14 @@ async function setConfig(config, args, configPath) {
   }
   // Override config values
   if (args.input) {
-    config.input = args.input;
+    config.input = path.resolve(args.input);
   }
   if (args.output) {
-    config.output = args.output;
+    config.output = path.resolve(args.output);
+  }
+  if (args.logLevel) {
+    config.logLevel = args.logLevel;
   }
-  if (args.logLevel) config.logLevel = args.logLevel;
   // Resolve paths
   config = await resolvePaths({
     config: config,

package/test/artifacts/httpRequest.spec.yaml

@@ -0,0 +1,37 @@
+tests:
+- steps:
+  - loadVariables: env
+  - httpRequest:
+      url: http://localhost:8080/api/users
+      method: post
+      request:
+        body:
+          name: $USER
+          job: $JOB
+      response:
+        body:
+          name: John Doe
+          job: Software Engineer
+  - httpRequest:
+      url: http://localhost:8080/api/users
+      method: post
+      request:
+        body:
+          data:
+            - first_name: George
+              last_name: Bluth
+              id: 1
+      response:
+        body:
+          data:
+            - first_name: George
+              last_name: Bluth
+    variables:
+      ID: $$response.body.data[0].id
+  - httpRequest:
+      url: http://localhost:8080/api/$ID
+      method: get
+      timeout: 1000
+    savePath: response.json
+    maxVariation: 0
+    overwrite: aboveVariation

package/test/artifacts/test.spec.json

@@ -20,20 +20,6 @@
           "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"

package/test/runTests.test.js

@@ -1,3 +1,4 @@
+const { createServer } = require("./server");
 const path = require("path");
 const { spawnCommand } = require("../src/utils");
 const assert = require("assert").strict;
@@ -5,6 +6,36 @@ const fs = require("fs");
 const artifactPath = path.resolve(__dirname, "./artifacts");
 const outputFile = path.resolve(`${artifactPath}/testResults.json`);
 
+// Create a server with custom options
+const server = createServer({
+  port: 8080,
+  staticDir: './test/server/public',
+  modifyResponse: (req, body) => {
+    // Optional modification of responses
+    return { ...body, extraField: 'added by server' };
+  }
+});
+
+// Start the server before tests
+before(async () => {
+  try {
+    await server.start();
+  } catch (error) {
+    console.error(`Failed to start test server: ${error.message}`);
+    throw error;
+  }
+});
+
+// Stop the server after tests
+after(async () => {
+  try {
+    await server.stop();
+  } catch (error) {
+    console.error(`Failed to stop test server: ${error.message}`);
+    // Don't rethrow here to avoid masking test failures
+  }
+});
+
 describe("Run tests successfully", function () {
   // Set indefinite timeout
   this.timeout(0);

package/test/server/index.js

@@ -0,0 +1,139 @@
+const express = require("express");
+const bodyParser = require("body-parser");
+const path = require("path");
+const fs = require("fs");
+
+/**
+ * Creates an echo server that can serve static content and echo back API requests
+ * @param {Object} options - Configuration options
+ * @param {number} [options.port=8080] - Port to run the server on
+ * @param {string} [options.staticDir="public"] - Directory to serve static files from
+ * @param {Function} [options.modifyResponse] - Function to modify responses before sending
+ * @returns {Object} Server object with start and stop methods
+ */
+function createServer(options = {}) {
+  const {
+    port = 8080,
+    staticDir = "public",
+    modifyResponse = (req, body) => body,
+  } = options;
+
+  const app = express();
+  let server = null;
+
+  // Parse JSON and urlencoded bodies
+  app.use(bodyParser.json({ limit: "10mb" }));
+  app.use(bodyParser.urlencoded({ extended: true }));
+
+  // Serve static files if a directory is provided
+  if (staticDir && fs.existsSync(staticDir)) {
+    app.use(express.static(staticDir));
+  }
+
+  // Echo API endpoint that returns the request body
+  app.all("/api/:path", (req, res) => {
+    try {
+      const requestBody = req.method === "GET" ? req.query : req.body;
+      const modifiedResponse = modifyResponse(req, requestBody);
+      console.log("Request:", {
+        Method: req.method,
+        Path: req.path,
+        Query: req.query,
+        Headers: req.headers,
+        Body: req.body,
+      });
+
+      res.set("x-server", "doc-detective-echo-server");
+
+      console.log("Response:", { Body: modifiedResponse });
+
+      res.json(modifiedResponse);
+    } catch (error) {
+      console.error("Error processing request:", error);
+      res.status(500).json({ error: "Internal server error" });
+    }
+  });
+
+  return {
+    /**
+     * Start the server
+     * @returns {Promise} Promise that resolves with the server address
+     */
+
+    start: () => {
+      return new Promise((resolve, reject) => {
+        try {
+          server = app.listen(port, () => {
+            const serverAddress = `http://localhost:${port}`;
+            console.log(`Echo server running at ${serverAddress}`);
+            resolve(serverAddress);
+          });
+
+          server.on("error", (error) => {
+            console.error(`Failed to start server: ${error.message}`);
+            reject(error);
+          });
+        } catch (error) {
+          console.error(`Error setting up server: ${error.message}`);
+          reject(error);
+        }
+      });
+    },
+
+    /**
+     * Stop the server
+     * @returns {Promise} Promise that resolves when server is stopped
+     */
+    stop: () => {
+      return new Promise((resolve) => {
+        if (server) {
+          server.close((error) => {
+            if (error) {
+              console.error("Error stopping server:", error);
+              reject(error);
+            } else {
+              console.log("Echo server stopped");
+              server = null;
+              resolve();
+            }
+          });
+        } else {
+          resolve();
+        }
+      });
+    },
+
+    /**
+     * Get the Express app instance
+     * @returns {Object} Express app
+     */
+    getApp: () => app,
+  };
+}
+
+// Export the function
+module.exports = { createServer };
+
+// If this file is run directly, start a server
+if (require.main === module) {
+  const server = createServer({
+    port: process.env.PORT || 8080,
+    staticDir:
+      process.env.STATIC_DIR ||
+      path.join(process.cwd(), "./test/server/public"),
+  });
+
+  server.start();
+
+  // Handle graceful shutdown
+  const shutdown = () => {
+    console.log("Shutting down server...");
+    server
+      .stop()
+      .then(() => process.exit(0))
+      .catch(() => process.exit(1));
+  };
+
+  process.on("SIGINT", shutdown);
+  process.on("SIGTERM", shutdown);
+}

package/test/server/public/index.html

@@ -0,0 +1,174 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Basic HTML Elements Demo</title>
+</head>
+<body>
+    <header>
+        <h1>Common HTML Elements</h1>
+        <p>This page demonstrates common HTML elements a user might interact with.</p>
+    </header>
+
+    <nav>
+        <ul>
+            <li><a href="#text-inputs">Text Inputs</a></li>
+            <li><a href="#selection-elements">Selection Elements</a></li>
+            <li><a href="#buttons">Buttons</a></li>
+            <li><a href="#text-elements">Text Elements</a></li>
+            <li><a href="#lists">Lists</a></li>
+            <li><a href="#tables">Tables</a></li>
+        </ul>
+    </nav>
+
+    <main>
+        <section id="text-inputs">
+            <h2>Text Inputs</h2>
+            <form>
+                <div>
+                    <label for="text-input">Text Input:</label>
+                    <input type="text" id="text-input" name="text-input" placeholder="Enter some text">
+                </div>
+                
+                <div>
+                    <label for="password-input">Password Input:</label>
+                    <input type="password" id="password-input" name="password-input" placeholder="Enter password">
+                </div>
+                
+                <div>
+                    <label for="email-input">Email Input:</label>
+                    <input type="email" id="email-input" name="email-input" placeholder="Enter your email">
+                </div>
+                
+                <div>
+                    <label for="textarea">Textarea:</label>
+                    <textarea id="textarea" name="textarea" rows="4" cols="50" placeholder="Enter longer text here..."></textarea>
+                </div>
+            </form>
+        </section>
+
+        <section id="selection-elements">
+            <h2>Selection Elements</h2>
+            <form>
+                <div>
+                    <p>Checkboxes:</p>
+                    <input type="checkbox" id="checkbox1" name="checkbox1" value="option1">
+                    <label for="checkbox1">Option 1</label><br>
+                    <input type="checkbox" id="checkbox2" name="checkbox2" value="option2">
+                    <label for="checkbox2">Option 2</label><br>
+                    <input type="checkbox" id="checkbox3" name="checkbox3" value="option3">
+                    <label for="checkbox3">Option 3</label>
+                </div>
+                
+                <div>
+                    <p>Radio Buttons:</p>
+                    <input type="radio" id="radio1" name="radio-group" value="option1">
+                    <label for="radio1">Option 1</label><br>
+                    <input type="radio" id="radio2" name="radio-group" value="option2">
+                    <label for="radio2">Option 2</label><br>
+                    <input type="radio" id="radio3" name="radio-group" value="option3">
+                    <label for="radio3">Option 3</label>
+                </div>
+                
+                <div>
+                    <label for="select">Dropdown Select:</label>
+                    <select id="select" name="select">
+                        <option value="">-- Please choose an option --</option>
+                        <option value="option1">Option 1</option>
+                        <option value="option2">Option 2</option>
+                        <option value="option3">Option 3</option>
+                    </select>
+                </div>
+            </form>
+        </section>
+
+        <section id="buttons">
+            <h2>Buttons</h2>
+            <button type="button">Standard Button</button>
+            <input type="button" value="Input Button">
+            <input type="submit" value="Submit Button">
+            <input type="reset" value="Reset Button">
+        </section>
+
+        <section id="text-elements">
+            <h2>Text Elements</h2>
+            <h3>This is a heading 3</h3>
+            <h4>This is a heading 4</h4>
+            <p>This is a paragraph of text. It demonstrates the paragraph element in HTML.</p>
+            <p><strong>Bold text</strong> and <em>italic text</em> are created using the strong and em elements.</p>
+            <p>This is a <a href="https://example.com">hyperlink</a> to example.com.</p>
+            <blockquote>
+                This is a blockquote. It's typically used for quoting content from another source.
+            </blockquote>
+            <pre>This is preformatted text.
+It preserves both      spaces
+and line breaks.</pre>
+            <code>This is inline code.</code>
+        </section>
+
+        <section id="lists">
+            <h2>Lists</h2>
+            <h3>Unordered List</h3>
+            <ul>
+                <li>Item 1</li>
+                <li>Item 2</li>
+                <li>Item 3</li>
+            </ul>
+            
+            <h3>Ordered List</h3>
+            <ol>
+                <li>First item</li>
+                <li>Second item</li>
+                <li>Third item</li>
+            </ol>
+            
+            <h3>Definition List</h3>
+            <dl>
+                <dt>Term 1</dt>
+                <dd>Definition for Term 1</dd>
+                <dt>Term 2</dt>
+                <dd>Definition for Term 2</dd>
+            </dl>
+        </section>
+
+        <section id="tables">
+            <h2>Tables</h2>
+            <table border="1">
+                <caption>Simple Data Table</caption>
+                <thead>
+                    <tr>
+                        <th>Name</th>
+                        <th>Age</th>
+                        <th>Country</th>
+                    </tr>
+                </thead>
+                <tbody>
+                    <tr>
+                        <td>John Doe</td>
+                        <td>25</td>
+                        <td>USA</td>
+                    </tr>
+                    <tr>
+                        <td>Jane Smith</td>
+                        <td>30</td>
+                        <td>Canada</td>
+                    </tr>
+                    <tr>
+                        <td>Bob Johnson</td>
+                        <td>45</td>
+                        <td>UK</td>
+                    </tr>
+                </tbody>
+            </table>
+        </section>
+    </main>
+
+    <footer>
+        <p>&copy; 2025 Basic HTML Elements Demo</p>
+        <address>
+            Contact: <a href="mailto:example@example.com">example@example.com</a>
+        </address>
+    </footer>
+</body>
+</html>

package/test/artifacts/httpRequest.spec.json

@@ -1,55 +0,0 @@
-{
-  "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]
-        }
-      ]
-    }
-  ]
-}