@japa/runner 3.0.4 → 3.1.0

package/build/src/cli_parser.js

@@ -1,75 +0,0 @@
-/*
- * @japa/runner
- *
- * (c) Japa
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-// @ts-ignore-error
-import getopts from 'getopts';
-import colors from '@poppinss/colors';
-const ansi = colors.ansi();
-/**
- * Known commandline options. The user can still define additional flags and they
- * will be parsed aswell, but without any normalization
- */
-const OPTIONS = {
-    string: ['tests', 'groups', 'tags', 'files', 'timeout', 'retries', 'reporters', 'failed'],
-    boolean: ['help', 'matchAll', 'failed'],
-    alias: {
-        forceExit: 'force-exit',
-        matchAll: 'match-all',
-        help: 'h',
-    },
-};
-/**
- * Help string to display when the `--help flag is used`
- */
-const GET_HELP = () => `
-${ansi.yellow('@japa/runner v2.3.0')}
-
-${ansi.green('--tests')}                     ${ansi.dim('Filter tests by the test title')}
-${ansi.green('--groups')}                    ${ansi.dim('Filter tests by the group title')}
-${ansi.green('--tags')}                      ${ansi.dim('Filter tests by tags')}
-${ansi.green('--files')}                     ${ansi.dim('Filter tests by the file name')}
-${ansi.green('--force-exit')}                ${ansi.dim('Forcefully exit the process')}
-${ansi.green('--timeout')}                   ${ansi.dim('Define default timeout for all tests')}
-${ansi.green('--retries')}                   ${ansi.dim('Define default retries for all tests')}
-${ansi.green('--reporters')}                 ${ansi.dim('Activate one or more test reporters')}
-${ansi.green('--failed')}                    ${ansi.dim('Run tests failed during the last run')}
-${ansi.green('-h, --help')}                  ${ansi.dim('View help')}
-
-${ansi.yellow('Examples:')}
-${ansi.dim('node bin/test.js --tags="@github"')}
-${ansi.dim('node bin/test.js --tags="~@github"')}
-${ansi.dim('node bin/test.js --tags="@github,@slow,@integration" --match-all')}
-${ansi.dim('node bin/test.js --force-exit')}
-${ansi.dim('node bin/test.js --files="user"')}
-${ansi.dim('node bin/test.js --files="functional/user"')}
-${ansi.dim('node bin/test.js --files="unit/user"')}
-
-${ansi.yellow('Notes:')}
-- When groups and tests filters are applied together. We will first filter the
-  tests by group title and then apply the tests title filter.
-- The timeout defined on test object takes precedence over the ${ansi.green('--timeout')} flag.
-- The retries defined on test object takes precedence over the ${ansi.green('--retries')} flag.
-- The ${ansi.green('--files')} flag checks for the file names ending with the filter substring.
-`;
-/**
- * CLI Parser is used to parse the commandline argument
- */
-export class CliParser {
-    /**
-     * Parses command-line arguments
-     */
-    parse(argv) {
-        return getopts(argv, OPTIONS);
-    }
-    /**
-     * Returns the help string
-     */
-    getHelp() {
-        return GET_HELP();
-    }
-}

package/build/src/config_manager.js

