@japa/runner 3.0.0-7 → 3.0.0-9

package/build/src/reporters/spec.js

@@ -8,7 +8,7 @@
  */
 import ms from 'ms';
 import { relative } from 'node:path';
-import cliui from '../helpers.js';
+import { colors, icons } from '../helpers.js';
 import { BaseReporter } from '../../modules/core/main.js';
 /**
  * Pretty prints the tests on the console
@@ -24,20 +24,18 @@ export class SpecReporter extends BaseReporter {
      */
     #getTestIcon(payload) {
         if (payload.isTodo) {
-            return cliui.colors.cyan(cliui.icons.info);
+            return colors.cyan(icons.info);
         }
         if (payload.isFailing) {
-            return payload.hasError
-                ? cliui.colors.magenta(cliui.icons.squareSmallFilled)
-                : cliui.colors.red(cliui.icons.cross);
+            return payload.hasError ? colors.magenta(icons.squareSmallFilled) : colors.red(icons.cross);
         }
         if (payload.hasError) {
-            return cliui.colors.red(cliui.icons.cross);
+            return colors.red(icons.cross);
         }
         if (payload.isSkipped) {
-            return cliui.colors.yellow(cliui.icons.bullet);
+            return colors.yellow(icons.bullet);
         }
-        return cliui.colors.green(cliui.icons.tick);
+        return colors.green(icons.tick);
     }
     /**
      * Returns the test message
@@ -45,38 +43,38 @@ export class SpecReporter extends BaseReporter {
     #getTestMessage(payload) {
         const message = typeof payload.title === 'string' ? payload.title : payload.title.expanded;
         if (payload.isTodo) {
-            return cliui.colors.blue(message);
+            return colors.blue(message);
         }
         if (payload.isFailing) {
-            return payload.hasError ? cliui.colors.magenta(message) : cliui.colors.red(message);
+            return payload.hasError ? colors.magenta(message) : colors.red(message);
         }
         if (payload.hasError) {
-            return cliui.colors.red(message);
+            return colors.red(message);
         }
         if (payload.isSkipped) {
-            return cliui.colors.yellow(message);
+            return colors.yellow(message);
         }
-        return cliui.colors.grey(message);
+        return colors.grey(message);
     }
     /**
      * Returns the subtext message for the test
      */
     #getSubText(payload) {
         if (payload.isSkipped && payload.skipReason) {
-            return cliui.colors.yellow(payload.skipReason);
+            return colors.yellow(payload.skipReason);
         }
         if (!payload.isFailing) {
             return;
         }
         if (!payload.hasError) {
-            return cliui.colors.magenta(`Test marked with ".fails()" must finish with an error`);
+            return colors.magenta(`Test marked with ".fails()" must finish with an error`);
         }
         if (payload.failReason) {
-            return cliui.colors.magenta(payload.failReason);
+            return colors.magenta(payload.failReason);
         }
         const testErrorMessage = payload.errors.find((error) => error.phase === 'test');
         if (testErrorMessage && testErrorMessage.error) {
-            return cliui.colors.magenta(testErrorMessage.error.message);
+            return colors.magenta(testErrorMessage.error.message);
         }
     }
     /**
@@ -91,11 +89,11 @@ export class SpecReporter extends BaseReporter {
     #printTest(payload) {
         const icon = this.#getTestIcon(payload);
         const message = this.#getTestMessage(payload);
-        const prefix = payload.isPinned ? cliui.colors.yellow('[PINNED] ') : '';
+        const prefix = payload.isPinned ? colors.yellow('[PINNED] ') : '';
         const indentation = this.currentFileName || this.currentGroupName ? '  ' : '';
-        const duration = cliui.colors.dim(`(${ms(Number(payload.duration.toFixed(2)))})`);
+        const duration = colors.dim(`(${ms(Number(payload.duration.toFixed(2)))})`);
         const retries = payload.retryAttempt && payload.retryAttempt > 1
-            ? cliui.colors.dim(`(x${payload.retryAttempt}) `)
+            ? colors.dim(`(x${payload.retryAttempt}) `)
             : '';
         let subText = this.#getSubText(payload);
         subText = subText ? `\n${indentation}  ${subText}` : '';
@@ -109,7 +107,7 @@ export class SpecReporter extends BaseReporter {
             ? `${this.currentSuiteName} / ${payload.title}`
             : payload.title;
         const suffix = this.currentFileName
-            ? cliui.colors.dim(` (${this.#getRelativeFilename(this.currentFileName)})`)
+            ? colors.dim(` (${this.#getRelativeFilename(this.currentFileName)})`)
             : '';
         console.log(`\n${title}${suffix}`);
     }
@@ -122,7 +120,7 @@ export class SpecReporter extends BaseReporter {
          * - Test is first in a sequence
          */
         if (this.currentFileName && this.#isFirstLoneTest) {
-            console.log(`\n${cliui.colors.dim(this.#getRelativeFilename(this.currentFileName))}`);
+            console.log(`\n${colors.dim(this.#getRelativeFilename(this.currentFileName))}`);
         }
         this.#isFirstLoneTest = false;
     }

