@japa/runner 3.0.4 → 3.1.0

package/build/src/plugins/retry.js

@@ -1,72 +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 { join } from 'node:path';
-import findCacheDirectory from 'find-cache-dir';
-import { mkdir, readFile, unlink, writeFile } from 'node:fs/promises';
-import { colors } from '../helpers.js';
-/**
- * Paths to the cache directory and the summary file
- */
-const CACHE_DIR = findCacheDirectory({ name: '@japa/runner' });
-const SUMMARY_FILE = CACHE_DIR ? join(CACHE_DIR, 'summary.json') : undefined;
-/**
- * Returns an object with the title of the tests failed during
- * the last run.
- */
-export async function getFailedTests() {
-    try {
-        const summary = await readFile(SUMMARY_FILE, 'utf-8');
-        return JSON.parse(summary);
-    }
-    catch (error) {
-        if (error.code === 'ENOENT') {
-            return {};
-        }
-        throw new Error('Unable to read failed tests cache file', { cause: error });
-    }
-}
-/**
- * Writes failing tests to the cache directory
- */
-export async function cacheFailedTests(tests) {
-    await mkdir(CACHE_DIR, { recursive: true });
-    await writeFile(SUMMARY_FILE, JSON.stringify({ tests: tests }));
-}
-/**
- * Clears the cache dir
- */
-export async function clearCache() {
-    await unlink(SUMMARY_FILE);
-}
-/**
- * Exposes the API to run failing tests using the "failed" CLI flag.
- */
-export const retryPlugin = async function retry({ config, cliArgs }) {
-    if (!SUMMARY_FILE) {
-        return;
-    }
-    config.teardown.push(async (runner) => {
-        const summary = runner.getSummary();
-        await cacheFailedTests(summary.failedTestsTitles);
-    });
-    if (cliArgs.failed) {
-        try {
-            const { tests } = await getFailedTests();
-            if (!tests || !tests.length) {
-                console.log(colors.bgYellow().black(' No failing tests found. Running all the tests '));
-                return;
-            }
-            config.filters.tests = tests;
-        }
-        catch (error) {
-            console.log(colors.bgRed().black(' Unable to read failed tests. Running all the tests '));
-            console.log(colors.red(error));
-        }
-    }
-};

package/build/src/reporters/dot.js

@@ -1,41 +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 { colors, icons } from '../helpers.js';
-import { BaseReporter } from '../../modules/core/reporters/base.js';
-/**
- * Minimal reporter that prints each test as an icon.
- */
-export class DotReporter extends BaseReporter {
-    /**
-     * When a test ended
-     */
-    onTestEnd(payload) {
-        let output = '';
-        if (payload.isTodo) {
-            output = colors.cyan(icons.info);
-        }
-        else if (payload.hasError || payload.isFailing) {
-            output = payload.hasError ? colors.magenta(icons.squareSmallFilled) : colors.red(icons.cross);
-        }
-        else if (payload.isSkipped) {
-            output = colors.yellow(icons.bullet);
-        }
-        else {
-            output = colors.green(icons.tick);
-        }
-        process.stdout.write(`${output}`);
-    }
-    /**
-     * When test runner ended
-     */
-    async end() {
-        console.log('');
-        await this.printSummary(this.runner.getSummary());
-    }
-}

package/build/src/reporters/ndjson.js

