@vitest/runner 4.1.11: beforeAll

Clean-room public code sample — generation instructions

Write a brand-new, minimal, self-contained code sample in this clean-room directory.
Do not copy, paraphrase, or reference any existing project source. Work only from this spec.

A csx.json manifest scaffold already exists. Do not recreate it from memory. Preserve its case.goal, packages and symbols; fill its empty case.contract with exact assertions and correct its environment, commands and verifierAdapter for the files you generate.

Goal: verify @vitest/runner.beforeAll in pkg:npm/%40vitest/runner@4.1.11
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/%40vitest/runner@4.1.11
Demonstrate these symbols/APIs:
  - @vitest/runner.beforeAll

Rules:
  - One focused purpose; the smallest project that proves the goal.
  - Include a contract test (test/contract.*) that runs OFFLINE and exits 0 exactly when the goal behavior works.
  - Pin every dependency with a lockfile so resolution is reproducible.
  - No secrets, credentials, or tokens. No real URLs (only example.com or localhost). No absolute paths.
  - No personal names, emails, company names, or project identifiers of any kind.
  - No binaries and no generated output (node_modules, dist, target, venv, .git, .env).
  - Keep it under 200 files and 256KB packed.

{"case":{"caseId":"case:sha256:b962772e52b472c7e5618ee536d545ee39f87955c644092f954d9dcc67caa86c","contract":["beforeAll callback executes before any test cases in the suite and runs exactly once across all tests in that suite","multiple beforeAll hooks registered within the same suite execute sequentially in FIFO registration order","asynchronous beforeAll hook returning a Promise is awaited before any suite tests begin execution","beforeAll hook teardown function returned by callback executes after all suite tests have finished","in nested suites parent beforeAll hook runs before child beforeAll hook, and parent teardown runs after child teardown","when beforeAll hook throws an error the suite fails with the error and subsequent tests in the suite are skipped","beforeAll validates fixture parameter pattern and produces FixtureParseError when first parameter is not object destructured"],"goal":"verify @vitest/runner.beforeAll in pkg:npm/%40vitest/runner@4.1.11","kind":"HOW","packages":["pkg:npm/%40vitest/runner@4.1.11"],"schemaVersion":1,"symbols":["@vitest/runner.beforeAll"]},"contractCommand":["node","test/contract.mjs"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"npm","libc":"glibc","libcVersion":"2.39","os":"linux","osVersionBucket":"24","packageManager":"npm","schemaVersion":1},"license":"MIT-0","packages":["pkg:npm/%40vitest/runner@4.1.11"],"schemaVersion":1,"subject":"pkg:npm/%40vitest/runner@4.1.11","symbols":["@vitest/runner.beforeAll"],"verifierAdapter":"node-typescript@1"}

