@japa/runner 1.1.3 → 2.0.1

package/build/index.d.ts

@@ -1,17 +1,17 @@
-import { TestExecutor } from '@japa/core';
+import { TestExecutor, ReporterContract } from '@japa/core';
 import { Test, TestContext, Group } from './src/Core';
-import { PluginFn, ConfigureOptions, RunnerHooksHandler, RunnerHooksCleanupHandler } from './src/Contracts';
-export { Test, TestContext, Group, PluginFn, RunnerHooksCleanupHandler, RunnerHooksHandler };
+import { Config, PluginFn, RunnerHooksHandler, RunnerHooksCleanupHandler } from './src/Contracts';
+export { Test, Config, Group, PluginFn, TestContext, ReporterContract, RunnerHooksHandler, RunnerHooksCleanupHandler, };
 /**
  * Configure the tests runner
  */
-export declare function configure(options: ConfigureOptions): void;
+export declare function configure(options: Config): void;
 /**
  * Add a new test
  */
-export declare function test(title: string, callback?: TestExecutor<TestContext, undefined>): Test<TestContext, undefined>;
+export declare function test(title: string, callback?: TestExecutor<TestContext, undefined>): Test<undefined>;
 export declare namespace test {
-    var group: (title: string, callback: (group: Group<TestContext>) => void) => void;
+    var group: (title: string, callback: (group: Group) => void) => void;
 }
 /**
  * Run japa tests
@@ -29,4 +29,4 @@ export declare function run(): Promise<void>;
  * * --force-exit=Enable/disable force exit
  * * --timeout=Define timeout for all the tests
  */
-export declare function processCliArgs(argv: string[]): Partial<ConfigureOptions>;
+export declare function processCliArgs(argv: string[]): Partial<Config>;

package/build/index.js

@@ -11,7 +11,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.processCliArgs = exports.run = exports.test = exports.configure = exports.Group = exports.TestContext = exports.Test = void 0;
+exports.processCliArgs = exports.run = exports.test = exports.configure = exports.TestContext = exports.Group = exports.Test = void 0;
 const getopts_1 = __importDefault(require("getopts"));
 const path_1 = require("path");
 const fast_glob_1 = __importDefault(require("fast-glob"));
@@ -32,6 +32,11 @@ const refinerFilteringLayers = ['tests', 'groups', 'tags'];
  * test and the group both
  */
 let recentlyImportedFile;
+/**
+ * Global timeout for tests. Fetched from runner options or suites
+ * options
+ */
+let globalTimeout;
 /**
  * Function to create the test context for the test
  */
@@ -41,9 +46,9 @@ const getContext = (testInstance) => new Core_1.TestContext(testInstance);
  */
 const emitter = new core_1.Emitter();
 /**
- * The default suite for registering tests
+ * Active suite for tests
  */
-const suite = new core_1.Suite('default', emitter);
+let activeSuite = new Core_1.Suite('default', emitter);
 /**
  * Currently active group
  */
@@ -60,6 +65,23 @@ function ensureIsConfigured(message) {
         throw new Error(message);
     }
 }
