@rspack/test-tools 1.5.5 → 1.5.7

package/dist/processor/error.js

@@ -1,95 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ErrorProcessor = void 0;
-const node_path_1 = __importDefault(require("node:path"));
-const webpack_merge_1 = __importDefault(require("webpack-merge"));
-const simple_1 = require("./simple");
-class RspackStatsDiagnostics {
-    constructor(errors, warnings) {
-        this.errors = errors;
-        this.warnings = warnings;
-    }
-}
-class ErrorProcessor extends simple_1.SimpleTaskProcessor {
-    constructor(_errorOptions) {
-        super({
-            options: (context) => {
-                let options = {
-                    context: node_path_1.default.resolve(__dirname, "../../../../tests/rspack-test/fixtures/errors"),
-                    mode: "none",
-                    devtool: false,
-                    optimization: {
-                        minimize: false,
-                        moduleIds: "named",
-                        chunkIds: "named"
-                    },
-                    experiments: {
-                        css: true,
-                        rspackFuture: {
-                            bundlerInfo: {
-                                force: false
-                            }
-                        }
-                    }
-                };
-                if (typeof _errorOptions.options === "function") {
-                    options = (0, webpack_merge_1.default)(options, _errorOptions.options(options, context));
-                }
-                if (options.mode === "production") {
-                    if (options.optimization)
-                        options.optimization.minimize = true;
-                    else
-                        options.optimization = { minimize: true };
-                }
-                return options;
-            },
-            build: _errorOptions.build,
-            compilerType: _errorOptions.compilerType,
-            name: _errorOptions.name
-        });
-        this._errorOptions = _errorOptions;
-    }
-    async compiler(context) {
-        await super.compiler(context);
-        const compiler = this.getCompiler(context).getCompiler();
-        if (compiler) {
-            compiler.outputFileSystem = {
-                // CHANGE: rspack outputFileSystem `mkdirp` uses option `{ recursive: true }`, webpack's second parameter is alway a callback
-                mkdir(dir, maybeOptionOrCallback, maybeCallback) {
-                    if (typeof maybeOptionOrCallback === "function") {
-                        maybeOptionOrCallback();
-                    }
-                    else if (typeof maybeCallback === "function") {
-                        maybeCallback();
-                    }
-                },
-                writeFile(file, content, callback) {
-                    callback();
-                },
-                stat(file, callback) {
-                    callback(new Error("ENOENT"));
-                },
-                mkdirSync() { },
-                writeFileSync() { }
-            };
-        }
-    }
-    async run(env, context) {
-        // do nothing
-    }
-    async check(env, context) {
-        const compiler = this.getCompiler(context);
-        const stats = compiler.getStats();
-        env.expect(typeof stats).toBe("object");
-        const statsResult = stats.toJson({ errorDetails: false });
-        env.expect(typeof statsResult).toBe("object");
-        const { errors, warnings } = statsResult;
-        env.expect(Array.isArray(errors)).toBe(true);
-        env.expect(Array.isArray(warnings)).toBe(true);
-        await this._errorOptions.check?.(new RspackStatsDiagnostics(errors, warnings));
-    }
-}
-exports.ErrorProcessor = ErrorProcessor;

package/dist/processor/hash.d.ts

@@ -1,10 +0,0 @@
-import type { ECompilerType, ITestContext, ITestEnv, TCompilerOptions } from "../type";
-import { type IMultiTaskProcessorOptions, MultiTaskProcessor } from "./multi";
-export interface IHashProcessorOptions<T extends ECompilerType> extends Omit<IMultiTaskProcessorOptions<T>, "runable"> {
-}
-export declare class HashProcessor<T extends ECompilerType> extends MultiTaskProcessor<T> {
-    constructor(_hashOptions: IHashProcessorOptions<T>);
-    check(env: ITestEnv, context: ITestContext): Promise<void>;
-    static defaultOptions<T extends ECompilerType>(index: number, context: ITestContext): TCompilerOptions<T>;
-    static overrideOptions<T extends ECompilerType>(index: number, context: ITestContext, options: TCompilerOptions<T>): void;
-}

package/dist/processor/hash.js

