@remix-run/test 0.0.0 → 0.2.0

package/dist/cli.d.ts

@@ -0,0 +1,8 @@
+import { getRemixTestHelpText } from './lib/config.ts';
+export { getRemixTestHelpText };
+export interface RunRemixTestOptions {
+    argv?: string[];
+    cwd?: string;
+}
+export declare function runRemixTest(options?: RunRemixTestOptions): Promise<number>;
+//# sourceMappingURL=cli.d.ts.map

package/dist/cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,oBAAoB,EAIrB,MAAM,iBAAiB,CAAA;AAYxB,OAAO,EAAE,oBAAoB,EAAE,CAAA;AAE/B,MAAM,WAAW,mBAAmB;IAClC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;IACf,GAAG,CAAC,EAAE,MAAM,CAAA;CACb;AASD,wBAAsB,YAAY,CAAC,OAAO,GAAE,mBAAwB,GAAG,OAAO,CAAC,MAAM,CAAC,CAerF"}

package/dist/cli.js

@@ -0,0 +1,305 @@
+import * as fsp from 'node:fs/promises';
+import * as path from 'node:path';
+import { getRemixTestHelpText, IS_RUNNING_FROM_SRC, loadConfig, } from "./lib/config.js";
+import { generateCombinedCoverageReport } from "./lib/coverage.js";
+import { loadPlaywrightConfig, resolveProjects } from "./lib/playwright.js";
+import { createReporter } from "./lib/reporters/index.js";
+import { runBrowserTests } from "./lib/runner-browser.js";
+import { runServerTests } from "./lib/runner.js";
+import { createWatcher } from "./lib/watcher.js";
+import { importModule } from "./lib/import-module.js";
+import { IS_BUN } from "./lib/runtime.js";
+import { isMainThread } from 'node:worker_threads';
+export { getRemixTestHelpText };
+export async function runRemixTest(options = {}) {
+    let argv = options.argv ?? process.argv.slice(2);
+    let cwd = await resolveCwd(options.cwd ?? process.cwd());
+    let previousCwd = process.cwd();
+    if (!isMainThread) {
+        return await runRemixTestInCwd(argv, cwd);
+    }
+    try {
+        process.chdir(cwd);
+        return await runRemixTestInCwd(argv, cwd);
+    }
+    finally {
+        process.chdir(previousCwd);
+    }
+}
+async function runRemixTestInCwd(argv, cwd) {
+    if (argv.includes('--help') || argv.includes('-h')) {
+        console.log(getRemixTestHelpText());
+        return 0;
+    }
+    let config = await loadConfig(argv, cwd);
+    let hasExited = false;
+    let latestExitCode = 0;
+    let watcher;
+    let running = false;
+    let queued = false;
+    let rerunTimer;
+    let browserServer;
+    let browserServerFilesKey;
+    let browserPort;
+    let resolveRun;
+    let runPromise = new Promise((resolve) => {
+        resolveRun = resolve;
+    });
+    let cleanupAndExit = (code) => {
+        if (hasExited)
+            return;
+        hasExited = true;
+        watcher?.close();
+        browserServer?.close();
+        clearTimeout(rerunTimer);
+        process.off('SIGINT', handleInterrupt);
+        process.off('SIGTERM', handleInterrupt);
+        resolveRun?.(code);
+    };
+    let handleInterrupt = () => cleanupAndExit(latestExitCode);
+    let closeBrowserServer = async () => {
+        if (!browserServer)
+            return;
+        let server = browserServer;
+        await new Promise((resolve, reject) => server.close((error) => (error ? reject(error) : resolve())));
+        browserServer = undefined;
+        browserServerFilesKey = undefined;
+        browserPort = undefined;
+    };
+    let queueRerun = (reason) => {
+        if (!config.watch || hasExited)
+            return;
+        clearTimeout(rerunTimer);
+        rerunTimer = setTimeout(() => {
+            rerunTimer = undefined;
+            if (running) {
+                queued = true;
+            }
+            else {
+                console.log(`\n↻ Change detected (${reason}), re-running tests...\n`);
+                void executeRun();
+            }
+        }, 100);
+    };
+    let executeRun = async () => {
+        if (hasExited)
+            return;
+        running = true;
+        let globalTeardown;
+        try {
+            if (config.setup) {
+                let mod = await importModule(path.resolve(cwd, config.setup), import.meta);
+                let globalSetup = mod.globalSetup;
+                globalTeardown = mod.globalTeardown;
+                await globalSetup?.();
+            }
+            let discoveredTests = await discoverTests(config, cwd);
+            if (discoveredTests == null) {
+                latestExitCode = 1;
+                cleanupAndExit(latestExitCode);
+                return;
+            }
+            let { files, serverFiles, browserFiles, e2eFiles } = discoveredTests;
+            if (config.watch) {
+                watcher ??= createWatcher((file) => queueRerun(file));
+                watcher.update(files);
+            }
+            let browserFilesKey = browserFiles.join('\0');
+            if (browserServer && browserFiles.length === 0) {
+                await closeBrowserServer();
+            }
+            else if (browserFiles.length > 0 &&
+                (!browserServer || browserServerFilesKey !== browserFilesKey)) {
+                await closeBrowserServer();
+                let { startServer } = IS_RUNNING_FROM_SRC
+                    ? await importModule('./app/server.ts', import.meta)
+                    : await import(`./app/server.js`);
+                let result = await startServer(browserFiles);
+                browserServer = result.server;
+                browserServerFilesKey = browserFilesKey;
+                browserPort = result.port;
+            }
+            let playwrightConfig = config.playwrightConfig == null || typeof config.playwrightConfig === 'string'
+                ? await loadPlaywrightConfig(config.playwrightConfig, cwd)
+                : config.playwrightConfig;
+            let reporter = createReporter(config.reporter);
+            let startTime = performance.now();
+            let counts = {
+                passed: 0,
+                failed: 0,
+                skipped: 0,
+                todo: 0,
+            };
+            let allCoverageMaps = [];
+            if (serverFiles.length > 0) {
+                reporter.onSectionStart('\nRunning server tests:');
+                let serverResult = await runServerTests(serverFiles, reporter, config.concurrency, 'server', {
+                    coverage: config.coverage,
+                    cwd,
+                });
+                counts.failed += serverResult.failed;
+                counts.passed += serverResult.passed;
+                counts.skipped += serverResult.skipped;
+                counts.todo += serverResult.todo;
+                allCoverageMaps.push(serverResult.coverageMap);
+            }
+            // Run browser/e2e tests for all browsers configured by the user
+            if (browserFiles.length > 0 || e2eFiles.length > 0) {
+                let projects = resolveProjects(playwrightConfig);
+                if (config.project) {
+                    let projectNames = config.project.split(',').map((project) => project.trim());
+                    projects = projects.filter((project) => project.name && projectNames.includes(project.name));
+                    if (projects.length === 0) {
+                        throw new Error(`No playwright projects found with name(s) "${config.project}"`);
+                    }
+                }
+                let lastBrowserResult = null;
+                for (let project of projects) {
+                    reporter.onSectionStart(`\nRunning tests for project \`${project.name}\`:`);
+                    if (config.browser?.open) {
+                        if (project.playwrightUseOpts?.headless === true) {
+                            let label = project.name ? ` (project "${project.name}")` : '';
+                            console.warn(`Warning: browser.open is set but playwright headless is explicitly true${label} — ignoring browser.open`);
+                        }
+                        else {
+                            project.playwrightUseOpts = { ...project.playwrightUseOpts, headless: false };
+                        }
+                    }
+                    let [browserResult, e2eResult] = await Promise.all([
+                        browserFiles.length > 0
+                            ? runBrowserTests({
+                                baseUrl: `http://localhost:${browserPort}`,
+                                console: config.browser?.echo,
+                                coverage: !!config.coverage,
+                                open: config.browser?.open,
+                                playwrightUseOpts: project.playwrightUseOpts,
+                                projectName: project.name,
+                                reporter,
+                                testFiles: browserFiles,
+                            })
+                            : null,
+                        e2eFiles.length > 0
+                            ? runServerTests(e2eFiles, reporter, config.concurrency, 'e2e', {
+                                open: config.browser?.open,
+                                playwrightUseOpts: project.playwrightUseOpts,
+                                projectName: project.name,
+                                coverage: config.coverage,
+                                cwd,
+                            })
+                            : null,
+                    ]);
+                    counts.passed += (browserResult?.results.passed ?? 0) + (e2eResult?.passed ?? 0);
+                    counts.failed += (browserResult?.results.failed ?? 0) + (e2eResult?.failed ?? 0);
+                    counts.skipped += (browserResult?.results.skipped ?? 0) + (e2eResult?.skipped ?? 0);
+                    counts.todo += (browserResult?.results.todo ?? 0) + (e2eResult?.todo ?? 0);
+                    allCoverageMaps.push(browserResult?.coverageMap);
+                    allCoverageMaps.push(e2eResult?.coverageMap);
+                    if (browserResult) {
+                        lastBrowserResult = browserResult;
+                    }
+                }
+                if (config.browser?.open && lastBrowserResult) {
+                    console.log('\nBrowser is open. Press Ctrl+C to close.');
+                    await Promise.race([
+                        lastBrowserResult.disconnected,
+                        new Promise((resolve) => {
+                            process.once('SIGINT', resolve);
+                            process.once('SIGTERM', resolve);
+                        }),
+                    ]);
+                    await lastBrowserResult.close();
+                }
+            }
+            reporter.onSummary(counts, performance.now() - startTime);
+            let thresholdsPassed = true;
+            if (config.coverage) {
+                thresholdsPassed = await generateCombinedCoverageReport(allCoverageMaps, cwd, config.coverage);
+            }
+            latestExitCode = counts.failed > 0 || !thresholdsPassed ? 1 : 0;
+        }
+        catch (error) {
+            console.error('Error running tests:', error);
+            latestExitCode = 1;
+        }
+        finally {
+            await globalTeardown?.();
+            running = false;
+            if (queued) {
+                queued = false;
+                queueRerun('queued change');
+            }
+            else if (!config.watch) {
+                cleanupAndExit(latestExitCode);
+            }
+        }
+    };
+    process.on('SIGINT', handleInterrupt);
+    process.on('SIGTERM', handleInterrupt);
+    try {
+        await executeRun();
+        if (config.watch && !hasExited) {
+            console.log('Watching for changes. Press Ctrl+C to stop.');
+        }
+    }
+    catch {
+        cleanupAndExit(1);
+    }
+    return await runPromise;
+}
+async function resolveCwd(cwd) {
+    try {
+        return await fsp.realpath(cwd);
+    }
+    catch {
+        return path.resolve(cwd);
+    }
+}
+async function discoverTests(config, cwd) {
+    let files = await findFiles(config.glob.test, config.glob.exclude, cwd);
+    if (files.length === 0) {
+        console.log(`No test files found matching pattern: ${config.glob.test}`);
+        return null;
+    }
+    let browserSet = new Set(await findFiles(config.glob.browser, config.glob.exclude, cwd));
+    let e2eSet = new Set(await findFiles(config.glob.e2e, config.glob.exclude, cwd));
+    let types = new Set(config.type.split(','));
+    let browserFiles = types.has('browser') ? files.filter((f) => browserSet.has(f)) : [];
+    let e2eFiles = types.has('e2e') ? files.filter((file) => e2eSet.has(file)) : [];
+    let serverFiles = types.has('server')
+        ? files.filter((file) => !browserSet.has(file) && !e2eSet.has(file))
+        : [];
+    let totalFiles = browserFiles.length + serverFiles.length + e2eFiles.length;
+    if (totalFiles === 0) {
+        console.log(`No test files remain after filtering for type ${config.type}`);
+        return null;
+    }
+    console.log(`Found ${totalFiles} test file(s) (${serverFiles.length} server, ${browserFiles.length} browser, ${e2eFiles.length} e2e)`);
+    return {
+        files,
+        serverFiles,
+        browserFiles,
+        e2eFiles,
+    };
+}
+async function findFiles(pattern, excludePattern, cwd) {
+    let files = [];
+    if (IS_BUN) {
+        // Bun's `fs.promises.glob` follows symlinks and doesn't prune traversal
+        // via `exclude`, so it enters pnpm symlink cycles in `node_modules`.
+        // Use Bun's native Glob, which defaults to `followSymlinks: false`.
+        // @ts-expect-error — bun module is only resolvable under the Bun runtime
+        let { Glob } = await import('bun');
+        let glob = new Glob(pattern);
+        let excludeGlob = new Glob(excludePattern);
+        for await (let file of glob.scan({ cwd, absolute: true })) {
+            if (!excludeGlob.match(path.relative(cwd, file))) {
+                files.push(file);
+            }
+        }
+        return files;
+    }
+    for await (let file of fsp.glob(pattern, { cwd, exclude: [excludePattern] })) {
+        files.push(path.resolve(cwd, file));
+    }
+    return files;
+}

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+export type { RemixTestConfig } from './lib/config.ts';
+export { describe, it, suite, test, before, after, beforeEach, afterEach, beforeAll, afterAll, } from './lib/framework.ts';
+export { mock } from './lib/mock.ts';
+export type { TestContext } from './lib/context.ts';
+export type { FakeTimers } from './lib/fake-timers.ts';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AACtD,OAAO,EACL,QAAQ,EACR,EAAE,EACF,KAAK,EACL,IAAI,EACJ,MAAM,EACN,KAAK,EACL,UAAU,EACV,SAAS,EACT,SAAS,EACT,QAAQ,GACT,MAAM,oBAAoB,CAAA;AAC3B,OAAO,EAAE,IAAI,EAAE,MAAM,eAAe,CAAA;AACpC,YAAY,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AACnD,YAAY,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA"}