+/**
+ * Validate suites filter to ensure a wrong suite is not
+ * mentioned
+ */
+function validateSuitesFilter() {
+    if (!('suites' in runnerOptions)) {
+        return;
+    }
+    if (!runnerOptions.filters.suites || !runnerOptions.filters.suites.length) {
+        return;
+    }
+    const suites = runnerOptions.suites.map(({ name }) => name);
+    const invalidSuites = runnerOptions.filters.suites.filter((suite) => !suites.includes(suite));
+    if (invalidSuites.length) {
+        throw new Error(`Unrecognized suite "${invalidSuites[0]}". Make sure to define it in the config first`);
+    }
+}
 /**
  * End tests. We wait for the "beforeExit" event when
  * forceExit is not set to true
@@ -100,12 +122,23 @@ function isFileAllowed(filePath, filters) {
         return filePath.replace((0, path_1.extname)(filePath), '').endsWith(matcher);
     });
 }
+/**
+ * Returns "true" when no filters are applied or the name is part
+ * of the applied filter
+ */
+function isSuiteAllowed(name, filters) {
+    if (!filters || !filters.length) {
+        return true;
+    }
+    return filters.includes(name);
+}
 /**
  * Configure the tests runner
  */
 function configure(options) {
     const defaultOptions = {
         files: [],
+        suites: [],
         plugins: [],
         reporters: [],
         timeout: 2000,
@@ -115,6 +148,7 @@ function configure(options) {
         importer: (filePath) => (0, inclusion_1.default)(filePath),
         refiner: new core_1.Refiner({}),
         forceExit: false,
+        configureSuite: () => { },
     };
     runnerOptions = Object.assign(defaultOptions, options);
 }
@@ -132,8 +166,8 @@ function test(title, callback) {
     /**
      * Define timeout on the test when exists globally
      */
-    if (runnerOptions.timeout !== undefined) {
-        testInstance.timeout(runnerOptions.timeout);
+    if (globalTimeout !== undefined) {
+        testInstance.timeout(globalTimeout);
     }
     /**
      * Define test executor function
@@ -148,7 +182,7 @@ function test(title, callback) {
         activeGroup.add(testInstance);
     }
     else {
-        suite.add(testInstance);
+        activeSuite.add(testInstance);
     }
     return testInstance;
 }
@@ -173,15 +207,46 @@ test.group = function (title, callback) {
     /**
      * Add group to the default suite
      */
-    suite.add(activeGroup);
+    activeSuite.add(activeGroup);
     activeGroup = undefined;
 };
+/**
+ * Collect files using the files collector function or by processing
+ * the glob pattern
+ */
+async function collectFiles(files) {
+    if (Array.isArray(files) || typeof files === 'string') {
+        return await (0, fast_glob_1.default)(files, { absolute: true, onlyFiles: true });
+    }
+    else if (typeof files === 'function') {
+        return await files();
+    }
+    throw new Error('Invalid value for "files" property. Expected a string, array or a function');
+}
+/**
+ * Import test files using the configured importer. Also
+ * filter files using the file filter. (if mentioned).
+ */
+async function importFiles(files) {
+    for (let file of files) {
+        recentlyImportedFile = file;
+        if (runnerOptions.filters.files && runnerOptions.filters.files.length) {
+            if (isFileAllowed(file, runnerOptions.filters.files)) {
+                await runnerOptions.importer(file);
+            }
+        }
+        else {
+            await runnerOptions.importer(file);
+        }
+    }
+}
 /**
  * Run japa tests
  */
 async function run() {
-    const runner = new core_1.Runner(emitter);
-    runner.add(suite).manageUnHandledExceptions();
+    const runner = new Core_1.Runner(emitter);
+    runner.manageUnHandledExceptions();
+    runner.onSuite(runnerOptions.configureSuite);
     const hooks = new hooks_1.Hooks();
     let setupRunner;
     let teardownRunner;
@@ -196,6 +261,7 @@ async function run() {
         for (let plugin of runnerOptions.plugins) {
             await plugin(runnerOptions, runner, { Test: Core_1.Test, TestContext: Core_1.TestContext, Group: Core_1.Group });
         }
+        validateSuitesFilter();
         /**
          * Step 2: Notify runner about reporters
          */
@@ -216,28 +282,34 @@ async function run() {
          */
         await setupRunner.run(runner);
         /**
-         * Step 4: Collect all test files
+         * Step 4: Entertain files property and import test files
+         * as part of the default suite
          */
-        let files = [];
-        if (Array.isArray(runnerOptions.files)) {
-            files = await (0, fast_glob_1.default)(runnerOptions.files, { absolute: true, onlyFiles: true });
-        }
-        else if (typeof runnerOptions.files === 'function') {
-            files = await runnerOptions.files();
+        if ('files' in runnerOptions && runnerOptions.files.length) {
+            globalTimeout = runnerOptions.timeout;
+            const files = await collectFiles(runnerOptions.files);
+            runner.add(activeSuite);
+            await importFiles(files);
         }
         /**
-         * Step 5: Import files
+         * Step 5: Entertain suites property and import test files
+         * for the filtered suites.
          */
-        for (let file of files) {
-            recentlyImportedFile = file;
-            if (runnerOptions.filters.files && runnerOptions.filters.files.length) {
-                if (isFileAllowed(file, runnerOptions.filters.files)) {
-                    await runnerOptions.importer(file);
+        if ('suites' in runnerOptions) {
+            for (let suite of runnerOptions.suites) {
+                if (isSuiteAllowed(suite.name, runnerOptions.filters.suites)) {
+                    if (suite.timeout !== undefined) {
+                        globalTimeout = suite.timeout;
+                    }
+                    else {
+                        globalTimeout = runnerOptions.timeout;
+                    }
+                    activeSuite = new Core_1.Suite(suite.name, emitter);
+                    const files = await collectFiles(suite.files);
+                    runner.add(activeSuite);
+                    await importFiles(files);
                 }
             }
-            else {
-                await runnerOptions.importer(file);
-            }
         }
         /**
          * Step 6: Add filters to the refiner
@@ -322,12 +394,24 @@ function processCliArgs(argv) {
     processAsString(parsed, 'groups', (groups) => (config.filters.groups = groups));
     processAsString(parsed, 'tests', (tests) => (config.filters.tests = tests));
     processAsString(parsed, 'files', (files) => (config.filters.files = files));
+    /**
+     * Get suites
+     */
+    if (parsed._.length) {
+        processAsString({ suites: parsed._ }, 'suites', (suites) => (config.filters.suites = suites));
+    }
+    /**
+     * Get timeout
+     */
     if (parsed.timeout) {
         const value = Number(parsed.timeout);
         if (!isNaN(value)) {
             config.timeout = value;
         }
     }
+    /**
+     * Get forceExit
+     */
     if (parsed.forceExit) {
         config.forceExit = true;
     }

package/build/src/Contracts/index.d.ts

@@ -1,39 +1,57 @@
-import { Runner, Refiner, FilteringOptions, ReporterContract } from '@japa/core';
-import { Test, Group, TestContext } from '../Core';
+import { Refiner, FilteringOptions, ReporterContract } from '@japa/core';
+import { Test, Group, TestContext, Runner, Suite } from '../Core';
 /**
  * The cleanup function for runner hooks
  */
-export declare type RunnerHooksCleanupHandler = (error: null | any, runner: Runner<TestContext>) => Promise<any> | any;
+export declare type RunnerHooksCleanupHandler = (error: null | any, runner: Runner) => Promise<any> | any;
 /**
  * The function that can be registered as a runner hook
  */
-export declare type RunnerHooksHandler = (runner: Runner<TestContext>) => Promise<any> | any | RunnerHooksCleanupHandler | Promise<RunnerHooksCleanupHandler>;
+export declare type RunnerHooksHandler = (runner: Runner) => Promise<any> | any | RunnerHooksCleanupHandler | Promise<RunnerHooksCleanupHandler>;
 /**
  * Allowed filters
  */
 export declare type Filters = FilteringOptions & {
     files?: string[];
+    suites?: string[];
 };
 /**
  * Shape of the plugin function
  */
-export declare type PluginFn = (config: Required<ConfigureOptions>, runner: Runner<TestContext>, classes: {
+export declare type PluginFn = (config: Required<Config>, runner: Runner, classes: {
     Test: typeof Test;
     TestContext: typeof TestContext;
     Group: typeof Group;
 }) => void | Promise<void>;
 /**
- * Configuration options
+ * Runner hooks
  */
-export declare type ConfigureOptions = {
-    files: string[] | (() => string[] | Promise<string[]>);
+export declare type RunnerHooks = {
+    setup: RunnerHooksHandler[];
+    teardown: RunnerHooksHandler[];
+};
+/**
+ * Base configuration options
+ */
+export declare type BaseConfig = {
     timeout?: number;
     plugins?: PluginFn[];
     filters?: Filters;
-    setup?: RunnerHooksHandler[];
-    teardown?: RunnerHooksHandler[];
+    configureSuite?: (suite: Suite) => void;
     reporters?: ReporterContract[];
     importer?: (filePath: string) => void | Promise<void>;
     refiner?: Refiner;
     forceExit?: boolean;
-};
+} & Partial<RunnerHooks>;
+/**
+ * Configuration options
+ */
+export declare type Config = BaseConfig & ({
+    files: string[] | (() => string[] | Promise<string[]>);
+} | {
+    suites: {
+        name: string;
+        files: string | string[] | (() => string[] | Promise<string[]>);
+        timeout?: number;
+    }[];
+});

package/build/src/Core/index.d.ts

@@ -1,6 +1,14 @@
-import { Test, Group, TestContext as BaseTestContext } from '@japa/core';
+import { DataSetNode, Test as BaseTest, Group as BaseGroup, Suite as BaseSuite, Runner as BaseRunner, TestContext as BaseTestContext } from '@japa/core';
 export declare class TestContext extends BaseTestContext {
-    test: Test<TestContext, any>;
-    constructor(test: Test<TestContext, any>);
+    test: Test;
+    constructor(test: Test);
+}
+export declare class Test<TestData extends DataSetNode = undefined> extends BaseTest<TestContext, TestData> {
+    static disposeCallbacks: never[];
+}
+export declare class Group extends BaseGroup<TestContext> {
+}
+export declare class Suite extends BaseSuite<TestContext> {
+}
+export declare class Runner extends BaseRunner<TestContext> {
 }
-export { Group, Test };

package/build/src/Core/index.js

@@ -8,10 +8,8 @@
  * file that was distributed with this source code.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Test = exports.Group = exports.TestContext = void 0;
+exports.Runner = exports.Suite = exports.Group = exports.Test = exports.TestContext = void 0;
 const core_1 = require("@japa/core");
-Object.defineProperty(exports, "Test", { enumerable: true, get: function () { return core_1.Test; } });
-Object.defineProperty(exports, "Group", { enumerable: true, get: function () { return core_1.Group; } });
 class TestContext extends core_1.TestContext {
     constructor(test) {
         super();
@@ -19,3 +17,16 @@ class TestContext extends core_1.TestContext {
     }
 }
 exports.TestContext = TestContext;
+class Test extends core_1.Test {
+}
+exports.Test = Test;
+Test.disposeCallbacks = [];
+class Group extends core_1.Group {
+}
+exports.Group = Group;
+class Suite extends core_1.Suite {
+}
+exports.Suite = Suite;
+class Runner extends core_1.Runner {
+}
+exports.Runner = Runner;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@japa/runner",
-  "version": "1.1.3",
+  "version": "2.0.1",
   "description": "Runner for Japa testing framework",
   "main": "build/index.js",
   "files": [
@@ -35,13 +35,13 @@
   "license": "MIT",
   "devDependencies": {
     "@adonisjs/mrm-preset": "^5.0.2",
-    "@adonisjs/require-ts": "^2.0.9",
-    "@types/node": "^17.0.18",
+    "@adonisjs/require-ts": "^2.0.10",
+    "@types/node": "^17.0.21",
     "commitizen": "^4.2.4",
     "cz-conventional-changelog": "^3.3.0",
     "del-cli": "^4.0.1",
-    "eslint": "^8.9.0",
-    "eslint-config-prettier": "^8.4.0",
+    "eslint": "^8.10.0",
+    "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-adonis": "^2.1.0",
     "eslint-plugin-prettier": "^4.0.0",
     "github-label-sync": "^2.0.2",
@@ -50,7 +50,7 @@
     "mrm": "^3.0.10",
     "np": "^7.6.0",
     "prettier": "^2.5.1",
-    "typescript": "^4.5.5"
+    "typescript": "^4.6.2"
   },
   "mrmConfig": {
     "core": false,
@@ -105,7 +105,7 @@
     "anyBranch": false
   },
   "dependencies": {
-    "@japa/core": "^5.1.1",
+    "@japa/core": "^6.0.0",
     "@japa/errors-printer": "^1.3.3",
     "@poppinss/hooks": "^6.0.2-0",
     "fast-glob": "^3.2.11",