{
  "name": "sample-vitest-runner-beforeall",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-vitest-runner-beforeall",
      "version": "1.0.0",
      "license": "MIT-0",
      "dependencies": {
        "@vitest/runner": "4.1.11"
      }
    },
    "node_modules/@vitest/pretty-format": {
      "version": "4.1.11",
      "resolved": "https://registry.npmjs.org/@vitest/pretty-format/-/pretty-format-4.1.11.tgz",
      "integrity": "sha512-yiZzPbGTS9Sr/JpFl8zHrcIkAofNbFV6k21vIgQN/cY/oxZeXhJv5sc/MBJ5jFKWmWs+oJHw0UXLZjmf931+Vw==",
      "license": "MIT",
      "dependencies": {
        "tinyrainbow": "^3.1.0"
      },
      "funding": {
        "url": "https://opencollective.com/vitest"
      }
    },
    "node_modules/@vitest/runner": {
      "version": "4.1.11",
      "resolved": "https://registry.npmjs.org/@vitest/runner/-/runner-4.1.11.tgz",
      "integrity": "sha512-LztvUgdwMNJMIkj3hQnnxiC2Xy1zNxq928W/xhjCLaNCzqTZOudjwbQf6v9IntZGPw132i2Lq2rgTRZHD3JHNw==",
      "license": "MIT",
      "dependencies": {
        "@vitest/utils": "4.1.11",
        "pathe": "^2.0.3"
      },
      "funding": {
        "url": "https://opencollective.com/vitest"
      }
    },
    "node_modules/@vitest/utils": {
      "version": "4.1.11",
      "resolved": "https://registry.npmjs.org/@vitest/utils/-/utils-4.1.11.tgz",
      "integrity": "sha512-zTCVGpyFsGWBhllOyKlTw/vnr6D9qxsfSDyfbyZmTyjHw5N/VuvzHpHoQjm2ZJzn4RJgx5w4r7V0er69CmLgPQ==",
      "license": "MIT",
      "dependencies": {
        "@vitest/pretty-format": "4.1.11",
        "convert-source-map": "^2.0.0",
        "tinyrainbow": "^3.1.0"
      },
      "funding": {
        "url": "https://opencollective.com/vitest"
      }
    },
    "node_modules/convert-source-map": {
      "version": "2.0.0",
      "resolved": "https://registry.npmjs.org/convert-source-map/-/convert-source-map-2.0.0.tgz",
      "integrity": "sha512-Kvp459HrV2FEJ1CAsi1Ku+MY3kasH19TFykTz2xWmMeq6bk2NU3XXvfJ+Q61m0xktWwt+1HSYf3JZsTms3aRJg==",
      "license": "MIT"
    },
    "node_modules/pathe": {
      "version": "2.0.3",
      "resolved": "https://registry.npmjs.org/pathe/-/pathe-2.0.3.tgz",
      "integrity": "sha512-WUjGcAqP1gQacoQe+OBJsFA7Ld4DyXuUIjZ5cc75cLHvJ7dtNsTugphxIADwspS+AraAUePCKrSVtPLFj/F88w==",
      "license": "MIT"
    },
    "node_modules/tinyrainbow": {
      "version": "3.1.1",
      "resolved": "https://registry.npmjs.org/tinyrainbow/-/tinyrainbow-3.1.1.tgz",
      "integrity": "sha512-yau8yJdTt989Mm0Bd/236QnzEiPf2xLLTqUZRUJOo/3CB078LSwzei343DgtJVmfJKJE3TMINY1u42SQsP6mXw==",
      "license": "MIT",
      "engines": {
        "node": ">=14.0.0"
      }
    }
  }
}

