@japa/runner 1.1.1 → 1.2.0

package/README.md

@@ -3,7 +3,9 @@
 
 [![github-actions-image]][github-actions-url] [![npm-image]][npm-url] [![license-image]][license-url] [![typescript-image]][typescript-url]
 
-Japa is an API-first testing framework. It focuses only on testing Node.js (backend) applications, thus resulting in a fast, small, and simple tests runner.
+Japa is an API first testing framework. It focuses only on testing Node.js (backend) applications, thus resulting in a fast, small, and a simple tests runner.
+
+#### 💁 Please visit https://japa.dev for documentation
 
 [github-actions-image]: https://img.shields.io/github/workflow/status/japa/runner/test?style=for-the-badge "github-actions"
 

package/build/index.d.ts

@@ -1,7 +1,7 @@
-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 };
+export { Test, TestContext, Group, PluginFn, RunnerHooksCleanupHandler, RunnerHooksHandler, ReporterContract, };
 /**
  * Configure the tests runner
  */

package/build/index.js

@@ -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
  */
@@ -100,12 +105,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 +131,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 +149,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 +165,7 @@ function test(title, callback) {
         activeGroup.add(testInstance);
     }
     else {
-        suite.add(testInstance);
+        activeSuite.add(testInstance);
     }
     return testInstance;
 }
@@ -173,15 +190,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();
+    runner.manageUnHandledExceptions();
+    runner.onSuite(runnerOptions.configureSuite);
     const hooks = new hooks_1.Hooks();
     let setupRunner;
     let teardownRunner;
@@ -216,28 +264,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) {
+            const files = await collectFiles(runnerOptions.files);
+            globalTimeout = runnerOptions.timeout;
+            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
@@ -305,7 +359,7 @@ exports.run = run;
  */
 function processCliArgs(argv) {
     const parsed = (0, getopts_1.default)(argv, {
-        string: ['tests', 'tags', 'groups', 'ignoreTags', 'files', 'timeout'],
+        string: ['tests', 'tags', 'groups', 'ignoreTags', 'files', 'timeout', 'suites'],
         boolean: ['forceExit'],
         alias: {
             ignoreTags: 'ignore-tags',
@@ -322,6 +376,7 @@ 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));
+    processAsString(parsed, 'suites', (suites) => (config.filters.suites = suites));
     if (parsed.timeout) {
         const value = Number(parsed.timeout);
         if (!isNaN(value)) {

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

@@ -1,4 +1,4 @@
-import { Runner, Refiner, FilteringOptions, ReporterContract } from '@japa/core';
+import { Runner, Refiner, FilteringOptions, ReporterContract, Suite } from '@japa/core';
 import { Test, Group, TestContext } from '../Core';
 /**
  * The cleanup function for runner hooks
@@ -13,6 +13,7 @@ export declare type RunnerHooksHandler = (runner: Runner<TestContext>) => Promis
  */
 export declare type Filters = FilteringOptions & {
     files?: string[];
+    suites?: string[];
 };
 /**
  * Shape of the plugin function
@@ -23,13 +24,13 @@ export declare type PluginFn = (config: Required<ConfigureOptions>, runner: Runn
     Group: typeof Group;
 }) => void | Promise<void>;
 /**
- * Configuration options
+ * Base configuration options
  */
-export declare type ConfigureOptions = {
-    files: string[] | (() => string[] | Promise<string[]>);
+export declare type BaseConfigureOptions = {
     timeout?: number;
     plugins?: PluginFn[];
     filters?: Filters;
+    configureSuite?: (suite: Suite<TestContext>) => void;
     setup?: RunnerHooksHandler[];
     teardown?: RunnerHooksHandler[];
     reporters?: ReporterContract[];
@@ -37,3 +38,15 @@ export declare type ConfigureOptions = {
     refiner?: Refiner;
     forceExit?: boolean;
 };
+/**
+ * Configuration options
+ */
+export declare type ConfigureOptions = BaseConfigureOptions & ({
+    files: string[] | (() => string[] | Promise<string[]>);
+} | {
+    suites: {
+        name: string;
+        files: string | string[] | (() => string[] | Promise<string[]>);
+        timeout?: number;
+    }[];
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@japa/runner",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "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.17",
+    "@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.8.0",
-    "eslint-config-prettier": "^8.3.0",
+    "eslint": "^8.10.0",
+    "eslint-config-prettier": "^8.4.0",
     "eslint-plugin-adonis": "^2.1.0",
     "eslint-plugin-prettier": "^4.0.0",
     "github-label-sync": "^2.0.2",
@@ -105,9 +105,9 @@
     "anyBranch": false
   },
   "dependencies": {
-    "@japa/core": "^5.1.0",
-    "@japa/errors-printer": "^1.3.1",
-    "@poppinss/hooks": "^6.0.1-0",
+    "@japa/core": "^5.1.1",
+    "@japa/errors-printer": "^1.3.3",
+    "@poppinss/hooks": "^6.0.2-0",
     "fast-glob": "^3.2.11",
     "getopts": "^2.3.0",
     "inclusion": "^1.0.1"
@@ -116,7 +116,6 @@
     "access": "public",
     "tag": "latest"
   },
-  "types": "./build/index.d.ts",
   "directories": {
     "test": "test"
   },