@vitest/runner 4.1.10: 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.10
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/%40vitest/runner@4.1.10
Demonstrate these symbols/APIs:
  - @vitest/runner.beforeAll
Constraints:
  - executionContext: node
Required runtime conditions:
  - ecosystem: npm
  - language: javascript
  - moduleSystem: cjs
  - packageManager: npm@10.9.8
  - runtime: node@22.23.2

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:7563e049f5fb356b4634483b0390408ff450ac6ce9d363487d3162ba16b772eb","constraints":{"executionContext":"node"},"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.10","kind":"HOW","packages":["pkg:npm/%40vitest/runner@4.1.10"],"schemaVersion":1,"symbols":["@vitest/runner.beforeAll"]},"contractCommand":["node","test/contract.mjs"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"npm","executionContext":"node","language":"javascript","libc":"glibc","libcVersion":"2.39","moduleSystem":"cjs","os":"linux","osVersionBucket":"24","packageManager":"npm","packageManagerVersion":"10.9.8","runtime":"node","runtimeVersion":"22.23.2","schemaVersion":1},"license":"MIT-0","packages":["pkg:npm/%40vitest/runner@4.1.10"],"schemaVersion":1,"subject":"pkg:npm/%40vitest/runner@4.1.10","symbols":["@vitest/runner.beforeAll"],"verifierAdapter":"node-typescript@1"}

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

/**
 * Creates a minimal VitestRunner instance configured for in-memory test execution.
 *
 * @param {Function} importHandler - Async function called to define or import tests
 * @param {Object} [configOverrides] - Optional configuration overrides
 * @returns {Object} A VitestRunner-compatible runner object
 */
export function createRunner(importHandler, configOverrides = {}) {
  return {
    config: {
      root: process.cwd(),
      setupFiles: [],
      name: "vitest-runner-beforeall",
      passWithNoTests: true,
      testNamePattern: undefined,
      allowOnly: true,
      sequence: {
        seed: 42,
        hooks: "stack",
        setupFiles: "list",
        shuffle: false,
      },
      chaiConfig: undefined,
      maxConcurrency: 5,
      testTimeout: 5000,
      hookTimeout: 5000,
      retry: 0,
      includeTaskLocation: false,
      tags: [],
      tagsFilter: undefined,
      strictTags: false,
      ...configOverrides,
    },
    async importFile(filepath, source) {
      if (typeof importHandler === "function") {
        return importHandler(filepath, source);
      }
      return import(filepath);
    },
  };
}

/**
 * Helper to run a test suite in-memory with the Vitest test runner.
 *
 * @param {Function} suiteDefinition - Function defining describe/test/beforeAll blocks
 * @param {string} [specName='spec.test.js'] - Virtual test spec name
 * @param {Object} [configOverrides] - Optional runner configuration overrides
 * @returns {Promise<Array>} Array of executed test file results
 */
export async function runSuite(suiteDefinition, specName = "spec.test.js", configOverrides = {}) {
  const runner = createRunner(async () => {
    suiteDefinition();
  }, configOverrides);

  return await startTests([specName], runner);
}

export {
  startTests,
  describe,
  it,
  test,
  suite,
  beforeAll,
  afterAll,
  beforeEach,
  afterEach,
};

