test-inventory 0.4.1 → 0.6.0

package/schema/v1.json

@@ -28,6 +28,13 @@
         "summary": {
           "$ref": "#/definitions/Summary"
         },
+        "configs": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/ConfigRecord"
+          },
+          "description": "The configs the scanned files use, sorted by path."
+        },
         "files": {
           "type": "array",
           "items": {
@@ -60,6 +67,7 @@
         "framework",
         "frameworkVersion",
         "summary",
+        "configs",
         "files",
         "suites",
         "tests",
@@ -225,6 +233,67 @@
       ],
       "description": "Counts over the whole scan. Each test count uses the same definition as the matching test key."
     },
+    "ConfigRecord": {
+      "type": "object",
+      "properties": {
+        "relativeFilePath": {
+          "type": "string",
+          "description": "Path from the project root, with `/` separators."
+        },
+        "extends": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Files the config takes settings from through imports, such as a shared base config, in the order read."
+        },
+        "projects": {
+          "anyOf": [
+            {
+              "type": "array",
+              "items": {
+                "$ref": "#/definitions/ProjectRecord"
+              }
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "description": "The projects the config runs tests in: Playwright's `projects`, or one for a config without them; Vitest's, with each browser instance as one. Null when the scan can't work them out."
+        }
+      },
+      "required": [
+        "relativeFilePath",
+        "extends",
+        "projects"
+      ],
+      "description": "A Playwright or Vitest config that scanned files use: the nearest one in a file's folder or a folder above it, up to the root, as the runner started in that folder would. Read as code, never run."
+    },
+    "ProjectRecord": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "description": "As the runner names it: `''` for a project without a name."
+        },
+        "testDir": {
+          "type": "string",
+          "description": "The folder the project's test files are found in, from the project root: Playwright's `testDir`, Vitest's `dir`."
+        },
+        "dependencies": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Playwright's projects that run before this one; `[]` for Vitest."
+        }
+      },
+      "required": [
+        "name",
+        "testDir",
+        "dependencies"
+      ]
+    },
     "FileRecord": {
       "type": "object",
       "properties": {
@@ -235,6 +304,13 @@
         "fileName": {
           "type": "string"
         },
+        "config": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "description": "The config the file uses, from the project root: the outermost config at or above it that runs it, as the runner started at the root would, else the nearest. Null when there is none."
+        },
         "hooks": {
           "$ref": "#/definitions/HookCounts",
           "description": "Hooks at the top level of the file, which run around every test in it."
@@ -251,6 +327,7 @@
       "required": [
         "relativeFilePath",
         "fileName",
+        "config",
         "hooks",
         "suiteCount",
         "testCount"
@@ -677,6 +754,22 @@
           ],
           "description": "Hash of the test body, ignoring whitespace and comments; null when the test has no body."
         },
+        "dependencyHash": {
+          "type": "string",
+          "pattern": "^[0-9a-f]{16}$",
+          "description": "Hash of everything the test runs in the project: its call, the hooks, options and code of the file and of every describe around it, and the functions, classes, constants and modules these use, followed through imports. Ignores whitespace and comments. Installed packages are not in it."
+        },
+        "dependencies": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "The files that went into `dependencyHash`, the test's own included, sorted, with `/` separators."
+        },
+        "hasUnfollowedDependencies": {
+          "type": "boolean",
+          "description": "Something the test reaches couldn't be followed, so a change there doesn't change `dependencyHash`."
+        },
         "suiteId": {
           "anyOf": [
             {
@@ -884,7 +977,7 @@
               "type": "null"
             }
           ],
-          "description": "In milliseconds: the last `test.setTimeout()` in the body or a `beforeEach`, otherwise the nearest describe or file that sets one. Null when the file sets none, so the config's timeout applies."
+          "description": "In milliseconds: the last `test.setTimeout()` in the body or a `beforeEach`, otherwise the nearest describe or file that sets one, otherwise the config. Null when none sets it, so the runner's default applies."
         },
         "isSlow": {
           "type": "boolean",
@@ -938,7 +1031,61 @@
               "type": "null"
             }
           ],
