test/WebpackCli.longtest.js - main - githubmirror/webpack

test/WebpackCli.longtest.js
273 строки9 KB
Alexander Akait
test: run WebpackCli suite under Bun instead of skipping (#21334)
04 июл 2026, 23:59
04 июл 2026, 23:59413b0be
"use strict";

const fs = require("fs");
const os = require("os");
const path = require("path");

const MOCK_WEBPACK = path.resolve(
	__dirname,
	"fixtures/webpack-cli/mock-webpack.js"
);

// webpack-cli requires a newer Node than webpack itself, so skip on Node versions
// it does not support (derived from webpack-cli's own `engines` field).
const [reqMajor, reqMinor = 0, reqPatch = 0] = /** @type {RegExpMatchArray} */ (
	require("webpack-cli/package.json").engines.node.match(/\d+(?:\.\d+)*/)
)[0]
	.split(".")
	.map(Number);

const [major, minor, patch] = process.versions.node.split(".").map(Number);
const supportsWebpackCli =
	major !== reqMajor
		? major > reqMajor
		: minor !== reqMinor
			? minor > reqMinor
			: patch >= reqPatch;

// Shape captured by mock-webpack: the mock schema's synthetic flags plus the
// `name`/`mode` the defineConfig fixtures set. `pattern` is a RegExp serialized
// to a plain marker by the JSON round-trip.
/**
 * @typedef {object} CapturedConfig
 * @property {string=} name
 * @property {string=} mode
 * @property {boolean=} flag
 * @property {number=} count
 * @property {string=} output
 * @property {{ source: string, flags: string }=} pattern
 * @property {("info" | "warn")=} level
 * @property {string[]=} list
 * @property {boolean=} boolConst
 * @property {number=} numConst
 * @property {string=} whenProd
 * @property {boolean=} whenDev
 */

// Runs webpack-cli in-process against a mock webpack module injected via the
// documented WEBPACK_PACKAGE env var (webpack-cli loads webpack through a native
// import jest.mock cannot intercept). process.exit/console.error are spied so a
// validation failure surfaces as an exit code plus the captured messages.
/**
 * @param {string[]} args args
 * @returns {Promise<{ config: CapturedConfig, exitCode: number, errors: string }>} result
 */
const run = async (args) => {
	const dir = fs.mkdtempSync(path.join(os.tmpdir(), "wp-cli-"));
	const capture = path.join(dir, "config.json");
	process.env.WEBPACK_PACKAGE = MOCK_WEBPACK;
	process.env.WEBPACK_CLI_TEST_CAPTURE = capture;
	jest.resetModules();

	/** @type {EXPECTED_ANY} */
	const WebpackCLI = require("webpack-cli").default;

	const exitSpy = jest.spyOn(process, "exit").mockImplementation((code) => {
		throw new Error(`__exit__ ${code}`);
	});
	/** @type {string[]} */
	const errors = [];
	const errorSpy = jest
		.spyOn(console, "error")
		.mockImplementation((message) => errors.push(`${message}`));
	let exitCode = 0;
	try {
		await new WebpackCLI().run(["node", "webpack", "build", ...args]);
	} catch (error) {
		const match = /__exit__ (\d+)/.exec(/** @type {Error} */ (error).message);
		if (!match) throw error;
		exitCode = Number(match[1]);
	} finally {
		exitSpy.mockRestore();
		errorSpy.mockRestore();
		delete process.env.WEBPACK_PACKAGE;
		delete process.env.WEBPACK_CLI_TEST_CAPTURE;
	}
	const config = fs.existsSync(capture)
		? JSON.parse(fs.readFileSync(capture, "utf8"))
		: undefined;
	fs.rmSync(dir, { recursive: true, force: true });
	return { config, exitCode, errors: errors.join("\n") };
};

describe("WebpackCLI integration", () => {
	// webpack-cli requires a newer Node than webpack itself; skip on older versions.
	if (!supportsWebpackCli) {
		// eslint-disable-next-line jest/no-disabled-tests
		it.skip("requires a Node version supported by webpack-cli", () => {});

		return;
	}

	it("parses every cli argument type into the webpack config", async () => {
		const { config } = await run([
			"--flag",
			"--count",
			"42",
			"--name",
			"hello",
			"--output",
			"rel/p",
			"--pattern",
			"/ab?c/i",
			"--level",
			"warn",
			"--list",
			"a",
			"--list",
			"b",
			"--mode",
			"production"
		]);
		expect(config.flag).toBe(true); // boolean
		expect(config.count).toBe(42); // number
		expect(config.name).toBe("hello"); // string
		expect(config.output).toBe(path.resolve("rel/p")); // path
		expect(config.pattern).toEqual({ source: "ab?c", flags: "i" }); // RegExp
		expect(config.level).toBe("warn"); // enum
		expect(config.list).toEqual(["a", "b"]); // array (multiple)
		expect(config.mode).toBe("production"); // const
	});

	it("resets an array via the reset flag", async () => {
		const { config } = await run(["--list-reset"]);
		expect(config.list).toEqual([]);
	});

	it("collects multiple values for a multiple flag", async () => {
		const { config } = await run(["--list", "a", "--list", "b", "--list", "c"]);
		expect(config.list).toEqual(["a", "b", "c"]);
	});

	it("negates a boolean flag via --no-flag", async () => {
		const { config } = await run(["--no-flag"]);
		expect(config.flag).toBe(false);
	});

	it("accepts the other allowed enum value", async () => {
		const { config } = await run(["--level", "info"]);
		expect(config.level).toBe("info");
	});

	it("treats a boolean `const` as a boolean flag", async () => {
		const { config } = await run(["--bool-const"]);
		expect(config.boolConst).toBe(true);
	});

	it("accepts a numeric `const` and rejects other numbers", async () => {
		const ok = await run(["--num-const", "5"]);
		expect(ok.config.numConst).toBe(5);

		const bad = await run(["--num-const", "6"]);
		expect(bad.exitCode).toBe(2);
		expect(bad.errors).toMatch(
			/Invalid value '6' for the '--num-const' option/
		);
		expect(bad.errors).toMatch(/Expected: '5'/);
	});

	it("registers flags from both branches of an if/then/else schema", async () => {
		const { config } = await run(["--when-prod", "hello", "--when-dev"]);
		expect(config.whenProd).toBe("hello"); // from `then`
		expect(config.whenDev).toBe(true); // from `else`
	});

	it("rejects an enum value outside the allowed set", async () => {
		const { exitCode, errors } = await run(["--level", "nope"]);
		expect(exitCode).toBe(2);
		expect(errors).toMatch(/Invalid value 'nope' for the '--level' option/);
		expect(errors).toMatch(/Expected: 'info \| warn'/);
	});

	it("rejects a value other than the `const`", async () => {
		const { exitCode, errors } = await run(["--mode", "development"]);
		expect(exitCode).toBe(2);
		expect(errors).toMatch(
			/Invalid value 'development' for the '--mode' option/
		);
		expect(errors).toMatch(/Expected: 'production'/);
	});

	// `webpack.defineConfig` is a runtime identity; the user config requires the
	// real webpack while the CLI builds against the mock, so the capture proves
	// every config shape is loaded and resolved end-to-end through webpack-cli.
	const CONFIG = path.resolve(__dirname, "fixtures/webpack-cli/define-config");

	/**
	 * @param {string} file fixture file name in the define-config directory
	 * @param {string[]=} args extra cli args prepended before --config
	 * @returns {Promise<CapturedConfig>} the single resolved config
	 */
	const loadConfig = async (file, args = []) =>
		(await run([...args, "--config", path.join(CONFIG, file)])).config;

	/**
	 * @param {string} file fixture file name in the define-config directory
	 * @param {string[]=} args extra cli args prepended before --config
	 * @returns {Promise<CapturedConfig[]>} the resolved multi-compiler config
	 */
	const loadMultiConfig = async (file, args) =>
		/** @type {CapturedConfig[]} */ (
			/** @type {unknown} */ (await loadConfig(file, args))
		);

	it("loads a defineConfig object configuration", async () => {
		const config = await loadConfig("object.js");
		expect(config.name).toBe("object");
	});

	it("loads a defineConfig multi-compiler configuration", async () => {
		const config = await loadMultiConfig("multi.js");
		expect(config.map((c) => c.name)).toEqual(["first", "second"]);
	});

	it("loads a defineConfig function configuration", async () => {
		const config = await loadConfig("function.js");
		expect(config.name).toBe("function");
	});

	it("loads a defineConfig function returning an array", async () => {
		const config = await loadMultiConfig("function-multi.js");
		expect(config.map((c) => c.name)).toEqual(["first", "second"]);
	});

	it("loads a defineConfig async function configuration", async () => {
		const config = await loadConfig("async-function.js");
		expect(config.name).toBe("async-function");
	});

	it("loads a defineConfig array of functions configuration", async () => {
		const config = await loadMultiConfig("array-functions.js");
		expect(config.map((c) => c.name)).toEqual(["first", "second"]);
	});

	it("loads a defineConfig promise configuration", async () => {
		const config = await loadConfig("promise.js");
		expect(config.name).toBe("promise");
	});

	it("loads a defineConfig promise returning an array", async () => {
		const config = await loadMultiConfig("promise-multi.js");
		expect(config.map((c) => c.name)).toEqual(["first", "second"]);
	});

	it("threads --env and argv into a defineConfig function", async () => {
		const config = await loadConfig("env-args.js", [
			"--env",
			"name=demo",
			"--mode",
			"production"
		]);
		expect(config.name).toBe("demo:production");
	});

	it("threads --env into a defineConfig function returning an array", async () => {
		const config = await loadMultiConfig("env-args-multi.js", [
			"--env",
			"first=a",
			"--env",
			"second=b"
		]);
		expect(config.map((c) => c.name)).toEqual(["a", "b"]);
	});
});