doc-detective-common 3.0.2 → 3.0.4-dev.0

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "doc-detective-common",
-  "version": "3.0.2",
+  "version": "3.0.4-dev.0",
   "description": "Shared components for Doc Detective projects.",
   "main": "src/index.js",
   "scripts": {
     "dereferenceSchemas": "node ./src/schemas/dereferenceSchemas.js",
-    "test:full": "npm run dereferenceSchemas && npm run test",
+    "build": "npm run dereferenceSchemas",
+    "postbuild": "npm run test",
     "test": "mocha"
   },
   "repository": {
@@ -20,16 +21,16 @@
   "homepage": "https://github.com/doc-detective/doc-detective-common#readme",
   "devDependencies": {
     "chai": "^5.2.0",
-    "mocha": "^11.1.0",
+    "mocha": "^11.2.2",
     "sinon": "^20.0.0"
   },
   "dependencies": {
-    "@apidevtools/json-schema-ref-parser": "^12.0.1",
+    "@apidevtools/json-schema-ref-parser": "^12.0.2",
     "ajv": "^8.17.1",
     "ajv-errors": "^3.0.0",
     "ajv-formats": "^3.0.1",
     "ajv-keywords": "^5.1.0",
-    "axios": "^1.8.4",
+    "axios": "^1.9.0",
     "uuid": "^11.1.0",
     "yaml": "^2.7.1"
   }

package/src/resolvePaths.js

@@ -30,9 +30,12 @@ async function resolvePaths({
   const configPaths = [
     "input",
     "output",
-    "envVariables",
+    "loadVariables",
     "setup",
     "cleanup",
+    "configPath",
+    "beforeAny",
+    "afterAll",
     "mediaDirectory",
     "downloadDirectory",
     "descriptionPath",
@@ -50,6 +53,7 @@ async function resolvePaths({
     "cleanup",
     "savePath",
     "saveDirectory",
+    "specPath",
     "descriptionPath",
     "workingDirectory",
   ];
@@ -131,7 +135,37 @@ async function resolvePaths({
   }
 
   for (const property of Object.keys(object)) {
-    if (
+    // If the property is an array, recursively call resolvePaths for each item in the array
+    if (Array.isArray(object[property])) {
+      for (let i = 0; i < object[property].length; i++) {
+        const item = object[property][i];
+
+        // If the item is an object, recursively call resolvePaths to resolve paths within the object
+        if (typeof item === "object") {
+          await resolvePaths({
+            config: config,
+            object: item,
+            filePath: filePath,
+            nested: true,
+            objectType: objectType,
+          });
+        } else if (
+          typeof item === "string" &&
+          pathProperties.includes(property)
+        ) {
+          // Resolve the string path and write it back into the array
+          const resolved =
+            property === "path" &&
+            object.directory &&
+            path.isAbsolute(object.directory)
+              ? resolve(relativePathBase, item, object.directory)
+              : resolve(relativePathBase, item, filePath);
+          object[property][i] = resolved;
+        }
+      }
+    }
+    // If the property is an object, recursively call resolvePaths to resolve paths within the object
+    else if (
       typeof object[property] === "object" &&
       ((objectType === "spec" && !specNoResolve.includes(property)) ||
         objectType === "config")
@@ -145,27 +179,62 @@ async function resolvePaths({
         objectType: objectType,
       });
     } else if (typeof object[property] === "string") {
-      // If the property is a string, check if it matches any of the path properties and resolve it if it does
-      pathProperties.forEach((pathProperty) => {
-        if (object[pathProperty]) {
-          if (pathProperty === "path" && object.directory) {
-            if (path.isAbsolute(object.directory)) {
-              object[pathProperty] = resolve(
-                relativePathBase,
-                object[pathProperty],
-                object.directory
-              );
-            }
-          } else {
-            object[pathProperty] = resolve(
-              relativePathBase,
-              object[pathProperty],
-              filePath
-            );
-          }
+      // If the property begins with "https://" or "http://", skip it
+      if (
+        object[property].startsWith("https://") ||
+        object[property].startsWith("http://")
+      ) {
+        continue;
+      }
+      // Check if it matches any of the path properties and resolve it if it does
+      if (pathProperties.includes(property)) {
+        if (property === "path" && object.directory) {
+          const directory = path.isAbsolute(object.directory)
+            ? object.directory
+            : resolve(relativePathBase, object.directory, filePath);
+          object[property] = resolve(
+            relativePathBase,
+            object[property],
+            directory
+          );
+        } else {
+          object[property] = resolve(
+            relativePathBase,
+            object[property],
+            filePath
+          );
         }
-      });
+      }
     }
   }
   return object;
 }
+
+// If called directly, resolve paths in the provided object
+if (require.main === module) {
+  (async () => {
+    // Example usage
+    const config = {
+      relativePathBase: "file",
+    };
+    const object = {
+      tests: [
+        {
+          steps: [
+            {
+              screenshot: {
+                path: "file.png",
+                directory:
+                  "/home/hawkeyexl/Workspaces/doc-detective-common/screenshots",
+              },
+            },
+          ],
+        },
+      ],
+    };
+    const filePath = process.cwd();
+
+    await resolvePaths({ config, object, filePath });
+    console.log(JSON.stringify(object, null, 2));
+  })();
+}

package/src/schemas/dereferenceSchemas.js

@@ -32,6 +32,7 @@ async function dereferenceSchemas() {
     "httpRequest_v3.schema.json",
     "openApi_v3.schema.json",
     "record_v3.schema.json",
+    "resolvedTests_v3.schema.json",
     "report_v3.schema.json",
     "runCode_v3.schema.json",
     "runShell_v3.schema.json",

package/src/schemas/output_schemas/config_v3.schema.json

@@ -12,6 +12,11 @@
       "description": "Identifier for the configuration.",
       "type": "string"
     },
+    "configPath": {
+      "description": "Path to the configuration file.",
+      "type": "string",
+      "readOnly": true
+    },
     "input": {
       "description": "Path(s) to test specifications and documentation source files. May be paths to specific files or to directories to scan for files.",
       "default": ".",
@@ -5297,10 +5302,78 @@
       "default": {
         "send": true
       }
+    },
+    "environment": {
+      "type": "object",
+      "description": "Environment information for the system running Doc Detective.",
+      "readmeOnly": true,
+      "additionalProperties": false,
+      "required": [
+        "platform"
+      ],
+      "properties": {
+        "workingDirectory": {
+          "description": "The current working directory of the process running Doc Detective.",
+          "type": "string"
+        },
+        "platform": {
+          "description": "The operating system type running Doc Detective.",
+          "type": "string",
+          "enum": [
+            "linux",
+            "mac",
+            "windows"
+          ]
+        },
+        "arch": {
+          "description": "The processor architecture of the system running Doc Detective.",
+          "type": "string",
+          "enum": [
+            "arm32",
+            "arm64",
+            "x32",
+            "x64"
+          ]
+        }
+      }
     }
   },
   "components": {
     "schemas": {
+      "environment": {
+        "type": "object",
+        "description": "Environment information for the system running Doc Detective.",
+        "readmeOnly": true,
+        "additionalProperties": false,
+        "required": [
+          "platform"
+        ],
+        "properties": {
+          "workingDirectory": {
+            "description": "The current working directory of the process running Doc Detective.",
+            "type": "string"
+          },
+          "platform": {
+            "description": "The operating system type running Doc Detective.",
+            "type": "string",
+            "enum": [
+              "linux",
+              "mac",
+              "windows"
+            ]
+          },
+          "arch": {
+            "description": "The processor architecture of the system running Doc Detective.",
+            "type": "string",
+            "enum": [
+              "arm32",
+              "arm64",
+              "x32",
+              "x64"
+            ]
+          }
+        }
+      },
       "markupDefinition": {
         "type": "object",
         "properties": {
@@ -9677,6 +9750,12 @@
           }
         }
       ]
+    },
+    {
+      "environment": {
+        "platform": "windows",
+        "arch": "x64"
+      }
     }
   ]
 }