@@ -1,86 +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 { relative } from 'node:path';
-import { serializeError } from 'serialize-error';
-import { BaseReporter } from '../../modules/core/main.js';
-/**
- * Prints tests progress as JSON. Each event is emitted
- * independently
- */
-export class NdJSONReporter extends BaseReporter {
-    /**
-     * Returns the filename relative from the current working dir
-     */
-    #getRelativeFilename(fileName) {
-        return relative(process.cwd(), fileName);
-    }
-    /**
-     * Serialize errors to JSON
-     */
-    #serializeErrors(errors) {
-        return errors.map((error) => ({
-            phase: error.phase,
-            error: serializeError(error.error),
-        }));
-    }
-    onTestEnd(payload) {
-        console.log(JSON.stringify({
-            event: 'test:end',
-            filePath: this.currentFileName,
-            relativePath: this.currentFileName
-                ? this.#getRelativeFilename(this.currentFileName)
-                : undefined,
-            title: payload.title,
-            duration: payload.duration,
-            failReason: payload.failReason,
-            isFailing: payload.isFailing,
-            skipReason: payload.skipReason,
-            isSkipped: payload.isSkipped,
-            isTodo: payload.isTodo,
-            isPinned: payload.isPinned,
-            retryAttempt: payload.retryAttempt,
-            retries: payload.retries,
-            errors: this.#serializeErrors(payload.errors),
-        }));
-    }
-    onGroupStart(payload) {
-        console.log(JSON.stringify({
-            event: 'group:start',
-            title: payload.title,
-        }));
-    }
-    onGroupEnd(payload) {
-        JSON.stringify({
-            event: 'group:end',
-            title: payload.title,
-            errors: this.#serializeErrors(payload.errors),
-        });
-    }
-    onSuiteStart(payload) {
-        console.log(JSON.stringify({
-            event: 'suite:start',
-            ...payload,
-        }));
-    }
-    onSuiteEnd(payload) {
-        console.log(JSON.stringify({
-            event: 'suite:end',
-            ...payload,
-        }));
-    }
-    async end() {
-        const summary = this.runner.getSummary();
-        console.log(JSON.stringify({
-            aggregates: summary.aggregates,
-            duration: summary.duration,
-            failedTestsTitles: summary.failedTestsTitles,
-            hasError: summary.hasError,
-        }));
-    }
-}

package/build/src/reporters/spec.js

@@ -1,152 +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 { relative } from 'node:path';
-import { colors, icons } from '../helpers.js';
-import { BaseReporter } from '../../modules/core/main.js';
-/**
- * Pretty prints the tests on the console
- */
-export class SpecReporter extends BaseReporter {
-    /**
-     * Tracking if the first event we get is for a test without any parent group
-     * We need this to decide the display style for tests without groups.
-     */
-    #isFirstLoneTest = true;
-    /**
-     * Returns the icon for the test
-     */
-    #getTestIcon(payload) {
-        if (payload.isTodo) {
-            return colors.cyan(icons.info);
-        }
-        if (payload.isFailing) {
-            return payload.hasError ? colors.magenta(icons.squareSmallFilled) : colors.red(icons.cross);
-        }
-        if (payload.hasError) {
-            return colors.red(icons.cross);
-        }
-        if (payload.isSkipped) {
-            return colors.yellow(icons.bullet);
-        }
-        return colors.green(icons.tick);
-    }
-    /**
-     * Returns the test message
-     */
-    #getTestMessage(payload) {
-        const message = typeof payload.title === 'string' ? payload.title : payload.title.expanded;
-        if (payload.isTodo) {
-            return colors.blue(message);
-        }
-        if (payload.isFailing) {
-            return payload.hasError ? colors.magenta(message) : colors.red(message);
-        }
-        if (payload.hasError) {
-            return colors.red(message);
-        }
-        if (payload.isSkipped) {
-            return colors.yellow(message);
-        }
-        return colors.grey(message);
-    }
-    /**
-     * Returns the subtext message for the test
-     */
-    #getSubText(payload) {
-        if (payload.isSkipped && payload.skipReason) {
-            return colors.yellow(payload.skipReason);
-        }
-        if (!payload.isFailing) {
-            return;
-        }
-        if (!payload.hasError) {
-            return colors.magenta(`Test marked with ".fails()" must finish with an error`);
-        }
-        if (payload.failReason) {
-            return colors.magenta(payload.failReason);
-        }
-        const testErrorMessage = payload.errors.find((error) => error.phase === 'test');
-        if (testErrorMessage && testErrorMessage.error) {
-            return colors.magenta(testErrorMessage.error.message);
-        }
-    }
-    /**
-     * Returns the filename relative from the current working dir
-     */
-    #getRelativeFilename(fileName) {
-        return relative(process.cwd(), fileName);
-    }
-    /**
-     * Prints the test details
-     */
-    #printTest(payload) {
-        const icon = this.#getTestIcon(payload);
-        const message = this.#getTestMessage(payload);
-        const prefix = payload.isPinned ? colors.yellow('[PINNED] ') : '';
-        const indentation = this.currentFileName || this.currentGroupName ? '  ' : '';
-        const duration = colors.dim(`(${ms(Number(payload.duration.toFixed(2)))})`);
-        const retries = payload.retryAttempt && payload.retryAttempt > 1
-            ? colors.dim(`(x${payload.retryAttempt}) `)
-            : '';
-        let subText = this.#getSubText(payload);
-        subText = subText ? `\n${indentation}  ${subText}` : '';
-        console.log(`${indentation}${icon} ${prefix}${retries}${message} ${duration}${subText}`);
-    }
-    /**
-     * Prints the group name
-     */
-    #printGroup(payload) {
-        const title = this.currentSuiteName !== 'default'
-            ? `${this.currentSuiteName} / ${payload.title}`
-            : payload.title;
-        const suffix = this.currentFileName
-            ? colors.dim(` (${this.#getRelativeFilename(this.currentFileName)})`)
-            : '';
-        console.log(`\n${title}${suffix}`);
-    }
-    onTestStart() {
-        /**
-         * Display the filename when
-         *
-         * - The filename exists
-         * - The test is not under a group
-         * - Test is first in a sequence
-         */
-        if (this.currentFileName && this.#isFirstLoneTest) {
-            console.log(`\n${colors.dim(this.#getRelativeFilename(this.currentFileName))}`);
-        }
-        this.#isFirstLoneTest = false;
-    }
-    onTestEnd(payload) {
-        this.#printTest(payload);
-    }
-    onGroupStart(payload) {
-        /**
-         * When a group starts, we mark the upcoming test as NOT a
-         * lone test
-         */
-        this.#isFirstLoneTest = false;
-        this.#printGroup(payload);
-    }
-    onGroupEnd() {
-        /**
-         * When the group ends we assume that the next test can
-         * be out of the group, hence a lone test.
-         *
-         * If this assumption is false, then the `onGroupStart` method
-         * will toggle the boolean
-         */
-        this.#isFirstLoneTest = true;
-    }
-    async end() {
-        const summary = this.runner.getSummary();
-        await this.printSummary(summary);
-    }
-}