@@ -1,63 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.HashProcessor = void 0;
-const multi_1 = require("./multi");
-const REG_ERROR_CASE = /error$/;
-class HashProcessor extends multi_1.MultiTaskProcessor {
-    constructor(_hashOptions) {
-        super({
-            defaultOptions: (HashProcessor.defaultOptions),
-            overrideOptions: (HashProcessor.overrideOptions),
-            runable: false,
-            ..._hashOptions
-        });
-    }
-    async check(env, context) {
-        const compiler = this.getCompiler(context);
-        const testConfig = context.getTestConfig();
-        const stats = compiler.getStats();
-        if (!stats) {
-            env.expect(false);
-            return;
-        }
-        if (REG_ERROR_CASE.test(this._options.name)) {
-            env.expect(stats.hasErrors());
-        }
-        else {
-            env.expect(!stats.hasErrors());
-        }
-        if (typeof testConfig.validate === "function") {
-            testConfig.validate(stats);
-        }
-        else {
-            throw new Error("HashTestCases should have test.config.js and a validate method");
-        }
-    }
-    static defaultOptions(index, context) {
-        return {
-            context: context.getSource(),
-            output: {
-                path: context.getDist()
-            },
-            experiments: {
-                css: true,
-                rspackFuture: {
-                    bundlerInfo: {
-                        force: false
-                    }
-                }
-            }
-        };
-    }
-    static overrideOptions(index, context, options) {
-        if (!options.entry) {
-            options.entry = "./index.js";
-        }
-        if (!global.printLogger) {
-            options.infrastructureLogging = {
-                level: "error"
-            };
-        }
-    }
-}
-exports.HashProcessor = HashProcessor;

package/dist/processor/hook.d.ts

@@ -1,44 +0,0 @@
-import { TestContext, type TTestContextOptions } from "../test/context";
-import type { ECompilerType, ITestContext, ITestEnv, TCompiler, TCompilerOptions } from "../type";
-import { type ISnapshotProcessorOptions, SnapshotProcessor } from "./snapshot";
-export declare class HookCasesContext extends TestContext {
-    protected src: string;
-    protected testName: string;
-    protected options: TTestContextOptions;
-    protected promises: Promise<void>[];
-    protected count: number;
-    protected snapshots: Record<string | number, Array<[string | Buffer, string]>>;
-    protected snapshotsList: Array<string | number>;
-    constructor(src: string, testName: string, options: TTestContextOptions);
-    /**
-     * Snapshot function arguments and return value.
-     * Generated snapshot is located in the same directory with the test source.
-     * @example
-     * compiler.hooks.compilation("name", context.snapped((...args) => { ... }))
-     */
-    snapped(cb: (...args: unknown[]) => Promise<unknown>, prefix?: string): (this: any, ...args: unknown[]) => Promise<unknown>;
-    /**
-     * @internal
-     */
-    _addSnapshot(content: unknown, name: string, group: string | number): void;
-    /**
-     * @internal
-     */
-    collectSnapshots(env: ITestEnv, options?: {
-        diff: {};
-    }): Promise<void>;
-}
-export interface IHookProcessorOptions<T extends ECompilerType> extends ISnapshotProcessorOptions<T> {
-    options?: (context: ITestContext) => TCompilerOptions<T>;
-    compiler?: (context: ITestContext, compiler: TCompiler<T>) => Promise<void>;
-    check?: (context: ITestContext) => Promise<void>;
-}
-export declare class HookTaskProcessor<T extends ECompilerType> extends SnapshotProcessor<T> {
-    protected _hookOptions: IHookProcessorOptions<T>;
-    constructor(_hookOptions: IHookProcessorOptions<T>);
-    config(context: ITestContext): Promise<void>;
-    compiler(context: ITestContext): Promise<void>;
-    check(env: ITestEnv, context: HookCasesContext): Promise<void>;
-    static defaultOptions<T extends ECompilerType>(context: ITestContext): TCompilerOptions<T>;
-    static overrideOptions<T extends ECompilerType>(options: TCompilerOptions<T>): void;
-}

package/dist/processor/hook.js

