@vitest/runner 0.30.1 → 0.31.1

package/dist/chunk-tasks.js

@@ -85,7 +85,7 @@ function normalizeErrorMessage(message) {
 }
 function processError(err, options = {}) {
   if (!err || typeof err !== "object")
-    return err;
+    return { message: err };
   if (err.stack)
     err.stackStr = String(err.stack);
   if (err.name)

package/dist/index.d.ts

@@ -1,7 +1,7 @@
-import { V as VitestRunner } from './runner-3b8473ea.js';
-export { a as VitestRunnerConfig, c as VitestRunnerConstructor, b as VitestRunnerImportSource } from './runner-3b8473ea.js';
-import { T as Task, F as File, S as SuiteAPI, a as TestAPI, b as SuiteCollector, c as SuiteHooks, O as OnTestFailedHandler, d as Test } from './tasks-c965d7f6.js';
-export { D as DoneCallback, m as HookCleanupCallback, H as HookListener, R as RunMode, o as RuntimeContext, q as SequenceHooks, r as SequenceSetupFiles, j as Suite, n as SuiteFactory, f as TaskBase, g as TaskCustom, h as TaskResult, i as TaskResultPack, e as TaskState, p as TestContext, k as TestFunction, l as TestOptions } from './tasks-c965d7f6.js';
+import { V as VitestRunner } from './runner-a2cd0770.js';
+export { C as CancelReason, a as VitestRunnerConfig, c as VitestRunnerConstructor, b as VitestRunnerImportSource } from './runner-a2cd0770.js';
+import { T as Task, F as File, S as SuiteAPI, a as TestAPI, b as SuiteCollector, c as SuiteHooks, O as OnTestFailedHandler, d as Test } from './tasks-891047e7.js';
+export { D as DoneCallback, m as HookCleanupCallback, H as HookListener, R as RunMode, o as RuntimeContext, q as SequenceHooks, r as SequenceSetupFiles, j as Suite, n as SuiteFactory, f as TaskBase, g as TaskCustom, h as TaskResult, i as TaskResultPack, e as TaskState, p as TestContext, k as TestFunction, l as TestOptions } from './tasks-891047e7.js';
 import { Awaitable } from '@vitest/utils';
 
 declare function updateTask(task: Task, runner: VitestRunner): void;

package/dist/index.js

@@ -65,9 +65,29 @@ function makeTimeoutMsg(isHook, timeout) {
 If this is a long-running ${isHook ? "hook" : "test"}, pass a timeout value as the last argument or configure it globally with "${isHook ? "hookTimeout" : "testTimeout"}".`;
 }
 
+var version = "0.31.1";
+
+function getVersion() {
+  return globalThis.__vitest_runner_version__ || version;
+}
+function markVersion() {
+  globalThis.__vitest_runner_version__ = version;
+}
+function checkVersion() {
+  const collectVersion = getVersion();
+  if (collectVersion !== version) {
+    const error = `Version mismatch: Vitest started as ${collectVersion}, but tests are collected with ${version} version.
+
+- If you are using global Vitest, make sure your package has the same version.
+- If you have a monorepo setup, make sure your main package has the same version as your test packages.`;
+    throw new Error(error);
+  }
+}
+
 const suite = createSuite();
 const test = createTest(
   function(name, fn, options) {
+    checkVersion();
     getCurrentSuite().test.fn.call(this, name, fn, options);
   }
 );
@@ -106,10 +126,17 @@ function createSuiteCollector(name, factory = () => {
   const factoryQueue = [];
   let suite2;
   initSuite();
-  const test2 = createTest(function(name2, fn = noop, options = suiteOptions) {
+  const test2 = createTest(function(name2, fn = noop, options) {
     const mode2 = this.only ? "only" : this.skip ? "skip" : this.todo ? "todo" : "run";
     if (typeof options === "number")
       options = { timeout: options };
+    if (typeof suiteOptions === "object") {
+      options = {
+        repeats: suiteOptions.repeats,
+        retry: suiteOptions.retry,
+        ...options
+      };
+    }
     const test3 = {
       id: "",
       type: "test",
@@ -117,7 +144,8 @@ function createSuiteCollector(name, factory = () => {
       mode: mode2,
       suite: void 0,
       fails: this.fails,
-      retry: options == null ? void 0 : options.retry
+      retry: options == null ? void 0 : options.retry,
+      repeats: options == null ? void 0 : options.repeats
     };
     if (this.concurrent || concurrent)
       test3.concurrent = true;
@@ -149,6 +177,7 @@ function createSuiteCollector(name, factory = () => {
     type: "collector",
     name,
     mode,
+    options: suiteOptions,
     test: test2,
     tasks,
     collect,
@@ -160,6 +189,8 @@ function createSuiteCollector(name, factory = () => {
     getHooks(suite2)[name2].push(...fn);
   }
   function initSuite() {
+    if (typeof suiteOptions === "number")
+      suiteOptions = { timeout: suiteOptions };
     suite2 = {
       id: "",
       type: "suite",
@@ -196,7 +227,15 @@ function createSuiteCollector(name, factory = () => {
 }
 function createSuite() {
   function suiteFn(name, factory, options) {
+    var _a;
+    checkVersion();
     const mode = this.only ? "only" : this.skip ? "skip" : this.todo ? "todo" : "run";
+    const currentSuite = getCurrentSuite();
+    if (typeof options === "number")
+      options = { timeout: options };
+    if (currentSuite && typeof ((_a = currentSuite.options) == null ? void 0 : _a.repeats) === "number") {
+      options = { repeats: currentSuite.options.repeats, ...options };
+    }
     return createSuiteCollector(name, factory, mode, this.concurrent, this.shuffle, options);
   }
   suiteFn.each = function(cases, ...args) {
@@ -433,41 +472,48 @@ async function runTest(test, runner) {
   };
   updateTask(test, runner);
   setCurrentTest(test);
-  const retry = test.retry || 1;
-  for (let retryCount = 0; retryCount < retry; retryCount++) {
-    let beforeEachCleanups = [];
-    try {
-      await ((_c = runner.onBeforeTryTest) == null ? void 0 : _c.call(runner, test, retryCount));
-      beforeEachCleanups = await callSuiteHook(test.suite, test, "beforeEach", runner, [test.context, test.suite]);
-      test.result.retryCount = retryCount;
-      if (runner.runTest) {
-        await runner.runTest(test);
-      } else {
-        const fn = getFn(test);
-        if (!fn)
-          throw new Error("Test function is not found. Did you add it using `setFn`?");
-        await fn();
+  const repeats = typeof test.repeats === "number" ? test.repeats : 1;
+  for (let repeatCount = 0; repeatCount < repeats; repeatCount++) {
+    const retry = test.retry || 1;
+    for (let retryCount = 0; retryCount < retry; retryCount++) {
+      let beforeEachCleanups = [];
+      try {
+        await ((_c = runner.onBeforeTryTest) == null ? void 0 : _c.call(runner, test, { retry: retryCount, repeats: repeatCount }));
+        test.result.retryCount = retryCount;
+        test.result.repeatCount = repeatCount;
+        beforeEachCleanups = await callSuiteHook(test.suite, test, "beforeEach", runner, [test.context, test.suite]);
+        if (runner.runTest) {
+          await runner.runTest(test);
+        } else {
+          const fn = getFn(test);
+          if (!fn)
+            throw new Error("Test function is not found. Did you add it using `setFn`?");
+          await fn();
+        }
+        if (test.promises) {
+          const result = await Promise.allSettled(test.promises);
+          const errors = result.map((r) => r.status === "rejected" ? r.reason : void 0).filter(Boolean);
+          if (errors.length)
+            throw errors;
+        }
+        await ((_d = runner.onAfterTryTest) == null ? void 0 : _d.call(runner, test, { retry: retryCount, repeats: repeatCount }));
+        if (!test.repeats)
+          test.result.state = "pass";
+        else if (test.repeats && retry === retryCount)
+          test.result.state = "pass";
+      } catch (e) {
+        failTask(test.result, e);
       }
-      if (test.promises) {
-        const result = await Promise.allSettled(test.promises);
-        const errors = result.map((r) => r.status === "rejected" ? r.reason : void 0).filter(Boolean);
-        if (errors.length)
-          throw errors;
+      try {
+        await callSuiteHook(test.suite, test, "afterEach", runner, [test.context, test.suite]);
+        await callCleanupHooks(beforeEachCleanups);
+      } catch (e) {
+        failTask(test.result, e);
       }
-      await ((_d = runner.onAfterTryTest) == null ? void 0 : _d.call(runner, test, retryCount));
-      test.result.state = "pass";
-    } catch (e) {
-      failTask(test.result, e);
-    }
-    try {
-      await callSuiteHook(test.suite, test, "afterEach", runner, [test.context, test.suite]);
-      await callCleanupHooks(beforeEachCleanups);
-    } catch (e) {
-      failTask(test.result, e);
+      if (test.result.state === "pass")
+        break;
+      updateTask(test, runner);
     }
-    if (test.result.state === "pass")
-      break;
-    updateTask(test, runner);
   }
   if (test.result.state === "fail")
     await Promise.all(((_e = test.onFailed) == null ? void 0 : _e.map((fn) => fn(test.result))) || []);
@@ -558,24 +604,24 @@ async function runSuite(suite, runner) {
     } catch (e) {
       failTask(suite.result, e);
     }
-  }
-  suite.result.duration = now() - start;
-  if (suite.mode === "run") {
-    if (!hasTests(suite)) {
-      suite.result.state = "fail";
-      if (!suite.result.error) {
-        const error = processError(new Error(`No test found in suite ${suite.name}`));
-        suite.result.error = error;
-        suite.result.errors = [error];
+    if (suite.mode === "run") {
+      if (!hasTests(suite)) {
+        suite.result.state = "fail";
+        if (!suite.result.error) {
+          const error = processError(new Error(`No test found in suite ${suite.name}`));
+          suite.result.error = error;
+          suite.result.errors = [error];
+        }
+      } else if (hasFailed(suite)) {
+        suite.result.state = "fail";
+      } else {
+        suite.result.state = "pass";
       }
-    } else if (hasFailed(suite)) {
-      suite.result.state = "fail";
-    } else {
-      suite.result.state = "pass";
     }
+    updateTask(suite, runner);
+    suite.result.duration = now() - start;
+    await ((_c = runner.onAfterRunSuite) == null ? void 0 : _c.call(runner, suite));
   }
-  await ((_c = runner.onAfterRunSuite) == null ? void 0 : _c.call(runner, suite));
-  updateTask(suite, runner);
 }
 async function runSuiteChild(c, runner) {
   if (c.type === "test")
@@ -601,6 +647,7 @@ async function runFiles(files, runner) {
 }
 async function startTests(paths, runner) {
   var _a, _b, _c, _d;
+  markVersion();
   await ((_a = runner.onBeforeCollect) == null ? void 0 : _a.call(runner, paths));
   const files = await collectTests(paths, runner);
   (_b = runner.onCollected) == null ? void 0 : _b.call(runner, files);

package/dist/{runner-3b8473ea.d.ts → runner-a2cd0770.d.ts}

@@ -1,4 +1,4 @@
-import { q as SequenceHooks, r as SequenceSetupFiles, F as File, d as Test, j as Suite, h as TaskResult, p as TestContext } from './tasks-c965d7f6.js';
+import { q as SequenceHooks, r as SequenceSetupFiles, F as File, d as Test, j as Suite, h as TaskResult, p as TestContext } from './tasks-891047e7.js';
 
 interface VitestRunnerConfig {
     root: string;
@@ -24,6 +24,7 @@ type VitestRunnerImportSource = 'collect' | 'setup';
 interface VitestRunnerConstructor {
     new (config: VitestRunnerConfig): VitestRunner;
 }
+type CancelReason = 'keyboard-input' | 'test-failure' | string & {};
 interface VitestRunner {
     /**
      * First thing that's getting called before actually collecting and running tests.
@@ -33,6 +34,12 @@ interface VitestRunner {
      * Called after collecting tests and before "onBeforeRun".
      */
     onCollected?(files: File[]): unknown;
+    /**
+     * Called when test runner should cancel next test runs.
+     * Runner should listen for this method and mark tests and suites as skipped in
+     * "onBeforeRunSuite" and "onBeforeRunTest" when called.
+     */
+    onCancel?(reason: CancelReason): unknown;
     /**
      * Called before running a single test. Doesn't have "result" yet.
      */
@@ -40,7 +47,10 @@ interface VitestRunner {
     /**
      * Called before actually running the test function. Already has "result" with "state" and "startTime".
      */
-    onBeforeTryTest?(test: Test, retryCount: number): unknown;
+    onBeforeTryTest?(test: Test, options: {
+        retry: number;
+        repeats: number;
+    }): unknown;
     /**
      * Called after result and state are set.
      */
@@ -48,7 +58,10 @@ interface VitestRunner {
     /**
      * Called right after running the test function. Doesn't have new state yet. Will not be called, if the test function throws.
      */
-    onAfterTryTest?(test: Test, retryCount: number): unknown;
+    onAfterTryTest?(test: Test, options: {
+        retry: number;
+        repeats: number;
+    }): unknown;
     /**
      * Called before running a single suite. Doesn't have "result" yet.
      */
@@ -94,4 +107,4 @@ interface VitestRunner {
     config: VitestRunnerConfig;
 }
 
-export { VitestRunner as V, VitestRunnerConfig as a, VitestRunnerImportSource as b, VitestRunnerConstructor as c };
+export { CancelReason as C, VitestRunner as V, VitestRunnerConfig as a, VitestRunnerImportSource as b, VitestRunnerConstructor as c };

package/dist/{tasks-c965d7f6.d.ts → tasks-891047e7.d.ts}

@@ -22,6 +22,7 @@ interface TaskBase {
     result?: TaskResult;
     retry?: number;
     meta?: any;
+    repeats?: number;
 }
 interface TaskCustom extends TaskBase {
     type: 'custom';
@@ -39,6 +40,7 @@ interface TaskResult {
     htmlError?: string;
     hooks?: Partial<Record<keyof SuiteHooks, TaskState>>;
     retryCount?: number;
+    repeatCount?: number;
 }
 type TaskResultPack = [id: string, result: TaskResult | undefined];
 interface Suite extends TaskBase {
@@ -111,6 +113,14 @@ interface TestOptions {
      * @default 1
      */
     retry?: number;
+    /**
+     * How many times the test will run.
+     * Only inner tests will repeat if set on `describe()`, nested `describe()` will inherit parent's repeat by default.
+     *
+     * @default 1
+     *
+     */
+    repeats?: number;
 }
 type TestAPI<ExtraContext = {}> = ChainableTestAPI<ExtraContext> & {
     each: TestEachFunction;
@@ -141,6 +151,7 @@ interface SuiteHooks<ExtraContext = {}> {
 interface SuiteCollector<ExtraContext = {}> {
     readonly name: string;
     readonly mode: RunMode;
+    options?: TestOptions;
     type: 'collector';
     test: TestAPI<ExtraContext>;
     tasks: (Suite | TaskCustom | Test | SuiteCollector<ExtraContext>)[];

package/dist/types.d.ts

@@ -1,3 +1,3 @@
-export { D as DoneCallback, F as File, m as HookCleanupCallback, H as HookListener, O as OnTestFailedHandler, R as RunMode, o as RuntimeContext, q as SequenceHooks, r as SequenceSetupFiles, j as Suite, S as SuiteAPI, b as SuiteCollector, n as SuiteFactory, c as SuiteHooks, T as Task, f as TaskBase, g as TaskCustom, h as TaskResult, i as TaskResultPack, e as TaskState, d as Test, a as TestAPI, p as TestContext, k as TestFunction, l as TestOptions } from './tasks-c965d7f6.js';
-export { V as VitestRunner, a as VitestRunnerConfig, c as VitestRunnerConstructor, b as VitestRunnerImportSource } from './runner-3b8473ea.js';
+export { D as DoneCallback, F as File, m as HookCleanupCallback, H as HookListener, O as OnTestFailedHandler, R as RunMode, o as RuntimeContext, q as SequenceHooks, r as SequenceSetupFiles, j as Suite, S as SuiteAPI, b as SuiteCollector, n as SuiteFactory, c as SuiteHooks, T as Task, f as TaskBase, g as TaskCustom, h as TaskResult, i as TaskResultPack, e as TaskState, d as Test, a as TestAPI, p as TestContext, k as TestFunction, l as TestOptions } from './tasks-891047e7.js';
+export { C as CancelReason, V as VitestRunner, a as VitestRunnerConfig, c as VitestRunnerConstructor, b as VitestRunnerImportSource } from './runner-a2cd0770.js';
 import '@vitest/utils';

package/dist/utils.d.ts

@@ -1,5 +1,5 @@
-import { j as Suite, T as Task, d as Test, g as TaskCustom } from './tasks-c965d7f6.js';
-export { C as ChainableFunction, s as createChainable } from './tasks-c965d7f6.js';
+import { j as Suite, T as Task, d as Test, g as TaskCustom } from './tasks-891047e7.js';
+export { C as ChainableFunction, s as createChainable } from './tasks-891047e7.js';
 import { Arrayable } from '@vitest/utils';
 export { ErrorWithDiff, ParsedStack } from '@vitest/utils';
 import { DiffOptions } from '@vitest/utils/diff';

package/package.json

@@ -1,14 +1,19 @@
 {
   "name": "@vitest/runner",
   "type": "module",
-  "version": "0.30.1",
+  "version": "0.31.1",
   "description": "Vitest test runner",
   "license": "MIT",
+  "funding": "https://opencollective.com/vitest",
+  "homepage": "https://github.com/vitest-dev/vitest/tree/main/packages/runner#readme",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/vitest-dev/vitest.git",
     "directory": "packages/runner"
   },
+  "bugs": {
+    "url": "https://github.com/vitest-dev/vitest/issues"
+  },
   "sideEffects": true,
   "exports": {
     ".": {
@@ -36,7 +41,7 @@
     "concordance": "^5.0.4",
     "p-limit": "^4.0.0",
     "pathe": "^1.1.0",
-    "@vitest/utils": "0.30.1"
+    "@vitest/utils": "0.31.1"
   },
   "scripts": {
     "build": "rimraf dist && rollup -c",