package/dist/index.js

@@ -0,0 +1,2 @@
+export { describe, it, suite, test, before, after, beforeEach, afterEach, beforeAll, afterAll, } from "./lib/framework.js";
+export { mock } from "./lib/mock.js";

package/dist/lib/colors.d.ts

@@ -0,0 +1,2 @@
+export declare const colors: import("@remix-run/terminal").TerminalStyles;
+//# sourceMappingURL=colors.d.ts.map

package/dist/lib/colors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"colors.d.ts","sourceRoot":"","sources":["../../src/lib/colors.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,MAAM,8CAAiB,CAAA"}

package/dist/lib/colors.js

@@ -0,0 +1,2 @@
+import { createStyles } from '@remix-run/terminal';
+export const colors = createStyles();

package/dist/lib/config.d.ts

@@ -0,0 +1,91 @@
+import type { PlaywrightTestConfig } from 'playwright/test';
+export declare const IS_RUNNING_FROM_SRC: boolean;
+export declare function getBrowserTestRootDir(): string;
+export interface RemixTestConfig {
+    /**
+     * Options for controlling the playwright browser
+     *  - `browser.echo`: Echo browser console output to stdout (--browser.echo)
+     *  - `browser.open`: Open browser window and keep open after test finish (--browser.open)
+     */
+    browser?: {
+        echo?: boolean;
+        open?: boolean;
+    };
+    /**
+     * Glob patterns to identify test files
+     *  - `glob.test`: Glob pattern for all test files (--glob.test)
+     *  - `glob.browser`: Glob pattern for the subset of browser test files (--glob.browser)
+     *  - `glob.e2e`: Glob pattern for the subset of e2e test files (--glob.e2e)
+     *  - `glob.exclude`: Glob pattern for paths to exclude from discovery (--glob.exclude)
+     */
+    glob?: {
+        test?: string;
+        browser?: string;
+        e2e?: string;
+        exclude?: string;
+    };
+    /** Max number of concurrent test workers (--concurrency) */
+    concurrency?: number | string;
+    /**
+     * Coverage configuration. `true` enables with defaults; an object enables with settings;
+     * `false` disables. CLI `--coverage` flag overrides the boolean aspect.
+     */
+    coverage?: boolean | {
+        dir?: string;
+        include?: string[];
+        exclude?: string[];
+        statements?: number | string;
+        lines?: number | string;
+        branches?: number | string;
+        functions?: number | string;
+    };
+    /**
+     * Path to a module that exports `globalSetup` and/or `globalTeardown` functions,
+     * called once before and after the test run respectively. (--setup)
+     */
+    setup?: string;
+    /**
+     * Playwright configuration — either a path to a playwright config file or an inline
+     * PlaywrightTestConfig object. CLI `--playwrightConfig` only accepts a file path.
+     */
+    playwrightConfig?: string | PlaywrightTestConfig;
+    /** Filter tests to a specific playwright project or comma-separated list of projects (--project) */
+    project?: string;
+    /** Test reporter (--reporter) */
+    reporter?: string;
+    /** Comma-separated list of test types to run (--type) */
+    type?: string;
+    /** Watch mode — re-run tests on file changes (--watch) */
+    watch?: boolean;
+}
+export interface ResolvedRemixTestConfig {
+    browser: {
+        echo?: boolean;
+        open?: boolean;
+    };
+    concurrency: number;
+    coverage: {
+        dir: string;
+        include?: string[];
+        exclude?: string[];
+        statements?: number;
+        lines?: number;
+        branches?: number;
+        functions?: number;
+    } | undefined;
+    glob: {
+        test: string;
+        browser: string;
+        e2e: string;
+        exclude: string;
+    };
+    playwrightConfig: string | PlaywrightTestConfig | undefined;
+    project: string | undefined;
+    reporter: string;
+    setup: string | undefined;
+    type: string;
+    watch: boolean;
+}
+export declare function loadConfig(args?: string[], cwd?: string): Promise<ResolvedRemixTestConfig>;
+export declare function getRemixTestHelpText(_target?: NodeJS.WriteStream): string;
+//# sourceMappingURL=config.d.ts.map