@@ -1,204 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.HookTaskProcessor = exports.HookCasesContext = void 0;
-const node_path_1 = __importDefault(require("node:path"));
-const core_1 = require("@rspack/core");
-const jest_snapshot_1 = require("jest-snapshot");
-const path_serializer_1 = require("path-serializer");
-const pretty_format_1 = require("pretty-format");
-const context_1 = require("../test/context");
-const snapshot_1 = require("./snapshot");
-const srcDir = node_path_1.default.resolve(__dirname, "../../../../tests/rspack-test/fixtures");
-const distDir = node_path_1.default.resolve(__dirname, "../../../../tests/rspack-test/js/hook");
-const sourceSerializer = {
-    test(val) {
-        return val instanceof core_1.sources.Source;
-    },
-    print(val) {
-        return val.source();
-    }
-};
-const internalSerializer = {
-    test(val) {
-        return val instanceof core_1.Compiler || val instanceof core_1.Compilation;
-    },
-    print(val) {
-        return JSON.stringify(`${val.constructor.name}(internal ignored)`);
-    }
-};
-const testPathSerializer = (0, path_serializer_1.createSnapshotSerializer)({
-    replace: [
-        {
-            match: srcDir,
-            mark: "<HOOK_SRC_DIR>"
-        },
-        {
-            match: distDir,
-            mark: "<HOOK_DIST_DIR>"
-        }
-    ]
-});
-const escapeRegex = true;
-const printFunctionName = false;
-const normalizeNewlines = (str) => str.replace(/\r\n|\r/g, "\n");
-const serialize = (val, indent = 2, formatOverrides = {}) => normalizeNewlines((0, pretty_format_1.format)(val, {
-    escapeRegex,
-    indent,
-    plugins: [
-        ...(0, jest_snapshot_1.getSerializers)(),
-        sourceSerializer,
-        internalSerializer,
-        testPathSerializer
-    ],
-    printFunctionName,
-    ...formatOverrides
-}));
-class HookCasesContext extends context_1.TestContext {
-    constructor(src, testName, options) {
-        super(options);
-        this.src = src;
-        this.testName = testName;
-        this.options = options;
-        this.promises = [];
-        this.count = 0;
-        this.snapshots = {};
-        this.snapshotsList = [];
-        this.snapped = this.snapped.bind(this);
-    }
-    /**
-     * Snapshot function arguments and return value.
-     * Generated snapshot is located in the same directory with the test source.
-     * @example
-     * compiler.hooks.compilation("name", context.snapped((...args) => { ... }))
-     */
-    snapped(cb, prefix = "") {
-        // eslint-disable-next-line
-        const context = this;
-        return function SNAPPED_HOOK(...args) {
-            const group = prefix ? prefix : context.count++;
-            context._addSnapshot(args, "input", group);
-            const output = cb.apply(this, args);
-            if (output && typeof output.then === "function") {
-                let resolve;
-                context.promises.push(new Promise(r => (resolve = r)));
-                return output
-                    .then((o) => {
-                    context._addSnapshot(o, "output (Promise resolved)", group);
-                    return o;
-                })
-                    .catch((o) => {
-                    context._addSnapshot(o, "output (Promise rejected)", group);
-                    return o;
-                })
-                    .finally(resolve);
-            }
-            context._addSnapshot(output, "output", group);
-            return output;
-        };
-    }
-    /**
-     * @internal
-     */
-    _addSnapshot(content, name, group) {
-        const normalizedContent = Buffer.isBuffer(content)
-            ? content
-            : serialize(content, undefined, {
-                escapeString: true,
-                printBasicPrototype: true
-            }).replace(/\r\n/g, "\n");
-        (this.snapshots[group] = this.snapshots[group] || []).push([
-            normalizedContent,
-            name
-        ]);
-        if (!this.snapshotsList.includes(group)) {
-            this.snapshotsList.push(group);
-        }
-    }
-    /**
-     * @internal
-     */
-    async collectSnapshots(env, options = {
-        diff: {}
-    }) {
-        await Promise.allSettled(this.promises);
-        if (!this.snapshotsList.length)
-            return;
-        const snapshots = this.snapshotsList.reduce((acc, group, index) => {
-            const block = this.snapshots[group || index].reduce((acc, [content, name]) => {
-                name = `## ${name || `test: ${index}`}\n\n`;
-                const block = `\`\`\`javascript\n${content}\n\`\`\`\n`;
-                return `${acc}${name + block}\n`;
-            }, "");
-            return `${acc}# ${Number.isInteger(group) ? `Group: ${index}` : group}\n\n${block}`;
-        }, "");
-        env
-            .expect(snapshots)
-            .toMatchFileSnapshot(node_path_1.default.join(this.src, "hooks.snap.txt"), options);
-    }
-}
-exports.HookCasesContext = HookCasesContext;
-class HookTaskProcessor extends snapshot_1.SnapshotProcessor {
-    constructor(_hookOptions) {
-        super({
-            defaultOptions: (HookTaskProcessor.defaultOptions),
-            ..._hookOptions
-        });
-        this._hookOptions = _hookOptions;
-    }
-    async config(context) {
-        await super.config(context);
-        const compiler = this.getCompiler(context);
-        if (typeof this._hookOptions.options === "function") {
-            compiler.mergeOptions(this._hookOptions.options(context));
-        }
-    }
-    async compiler(context) {
-        await super.compiler(context);
-        if (typeof this._hookOptions.compiler === "function") {
-            const compiler = this.getCompiler(context);
-            await this._hookOptions.compiler(context, compiler.getCompiler());
-        }
-    }
-    async check(env, context) {
-        await context.collectSnapshots(env);
-        await super.check(env, context);
-        if (typeof this._hookOptions.check === "function") {
-            await this._hookOptions.check(context);
-        }
-    }
-    static defaultOptions(context) {
-        return {
-            context: context.getSource(),
-            mode: "production",
-            target: "async-node",
-            devtool: false,
-            cache: false,
-            entry: "./hook",
-            output: {
-                path: context.getDist()
-            },
-            optimization: {
-                minimize: false
-            },
-            experiments: {
-                css: true,
-                rspackFuture: {
-                    bundlerInfo: {
-                        force: false
-                    }
-                }
-            }
-        };
-    }
-    static overrideOptions(options) {
-        if (!global.printLogger) {
-            options.infrastructureLogging = {
-                level: "error"
-            };
-        }
-    }
-}
-exports.HookTaskProcessor = HookTaskProcessor;