package/build/src/validator.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.
- */
-/**
- * Validator encapsulates the validations to perform before running
- * the tests
- */
-class Validator {
-    /**
-     * Ensures the japa is configured. Otherwise raises an exception
-     */
-    ensureIsConfigured(config) {
-        if (!config) {
-            throw new Error(`Cannot run tests. Make sure to call "configure" method before the "run" method`);
-        }
-    }
-    /**
-     * Ensures the japa is in planning phase
-     */
-    ensureIsInPlanningPhase(phase) {
-        if (phase !== 'planning') {
-            throw new Error(`Cannot import japa test file directly. It must be imported by calling the "japa.run" method`);
-        }
-    }
-    /**
-     * Ensures the suites filter uses a subset of the user configured suites.
-     */
-    validateSuitesFilter(config) {
-        /**
-         * Do not perform any validation if no filters are applied
-         * in the first place
-         */
-        if (!config.filters.suites || !config.filters.suites.length) {
-            return;
-        }
-        /**
-         * Notify user they have applied the suites filter but forgot to define
-         * suites
-         */
-        if (!('suites' in config) || !config.suites.length) {
-            throw new Error(`Cannot apply suites filter. You have not configured any test suites`);
-        }
-        const suites = config.suites.map(({ name }) => name);
-        /**
-         * Find unknown suites and report the error
-         */
-        const unknownSuites = config.filters.suites.filter((suite) => !suites.includes(suite));
-        if (unknownSuites.length) {
-            throw new Error(`Cannot apply suites filter. "${unknownSuites[0]}" suite is not configured`);
-        }
-    }
-    /**
-     * Ensure there are unique suites
-     */
-    validateSuitesForUniqueness(config) {
-        if (!('suites' in config)) {
-            return;
-        }
-        const suites = new Set();
-        config.suites.forEach(({ name }) => {
-            if (suites.has(name)) {
-                throw new Error(`Duplicate suite "${name}"`);
-            }
-            suites.add(name);
-        });
-        suites.clear();
-    }
-    /**
-     * Ensure the activated reporters are in the list of defined
-     * reporters
-     */
-    validateActivatedReporters(config) {
-        const reportersList = config.reporters.list.map(({ name }) => name);
-        const unknownReporters = config.reporters.activated.filter((name) => !reportersList.includes(name));
-        if (unknownReporters.length) {
-            throw new Error(`Invalid reporter "${unknownReporters[0]}". Make sure to register it first inside the "reporters.list" array`);
-        }
-    }
-}
-export default new Validator();