package/build/src/types.d.ts

@@ -1,4 +1,4 @@
-/// <reference types="@types/node" resolution-mode="require"/>
+/// <reference types="node" resolution-mode="require"/>
 import type { HookHandler } from '@poppinss/hooks/types';
 import type { Emitter, Refiner, Runner, Suite } from '../modules/core/main.js';
 import type { FilteringOptions, NamedReporterContract } from '../modules/core/types.js';

package/build/tests/base_reporter.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/build/tests/base_reporter.spec.js

@@ -0,0 +1,111 @@
+/*
+ * @japa/runner
+ *
+ * (c) Japa
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import { test } from 'node:test';
+import chaiSubset from 'chai-subset';
+import { assert, default as chai } from 'chai';
+chai.use(chaiSubset);
+import { wrapAssertions } from '../tests_helpers/main.js';
+import { Test, Suite, Group, Runner, Refiner, Emitter, TestContext, BaseReporter, } from '../modules/core/main.js';
+test.describe('Base reporter', () => {
+    test('extend base reporter to create a custom reporter', async () => {
+        const stack = [];
+        class MyReporter extends BaseReporter {
+            async start() {
+                stack.push('reporter started');
+            }
+        }
+        const emitter = new Emitter();
+        const runner = new Runner(emitter);
+        runner.registerReporter((r, e) => new MyReporter({}).boot(r, e));
+        await runner.start();
+        await wrapAssertions(() => {
+            assert.deepEqual(stack, ['reporter started']);
+        });
+    });
+    test('invoke handlers when suite, groups and tests are executed', async () => {
+        const stack = [];
+        let summary;
+        class MyReporter extends BaseReporter {
+            async start() {
+                stack.push('reporter started');
+            }
+            async end() {
+                summary = this.runner.getSummary();
+                stack.push('reporter ended');
+            }
+            onTestStart(t) {
+                assert.equal(t.title.expanded, '2 + 2');
+                assert.equal(this.currentSuiteName, 'unit');
+                assert.equal(this.currentGroupName, 'default');
+                stack.push('test started');
+            }
+            onTestEnd(t) {
+                assert.equal(t.title.expanded, '2 + 2');
+                assert.isFalse(t.hasError);
+                stack.push('test ended');
+            }
+            onGroupStart(g) {
+                assert.equal(g.title, 'default');
+                assert.equal(this.currentSuiteName, 'unit');
+                stack.push('group started');
+            }
+            onGroupEnd(g) {
+                assert.equal(g.title, 'default');
+                assert.isFalse(g.hasError);
+                stack.push('group ended');
+            }
+            onSuiteStart(s) {
+                assert.equal(s.name, 'unit');
+                stack.push('suite started');
+            }
+            onSuiteEnd(s) {
+                assert.equal(s.name, 'unit');
+                stack.push('suite ended');
+            }
+        }
+        const emitter = new Emitter();
+        const runner = new Runner(emitter);
+        const refiner = new Refiner();
+        const suite = new Suite('unit', emitter, refiner);
+        const group = new Group('default', emitter, refiner);
+        const t = new Test('2 + 2', (_t) => new TestContext(_t), emitter, refiner, group);
+        group.add(t);
+        suite.add(group);
+        runner.add(suite);
+        runner.registerReporter((r, e) => new MyReporter({}).boot(r, e));
+        await runner.start();
+        await runner.exec();
+        await runner.end();
+        await wrapAssertions(() => {
+            assert.deepEqual(stack, [
+                'reporter started',
+                'suite started',
+                'group started',
+                'test started',
+                'test ended',
+                'group ended',
+                'suite ended',
+                'reporter ended',
+            ]);
+            assert.containSubset(summary, {
+                aggregates: {
+                    total: 1,
+                    failed: 0,
+                    passed: 0,
+                    regression: 0,
+                    skipped: 0,
+                    todo: 1,
+                },
+                hasError: false,
+                failureTree: [],
+                failedTestsTitles: [],
+            });
+        });
+    });
+});

package/build/tests/cli_parser.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/build/tests/cli_parser.spec.js

@@ -0,0 +1,265 @@
+/*
+ * @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 'chai';
+import { test } from 'node:test';
+import colors from '@poppinss/colors';
+import { CliParser } from '../src/cli_parser.js';
+import { wrapAssertions } from '../tests_helpers/main.js';
+const DATASET = [
+    [
+        new CliParser().parse([]),
+        {
+            '_': [],
+            'files': '',
+            'groups': '',
+            'reporter': '',
+            'h': false,
+            'help': false,
+            'failed': false,
+            'match-all': false,
+            'matchAll': false,
+            'retries': '',
+            'tags': '',
+            'tests': '',
+            'timeout': '',
+        },
+    ],
+    [
+        new CliParser().parse(['unit', 'functional']),
+        {
+            '_': ['unit', 'functional'],
+            'files': '',
+            'reporter': '',
+            'groups': '',
+            'h': false,
+            'help': false,
+            'failed': false,
+            'match-all': false,
+            'matchAll': false,
+            'retries': '',
+            'tags': '',
+            'tests': '',
+            'timeout': '',
+        },
+    ],
+    [
+        new CliParser().parse(['--timeout', '1000']),
+        {
+            '_': [],
+            'files': '',
+            'reporter': '',
+            'groups': '',
+            'h': false,
+            'help': false,
+            'failed': false,
+            'match-all': false,
+            'matchAll': false,
+            'retries': '',
+            'tags': '',
+            'tests': '',
+            'timeout': '1000',
+        },
+    ],
+    [
+        new CliParser().parse(['--timeout', '1000', '--retries', '2']),
+        {
+            '_': [],
+            'files': '',
+            'reporter': '',
+            'groups': '',
+            'h': false,
+            'help': false,
+            'failed': false,
+            'match-all': false,
+            'matchAll': false,
+            'retries': '2',
+            'tags': '',
+            'tests': '',
+            'timeout': '1000',
+        },
+    ],
+    [
+        new CliParser().parse(['--match-all']),
+        {
+            '_': [],
+            'files': '',
+            'reporter': '',
+            'groups': '',
+            'h': false,
+            'help': false,
+            'failed': false,
+            'match-all': true,
+            'matchAll': true,
+            'retries': '',
+            'tags': '',
+            'tests': '',
+            'timeout': '',
+        },
+    ],
+    [
+        new CliParser().parse(['--force-exit']),
+        {
+            '_': [],
+            'files': '',
+            'force-exit': true,
+            'forceExit': true,
+            'reporter': '',
+            'groups': '',
+            'h': false,
+            'help': false,
+            'failed': false,
+            'match-all': false,
+            'matchAll': false,
+            'retries': '',
+            'tags': '',
+            'tests': '',
+            'timeout': '',
+        },
+    ],
+    [
+        new CliParser().parse(['--browser', 'chrome', '--browser', 'firefox']),
+        {
+            '_': [],
+            'files': '',
+            'browser': ['chrome', 'firefox'],
+            'reporter': '',
+            'groups': '',
+            'h': false,
+            'help': false,
+            'failed': false,
+            'match-all': false,
+            'matchAll': false,
+            'retries': '',
+            'tags': '',
+            'tests': '',
+            'timeout': '',
+        },
+    ],
+    [
+        new CliParser().parse(['--reporter', 'spec']),
+        {
+            '_': [],
+            'files': '',
+            'reporter': 'spec',
+            'groups': '',
+            'h': false,
+            'help': false,
+            'failed': false,
+            'match-all': false,
+            'matchAll': false,
+            'retries': '',
+            'tags': '',
+            'tests': '',
+            'timeout': '',
+        },
+    ],
+    [
+        new CliParser().parse(['--reporter', 'spec', '--reporter', 'dot']),
+        {
+            '_': [],
+            'files': '',
+            'reporter': ['spec', 'dot'],
+            'groups': '',
+            'h': false,
+            'help': false,
+            'failed': false,
+            'match-all': false,
+            'matchAll': false,
+            'retries': '',
+            'tags': '',
+            'tests': '',
+            'timeout': '',
+        },
+    ],
+    [
+        new CliParser().parse(['--reporter', 'spec,dot']),
+        {
+            '_': [],
+            'files': '',
+            'reporter': 'spec,dot',
+            'groups': '',
+            'h': false,
+            'help': false,
+            'failed': false,
+            'match-all': false,
+            'matchAll': false,
+            'retries': '',
+            'tags': '',
+            'tests': '',
+            'timeout': '',
+        },
+    ],
+    [
+        new CliParser().parse(['--failed']),
+        {
+            '_': [],
+            'files': '',
+            'reporter': '',
+            'groups': '',
+            'h': false,
+            'help': false,
+            'failed': true,
+            'match-all': false,
+            'matchAll': false,
+            'retries': '',
+            'tags': '',
+            'tests': '',
+            'timeout': '',
+        },
+    ],
+];
+test.describe('CLI parser', () => {
+    test('parse CLI arguments', async () => {
+        for (let [cliArgs, output] of DATASET) {
+            await wrapAssertions(() => {
+                assert.deepEqual(cliArgs, output);
+            });
+        }
+    });
+    if (!process.env.CI) {
+        test('display help', async () => {
+            const ansi = colors.ansi();
+            console.log(new CliParser().getHelp());
+            await wrapAssertions(() => {
+                assert.deepEqual(new CliParser().getHelp().split('\n'), [
+                    '',
+                    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.`,
+                    ``,
+                ]);
+            });
+        });
+    }
+});

package/build/tests/config_manager.spec.d.ts

@@ -0,0 +1 @@
+export {};