@japa/runner 4.3.0 → 4.4.0

package/build/{chunk-PCBL2VZP.js → chunk-L7YZLDZD.js}

@@ -16,8 +16,11 @@ import ms from "ms";
 import { ErrorsPrinter } from "@japa/errors-printer";
 
 // src/helpers.ts
+import string from "@poppinss/string";
 import useColors from "@poppinss/colors";
+import { fileURLToPath } from "url";
 import supportsColor from "supports-color";
+import { parse } from "error-stack-parser-es";
 var colors = supportsColor.stdout ? useColors.ansi() : useColors.silent();
 var icons = process.platform === "win32" && !process.env.WT_SESSION ? {
   tick: "\u221A",
@@ -40,6 +43,47 @@ var icons = process.platform === "win32" && !process.env.WT_SESSION ? {
   branch: "\u2514\u2500\u2500",
   squareSmallFilled: "\u25FC"
 };
+function formatPinnedTest(test) {
+  let fileName = "";
+  let line = 0;
+  let column = 0;
+  try {
+    test.options.meta.abort("Finding pinned test location");
+  } catch (error) {
+    const frame = parse(error).find(
+      (f) => f.fileName && f.lineNumber !== void 0 && f.columnNumber !== void 0 && !f.fileName.includes("node:") && !f.fileName.includes("ext:") && !f.fileName.includes("node_modules/")
+    );
+    if (frame) {
+      fileName = frame.fileName.startsWith("file:") ? string.toUnixSlash(fileURLToPath(frame.fileName)) : string.toUnixSlash(frame.fileName);
+      line = frame.lineNumber;
+      column = frame.columnNumber;
+    }
+  }
+  return `${colors.yellow(` \u2043 ${test.title}`)}
+${colors.dim(`   ${fileName}:${line}:${column}`)}`;
+}
+function printPinnedTests(runner) {
+  let pinnedTests = [];
+  runner.suites.forEach((suite) => {
+    suite.stack.forEach((testOrGroup) => {
+      if (testOrGroup instanceof Group) {
+        testOrGroup.tests.forEach(($test) => {
+          if ($test.isPinned) {
+            pinnedTests.push(formatPinnedTest($test));
+          }
+        });
+      } else if (testOrGroup.isPinned) {
+        pinnedTests.push(formatPinnedTest(testOrGroup));
+      }
+    });
+  });
+  if (pinnedTests.length) {
+    console.log(colors.bgYellow().black(` ${pinnedTests.length} pinned test(s) found `));
+    pinnedTests.forEach((row) => console.log(row));
+  } else {
+    console.log(colors.bgYellow().black(` No pinned tests found `));
+  }
+}
 
 // modules/core/reporters/base.ts
 var BaseReporter = class {
@@ -218,7 +262,7 @@ var TestContext = class extends BaseTestContext {
     };
   }
 };