@@ -1,168 +0,0 @@
-/*
- * @japa/runner
- *
- * (c) Japa
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import debug from './debug.js';
-import { Refiner } from '../modules/core/main.js';
-import { dot, ndjson, spec } from './reporters/main.js';
-export const NOOP = () => { };
-/**
- * Defaults to use for configuration
- */
-const DEFAULTS = {
-    files: [],
-    timeout: 2000,
-    retries: 0,
-    forceExit: false,
-    plugins: [],
-    reporters: {
-        activated: ['spec'],
-        list: [spec(), ndjson(), dot()],
-    },
-    importer: (filePath) => import(filePath.href),
-    configureSuite: () => { },
-};
-/**
- * Config manager is used to hydrate the configuration by merging
- * the defaults, user defined config and the command line
- * flags.
- *
- * The command line flags have the upmost priority
- */
-export class ConfigManager {
-    #config;
-    #cliArgs;
-    constructor(config, cliArgs) {
-        this.#config = config;
-        this.#cliArgs = cliArgs;
-    }
-    /**
-     * Processes a CLI argument and converts it to an
-     * array of strings
-     */
-    #processAsArray(value) {
-        return Array.isArray(value) ? value : value.split(',').map((item) => item.trim());
-    }
-    /**
-     * Returns a copy of filters based upon the CLI
-     * arguments.
-     */
-    #getCLIFilters() {
-        const filters = {};
-        if (this.#cliArgs.tags) {
-            filters.tags = this.#processAsArray(this.#cliArgs.tags);
-        }
-        if (this.#cliArgs.tests) {
-            filters.tests = this.#processAsArray(this.#cliArgs.tests);
-        }
-        if (this.#cliArgs.files) {
-            filters.files = this.#processAsArray(this.#cliArgs.files);
-        }
-        if (this.#cliArgs.groups) {
-            filters.groups = this.#processAsArray(this.#cliArgs.groups);
-        }
-        if (this.#cliArgs._ && this.#cliArgs._.length) {
-            filters.suites = this.#processAsArray(this.#cliArgs._);
-        }
-        return filters;
-    }
-    /**
-     * Returns the timeout from the CLI args
-     */
-    #getCLITimeout() {
-        if (this.#cliArgs.timeout) {
-            const value = Number(this.#cliArgs.timeout);
-            if (!Number.isNaN(value)) {
-                return value;
-            }
-        }
-    }
-    /**
-     * Returns the retries from the CLI args
-     */
-    #getCLIRetries() {
-        if (this.#cliArgs.retries) {
-            const value = Number(this.#cliArgs.retries);
-            if (!Number.isNaN(value)) {
-                return value;
-            }
-        }
-    }
-    /**
-     * Returns the forceExit property from the CLI args
-     */
-    #getCLIForceExit() {
-        if (this.#cliArgs.forceExit) {
-            return true;
-        }
-    }
-    /**
-     * Returns reporters selected using the commandline
-     * --reporter flag
-     */
-    #getCLIReporters() {
-        if (this.#cliArgs.reporters) {
-            return this.#processAsArray(this.#cliArgs.reporters);
-        }
-    }
-    /**
-     * Hydrates the config with user defined options and the
-     * command-line flags.
-     */
-    hydrate() {
-        const cliFilters = this.#getCLIFilters();
-        const cliRetries = this.#getCLIRetries();
-        const cliTimeout = this.#getCLITimeout();
-        const cliReporters = this.#getCLIReporters();
-        const cliForceExit = this.#getCLIForceExit();
-        debug('filters applied using CLI flags %O', cliFilters);
-        const baseConfig = {
-            cwd: this.#config.cwd ?? process.cwd(),
-            filters: Object.assign({}, this.#config.filters ?? {}, cliFilters),
-            importer: this.#config.importer ?? DEFAULTS.importer,
-            refiner: this.#config.refiner ?? new Refiner(),
-            retries: cliRetries ?? this.#config.retries ?? DEFAULTS.retries,
-            timeout: cliTimeout ?? this.#config.timeout ?? DEFAULTS.timeout,
-            plugins: this.#config.plugins ?? DEFAULTS.plugins,
-            forceExit: cliForceExit ?? this.#config.forceExit ?? DEFAULTS.forceExit,
-            reporters: this.#config.reporters
-                ? {
-                    activated: this.#config.reporters.activated,
-                    list: this.#config.reporters.list || DEFAULTS.reporters.list,
-                }
-                : DEFAULTS.reporters,
-            configureSuite: this.#config.configureSuite ?? DEFAULTS.configureSuite,
-            setup: this.#config.setup || [],
-            teardown: this.#config.teardown || [],
-        };
-        /**
-         * Overwrite activated reporters when defined using CLI
-         * flag
-         */
-        if (cliReporters) {
-            baseConfig.reporters.activated = cliReporters;
-        }
-        if ('files' in this.#config) {
-            return {
-                files: this.#config.files,
-                ...baseConfig,
-            };
-        }
-        return {
-            suites: this.#config.suites.map((suite) => {
-                return {
-                    name: suite.name,
-                    files: suite.files,
-                    timeout: cliTimeout ?? suite.timeout ?? baseConfig.timeout,
-                    retries: cliRetries ?? suite.retries ?? baseConfig.retries,
-                    configure: suite.configure || NOOP,
-                };
-            }),
-            ...baseConfig,
-        };
-    }
-}

