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

package/src/schemas/src_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": ".",
@@ -202,10 +207,45 @@
       "default": {
         "send": true
       }
+    },
+    "environment": {
+      "$ref": "#/components/schemas/environment"
     }
   },
   "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": {
@@ -390,6 +430,12 @@
           }
         }
       ]
+    },
+    {
+      "environment": {
+        "platform": "windows",
+        "arch": "x64"
+      }
     }
   ]
 }

package/src/schemas/src_schemas/resolvedTests_v3.schema.json

@@ -0,0 +1,184 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "resolvedTests",
+  "description": "A collection of resolved tests ready to be performed.",
+  "type": "object",
+  "dynamicDefaults": {
+    "reportId": "uuid"
+  },
+  "properties": {
+    "resolvedTestsId": {
+      "type": "string",
+      "description": "Unique identifier for the resolved tests."
+    },
+    "config": {
+      "$ref": "config_v3.schema.json#"
+    },
+    "specs": {
+      "description": "Test specifications that were performed.",
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "anyOf": [{ "$ref": "spec_v3.schema.json#" }]
+      }
+    }
+  },
+  "required": ["specs"],
+  "examples": [
+    {
+      "config": {
+        "input": [
+          "/home/hawkeyexl/Workspaces/resolver/dev/doc-content-yaml.md"
+        ],
+        "logLevel": "debug",
+        "output": ".",
+        "recursive": true,
+        "relativePathBase": "file",
+        "detectSteps": true,
+        "fileTypes": [
+          {
+            "name": "markdown",
+            "extensions": ["md", "markdown", "mdx"],
+            "inlineStatements": {
+              "testStart": [
+                "{\\/\\*\\s*test\\s+?([\\s\\S]*?)\\s*\\*\\/}",
+                "<!--\\s*test\\s*([\\s\\S]*?)\\s*-->",
+                "\\[comment\\]:\\s+#\\s+\\(test\\s*(.*?)\\s*\\)",
+                "\\[comment\\]:\\s+#\\s+\\(test start\\s*(.*?)\\s*\\)"
+              ],
+              "testEnd": [
+                "{\\/\\*\\s*test end\\s*\\*\\/}",
+                "<!--\\s*test end\\s*([\\s\\S]*?)\\s*-->",
+                "\\[comment\\]:\\s+#\\s+\\(test end\\)"
+              ],
+              "ignoreStart": [
+                "{\\/\\*\\s*test ignore start\\s*\\*\\/}",
+                "<!--\\s*test ignore start\\s*-->"
+              ],
+              "ignoreEnd": [
+                "{\\/\\*\\s*test ignore end\\s*\\*\\/}",
+                "<!--\\s*test ignore end\\s*-->"
+              ],
+              "step": [
+                "{\\/\\*\\s*step\\s+?([\\s\\S]*?)\\s*\\*\\/}",
+                "<!--\\s*step\\s*([\\s\\S]*?)\\s*-->",
+                "\\[comment\\]:\\s+#\\s+\\(step\\s*(.*?)\\s*\\)"
+              ]
+            },
+            "markup": [
+              {
+                "name": "checkHyperlink",
+                "regex": [
+                  "(?<!\\!)\\[[^\\]]+\\]\\(\\s*(https?:\\/\\/[^\\s)]+)(?:\\s+\"[^\"]*\")?\\s*\\)"
+                ],
+                "actions": ["checkLink"]
+              },
+              {
+                "name": "clickOnscreenText",
+                "regex": [
+                  "\\b(?:[Cc]lick|[Tt]ap|[Ll]eft-click|[Cc]hoose|[Ss]elect|[Cc]heck)\\b\\s+\\*\\*((?:(?!\\*\\*).)+)\\*\\*"
+                ],
+                "actions": ["click"]
+              },
+              {
+                "name": "findOnscreenText",
+                "regex": ["\\*\\*((?:(?!\\*\\*).)+)\\*\\*"],
+                "actions": ["find"]
+              },
+              {
+                "name": "goToUrl",
+                "regex": [
+                  "\\b(?:[Gg]o\\s+to|[Oo]pen|[Nn]avigate\\s+to|[Vv]isit|[Aa]ccess|[Pp]roceed\\s+to|[Ll]aunch)\\b\\s+\\[[^\\]]+\\]\\(\\s*(https?:\\/\\/[^\\s)]+)(?:\\s+\"[^\"]*\")?\\s*\\)"
+                ],
+                "actions": ["goTo"]
+              },
+              {
+                "name": "screenshotImage",
+                "regex": [
+                  "!\\[[^\\]]*\\]\\(\\s*([^\\s)]+)(?:\\s+\"[^\"]*\")?\\s*\\)\\s*\\{(?=[^}]*\\.screenshot)[^}]*\\}"
+                ],
+                "actions": ["screenshot"]
+              },
+              {
+                "name": "typeText",
+                "regex": ["\\b(?:press|enter|type)\\b\\s+\"([^\"]+)\""],
+                "actions": ["type"]
+              }
+            ]
+          },
+          {
+            "name": "asciidoc",
+            "extensions": ["adoc", "asciidoc", "asc"],
+            "inlineStatements": {
+              "testStart": ["\\/\\/\\s+\\(\\s*test\\s+([\\s\\S]*?)\\s*\\)"],
+              "testEnd": ["\\/\\/\\s+\\(\\s*test end\\s*\\)"],
+              "ignoreStart": ["\\/\\/\\s+\\(\\s*test ignore start\\s*\\)"],
+              "ignoreEnd": ["\\/\\/\\s+\\(\\s*test ignore end\\s*\\)"],
+              "step": ["\\/\\/\\s+\\(\\s*step\\s+([\\s\\S]*?)\\s*\\)"]
+            },
+            "markup": []
+          },
+          {
+            "name": "html",
+            "extensions": ["html", "htm"],
+            "inlineStatements": {
+              "testStart": ["<!--\\s*test\\s+?([\\s\\S]*?)\\s*-->"],
+              "testEnd": ["<!--\\s*test end\\s*([\\s\\S]*?)\\s*-->"],
+              "ignoreStart": ["<!--\\s*test ignore start\\s*-->"],
+              "ignoreEnd": ["<!--\\s*test ignore end\\s*-->"],
+              "step": ["<!--\\s*step\\s+?([\\s\\S]*?)\\s*-->"]
+            },
+            "markup": []
+          }
+        ],
+        "telemetry": {
+          "send": true
+        },
+        "configId": "3e467e5d-27cb-41f3-800f-aeb3c20dcb4c",
+        "environment": {
+          "arch": "x64",
+          "platform": "linux",
+          "workingDirectory": "/home/hawkeyexl/Workspaces/resolver"
+        }
+      },
+      "specs": [
+        {
+          "specId": "cc656bba-132f-4f0f-b093-2cfbdd784f69",
+          "contentPath": "/home/hawkeyexl/Workspaces/resolver/dev/doc-content-yaml.md",
+          "tests": [
+            {
+              "testId": "doc-detective-docs",
+              "detectSteps": false,
+              "runOn": [],
+              "openApi": [],
+              "contexts": [
+                {
+                  "steps": [
+                    {
+                      "checkLink": "https://doc-detective.com"
+                    },
+                    {
+                      "checkLink": "https://doc-detective.com/docs/get-started/intro"
+                    },
+                    {
+                      "goTo": "https://doc-detective.com/docs/get-started/actions/type"
+                    },
+                    {
+                      "find": "Special keys"
+                    },
+                    {
+                      "screenshot": "reference.png"
+                    }
+                  ],
+                  "contextId": "eec1d123-7dfd-4362-b41a-942f36e0da5a"
+                }
+              ]
+            }
+          ],
+          "runOn": [],
+          "openApi": []
+        }
+      ]
+    }
+  ]
+}