-var Test = class extends BaseTest {
+var Test2 = class extends BaseTest {
   /**
    * @inheritdoc
    */
@@ -278,18 +322,19 @@ var Group = class extends BaseGroup {
 };
 var Suite = class extends BaseSuite {
 };
-var Runner = class extends BaseRunner {
+var Runner2 = class extends BaseRunner {
 };
 
 export {
-  colors,
-  icons,
   BaseReporter,
   Emitter,
   Refiner,
   TestContext,
-  Test,
+  Test2 as Test,
   Group,
   Suite,
-  Runner
+  Runner2 as Runner,
+  colors,
+  icons,
+  printPinnedTests
 };

package/build/{chunk-U3BSXCEH.js → chunk-RFKFNXTE.js}

@@ -2,7 +2,7 @@ import {
   BaseReporter,
   colors,
   icons
-} from "./chunk-PCBL2VZP.js";
+} from "./chunk-L7YZLDZD.js";
 
 // src/reporters/dot.ts
 var DotReporter = class extends BaseReporter {

package/build/{chunk-Y57JXJ7G.js → chunk-TLYU3GFT.js}

@@ -3,14 +3,14 @@ import {
   github,
   ndjson,
   spec
-} from "./chunk-U3BSXCEH.js";
+} from "./chunk-RFKFNXTE.js";
 import {
   Group,
   Refiner,
   Test,
   TestContext,
   colors
-} from "./chunk-PCBL2VZP.js";
+} from "./chunk-L7YZLDZD.js";
 
 // src/debug.ts
 import { debuglog } from "util";
@@ -261,10 +261,11 @@ var GlobalHooks = class {
 import getopts from "getopts";
 var OPTIONS = {
   string: ["tests", "groups", "tags", "files", "timeout", "retries", "reporters", "bailLayer"],
-  boolean: ["help", "matchAll", "failed", "bail"],
+  boolean: ["help", "matchAll", "failed", "bail", "listPinned"],
   alias: {
     forceExit: "force-exit",
     matchAll: "match-all",
+    listPinned: "list-pinned",
     bailLayer: "bail-layer",
     help: "h"
   }
@@ -276,6 +277,7 @@ ${colors.green("--tests")}                     ${colors.dim("Filter tests by the
 ${colors.green("--groups")}                    ${colors.dim("Filter tests by the group title")}
 ${colors.green("--tags")}                      ${colors.dim("Filter tests by tags")}
 ${colors.green("--match-all")}                 ${colors.dim("Run tests that matches all the supplied tags")}
+${colors.green("--list-pinned")}               ${colors.dim("List pinned tests")}
 ${colors.green("--files")}                     ${colors.dim("Filter tests by the file name")}
 ${colors.green("--force-exit")}                ${colors.dim("Forcefully exit the process")}
 ${colors.green("--timeout")}                   ${colors.dim("Define default timeout for all tests")}
@@ -470,11 +472,15 @@ var ConfigManager = class {
 
 // src/create_test.ts
 var contextBuilder = (testInstance) => new TestContext(testInstance);
-function createTest(title, emitter, refiner, options) {
+function createTest(title, emitter, refiner, debuggingError, options) {
   const testInstance = new Test(title, contextBuilder, emitter, refiner, options.group);
   testInstance.options.meta.suite = options.suite;
   testInstance.options.meta.group = options.group;
   testInstance.options.meta.fileName = options.file;
+  testInstance.options.meta.abort = (message) => {
+    debuggingError.message = message;
+    throw debuggingError;
+  };
   if (options.timeout !== void 0) {
     testInstance.timeout(options.timeout);
   }

package/build/factories/main.js

@@ -5,13 +5,13 @@ import {
   Planner,
   createTest,
   createTestGroup
-} from "../chunk-Y57JXJ7G.js";
-import "../chunk-U3BSXCEH.js";
+} from "../chunk-TLYU3GFT.js";
+import "../chunk-RFKFNXTE.js";
 import {
   Emitter,
   Runner,
   Suite
-} from "../chunk-PCBL2VZP.js";
+} from "../chunk-L7YZLDZD.js";
 import "../chunk-2KG3PWR4.js";
 
 // factories/runner.ts
@@ -59,10 +59,11 @@ var RunnerFactory = class {
   async runTest(title, callback) {
     return this.runSuites((emitter, refiner, file) => {
       const defaultSuite = new Suite("default", emitter, refiner);
-      createTest(title, emitter, refiner, {
+      const debuggingError = new Error();
+      createTest(title, emitter, refiner, debuggingError, {
         suite: defaultSuite,
         file
-      }).run(callback);
+      }).run(callback, debuggingError);
       return [defaultSuite];
     });
   }
@@ -107,38 +108,38 @@ function createUnitTestsSuite(emitter, refiner, file) {
     suite,
     file
   });
-  createTest("A top level test inside a suite", emitter, refiner, {
+  createTest("A top level test inside a suite", emitter, refiner, new Error(), {
     suite,
     file
   }).run(() => {
   });
-  createTest("add two numbers", emitter, refiner, { group, file }).run(() => {
+  createTest("add two numbers", emitter, refiner, new Error(), { group, file }).run(() => {
     assert.equal(2 + 2, 4);
   });
-  createTest("add three numbers", emitter, refiner, {
+  createTest("add three numbers", emitter, refiner, new Error(), {
     group,
     file
   }).run(() => {
     assert.equal(2 + 2 + 2, 6);
   });
-  createTest("add group of numbers", emitter, refiner, { group, file });
-  createTest("use math.js lib", emitter, refiner, { group, file }).skip(
+  createTest("add group of numbers", emitter, refiner, new Error(), { group, file });
+  createTest("use math.js lib", emitter, refiner, new Error(), { group, file }).skip(
     true,
     "Library work pending"
   );
-  createTest("add multiple numbers", emitter, refiner, {
+  createTest("add multiple numbers", emitter, refiner, new Error(), {
     file,
     group
   }).run(() => {
     assert.equal(2 + 2 + 2 + 2, 6);
   });
-  createTest("add floating numbers", emitter, refiner, { group, file }).run(() => {
+  createTest("add floating numbers", emitter, refiner, new Error(), { group, file }).run(() => {
     assert.equal(2 + 2.2 + 2.1, 6);
   }).fails("Have to add support for floating numbers");
-  createTest("regression test that is passing", emitter, refiner, { group, file }).run(() => {
+  createTest("regression test that is passing", emitter, refiner, new Error(), { group, file }).run(() => {
     assert.equal(2 + 2.2 + 2.1, 2 + 2.2 + 2.1);
   }).fails("Have to add support for floating numbers");
-  createTest("A test with an error that is not an AssertionError", emitter, refiner, {
+  createTest("A test with an error that is not an AssertionError", emitter, refiner, new Error(), {
     group,
     file
   }).run(() => {
@@ -152,32 +153,32 @@ function createFunctionalTestsSuite(emitter, refiner, file) {
     suite,
     file
   });
-  createTest("Validate user data", emitter, refiner, {
+  createTest("Validate user data", emitter, refiner, new Error(), {
     group,
     file
   }).run(() => {
   });
-  createTest("Disallow duplicate emails", emitter, refiner, {
+  createTest("Disallow duplicate emails", emitter, refiner, new Error(), {
     group,
     file
   }).run(() => {
   });
-  createTest("Disallow duplicate emails across tenants", emitter, refiner, {
+  createTest("Disallow duplicate emails across tenants", emitter, refiner, new Error(), {
     group,
     file
   }).run(() => {
     const users = ["", ""];
     assert.equal(users.length, 1);
   });
-  createTest("Normalize email before persisting it", emitter, refiner, {
+  createTest("Normalize email before persisting it", emitter, refiner, new Error(), {
     group,
     file
   }).skip(true, "Have to build a normalizer");
-  createTest("Send email verification mail", emitter, refiner, {
+  createTest("Send email verification mail", emitter, refiner, new Error(), {
     group,
     file
   });
-  createTest("Test that times out", emitter, refiner, {
+  createTest("Test that times out", emitter, refiner, new Error(), {
     group,
     file
   }).run(() => {
@@ -192,10 +193,16 @@ function createFunctionalTestsSuite(emitter, refiner, file) {
   usersListGroup.setup(() => {
     throw new Error("Unable to cleanup database");
   });
-  createTest("A test that will never run because the group hooks fails", emitter, refiner, {
-    group: usersListGroup
-  });
-  createTest("A top level test inside functional suite", emitter, refiner, {
+  createTest(
+    "A test that will never run because the group hooks fails",
+    emitter,
+    refiner,
+    new Error(),
+    {
+      group: usersListGroup
+    }
+  );
+  createTest("A top level test inside functional suite", emitter, refiner, new Error(), {
     suite,
     file
   }).run(() => {

package/build/index.js

@@ -7,14 +7,15 @@ import {
   createTestGroup,
   debug_default,
   validator_default
-} from "./chunk-Y57JXJ7G.js";
-import "./chunk-U3BSXCEH.js";
+} from "./chunk-TLYU3GFT.js";
+import "./chunk-RFKFNXTE.js";
 import {
   Emitter,
   Runner,
   Suite,
-  colors
-} from "./chunk-PCBL2VZP.js";
+  colors,
+  printPinnedTests
+} from "./chunk-L7YZLDZD.js";
 import "./chunk-2KG3PWR4.js";
 
 // index.ts
@@ -23,7 +24,7 @@ import { ErrorsPrinter as ErrorsPrinter2 } from "@japa/errors-printer";
 
 // src/plugins/retry.ts
 import { join } from "path";
-import findCacheDirectory from "find-cache-dir";
+import findCacheDirectory from "find-cache-directory";
 import { mkdir, readFile, unlink, writeFile } from "fs/promises";
 var CACHE_DIR = findCacheDirectory({ name: "@japa/runner" });
 var SUMMARY_FILE = CACHE_DIR ? join(CACHE_DIR, "summary.json") : void 0;
@@ -144,7 +145,14 @@ var executionPlanState = {
 };
 function test(title, callback) {
   validator_default.ensureIsInPlanningPhase(executionPlanState.phase);
-  const testInstance = createTest(title, emitter, runnerConfig.refiner, executionPlanState);
+  const debuggingError = new Error();
+  const testInstance = createTest(
+    title,
+    emitter,
+    runnerConfig.refiner,
+    debuggingError,
+    executionPlanState
+  );
   testInstance.setup((t) => {
     activeTest = t;
     return () => {
@@ -152,7 +160,7 @@ function test(title, callback) {
     };
   });
   if (callback) {
-    testInstance.run(callback, new Error());
+    testInstance.run(callback, debuggingError);
   }
   return testInstance;
 }
@@ -220,7 +228,9 @@ async function run() {
     runner.onSuite(config.configureSuite);
     debug_default("executing global hooks");
     globalHooks.apply(config);
-    await globalHooks.setup(runner);
+    if (!cliArgs.listPinned) {
+      await globalHooks.setup(runner);
+    }
     for (let suite of suites) {
       debug_default("initiating suite %s", suite.name);
       executionPlanState.suite = new Suite(suite.name, emitter, config.refiner);
@@ -241,6 +251,14 @@ async function run() {
       }
       executionPlanState.suite = void 0;
     }
+    if (cliArgs.listPinned) {
+      printPinnedTests(runner);
+      if (config.forceExit) {
+        debug_default("force exiting process");
+        process.exit();
+      }
+      return;
+    }
     executionPlanState.phase = "executing";
     exceptionsManager.monitor();
     await runner.start();

package/build/modules/core/main.js

@@ -7,7 +7,7 @@ import {
   Suite,
   Test,
   TestContext
-} from "../../chunk-PCBL2VZP.js";
+} from "../../chunk-L7YZLDZD.js";
 import "../../chunk-2KG3PWR4.js";
 export {
   BaseReporter,

package/build/src/create_test.d.ts

@@ -2,7 +2,7 @@ import { Emitter, Group, Refiner, Suite, Test } from '../modules/core/main.js';
 /**
  * Create a new instance of the Test
  */
-export declare function createTest(title: string, emitter: Emitter, refiner: Refiner, options: {
+export declare function createTest(title: string, emitter: Emitter, refiner: Refiner, debuggingError: Error, options: {
     group?: Group;
     suite?: Suite;
     file?: string;

package/build/src/helpers.d.ts

@@ -1,4 +1,5 @@
 import { Colors } from '@poppinss/colors/types';
+import { Runner, Test } from '../modules/core/main.js';
 export declare const colors: Colors;
 /**
  * A collection of platform specific icons
@@ -14,3 +15,12 @@ export declare const icons: {
     branch: string;
     squareSmallFilled: string;
 };
+/**
+ * Returns a formatted string to print the information about
+ * a pinned test
+ */
+export declare function formatPinnedTest(test: Test): string;
+/**
+ * Prints a summary of all the pinned tests
+ */
+export declare function printPinnedTests(runner: Runner): void;

package/build/src/plugins/disallow_pinned_tests.d.ts

@@ -0,0 +1,9 @@
+import type { PluginFn } from '../types.js';
+/**
+ * Disallows pinned tests by throwing an error before the runner
+ * starts executing the tests.
+ */
+export declare function disallowPinnedTests(options?: {
+    disallow?: boolean;
+    errorMessage?: string;
+}): PluginFn;

package/build/src/plugins/main.d.ts

@@ -0,0 +1 @@
+export { disallowPinnedTests } from './disallow_pinned_tests.js';

package/build/src/plugins/main.js

@@ -0,0 +1,31 @@
+import "../../chunk-2KG3PWR4.js";
+
+// src/plugins/disallow_pinned_tests.ts
+import string from "@poppinss/string";
+function disallowPinnedTests(options) {
+  const disallow = options?.disallow ?? true;
+  const errorMessage = options?.errorMessage ?? 'Pinning tests are disallowed by the "disallowPinnedTests" plugin. Use the "--list-pinned" flag to list pinned tests';
+  const pluginFn = async function disallowPinnedTestsPluginFn({ runner, emitter }) {
+    if (!disallow) {
+      return;
+    }
+    function disallowPinned(test) {
+      if (test.isPinned) {
+        test.options.meta.abort(string.interpolate(errorMessage, { test: test.title }));
+        process.exitCode = 1;
+      }
+    }
+    emitter.on("runner:start", () => {
+      runner.onSuite((suite) => {
+        suite.onGroup((group) => {
+          group.tap(disallowPinned);
+        });
+        suite.onTest(disallowPinned);
+      });
+    });
+  };
+  return pluginFn;
+}
+export {
+  disallowPinnedTests
+};

package/build/src/reporters/main.js

@@ -3,8 +3,8 @@ import {
   github,
   ndjson,
   spec
-} from "../../chunk-U3BSXCEH.js";
-import "../../chunk-PCBL2VZP.js";
+} from "../../chunk-RFKFNXTE.js";
+import "../../chunk-L7YZLDZD.js";
 import "../../chunk-2KG3PWR4.js";
 export {
   dot,

package/build/src/types.d.ts

@@ -35,6 +35,7 @@ export type CLIArgs = {
     failed?: boolean;
     help?: boolean;
     matchAll?: boolean;
+    listPinned?: boolean;
     bail?: boolean;
     bailLayer?: string;
 } & Record<string, string | string[] | boolean>;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@japa/runner",
   "description": "A simple yet powerful testing framework for Node.js",
-  "version": "4.3.0",
+  "version": "4.4.0",
   "engines": {
     "node": ">=18.16.0"
   },
@@ -16,6 +16,7 @@
     ".": "./build/index.js",
     "./types": "./build/src/types.js",
     "./reporters": "./build/src/reporters/main.js",
+    "./plugins": "./build/src/plugins/main.js",
     "./factories": "./build/factories/main.js",
     "./core": "./build/modules/core/main.js"
   },
@@ -35,39 +36,40 @@
     "quick:test": "glob -c \"node --import=ts-node-maintained/register/esm --enable-source-maps --test-reporter=spec --test\" \"tests/*.spec.ts\""
   },
   "devDependencies": {
-    "@adonisjs/eslint-config": "^2.1.0",
+    "@adonisjs/eslint-config": "^2.1.2",
     "@adonisjs/prettier-config": "^1.4.5",
     "@adonisjs/tsconfig": "^1.4.1",
     "@release-it/conventional-changelog": "^10.0.1",
-    "@swc/core": "1.13.1",
+    "@swc/core": "1.13.3",
     "@types/chai": "^5.2.2",
-    "@types/find-cache-dir": "^5.0.2",
     "@types/ms": "^2.1.0",
-    "@types/node": "^24.0.15",
+    "@types/node": "^24.2.1",
     "c8": "^10.1.3",
     "chai": "^5.2.1",
-    "cross-env": "^7.0.3",
+    "cross-env": "^10.0.0",
     "del-cli": "^6.0.0",
-    "eslint": "^9.31.0",
+    "eslint": "^9.33.0",
     "glob": "^11.0.3",
     "prettier": "^3.6.2",
     "release-it": "^19.0.4",
-    "ts-node-maintained": "^10.9.5",
+    "ts-node-maintained": "^10.9.6",
     "tsup": "^8.5.0",
-    "typescript": "^5.8.3"
+    "typescript": "^5.9.2"
   },
   "dependencies": {
     "@japa/core": "^10.3.0",
-    "@japa/errors-printer": "^4.1.2",
+    "@japa/errors-printer": "^4.1.3",
     "@poppinss/colors": "^4.1.5",
     "@poppinss/hooks": "^7.2.6",
+    "@poppinss/string": "^1.7.0",
+    "error-stack-parser-es": "^1.0.5",
     "fast-glob": "^3.3.3",
-    "find-cache-dir": "^6.0.0",
+    "find-cache-directory": "^6.0.0",
     "getopts": "^2.3.0",
     "ms": "^2.1.3",
     "serialize-error": "^12.0.0",
     "slash": "^5.1.0",
-    "supports-color": "^10.0.0"
+    "supports-color": "^10.1.0"
   },
   "homepage": "https://github.com/japa/runner#readme",
   "repository": {
@@ -92,6 +94,7 @@
     "entry": [
       "./index.ts",
       "./src/types.ts",
+      "./src/plugins/main.ts",
       "./src/reporters/main.ts",
       "./factories/main.ts",
       "./modules/core/main.ts"