@japa/runner 3.0.0-6 → 3.0.0-8

package/build/factories/runner.js

@@ -1,206 +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 assert from 'node:assert';
-import { fileURLToPath } from 'node:url';
-import { Planner } from '../src/planner.js';
-import { GlobalHooks } from '../src/hooks.js';
-import { CliParser } from '../src/cli_parser.js';
-import { ConfigManager } from '../src/config_manager.js';
-import { createTest, createTestGroup } from '../src/create_test.js';
-import { Suite, Runner, Emitter } from '../modules/core/main.js';
-/**
- * Runner factory exposes the API to run dummy suites, groups and tests.
- * You might want to use the factory for testing reporters and
- * plugins usage
- */
-export class RunnerFactory {
-    #emitter = new Emitter();
-    #config;
-    #cliArgs;
-    #suites;
-    #file = fileURLToPath(import.meta.url);
-    get #refiner() {
-        return this.#config.refiner;
-    }
-    /**
-     * Creating unit and functional suites
-     */
-    #createSuites() {
-        return [
-            new Suite('unit', this.#emitter, this.#refiner),
-            new Suite('functional', this.#emitter, this.#refiner),
-        ];
-    }
-    /**
-     * Creates a variety of tests for Maths.add method
-     */
-    #createAdditionTests(group) {
-        createTest('add two numbers', this.#emitter, this.#refiner, { group, file: this.#file }).run(() => {
-            assert.equal(2 + 2, 4);
-        });
-        createTest('add three numbers', this.#emitter, this.#refiner, {
-            group,
-            file: this.#file,
-        }).run(() => {
-            assert.equal(2 + 2 + 2, 6);
-        });
-        createTest('add group of numbers', this.#emitter, this.#refiner, { group, file: this.#file });
-        createTest('use math.js lib', this.#emitter, this.#refiner, { group, file: this.#file }).skip(true, 'Library work pending');
-        createTest('add multiple numbers', this.#emitter, this.#refiner, {
-            file: this.#file,
-            group,
-        }).run(() => {
-            assert.equal(2 + 2 + 2 + 2, 6);
-        });
-        createTest('add floating numbers', this.#emitter, this.#refiner, { group, file: this.#file })
-            .run(() => {
-            assert.equal(2 + 2.2 + 2.1, 6);
-        })
-            .fails('Have to add support for floating numbers');
-        createTest('A test with an error that is not an AssertionError', this.#emitter, this.#refiner, {
-            group,
-            file: this.#file,
-        }).run(() => {
-            throw new Error('This is an error');
-        });
-    }
-    /**
-     * Creates a variety of dummy tests for creating
-     * a new user
-     */
-    #createUserStoreTests(group) {
-        createTest('Validate user data', this.#emitter, this.#refiner, {
-            group,
-            file: this.#file,
-        }).run(() => { });
-        createTest('Disallow duplicate emails', this.#emitter, this.#refiner, {
-            group,
-            file: this.#file,
-        }).run(() => { });
-        createTest('Disallow duplicate emails across tenants', this.#emitter, this.#refiner, {
-            group,
-            file: this.#file,
-        }).run(() => {
-            const users = ['', ''];
-            assert.equal(users.length, 1);
-        });
-        createTest('Normalize email before persisting it', this.#emitter, this.#refiner, {
-            group,
-            file: this.#file,
-        }).skip(true, 'Have to build a normalizer');
-        createTest('Send email verification mail', this.#emitter, this.#refiner, {
-            group,
-            file: this.#file,
-        });
-    }
-    /**
-     * Creates tests for the unit tests suite
-     */
-    #createUnitTests(suite) {
-        const additionGroup = createTestGroup('Maths#add', this.#emitter, this.#refiner, {
-            suite,
-            file: this.#file,
-        });
-        this.#createAdditionTests(additionGroup);
-        createTest('A top level test inside a suite', this.#emitter, this.#refiner, {
-            suite,
-            file: this.#file,
-        }).run(() => { });
-    }
-    /**
-     * Creates tests for the functional tests suite
-     */
-    #createFunctionalTests(suite) {
-        const usersStoreGroup = createTestGroup('Users/store', this.#emitter, this.#refiner, {
-            suite,
-            file: this.#file,
-        });
-        this.#createUserStoreTests(usersStoreGroup);
-        const usersListGroup = createTestGroup('Users/list', this.#emitter, this.#refiner, {
-            suite,
-            file: this.#file,
-        });
-        usersListGroup.setup(() => {
-            throw new Error('Unable to cleanup database');
-        });
-        createTest('A test that will never because the group hooks fails', this.#emitter, this.#refiner, { group: usersListGroup });
-        createTest('A top level test inside functional suite', this.#emitter, this.#refiner, {
-            suite,
-            file: this.#file,
-        }).run(() => { });
-    }
-    /**
-     * Registers plugins
-     */
-    async #registerPlugins(runner) {
-        for (let plugin of this.#config.plugins) {
-            await plugin({
-                config: this.#config,
-                runner,
-                emitter: this.#emitter,
-                cliArgs: this.#cliArgs,
-            });
-        }
-    }
-    /**
-     * Configure runner
-     */
-    configure(config, argv) {
-        this.#cliArgs = new CliParser().parse(argv || []);
-        this.#config = new ConfigManager(config, this.#cliArgs).hydrate();
-        return this;
-    }
-    /**
-     * Register custom suites to execute instead
-     * of the dummy one's
-     */
-    withSuites(suites) {
-        this.#suites = suites;
-        return this;
-    }
-    /**
-     * Define a custom emitter instance to use
-     */
-    useEmitter(emitter) {
-        this.#emitter = emitter;
-        return this;
-    }
-    /**
-     * Run dummy tests. You might use
-     */
-    async run() {
-        const runner = new Runner(this.#emitter);
-        await this.#registerPlugins(runner);
-        const { config, reporters, refinerFilters } = await new Planner(this.#config).plan();
-        const globalHooks = new GlobalHooks();
-        globalHooks.apply(config);
-        reporters.forEach((reporter) => {
-            runner.registerReporter(reporter);
-        });
-        refinerFilters.forEach((filter) => {
-            config.refiner.add(filter.layer, filter.filters);
-        });
-        if (this.#suites) {
-            this.#suites.forEach((suite) => runner.add(suite));
-        }
-        else {
-            const [unit, functional] = this.#createSuites();
-            this.#createUnitTests(unit);
-            runner.add(unit);
-            this.#createFunctionalTests(functional);
-            runner.add(functional);
-        }
-        await globalHooks.setup(runner);
-        await runner.start();
-        await runner.exec();
-        await runner.end();
-        await globalHooks.teardown(null, runner);
-        return runner.getSummary();
-    }
-}

package/build/modules/core/reporters/base.d.ts

@@ -1,41 +0,0 @@
-import type { TestEndNode, SuiteEndNode, GroupEndNode, TestStartNode, RunnerSummary, RunnerEndNode, GroupStartNode, SuiteStartNode, RunnerStartNode, BaseReporterOptions } from '../types.js';
-import { Emitter, Runner } from '../main.js';
-/**
- * Base reporter to build custom reporters on top of
- */
-export declare abstract class BaseReporter {
-    #private;
-    runner?: Runner;
-    /**
-     * Path to the file for which the tests are getting executed
-     */
-    currentFileName?: string;
-    /**
-     * Suite for which the tests are getting executed
-     */
-    currentSuiteName?: string;
-    /**
-     * Group for which the tests are getting executed
-     */
-    currentGroupName?: string;
-    constructor(options?: BaseReporterOptions);
-    /**
-     * Handlers to capture events
-     */
-    protected onTestStart(_: TestStartNode): void;
-    protected onTestEnd(_: TestEndNode): void;
-    protected onGroupStart(_: GroupStartNode): void;
-    protected onGroupEnd(_: GroupEndNode): void;
-    protected onSuiteStart(_: SuiteStartNode): void;
-    protected onSuiteEnd(_: SuiteEndNode): void;
-    protected start(_: RunnerStartNode): Promise<void>;
-    protected end(_: RunnerEndNode): Promise<void>;
-    /**
-     * Print tests summary
-     */
-    protected printSummary(summary: RunnerSummary): Promise<void>;
-    /**
-     * Invoked by the tests runner when tests are about to start
-     */
-    boot(runner: Runner, emitter: Emitter): void;
-}

package/build/modules/core/reporters/base.js

@@ -1,183 +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 ms from 'ms';
-import colors from '@poppinss/colors';
-import { ErrorsPrinter } from '@japa/errors-printer';
-const ansi = colors.ansi();
-/**
- * Base reporter to build custom reporters on top of
- */
-export class BaseReporter {
-    #options;
-    runner;
-    /**
-     * Path to the file for which the tests are getting executed
-     */
-    currentFileName;
-    /**
-     * Suite for which the tests are getting executed
-     */
-    currentSuiteName;
-    /**
-     * Group for which the tests are getting executed
-     */
-    currentGroupName;
-    constructor(options = {}) {
-        this.#options = Object.assign({ stackLinesCount: 2 }, options);
-    }
-    /**
-     * Pretty prints the aggregates
-     */
-    #printAggregates(summary) {
-        const tests = [];
-        /**
-         * Set value for tests row
-         */
-        if (summary.aggregates.passed) {
-            tests.push(ansi.green(`${summary.aggregates.passed} passed`));
-        }
-        if (summary.aggregates.failed) {
-            tests.push(ansi.red(`${summary.aggregates.failed} failed`));
-        }
-        if (summary.aggregates.todo) {
-            tests.push(ansi.cyan(`${summary.aggregates.todo} todo`));
-        }
-        if (summary.aggregates.skipped) {
-            tests.push(ansi.yellow(`${summary.aggregates.skipped} skipped`));
-        }
-        if (summary.aggregates.regression) {
-            tests.push(ansi.magenta(`${summary.aggregates.regression} regression`));
-        }
-        this.runner.summaryBuilder.use(() => {
-            return [
-                {
-                    key: ansi.dim('Tests'),
-                    value: `${tests.join(', ')} ${ansi.dim(`(${summary.aggregates.total})`)}`,
-                },
-                {
-                    key: ansi.dim('Time'),
-                    value: ansi.dim(ms(summary.duration)),
-                },
-            ];
-        });
-        console.log(this.runner.summaryBuilder.build().join('\n'));
-    }
-    /**
-     * Aggregates errors tree to a flat array
-     */
-    #aggregateErrors(summary) {
-        const errorsList = [];
-        summary.failureTree.forEach((suite) => {
-            suite.errors.forEach((error) => errorsList.push({ title: suite.name, ...error }));
-            suite.children.forEach((testOrGroup) => {
-                /**
-                 * Suite child is a test
-                 */
-                if (testOrGroup.type === 'test') {
-                    testOrGroup.errors.forEach((error) => {
-                        errorsList.push({ title: `${suite.name} / ${testOrGroup.title}`, ...error });
-                    });
-                    return;
-                }
-                /**
-                 * Suite child is a group
-                 */
-                testOrGroup.errors.forEach((error) => {
-                    errorsList.push({ title: testOrGroup.name, ...error });
-                });
-                testOrGroup.children.forEach((test) => {
-                    test.errors.forEach((error) => {
-                        errorsList.push({ title: `${testOrGroup.name} / ${test.title}`, ...error });
-                    });
-                });
-            });
-        });
-        return errorsList;
-    }
-    /**
-     * Pretty print errors
-     */
-    async #printErrors(summary) {
-        if (!summary.failureTree.length) {
-            return;
-        }
-        const errorPrinter = new ErrorsPrinter({
-            stackLinesCount: this.#options.stackLinesCount,
-            framesMaxLimit: this.#options.framesMaxLimit,
-        });
-        errorPrinter.printSectionHeader('ERRORS');
-        await errorPrinter.printErrors(this.#aggregateErrors(summary));
-    }
-    /**
-     * Handlers to capture events
-     */
-    onTestStart(_) { }
-    onTestEnd(_) { }
-    onGroupStart(_) { }
-    onGroupEnd(_) { }
-    onSuiteStart(_) { }
-    onSuiteEnd(_) { }
-    async start(_) { }
-    async end(_) { }
-    /**
-     * Print tests summary
-     */
-    async printSummary(summary) {
-        await this.#printErrors(summary);
-        console.log('');
-        if (summary.aggregates.total === 0 && !summary.hasError) {
-            console.log(ansi.bgYellow().black(' NO TESTS EXECUTED '));
-            return;
-        }
-        if (summary.hasError) {
-            console.log(ansi.bgRed().black(' FAILED '));
-        }
-        else {
-            console.log(ansi.bgGreen().black(' PASSED '));
-        }
-        console.log('');
-        this.#printAggregates(summary);
-    }
-    /**
-     * Invoked by the tests runner when tests are about to start
-     */
-    boot(runner, emitter) {
-        this.runner = runner;
-        emitter.on('test:start', (payload) => {
-            this.currentFileName = payload.meta.fileName;
-            this.onTestStart(payload);
-        });
-        emitter.on('test:end', (payload) => {
-            this.onTestEnd(payload);
-        });
-        emitter.on('group:start', (payload) => {
-            this.currentGroupName = payload.title;
-            this.currentFileName = payload.meta.fileName;
-            this.onGroupStart(payload);
-        });
-        emitter.on('group:end', (payload) => {
-            this.currentGroupName = undefined;
-            this.onGroupEnd(payload);
-        });
-        emitter.on('suite:start', (payload) => {
-            this.currentSuiteName = payload.name;
-            this.onSuiteStart(payload);
-        });
-        emitter.on('suite:end', (payload) => {
-            this.currentSuiteName = undefined;
-            this.onSuiteEnd(payload);
-        });
-        emitter.on('runner:start', async (payload) => {
-            await this.start(payload);
-        });
-        emitter.on('runner:end', async (payload) => {
-            await this.end(payload);
-        });
-    }
-}

package/build/modules/core/types.d.ts

@@ -1,5 +0,0 @@
-export * from '@japa/core/types';
-export type BaseReporterOptions = {
-    stackLinesCount?: number;
-    framesMaxLimit?: number;
-};

package/build/modules/core/types.js

@@ -1,9 +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.
- */
-export * from '@japa/core/types';

package/build/src/cli_parser.d.ts

@@ -1,14 +0,0 @@
-import type { CLIArgs } from './types.js';
-/**
- * CLI Parser is used to parse the commandline argument
- */
-export declare class CliParser {
-    /**
-     * Parses command-line arguments
-     */
-    parse(argv: string[]): CLIArgs;
-    /**
-     * Returns the help string
-     */
-    getHelp(): string;
-}

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', 'reporter', '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('--reporter')}                  ${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.d.ts

@@ -1,18 +0,0 @@
-import type { CLIArgs, Config, NormalizedConfig } from './types.js';
-export declare const NOOP: () => void;
-/**
- * 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 declare class ConfigManager {
-    #private;
-    constructor(config: Config, cliArgs: CLIArgs);
-    /**
-     * Hydrates the config with user defined options and the
-     * command-line flags.
-     */
-    hydrate(): NormalizedConfig;
-}