package/build/src/create_test.js

@@ -1,53 +0,0 @@
-/*
- * @japa/runner
- *
- * (c) Japa
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import { Group, Test, TestContext } from '../modules/core/main.js';
-/**
- * Function to create the test context for the test
- */
-const contextBuilder = (testInstance) => new TestContext(testInstance);
-/**
- * Create a new instance of the Test
- */
-export function createTest(title, emitter, refiner, 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;
-    if (options.timeout !== undefined) {
-        testInstance.timeout(options.timeout);
-    }
-    if (options.retries !== undefined) {
-        testInstance.retry(options.retries);
-    }
-    /**
-     * Register test as a child either with the group or the suite
-     */
-    if (options.group) {
-        options.group.add(testInstance);
-    }
-    else if (options.suite) {
-        options.suite.add(testInstance);
-    }
-    return testInstance;
-}
-/**
- * Create a new instance of the Group
- */
-export function createTestGroup(title, emitter, refiner, options) {
-    if (options.group) {
-        throw new Error('Nested groups are not supported by Japa');
-    }
-    const group = new Group(title, emitter, refiner);
-    group.options.meta.suite = options.suite;
-    group.options.meta.fileName = options.file;
-    if (options.suite) {
-        options.suite.add(group);
-    }
-    return group;
-}

package/build/src/debug.js

@@ -1,10 +0,0 @@
-/*
- * @japa/runner
- *
- * (c) Japa
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import { debuglog } from 'node:util';
-export default debuglog('japa:runner');

package/build/src/exceptions_manager.js

@@ -1,85 +0,0 @@
-/*
- * @japa/runner
- *
- * (c) Japa
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import { ErrorsPrinter } from '@japa/errors-printer';
-/**
- * Handles uncaught exceptions and prints them to the
- * console
- */
-export class ExceptionsManager {
-    #exceptionsBuffer = [];
-    #rejectionsBuffer = [];
-    #state = 'watching';
-    #errorsPrinter = new ErrorsPrinter({ stackLinesCount: 2, framesMaxLimit: 4 });
-    hasErrors = false;
-    /**
-     * Monitors unhandled exceptions and rejections. The exceptions
-     * are stacked in a buffer, so that we do not clutter the
-     * tests output and once the tests are over, we will
-     * print them to the console.
-     *
-     * In case the tests are completed, we will print errors as they
-     * happen.
-     */
-    monitor() {
-        process.on('uncaughtException', async (error) => {
-            this.hasErrors = true;
-            if (this.#state === 'watching') {
-                this.#exceptionsBuffer.push(error);
-            }
-            else {
-                this.#errorsPrinter.printSectionBorder('[Unhandled Error]');
-                await this.#errorsPrinter.printError(error);
-                process.exitCode = 1;
-            }
-        });
-        process.on('unhandledRejection', async (error) => {
-            this.hasErrors = true;
-            if (this.#state === 'watching') {
-                this.#rejectionsBuffer.push(error);
-            }
-            else {
-                this.#errorsPrinter.printSectionBorder('[Unhandled Rejection]');
-                await this.#errorsPrinter.printError(error);
-                process.exitCode = 1;
-            }
-        });
-    }
-    async flow() {
-        if (this.#state === 'flowing') {
-            return;
-        }
-        this.#state = 'flowing';
-        /**
-         * Print exceptions
-         */
-        if (this.#exceptionsBuffer.length) {
-            let exceptionsCount = this.#exceptionsBuffer.length;
-            let exceptionsIndex = this.#exceptionsBuffer.length;
-            this.#errorsPrinter.printSectionHeader('Unhandled Errors');
-            for (let exception of this.#exceptionsBuffer) {
-                await this.#errorsPrinter.printError(exception);
-                this.#errorsPrinter.printSectionBorder(`[${++exceptionsIndex}/${exceptionsCount}]`);
-            }
-            this.#exceptionsBuffer = [];
-        }
-        /**
-         * Print rejections
-         */
-        if (this.#rejectionsBuffer.length) {
-            let rejectionsCount = this.#exceptionsBuffer.length;
-            let rejectionsIndex = this.#exceptionsBuffer.length;
-            this.#errorsPrinter.printSectionBorder('Unhandled Rejections');
-            for (let rejection of this.#rejectionsBuffer) {
-                await this.#errorsPrinter.printError(rejection);
-                this.#errorsPrinter.printSectionBorder(`[${++rejectionsIndex}/${rejectionsCount}]`);
-            }
-            this.#rejectionsBuffer = [];
-        }
-    }
-}