package/src/schemas/src_schemas/spec_v3.schema.json

@@ -14,6 +14,10 @@
       "type": "string",
       "description": "Description of the test specification."
     },
+    "specPath": {
+      "type": "string",
+      "description": "Path to the test specification."
+    },
     "contentPath": {
       "type": "string",
       "description": "Path to the content that the specification is associated with."

package/src/schemas/src_schemas/test_v3.schema.json

@@ -64,12 +64,37 @@
       "items": {
         "$ref": "step_v3.schema.json#"
       }
+    },
+    "contexts": {
+      "array": "array",
+      "readOnly": true,
+      "description": "Resolved contexts to run the test in. This is a resolved version of the `runOn` property. It is not user-defined and should not be used in test specifications.",
+      "items": {
+        "type": "object",
+        "properties": {
+          "platform": {
+            "type": "string",
+            "description": "Platform to run the test on. This is a resolved version of the `platforms` property."
+          },
+          "browser": {
+            "$ref": "context_v3.schema.json#/components/schemas/browser"
+          },
+          "steps": {
+            "description": "Steps to perform as part of the test. Performed in the sequence defined. If one or more actions fail, the test fails. By default, if a step fails, the test stops and the remaining steps are not executed.",
+            "type": "array",
+            "minItems": 1,
+            "items": {
+              "$ref": "step_v3.schema.json#"
+            }
+          }
+        }
+      }
     }
   },
   "dynamicDefaults": {
     "testId": "uuid"
   },
-  "required": ["steps"],
+  "anyOf": [{ "required": ["steps"] }, { "required": ["contexts"] }],
   "additionalProperties": false,
   "examples": [
     {