package/dist/processor/hot-incremental.d.ts

@@ -1,14 +0,0 @@
-import { ECompilerType, type ITestContext, type ITestEnv, type TCompilerOptions } from "../type";
-import type { IBasicProcessorOptions } from "./basic";
-import { HotProcessor } from "./hot";
-export interface IHotIncrementalProcessorOptions<T extends ECompilerType> extends Omit<IBasicProcessorOptions<T>, "runable"> {
-    target: TCompilerOptions<T>["target"];
-    webpackCases: boolean;
-}
-export declare class HotIncrementalProcessor<T extends ECompilerType> extends HotProcessor<T> {
-    protected _hotOptions: IHotIncrementalProcessorOptions<T>;
-    constructor(_hotOptions: IHotIncrementalProcessorOptions<T>);
-    run(env: ITestEnv, context: ITestContext): Promise<void>;
-    afterAll(context: ITestContext): Promise<void>;
-    static defaultOptions<T extends ECompilerType>(this: HotIncrementalProcessor<T>, context: ITestContext): TCompilerOptions<T>;
-}

package/dist/processor/hot-incremental.js

@@ -1,43 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.HotIncrementalProcessor = void 0;
-const type_1 = require("../type");
-const hot_1 = require("./hot");
-class HotIncrementalProcessor extends hot_1.HotProcessor {
-    constructor(_hotOptions) {
-        super({
-            defaultOptions: HotIncrementalProcessor.defaultOptions,
-            ..._hotOptions
-        });
-        this._hotOptions = _hotOptions;
-    }
-    async run(env, context) {
-        context.setValue(this._options.name, "documentType", this._hotOptions.webpackCases ? type_1.EDocumentType.Fake : type_1.EDocumentType.JSDOM);
-        await super.run(env, context);
-    }
-    async afterAll(context) {
-        try {
-            await super.afterAll(context);
-        }
-        catch (e) {
-            const isFake = context.getValue(this._options.name, "documentType") ===
-                type_1.EDocumentType.Fake;
-            if (isFake && /Should run all hot steps/.test(e.message))
-                return;
-            throw e;
-        }
-    }
-    static defaultOptions(context) {
-        const options = super.defaultOptions(context);
-        if (this._hotOptions.compilerType === type_1.ECompilerType.Rspack) {
-            const rspackOptions = options;
-            rspackOptions.experiments ??= {};
-            rspackOptions.experiments.incremental ??= "advance-silent";
-        }
-        else {
-            throw new Error("HotIncrementalProcessor should only used for Rspack.");
-        }
-        return options;
-    }
-}
-exports.HotIncrementalProcessor = HotIncrementalProcessor;

package/dist/processor/hot-step.d.ts

@@ -1,18 +0,0 @@
-import type { THotStepRuntimeData } from "../runner";
-import type { ECompilerType, ITestContext, ITestEnv, TCompilerOptions, TCompilerStatsCompilation } from "../type";
-import { HotProcessor, type IHotProcessorOptions } from "./hot";
-type TModuleGetHandler = (file: string, options: TCompilerOptions<ECompilerType>) => string[];
-export interface IHotSnapshotProcessorOptions<T extends ECompilerType> extends IHotProcessorOptions<T> {
-    getModuleHandler?: TModuleGetHandler;
-    snapshot?: string;
-}
-export declare class HotSnapshotProcessor<T extends ECompilerType> extends HotProcessor<T> {
-    protected _hotOptions: IHotSnapshotProcessorOptions<T>;
-    private hashes;
-    private entries;
-    constructor(_hotOptions: IHotSnapshotProcessorOptions<T>);
-    run(env: ITestEnv, context: ITestContext): Promise<void>;
-    check(env: ITestEnv, context: ITestContext): Promise<void>;
-    protected matchStepSnapshot(env: ITestEnv, context: ITestContext, step: number, stats: TCompilerStatsCompilation<T>, runtime?: THotStepRuntimeData): void;
-}
-export {};