{
  "name": "sample-vitest-runner-beforeall",
  "version": "1.0.0",
  "private": true,
  "type": "module",
  "license": "MIT-0",
  "dependencies": {
    "@vitest/runner": "4.1.11"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify @vitest/runner.beforeAll in pkg:npm/%40vitest/runner@4.1.11",
  "kind": "HOW",
  "packages": [
    "pkg:npm/%40vitest/runner@4.1.11"
  ],
  "symbols": [
    "@vitest/runner.beforeAll"
  ]
}

import { beforeAll, describe, test, it, startTests } from "@vitest/runner";

export { beforeAll, describe, test, it, startTests };

export function createRunner(importHandler, customConfig = {}) {
  return {
    config: {
      root: customConfig.root ?? process.cwd(),
      setupFiles: customConfig.setupFiles ?? [],
      name: customConfig.name ?? "contract-runner",
      passWithNoTests: true,
      testNamePattern: undefined,
      allowOnly: false,
      sequence: {
        shuffle: false,
        concurrent: false,
        seed: 1234,
        hooks: customConfig.hooksSequence ?? "stack",
        setupFiles: "list"
      },
      chaiConfig: undefined,
      maxConcurrency: 5,
      testTimeout: customConfig.testTimeout ?? 5000,
      hookTimeout: customConfig.hookTimeout ?? 10000,
      retry: 0,
      includeTaskLocation: false,
      tags: [],
      tagsFilter: undefined,
      strictTags: false
    },
    async importFile(filepath, source) {
      if (typeof importHandler === "function") {
        return importHandler(filepath, source);
      }
      return import(filepath);
    }
  };
}

export async function runRunnerSuite(specs, importHandler, customConfig = {}) {
  const runner = createRunner(importHandler, customConfig);
  return startTests(specs, runner);
}

import assert from "node:assert/strict";
import { runRunnerSuite } from "../src/index.mjs";
import { beforeAll, describe, test } from "@vitest/runner";

async function main() {
  // Assertion 1 & 2 & 3 & 4: beforeAll executes before any test cases, runs once across tests, executes FIFO, awaits async hooks, and supports teardown callbacks
  {
    let beforeAllCount = 0;
    const executionOrder = [];
    let asyncCompleted = false;

    const files = await runRunnerSuite(["suite-lifecycle.spec.mjs"], () => {
      describe("suite-lifecycle", () => {
        beforeAll(async () => {
          await new Promise((resolve) => setTimeout(resolve, 20));
          asyncCompleted = true;
          beforeAllCount++;
          executionOrder.push("beforeAll-1-async");
          return () => {
            executionOrder.push("beforeAll-1-teardown");
          };
        });

        beforeAll(() => {
          beforeAllCount++;
          executionOrder.push("beforeAll-2-sync");
        });

        test("test-1", () => {
          assert.equal(asyncCompleted, true);
          executionOrder.push("test-1");
        });

        test("test-2", () => {
          executionOrder.push("test-2");
        });
      });
    });

    assert.equal(files[0].result?.state, "pass");
    assert.equal(beforeAllCount, 2);
    assert.deepEqual(executionOrder, [
      "beforeAll-1-async",
      "beforeAll-2-sync",
      "test-1",
      "test-2",
      "beforeAll-1-teardown"
    ]);
    console.log("Assertion 1-4 passed: beforeAll execution order, singleton run, async awaiting, and teardown");
  }

  // Assertion 5: In nested suites, parent beforeAll runs before child beforeAll, and parent teardown runs after child teardown
  {
    const nestedOrder = [];

    const files = await runRunnerSuite(["nested-suites.spec.mjs"], () => {
      describe("parent-suite", () => {
        beforeAll(() => {
          nestedOrder.push("parent-before");
          return () => {
            nestedOrder.push("parent-after");
          };
        });

        test("parent-test", () => {
          nestedOrder.push("parent-test");
        });

        describe("child-suite", () => {
          beforeAll(() => {
            nestedOrder.push("child-before");
            return () => {
              nestedOrder.push("child-after");
            };
          });

          test("child-test", () => {
            nestedOrder.push("child-test");
          });
        });
      });
    });

    assert.equal(files[0].result?.state, "pass");
    assert.deepEqual(nestedOrder, [
      "parent-before",
      "parent-test",
      "child-before",
      "child-test",
      "child-after",
      "parent-after"
    ]);
    console.log("Assertion 5 passed: nested suite hook hierarchy and teardown ordering");
  }

  // Assertion 6: When beforeAll throws an error, suite fails and subsequent tests in the suite are skipped
  {
    let testExecuted = false;

    const files = await runRunnerSuite(["failing-hook.spec.mjs"], () => {
      describe("failing-suite", () => {
        beforeAll(() => {
          throw new Error("Deliberate hook failure for contract verification");
        });

        test("should-be-skipped", () => {
          testExecuted = true;
        });
      });
    });

    assert.equal(testExecuted, false);
    const suiteTask = files[0].tasks[0];
    assert.equal(suiteTask.result?.state, "fail");
    assert.equal(suiteTask.tasks[0].result?.state, "skip");
    assert.ok(suiteTask.result?.errors?.length > 0);
    assert.match(suiteTask.result.errors[0].message, /Deliberate hook failure/);
    console.log("Assertion 6 passed: failing beforeAll marks suite failed and skips tests");
  }

  // Assertion 7: beforeAll validates fixture parameter pattern and produces FixtureParseError when first parameter is not object destructured
  {
    const files = await runRunnerSuite(["fixture-validation.spec.mjs"], () => {
      describe("fixture-validation-suite", () => {
        beforeAll((undestructuredParam) => {});
        test("placeholder", () => {});
      });
    });

    const suiteTask = files[0].tasks[0];
    assert.equal(suiteTask.result?.state, "fail");
    assert.ok(suiteTask.result?.errors?.length > 0);
    const parseError = suiteTask.result.errors[0];
    assert.equal(parseError.name, "FixtureParseError");
    assert.match(
      parseError.message,
      /The 1st argument inside a fixture must use object destructuring pattern/
    );
    console.log("Assertion 7 passed: fixture argument pattern validation enforces object destructuring");
  }

  console.log("All @vitest/runner.beforeAll contract assertions passed successfully.");
}

main().catch((err) => {
  console.error("Contract test failed:", err);
  process.exit(1);
});