package/build/src/files_manager.js

@@ -1,57 +0,0 @@
-/*
- * @japa/runner
- *
- * (c) Japa
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import slash from 'slash';
-import fastGlob from 'fast-glob';
-import { pathToFileURL } from 'node:url';
-/**
- * The expression to remove file extension and optionally
- * .spec|.test from the test file name
- */
-const FILE_SUFFIX_EXPRESSION = /(\.spec|\.test)?\.[js|ts|jsx|tsx|mjs|mts|cjs|cts]+$/;
-/**
- * Files manager exposes the API to collect, filter and import test
- * files based upon the config
- */
-export class FilesManager {
-    /**
-     * Returns a collection of files from the user defined
-     * glob or the implementation function
-     */
-    async getFiles(cwd, files) {
-        if (Array.isArray(files) || typeof files === 'string') {
-            const testFiles = await fastGlob(files, {
-                absolute: true,
-                onlyFiles: true,
-                cwd: cwd,
-            });
-            return testFiles.map((file) => pathToFileURL(file));
-        }
-        return await files();
-    }
-    /**
-     * Applies file name filter on a collection of file
-     * URLs
-     */
-    grep(files, filters) {
-        return files.filter((file) => {
-            const filename = slash(file.pathname);
-            const filenameWithoutTestSuffix = filename.replace(FILE_SUFFIX_EXPRESSION, '');
-            return !!filters.find((filter) => {
-                if (filename.endsWith(filter)) {
-                    return true;
-                }
-                const filterSegments = filter.split('/').reverse();
-                const fileSegments = filenameWithoutTestSuffix.split('/').reverse();
-                return filterSegments.every((segment, index) => {
-                    return fileSegments[index] && (segment === '*' || fileSegments[index].endsWith(segment));
-                });
-            });
-        });
-    }
-}

package/build/src/helpers.js

@@ -1,34 +0,0 @@
-/*
- * @japa/runner
- *
- * (c) Japa
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import useColors from '@poppinss/colors';
-export const colors = useColors.ansi();
-/**
- * A collection of platform specific icons
- */
-export const icons = process.platform === 'win32' && !process.env.WT_SESSION
-    ? {
-        tick: '√',
-        cross: '×',
-        bullet: '*',
-        nodejs: '♦',
-        pointer: '>',
-        info: 'i',
-        warning: '‼',
-        squareSmallFilled: '[█]',
-    }
-    : {
-        tick: '✔',
-        cross: '✖',
-        bullet: '●',
-        nodejs: '⬢',
-        pointer: '❯',
-        info: 'ℹ',
-        warning: '⚠',
-        squareSmallFilled: '◼',
-    };

package/build/src/hooks.js