package/dist/lib/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/lib/config.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAA;AAG3D,eAAO,MAAM,mBAAmB,SAA4D,CAAA;AAa5F,wBAAgB,qBAAqB,IAAI,MAAM,CAS9C;AAqID,MAAM,WAAW,eAAe;IAC9B;;;;OAIG;IACH,OAAO,CAAC,EAAE;QACR,IAAI,CAAC,EAAE,OAAO,CAAA;QACd,IAAI,CAAC,EAAE,OAAO,CAAA;KACf,CAAA;IACD;;;;;;OAMG;IACH,IAAI,CAAC,EAAE;QACL,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,OAAO,CAAC,EAAE,MAAM,CAAA;QAChB,GAAG,CAAC,EAAE,MAAM,CAAA;QACZ,OAAO,CAAC,EAAE,MAAM,CAAA;KACjB,CAAA;IACD,4DAA4D;IAC5D,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IAC7B;;;OAGG;IACH,QAAQ,CAAC,EACL,OAAO,GACP;QACE,GAAG,CAAC,EAAE,MAAM,CAAA;QACZ,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;QAClB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;QAClB,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;QAC5B,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;QACvB,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;QAC1B,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;KAC5B,CAAA;IACL;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,oBAAoB,CAAA;IAChD,oGAAoG;IACpG,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,iCAAiC;IACjC,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,yDAAyD;IACzD,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,4DAA0D;IAC1D,KAAK,CAAC,EAAE,OAAO,CAAA;CAChB;AAED,MAAM,WAAW,uBAAuB;IACtC,OAAO,EAAE;QACP,IAAI,CAAC,EAAE,OAAO,CAAA;QACd,IAAI,CAAC,EAAE,OAAO,CAAA;KACf,CAAA;IACD,WAAW,EAAE,MAAM,CAAA;IACnB,QAAQ,EACJ;QACE,GAAG,EAAE,MAAM,CAAA;QACX,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;QAClB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;QAClB,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,KAAK,CAAC,EAAE,MAAM,CAAA;QACd,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,SAAS,CAAC,EAAE,MAAM,CAAA;KACnB,GACD,SAAS,CAAA;IACb,IAAI,EAAE;QACJ,IAAI,EAAE,MAAM,CAAA;QACZ,OAAO,EAAE,MAAM,CAAA;QACf,GAAG,EAAE,MAAM,CAAA;QACX,OAAO,EAAE,MAAM,CAAA;KAChB,CAAA;IACD,gBAAgB,EAAE,MAAM,GAAG,oBAAoB,GAAG,SAAS,CAAA;IAC3D,OAAO,EAAE,MAAM,GAAG,SAAS,CAAA;IAC3B,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,MAAM,GAAG,SAAS,CAAA;IACzB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,OAAO,CAAA;CACf;AAED,wBAAsB,UAAU,CAAC,IAAI,GAAE,MAAM,EAA0B,EAAE,GAAG,SAAgB,oCAK3F;AAED,wBAAgB,oBAAoB,CAAC,OAAO,GAAE,MAAM,CAAC,WAA4B,GAAG,MAAM,CAmBzF"}