| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344 |
- "use strict";
- var __create = Object.create;
- var __defProp = Object.defineProperty;
- var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
- var __getOwnPropNames = Object.getOwnPropertyNames;
- var __getProtoOf = Object.getPrototypeOf;
- var __hasOwnProp = Object.prototype.hasOwnProperty;
- var __export = (target, all) => {
- for (var name in all)
- __defProp(target, name, { get: all[name], enumerable: true });
- };
- var __copyProps = (to, from, except, desc) => {
- if (from && typeof from === "object" || typeof from === "function") {
- for (let key of __getOwnPropNames(from))
- if (!__hasOwnProp.call(to, key) && key !== except)
- __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
- }
- return to;
- };
- var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
- // If the importer is in node compatibility mode or this is not an ESM
- // file that has been converted to a CommonJS file using a Babel-
- // compatible transform (i.e. "__esModule" has not been set), then set
- // "default" to the CommonJS "module.exports" for node compatibility.
- isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
- mod
- ));
- var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
- var program_exports = {};
- __export(program_exports, {
- program: () => import_program2.program
- });
- module.exports = __toCommonJS(program_exports);
- var import_fs = __toESM(require("fs"));
- var import_path = __toESM(require("path"));
- var import_program = require("playwright-core/lib/cli/program");
- var import_utils = require("playwright-core/lib/utils");
- var import_config = require("./common/config");
- var import_configLoader = require("./common/configLoader");
- var import_program2 = require("playwright-core/lib/cli/program");
- var import_base = require("./reporters/base");
- var import_html = require("./reporters/html");
- var import_merge = require("./reporters/merge");
- var import_projectUtils = require("./runner/projectUtils");
- var testServer = __toESM(require("./runner/testServer"));
- var import_watchMode = require("./runner/watchMode");
- var import_testRunner = require("./runner/testRunner");
- var import_reporters = require("./runner/reporters");
- function addTestCommand(program3) {
- const command = program3.command("test [test-filter...]");
- command.description("run tests with Playwright Test");
- const options = testOptions.sort((a, b) => a[0].replace(/-/g, "").localeCompare(b[0].replace(/-/g, "")));
- options.forEach(([name, { description, choices, preset }]) => {
- const option = command.createOption(name, description);
- if (choices)
- option.choices(choices);
- if (preset)
- option.preset(preset);
- command.addOption(option);
- return command;
- });
- command.action(async (args, opts) => {
- try {
- await runTests(args, opts);
- } catch (e) {
- console.error(e);
- (0, import_utils.gracefullyProcessExitDoNotHang)(1);
- }
- });
- command.addHelpText("afterAll", `
- Arguments [test-filter...]:
- Pass arguments to filter test files. Each argument is treated as a regular expression. Matching is performed against the absolute file paths.
- Examples:
- $ npx playwright test my.spec.ts
- $ npx playwright test some.spec.ts:42
- $ npx playwright test --headed
- $ npx playwright test --project=webkit`);
- }
- function addClearCacheCommand(program3) {
- const command = program3.command("clear-cache");
- command.description("clears build and test caches");
- command.option("-c, --config <file>", `Configuration file, or a test directory with optional "playwright.config.{m,c}?{js,ts}"`);
- command.action(async (opts) => {
- const runner = new import_testRunner.TestRunner((0, import_configLoader.resolveConfigLocation)(opts.config), {});
- const { status } = await runner.clearCache((0, import_reporters.createErrorCollectingReporter)(import_base.terminalScreen));
- const exitCode = status === "interrupted" ? 130 : status === "passed" ? 0 : 1;
- (0, import_utils.gracefullyProcessExitDoNotHang)(exitCode);
- });
- }
- function addDevServerCommand(program3) {
- const command = program3.command("dev-server", { hidden: true });
- command.description("start dev server");
- command.option("-c, --config <file>", `Configuration file, or a test directory with optional "playwright.config.{m,c}?{js,ts}"`);
- command.action(async (options) => {
- const runner = new import_testRunner.TestRunner((0, import_configLoader.resolveConfigLocation)(options.config), {});
- await runner.startDevServer((0, import_reporters.createErrorCollectingReporter)(import_base.terminalScreen), "in-process");
- });
- }
- function addTestServerCommand(program3) {
- const command = program3.command("test-server", { hidden: true });
- command.description("start test server");
- command.option("-c, --config <file>", `Configuration file, or a test directory with optional "playwright.config.{m,c}?{js,ts}"`);
- command.option("--host <host>", "Host to start the server on", "localhost");
- command.option("--port <port>", "Port to start the server on", "0");
- command.action((opts) => runTestServer(opts));
- }
- function addShowReportCommand(program3) {
- const command = program3.command("show-report [report]");
- command.description("show HTML report");
- command.action((report, options) => (0, import_html.showHTMLReport)(report, options.host, +options.port));
- command.option("--host <host>", "Host to serve report on", "localhost");
- command.option("--port <port>", "Port to serve report on", "9323");
- command.addHelpText("afterAll", `
- Arguments [report]:
- When specified, opens given report, otherwise opens last generated report.
- Examples:
- $ npx playwright show-report
- $ npx playwright show-report playwright-report`);
- }
- function addMergeReportsCommand(program3) {
- const command = program3.command("merge-reports [dir]");
- command.description("merge multiple blob reports (for sharded tests) into a single report");
- command.action(async (dir, options) => {
- try {
- await mergeReports(dir, options);
- } catch (e) {
- console.error(e);
- (0, import_utils.gracefullyProcessExitDoNotHang)(1);
- }
- });
- command.option("-c, --config <file>", `Configuration file. Can be used to specify additional configuration for the output report.`);
- command.option("--reporter <reporter>", `Reporter to use, comma-separated, can be ${import_config.builtInReporters.map((name) => `"${name}"`).join(", ")} (default: "${import_config.defaultReporter}")`);
- command.addHelpText("afterAll", `
- Arguments [dir]:
- Directory containing blob reports.
- Examples:
- $ npx playwright merge-reports playwright-report`);
- }
- async function runTests(args, opts) {
- await (0, import_utils.startProfiling)();
- const cliOverrides = overridesFromOptions(opts);
- const config = await (0, import_configLoader.loadConfigFromFile)(opts.config, cliOverrides, opts.deps === false);
- config.cliArgs = args;
- config.cliGrep = opts.grep;
- config.cliOnlyChanged = opts.onlyChanged === true ? "HEAD" : opts.onlyChanged;
- config.cliGrepInvert = opts.grepInvert;
- config.cliListOnly = !!opts.list;
- config.cliProjectFilter = opts.project || void 0;
- config.cliPassWithNoTests = !!opts.passWithNoTests;
- config.cliLastFailed = !!opts.lastFailed;
- (0, import_projectUtils.filterProjects)(config.projects, config.cliProjectFilter);
- if (opts.ui || opts.uiHost || opts.uiPort) {
- if (opts.onlyChanged)
- throw new Error(`--only-changed is not supported in UI mode. If you'd like that to change, see https://github.com/microsoft/playwright/issues/15075 for more details.`);
- const status2 = await testServer.runUIMode(opts.config, cliOverrides, {
- host: opts.uiHost,
- port: opts.uiPort ? +opts.uiPort : void 0,
- args,
- grep: opts.grep,
- grepInvert: opts.grepInvert,
- project: opts.project || void 0,
- reporter: Array.isArray(opts.reporter) ? opts.reporter : opts.reporter ? [opts.reporter] : void 0
- });
- await (0, import_utils.stopProfiling)("runner");
- const exitCode2 = status2 === "interrupted" ? 130 : status2 === "passed" ? 0 : 1;
- (0, import_utils.gracefullyProcessExitDoNotHang)(exitCode2);
- return;
- }
- if (process.env.PWTEST_WATCH) {
- if (opts.onlyChanged)
- throw new Error(`--only-changed is not supported in watch mode. If you'd like that to change, file an issue and let us know about your usecase for it.`);
- const status2 = await (0, import_watchMode.runWatchModeLoop)(
- (0, import_configLoader.resolveConfigLocation)(opts.config),
- {
- projects: opts.project,
- files: args,
- grep: opts.grep
- }
- );
- await (0, import_utils.stopProfiling)("runner");
- const exitCode2 = status2 === "interrupted" ? 130 : status2 === "passed" ? 0 : 1;
- (0, import_utils.gracefullyProcessExitDoNotHang)(exitCode2);
- return;
- }
- const status = await (0, import_testRunner.runAllTestsWithConfig)(config);
- await (0, import_utils.stopProfiling)("runner");
- const exitCode = status === "interrupted" ? 130 : status === "passed" ? 0 : 1;
- (0, import_utils.gracefullyProcessExitDoNotHang)(exitCode);
- }
- async function runTestServer(opts) {
- const host = opts.host || "localhost";
- const port = opts.port ? +opts.port : 0;
- const status = await testServer.runTestServer(opts.config, {}, { host, port });
- const exitCode = status === "interrupted" ? 130 : status === "passed" ? 0 : 1;
- (0, import_utils.gracefullyProcessExitDoNotHang)(exitCode);
- }
- async function mergeReports(reportDir, opts) {
- const configFile = opts.config;
- const config = configFile ? await (0, import_configLoader.loadConfigFromFile)(configFile) : await (0, import_configLoader.loadEmptyConfigForMergeReports)();
- const dir = import_path.default.resolve(process.cwd(), reportDir || "");
- const dirStat = await import_fs.default.promises.stat(dir).catch((e) => null);
- if (!dirStat)
- throw new Error("Directory does not exist: " + dir);
- if (!dirStat.isDirectory())
- throw new Error(`"${dir}" is not a directory`);
- let reporterDescriptions = resolveReporterOption(opts.reporter);
- if (!reporterDescriptions && configFile)
- reporterDescriptions = config.config.reporter;
- if (!reporterDescriptions)
- reporterDescriptions = [[import_config.defaultReporter]];
- const rootDirOverride = configFile ? config.config.rootDir : void 0;
- await (0, import_merge.createMergedReport)(config, dir, reporterDescriptions, rootDirOverride);
- (0, import_utils.gracefullyProcessExitDoNotHang)(0);
- }
- function overridesFromOptions(options) {
- const overrides = {
- failOnFlakyTests: options.failOnFlakyTests ? true : void 0,
- forbidOnly: options.forbidOnly ? true : void 0,
- fullyParallel: options.fullyParallel ? true : void 0,
- globalTimeout: options.globalTimeout ? parseInt(options.globalTimeout, 10) : void 0,
- maxFailures: options.x ? 1 : options.maxFailures ? parseInt(options.maxFailures, 10) : void 0,
- outputDir: options.output ? import_path.default.resolve(process.cwd(), options.output) : void 0,
- quiet: options.quiet ? options.quiet : void 0,
- repeatEach: options.repeatEach ? parseInt(options.repeatEach, 10) : void 0,
- retries: options.retries ? parseInt(options.retries, 10) : void 0,
- reporter: resolveReporterOption(options.reporter),
- shard: resolveShardOption(options.shard),
- timeout: options.timeout ? parseInt(options.timeout, 10) : void 0,
- tsconfig: options.tsconfig ? import_path.default.resolve(process.cwd(), options.tsconfig) : void 0,
- ignoreSnapshots: options.ignoreSnapshots ? !!options.ignoreSnapshots : void 0,
- updateSnapshots: options.updateSnapshots,
- updateSourceMethod: options.updateSourceMethod,
- workers: options.workers
- };
- if (options.browser) {
- const browserOpt = options.browser.toLowerCase();
- if (!["all", "chromium", "firefox", "webkit"].includes(browserOpt))
- throw new Error(`Unsupported browser "${options.browser}", must be one of "all", "chromium", "firefox" or "webkit"`);
- const browserNames = browserOpt === "all" ? ["chromium", "firefox", "webkit"] : [browserOpt];
- overrides.projects = browserNames.map((browserName) => {
- return {
- name: browserName,
- use: { browserName }
- };
- });
- }
- if (options.headed || options.debug)
- overrides.use = { headless: false };
- if (!options.ui && options.debug) {
- overrides.debug = true;
- process.env.PWDEBUG = "1";
- }
- if (!options.ui && options.trace) {
- overrides.use = overrides.use || {};
- overrides.use.trace = options.trace;
- }
- if (overrides.tsconfig && !import_fs.default.existsSync(overrides.tsconfig))
- throw new Error(`--tsconfig "${options.tsconfig}" does not exist`);
- return overrides;
- }
- function resolveReporterOption(reporter) {
- if (!reporter || !reporter.length)
- return void 0;
- return reporter.split(",").map((r) => [resolveReporter(r)]);
- }
- function resolveShardOption(shard) {
- if (!shard)
- return void 0;
- const shardPair = shard.split("/");
- if (shardPair.length !== 2) {
- throw new Error(
- `--shard "${shard}", expected format is "current/all", 1-based, for example "3/5".`
- );
- }
- const current = parseInt(shardPair[0], 10);
- const total = parseInt(shardPair[1], 10);
- if (isNaN(total) || total < 1)
- throw new Error(`--shard "${shard}" total must be a positive number`);
- if (isNaN(current) || current < 1 || current > total) {
- throw new Error(
- `--shard "${shard}" current must be a positive number, not greater than shard total`
- );
- }
- return { current, total };
- }
- function resolveReporter(id) {
- if (import_config.builtInReporters.includes(id))
- return id;
- const localPath = import_path.default.resolve(process.cwd(), id);
- if (import_fs.default.existsSync(localPath))
- return localPath;
- return require.resolve(id, { paths: [process.cwd()] });
- }
- const kTraceModes = ["on", "off", "on-first-retry", "on-all-retries", "retain-on-failure", "retain-on-first-failure"];
- const testOptions = [
- /* deprecated */
- ["--browser <browser>", { description: `Browser to use for tests, one of "all", "chromium", "firefox" or "webkit" (default: "chromium")` }],
- ["-c, --config <file>", { description: `Configuration file, or a test directory with optional "playwright.config.{m,c}?{js,ts}"` }],
- ["--debug", { description: `Run tests with Playwright Inspector. Shortcut for "PWDEBUG=1" environment variable and "--timeout=0 --max-failures=1 --headed --workers=1" options` }],
- ["--fail-on-flaky-tests", { description: `Fail if any test is flagged as flaky (default: false)` }],
- ["--forbid-only", { description: `Fail if test.only is called (default: false)` }],
- ["--fully-parallel", { description: `Run all tests in parallel (default: false)` }],
- ["--global-timeout <timeout>", { description: `Maximum time this test suite can run in milliseconds (default: unlimited)` }],
- ["-g, --grep <grep>", { description: `Only run tests matching this regular expression (default: ".*")` }],
- ["--grep-invert <grep>", { description: `Only run tests that do not match this regular expression` }],
- ["--headed", { description: `Run tests in headed browsers (default: headless)` }],
- ["--ignore-snapshots", { description: `Ignore screenshot and snapshot expectations` }],
- ["--last-failed", { description: `Only re-run the failures` }],
- ["--list", { description: `Collect all the tests and report them, but do not run` }],
- ["--max-failures <N>", { description: `Stop after the first N failures` }],
- ["--no-deps", { description: `Do not run project dependencies` }],
- ["--output <dir>", { description: `Folder for output artifacts (default: "test-results")` }],
- ["--only-changed [ref]", { description: `Only run test files that have been changed between 'HEAD' and 'ref'. Defaults to running all uncommitted changes. Only supports Git.` }],
- ["--pass-with-no-tests", { description: `Makes test run succeed even if no tests were found` }],
- ["--project <project-name...>", { description: `Only run tests from the specified list of projects, supports '*' wildcard (default: run all projects)` }],
- ["--quiet", { description: `Suppress stdio` }],
- ["--repeat-each <N>", { description: `Run each test N times (default: 1)` }],
- ["--reporter <reporter>", { description: `Reporter to use, comma-separated, can be ${import_config.builtInReporters.map((name) => `"${name}"`).join(", ")} (default: "${import_config.defaultReporter}")` }],
- ["--retries <retries>", { description: `Maximum retry count for flaky tests, zero for no retries (default: no retries)` }],
- ["--shard <shard>", { description: `Shard tests and execute only the selected shard, specify in the form "current/all", 1-based, for example "3/5"` }],
- ["--timeout <timeout>", { description: `Specify test timeout threshold in milliseconds, zero for unlimited (default: ${import_config.defaultTimeout})` }],
- ["--trace <mode>", { description: `Force tracing mode`, choices: kTraceModes }],
- ["--tsconfig <path>", { description: `Path to a single tsconfig applicable to all imported files (default: look up tsconfig for each imported file separately)` }],
- ["--ui", { description: `Run tests in interactive UI mode` }],
- ["--ui-host <host>", { description: `Host to serve UI on; specifying this option opens UI in a browser tab` }],
- ["--ui-port <port>", { description: `Port to serve UI on, 0 for any free port; specifying this option opens UI in a browser tab` }],
- ["-u, --update-snapshots [mode]", { description: `Update snapshots with actual results. Running tests without the flag defaults to "missing"`, choices: ["all", "changed", "missing", "none"], preset: "changed" }],
- ["--update-source-method <method>", { description: `Chooses the way source is updated (default: "patch")`, choices: ["overwrite", "3way", "patch"] }],
- ["-j, --workers <workers>", { description: `Number of concurrent workers or percentage of logical CPU cores, use 1 to run in a single worker (default: 50%)` }],
- ["-x", { description: `Stop after the first failure` }]
- ];
- addTestCommand(import_program.program);
- addShowReportCommand(import_program.program);
- addMergeReportsCommand(import_program.program);
- addClearCacheCommand(import_program.program);
- addDevServerCommand(import_program.program);
- addTestServerCommand(import_program.program);
- // Annotate the CommonJS export names for ESM import in node:
- 0 && (module.exports = {
- program
- });
|