@@ -1,46 +0,0 @@
-/*
- * @japa/runner
- *
- * (c) Japa
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import Hooks from '@poppinss/hooks';
-/**
- * Exposes API for working with global hooks
- */
-export class GlobalHooks {
-    #hooks = new Hooks();
-    #setupRunner;
-    #teardownRunner;
-    /**
-     * Apply hooks from the config
-     */
-    apply(config) {
-        config.setup.forEach((hook) => this.#hooks.add('setup', hook));
-        config.teardown.forEach((hook) => this.#hooks.add('teardown', hook));
-    }
-    /**
-     * Perform setup
-     */
-    async setup(runner) {
-        this.#setupRunner = this.#hooks.runner('setup');
-        this.#teardownRunner = this.#hooks.runner('teardown');
-        await this.#setupRunner.run(runner);
-    }
-    /**
-     * Perform cleanup
-     */
-    async teardown(error, runner) {
-        if (this.#setupRunner) {
-            await this.#setupRunner.cleanup(error, runner);
-        }
-        if (this.#teardownRunner) {
-            if (!error) {
-                await this.#teardownRunner.run(runner);
-            }
-            await this.#teardownRunner.cleanup(error, runner);
-        }
-    }
-}

package/build/src/planner.js

@@ -1,98 +0,0 @@
-/*
- * @japa/runner
- *
- * (c) Japa
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import validator from './validator.js';
-import { FilesManager } from './files_manager.js';
-/**
- * The tests planner is used to plan the tests by doing all
- * the heavy lifting of executing plugins, registering
- * reporters, filtering tests and so on.
- */
-export class Planner {
-    #config;
-    #fileManager = new FilesManager();
-    constructor(config) {
-        validator.validateActivatedReporters(config);
-        validator.validateSuitesFilter(config);
-        validator.validateSuitesForUniqueness(config);
-        this.#config = config;
-    }
-    /**
-     * Returns a list of reporters based upon the activated
-     * reporters list.
-     */
-    #getActivatedReporters() {
-        return this.#config.reporters.activated.map((activated) => {
-            return this.#config.reporters.list.find(({ name }) => activated === name);
-        });
-    }
-    /**
-     * A generic method to collect files from the user defined
-     * files glob and apply the files filter
-     */
-    async #collectFiles(files) {
-        let filesURLs = await this.#fileManager.getFiles(this.#config.cwd, files);
-        if (this.#config.filters.files && this.#config.filters.files.length) {
-            filesURLs = this.#fileManager.grep(filesURLs, this.#config.filters.files);
-        }
-        return filesURLs;
-    }
-    /**
-     * Returns a collection of suites and their associated
-     * test files by applying all the filters
-     */
-    async #getSuites() {
-        let suites = [];
-        let suitesFilters = this.#config.filters.suites || [];
-        if ('files' in this.#config) {
-            suites.push({
-                name: 'default',
-                files: this.#config.files,
-                timeout: this.#config.timeout,
-                retries: this.#config.retries,
-                filesURLs: await this.#collectFiles(this.#config.files),
-            });
-        }
-        if ('suites' in this.#config) {
-            for (let suite of this.#config.suites) {
-                if (!suitesFilters.length || suitesFilters.includes(suite.name)) {
-                    suites.push({
-                        ...suite,
-                        filesURLs: await this.#collectFiles(suite.files),
-                    });
-                }
-            }
-        }
-        return suites;
-    }
-    /**
-     * Returns a list of filters to the passed to the refiner
-     */
-    #getRefinerFilters() {
-        return Object.keys(this.#config.filters).reduce((result, layer) => {
-            if (layer === 'tests' || layer === 'tags' || layer === 'groups') {
-                result.push({ layer, filters: this.#config.filters[layer] });
-            }
-            return result;
-        }, []);
-    }
-    /**
-     * Creates a plan for running the tests
-     */
-    async plan() {
-        const suites = await this.#getSuites();
-        const reporters = this.#getActivatedReporters();
-        const refinerFilters = this.#getRefinerFilters();
-        return {
-            reporters,
-            suites,
-            refinerFilters,
-            config: this.#config,
-        };
-    }
-}