{
  "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.10"
      }
    },
    "node_modules/@vitest/pretty-format": {
      "version": "4.1.10",
      "resolved": "https://registry.npmjs.org/@vitest/pretty-format/-/pretty-format-4.1.10.tgz",
      "integrity": "sha512-W1HsjSH4MXQ9YfmmhLAoIYf1HRfekQCGngeIgcei6MP5QQGWUe0gkopdZQaVCFO+JDJMrAJGwa5pRpNpvy4P8Q==",
      "license": "MIT",
      "dependencies": {
        "tinyrainbow": "^3.1.0"
      },
      "funding": {
        "url": "https://opencollective.com/vitest"
      }
    },
    "node_modules/@vitest/runner": {
      "version": "4.1.10",
      "resolved": "https://registry.npmjs.org/@vitest/runner/-/runner-4.1.10.tgz",
      "integrity": "sha512-IKI6kpIH+LmpROplyLwBBaCfMgOZOMsygVa6BARD6ahA04VRuJSa6OaVG7kRvSEMD870Vd91rSSw0eegtWyLGg==",
      "license": "MIT",
      "dependencies": {
        "@vitest/utils": "4.1.10",
        "pathe": "^2.0.3"
      },
      "funding": {
        "url": "https://opencollective.com/vitest"
      }
    },
    "node_modules/@vitest/utils": {
      "version": "4.1.10",
      "resolved": "https://registry.npmjs.org/@vitest/utils/-/utils-4.1.10.tgz",
      "integrity": "sha512-fy9am/HWxbaGt/Sawrp90vt6Y6jQwf1RX77cz3uwoJwJVMli/e1IEwRPnMNJ7vKfPTwo0diXifkpPvwH9v7nGA==",
      "license": "MIT",
      "dependencies": {
        "@vitest/pretty-format": "4.1.10",
        "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",
  "description": "Clean-room verification of @vitest/runner.beforeAll in @vitest/runner@4.1.10",
  "type": "module",
  "private": true,
  "license": "MIT-0",
  "scripts": {
    "test": "node test/contract.mjs"
  },
  "dependencies": {
    "@vitest/runner": "4.1.10"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify @vitest/runner.beforeAll in pkg:npm/%40vitest/runner@4.1.10",
  "kind": "HOW",
  "packages": [
    "pkg:npm/%40vitest/runner@4.1.10"
  ],
  "symbols": [
    "@vitest/runner.beforeAll"
  ],
  "constraints": {
    "executionContext": "node"
  },
  "runtimeConditions": {
    "ecosystem": "npm",
    "language": "javascript",
    "moduleSystem": "cjs",
    "packageManager": "npm@10.9.8",
    "runtime": "node@22.23.2"
  }
}

import assert from "node:assert/strict";
import {
  runSuite,
  beforeAll,
  describe,
  test,
} from "../index.mjs";

async function main() {
  // Assertion 1: beforeAll callback executes before any test cases in the suite and runs exactly once across all tests in that suite
  {
    let beforeAllCount = 0;
    const executionOrder = [];

    const files = await runSuite(() => {
      describe("suite-singleton", () => {
        beforeAll(() => {
          beforeAllCount++;
          executionOrder.push("beforeAll");
        });

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

        test("test-2", () => {
          executionOrder.push("test-2");
        });
      });
    }, "suite-singleton.spec.mjs");

    assert.equal(files[0].result?.state, "pass");
    assert.equal(beforeAllCount, 1);
    assert.deepEqual(executionOrder, ["beforeAll", "test-1", "test-2"]);
    console.log("Assertion 1 passed");
  }

  // Assertion 2: multiple beforeAll hooks registered within the same suite execute sequentially in FIFO registration order
  {
    const order = [];
    const files = await runSuite(() => {
      describe("suite-fifo", () => {
        beforeAll(() => {
          order.push("first");
        });
        beforeAll(() => {
          order.push("second");
        });
        test("test", () => {
          order.push("test");
        });
      });
    }, "suite-fifo.spec.mjs");

    assert.equal(files[0].result?.state, "pass");
    assert.deepEqual(order, ["first", "second", "test"]);
    console.log("Assertion 2 passed");
  }

  // Assertion 3: asynchronous beforeAll hook returning a Promise is awaited before any suite tests begin execution
  {
    let asyncCompleted = false;
    const files = await runSuite(() => {
      describe("suite-async", () => {
        beforeAll(async () => {
          await new Promise((resolve) => setTimeout(resolve, 20));
          asyncCompleted = true;
        });
        test("test-async-awaited", () => {
          assert.equal(asyncCompleted, true);
        });
      });
    }, "suite-async.spec.mjs");

    assert.equal(files[0].result?.state, "pass");
    assert.equal(asyncCompleted, true);
    console.log("Assertion 3 passed");
  }

  // Assertion 4: beforeAll hook teardown function returned by callback executes after all suite tests have finished
  {
    const events = [];
    const files = await runSuite(() => {
      describe("suite-teardown", () => {
        beforeAll(() => {
          events.push("setup");
          return () => {
            events.push("teardown");
          };
        });
        test("test-1", () => {
          events.push("test-1");
        });
        test("test-2", () => {
          events.push("test-2");
        });
      });
    }, "suite-teardown.spec.mjs");

    assert.equal(files[0].result?.state, "pass");
    assert.deepEqual(events, ["setup", "test-1", "test-2", "teardown"]);
    console.log("Assertion 4 passed");
  }

  // Assertion 5: in nested suites parent beforeAll hook runs before child beforeAll hook, and parent teardown runs after child teardown
  {
    const nestedOrder = [];
    const files = await runSuite(() => {
      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");
          });
        });
      });
    }, "nested-suites.spec.mjs");

    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");
  }

  // Assertion 6: when beforeAll hook throws an error the suite fails with the error and subsequent tests in the suite are skipped
  {
    let testExecuted = false;
    const files = await runSuite(() => {
      describe("failing-suite", () => {
        beforeAll(() => {
          throw new Error("Deliberate hook failure for contract verification");
        });

        test("should-be-skipped", () => {
          testExecuted = true;
        });
      });
    }, "failing-hook.spec.mjs");

    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");
  }

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

    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");
  }

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

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