@japa/runner 2.5.1 → 3.0.0-1

package/LICENSE.md

@@ -1,6 +1,6 @@
 # The MIT License
 
-Copyright 2022 Harminder Virk, contributors
+Copyright (c) 2023 Harminder Virk
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

package/build/factories/main.d.ts

@@ -0,0 +1,3 @@
+import { RunnerFactory } from './runner.js';
+export declare const runner: () => RunnerFactory;
+//# sourceMappingURL=main.d.ts.map

package/build/factories/main.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../../factories/main.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAK3C,eAAO,MAAM,MAAM,qBAA4B,CAAA"}

package/build/factories/main.js

@@ -0,0 +1,2 @@
+import { RunnerFactory } from './runner.js';
+export const runner = () => new RunnerFactory();

package/build/factories/runner.d.ts

@@ -0,0 +1,10 @@
+import { Config } from '../src/types.js';
+import { Suite, Emitter } from '../modules/core/main.js';
+export declare class RunnerFactory {
+    #private;
+    configure(config: Config, argv?: string[]): this;
+    withSuites(suites: Suite[]): this;
+    useEmitter(emitter: Emitter): this;
+    run(): Promise<import("@japa/core/types").RunnerSummary>;
+}
+//# sourceMappingURL=runner.d.ts.map

package/build/factories/runner.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"runner.d.ts","sourceRoot":"","sources":["../../factories/runner.ts"],"names":[],"mappings":"AAeA,OAAO,EAAW,MAAM,EAAE,MAAM,iBAAiB,CAAA;AAGjD,OAAO,EAAS,KAAK,EAAU,OAAO,EAAE,MAAM,yBAAyB,CAAA;AAOvE,qBAAa,aAAa;;IAmJxB,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE;IAUzC,UAAU,CAAC,MAAM,EAAE,KAAK,EAAE;IAQ1B,UAAU,CAAC,OAAO,EAAE,OAAO;IAQrB,GAAG;CAoCV"}

package/build/factories/runner.js

@@ -0,0 +1,155 @@
+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';
+export class RunnerFactory {
+    #emitter = new Emitter();
+    #config;
+    #cliArgs;
+    #suites;
+    #file = fileURLToPath(import.meta.url);
+    get #refiner() {
+        return this.#config.refiner;
+    }
+    #createSuites() {
+        return [
+            new Suite('unit', this.#emitter, this.#refiner),
+            new Suite('functional', this.#emitter, this.#refiner),
+        ];
+    }
+    #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');
+    }
+    #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,
+        });
+    }
+    #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(() => { });
+    }
+    #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(() => { });
+    }
+    async #registerPlugins(runner) {
+        for (let plugin of this.#config.plugins) {
+            await plugin({
+                config: this.#config,
+                runner,
+                emitter: this.#emitter,
+                cliArgs: this.#cliArgs,
+            });
+        }
+    }
+    configure(config, argv) {
+        this.#cliArgs = new CliParser().parse(argv || []);
+        this.#config = new ConfigManager(config, this.#cliArgs).hydrate();
+        return this;
+    }
+    withSuites(suites) {
+        this.#suites = suites;
+        return this;
+    }
+    useEmitter(emitter) {
+        this.#emitter = emitter;
+        return this;
+    }
+    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/index.d.ts

@@ -1,33 +1,12 @@
-import { TestExecutor, ReporterContract } from '@japa/core';
-import { Test, TestContext, Group, Suite, Runner } from './src/core/main';
-import { Config, PluginFn, RunnerHooksHandler, RunnerHooksCleanupHandler } from './src/types';
-export { Test, Config, Suite, Runner, Group, PluginFn, TestContext, ReporterContract, RunnerHooksHandler, RunnerHooksCleanupHandler, };
-/**
- * Configure the tests runner
- */
-export declare function configure(options: Config): void;
-/**
- * Process CLI arguments into configuration options. The following
- * command line arguments are processed.
- *
- * * --tests=Specify test titles
- * * --tags=Specify test tags
- * * --groups=Specify group titles
- * * --ignore-tags=Specify negated tags
- * * --files=Specify files to match and run
- * * --force-exit=Enable/disable force exit
- * * --timeout=Define timeout for all the tests
- * * -h, --help=Show help
- */
-export declare function processCliArgs(argv: string[]): Partial<Config>;
-/**
- * Run japa tests
- */
-export declare function run(): Promise<void>;
-/**
- * Add a new test
- */
+import type { TestExecutor } from '@japa/core/types';
+import type { Config } from './src/types.js';
+import { Group, Test, TestContext } from './modules/core/main.js';
 export declare function test(title: string, callback?: TestExecutor<TestContext, undefined>): Test<undefined>;
 export declare namespace test {
     var group: (title: string, callback: (group: Group) => void) => void;
 }
+export declare function getActiveTest(): Test<any> | undefined;
+export declare function processCLIArgs(argv: string[]): void;
+export declare function configure(options: Config): void;
+export declare function run(): Promise<void>;
+//# sourceMappingURL=index.d.ts.map