-          "description": "Vitest only: how many times the runner runs the test again after the first run."
+          "description": "How many times the runner runs the test again after the first run: Vitest's `repeats`, or Playwright's `repeatEach` from the config less one."
+        },
+        "timeoutSource": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/SettingSource"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "description": "Where `timeout` comes from; null when nothing sets it. A null `timeout` from the config means the config sets it, but its projects set different values or the value depends on a condition, as in `process.env.CI ? 2 : 0`."
+        },
+        "retriesSource": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/SettingSource"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "description": "Where `retries`, `retryDelay` and `retryCondition` come from, read as `timeoutSource` is."
+        },
+        "repeatsSource": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/SettingSource"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "description": "Where `repeats` comes from, read as `timeoutSource` is."
+        },
+        "timeoutConfigText": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "description": "The config's source text for `timeout` when the config sets it under a condition, as in `process.env.CI ? 60_000 : 30_000`, shortened when long; null otherwise."
+        },
+        "retriesConfigText": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "description": "The config's source text for `retries`, read as `timeoutConfigText` is."
+        },
+        "repeatsConfigText": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "description": "The config's source text for `repeats`, Playwright's `repeatEach`, read as `timeoutConfigText` is."
         },
         "fixtures": {
           "type": "array",
@@ -1010,11 +1157,28 @@
         "isInFunction": {
           "type": "boolean",
           "description": "Declared inside a plain function."
+        },
+        "projects": {
+          "anyOf": [
+            {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "description": "Names of the projects that run the test, of the config its file uses, after each project's files and Playwright's `grep` and `grepInvert`. `[]` when no project runs it; null when there is no config, or the scan can't tell."
         }
       },
       "required": [
         "id",
         "bodyHash",
+        "dependencyHash",
+        "dependencies",
+        "hasUnfollowedDependencies",
         "suiteId",
         "suitePath",
         "relativeFilePath",
@@ -1058,6 +1222,12 @@
         "retryDelay",
         "retryCondition",
         "repeats",
+        "timeoutSource",
+        "retriesSource",
+        "repeatsSource",
+        "timeoutConfigText",
+        "retriesConfigText",
+        "repeatsConfigText",
         "fixtures",
         "expectCount",
         "expectedAssertions",
@@ -1069,7 +1239,8 @@
         "caseCount",
         "isInLoop",
         "isInCondition",
-        "isInFunction"
+        "isInFunction",
+        "projects"
       ],
       "description": "A test, with the effective values the runner applies, including those inherited from its describes."
     },
@@ -1093,14 +1264,32 @@
       ]
     },
     "StateSource": {
-      "description": "Where a test's state is set: on the test, on a describe around it, or at file level. Other values may be added in later releases.",
+      "description": "Where a test's state is set: on the test, on a describe around it, at file level, or by a Vitest tag the config defines. Other values may be added in later releases.",
+      "anyOf": [
+        {
+          "type": "string",
+          "enum": [
+            "test",
+            "suite",
+            "file",
+            "config"
+          ]
+        },
+        {
+          "type": "string"
+        }
+      ]
+    },
+    "SettingSource": {
+      "description": "Where a test's run setting comes from: the test, a describe around it, the file, or the config its file uses. Other values may be added in later releases.",
       "anyOf": [
         {
           "type": "string",
           "enum": [
             "test",
             "suite",
-            "file"
+            "file",
+            "config"
           ]
         },
         {
@@ -1238,6 +1427,7 @@
             "removed-api",
             "only-in-skipped-describe",
             "config-may-change-state",
+            "undefined-tag",
             "symlink-ignored",
             "invalid-import",
             "globals-not-enabled",
@@ -1252,7 +1442,11 @@
             "approximate-framework-version",
             "test-in-function",
             "empty-title",
-            "bench-outside-benchmark-file"
+            "bench-outside-benchmark-file",
+            "config-value-unknown",
+            "file-not-run",
+            "forbidden-only",
+            "dependency-not-followed"
           ]
         },
         {