Skip to content

Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.

feat(cli): add --add-reporter to append reporters without replacing existing config (#41993)

himasree42475689d189932
diff --git a/docs/src/test-cli-js.md b/docs/src/test-cli-js.md
index 85171da62f..4fea276f3b 100644
--- a/docs/src/test-cli-js.md
+++ b/docs/src/test-cli-js.md
@@ -79,6 +79,7 @@ npx playwright test --ui
| Option | Description |
| :--- | :--- |
| Non-option arguments | Each argument is treated as a regular expression matched against the full test file path. Only tests from files matching the pattern will be executed. Special symbols like `$` or `*` should be escaped with `\`. In many shells/terminals you may need to quote the arguments. |
+| `--add-reporter <reporter>` | Reporter to add on top of the reporters configured in the config file, comma-separated. Can be a built-in reporter name or a path to a custom reporter file. Unlike `--reporter`, this keeps the configured reporters instead of replacing them. |
| `-c <file>` or `--config <file>` | Configuration file, or a test directory with optional "playwright.config.&#123;m,c&#125;?&#123;js,ts&#125;". Defaults to `playwright.config.ts` or `playwright.config.js` in the current directory. |
| `--debug` | 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` | Fail if any test is flagged as flaky (default: false). |
diff --git a/packages/playwright/src/cli/testActions.ts b/packages/playwright/src/cli/testActions.ts
index c4bc09e2df..f3cd08f907 100644
--- a/packages/playwright/src/cli/testActions.ts
+++ b/packages/playwright/src/cli/testActions.ts
@@ -126,6 +126,7 @@ function overridesFromOptions(options: { [key: string]: any }): ipc.ConfigCLIOve
repeatEach: options.repeatEach ? parseInt(options.repeatEach, 10) : undefined,
retries: options.retries ? parseInt(options.retries, 10) : undefined,
reporter: resolveReporterOption(options.reporter),
+ additionalReporters: resolveReporterOption(options.addReporter),
shard: resolveShardOption(options.shard),
timeout: options.timeout ? parseInt(options.timeout, 10) : undefined,
tsconfig: options.tsconfig ? path.resolve(process.cwd(), options.tsconfig) : undefined,
diff --git a/packages/playwright/src/common/config.ts b/packages/playwright/src/common/config.ts
index 0287e87d3e..99328f3f9b 100644
--- a/packages/playwright/src/common/config.ts
+++ b/packages/playwright/src/common/config.ts
@@ -100,7 +100,7 @@ export class FullConfigInternal {
preserveOutput: takeFirst(userConfig.preserveOutput, 'always'),
projects: [],
quiet: takeFirst(configCLIOverrides.quiet, userConfig.quiet, false),
- reporter: takeFirst(configCLIOverrides.reporter, resolveReporters(userConfig.reporter, configDir), [[defaultReporter]]),
+ reporter: [...takeFirst(configCLIOverrides.reporter, resolveReporters(userConfig.reporter, configDir), [[defaultReporter]]), ...(configCLIOverrides.additionalReporters ?? [])],
reportSlowTests: takeFirst(userConfig.reportSlowTests, { max: 5, threshold: 300_000 /* 5 minutes */ }),
shard: takeFirst(configCLIOverrides.shard, userConfig.shard, null),
tags: globalTags,
diff --git a/packages/playwright/src/common/ipc.ts b/packages/playwright/src/common/ipc.ts
index 6cc0436d33..3943730099 100644
--- a/packages/playwright/src/common/ipc.ts
+++ b/packages/playwright/src/common/ipc.ts
@@ -36,6 +36,7 @@ export type ConfigCLIOverrides = {
repeatEach?: number;
retries?: number;
reporter?: ReporterDescription[];
+ additionalReporters?: ReporterDescription[];
shard?: { current: number, total: number };
timeout?: number;
tsconfig?: string;
diff --git a/packages/playwright/src/program.ts b/packages/playwright/src/program.ts
index 2384f49a88..4d88f7440a 100644
--- a/packages/playwright/src/program.ts
+++ b/packages/playwright/src/program.ts
@@ -206,6 +206,7 @@ const kTraceModes: TraceMode[] = ['on', 'off', 'on-first-retry', 'on-all-retries
// Note: update docs/src/test-cli-js.md when you update this, program is the source of truth.
const testOptions: [string, { description: string, choices?: string[], preset?: string }][] = [
+ ['--add-reporter <reporter>', { description: `Reporter to add on top of the configured reporters, comma-separated, can be ${builtInReporters.map(name => `"${name}"`).join(', ')} or a path to a reporter module` }],
/* 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 [mode]', { description: `Run tests with Playwright Inspector. Shortcut for "PWDEBUG=1" environment variable and "--timeout=0 --max-failures=1 --headed --workers=1" options`, choices: ['inspector', 'cli'], preset: 'inspector' }],
diff --git a/packages/playwright/src/runner/reporters.ts b/packages/playwright/src/runner/reporters.ts
index 00dd732b63..ef3d45a79f 100644
--- a/packages/playwright/src/runner/reporters.ts
+++ b/packages/playwright/src/runner/reporters.ts
@@ -51,8 +51,6 @@ export async function createReporters(config: FullConfigInternal, mode: 'list' |
};
const reporters: ReporterV2[] = [];
descriptions ??= config.config.reporter;
- if (runOptions?.additionalReporters)
- descriptions = [...descriptions, ...runOptions.additionalReporters];
const reportOptions = reporterCommandOptions(config, mode, runOptions);
for (const r of descriptions) {
const [name, arg] = r;
diff --git a/packages/playwright/src/runner/tasks.ts b/packages/playwright/src/runner/tasks.ts
index 7890ed51fc..6699c6292c 100644
--- a/packages/playwright/src/runner/tasks.ts
+++ b/packages/playwright/src/runner/tasks.ts
@@ -37,7 +37,6 @@ import type { TestGroup } from '../runner/testGroups';
import type { EnvByProjectId } from './dispatcher';
import type { TestRunnerPluginRegistration } from '../plugins';
import type { Task } from './taskRunner';
-import type { ReporterDescription } from '../../types/test';
import type { FullResult, TestError } from '../../types/testReporter';
import type { Matcher, TestCaseFilter } from '../util';
import type { InternalReporter } from '../reporters/internalReporter';
@@ -72,7 +71,6 @@ export type TestRunOptions = {
pauseAtEnd?: boolean;
onTestPaused?: (params: TestPausedParams) => void;
preserveOutputDir?: boolean;
- additionalReporters?: ReporterDescription[];
shardWeights?: number[];
};
diff --git a/tests/playwright-test/reporter.spec.ts b/tests/playwright-test/reporter.spec.ts
index e0330b1e83..851148ead8 100644
--- a/tests/playwright-test/reporter.spec.ts
+++ b/tests/playwright-test/reporter.spec.ts
@@ -987,3 +987,23 @@ test('AggregateError sub-errors are spread into testInfo.errors', async ({ runIn
expect.stringMatching(/^FRAME Error: sub b: at .*a\.spec\.ts:19:/),
]);
});
+
+test('--add-reporter should append to configured reporters instead of replacing them', async ({ runInlineTest }) => {
+ const result = await runInlineTest({
+ 'configured-reporter.js': `
+ module.exports = class { onBegin() { console.log('FROM_CONFIGURED_REPORTER'); } };
+ `,
+ 'added-reporter.js': `
+ module.exports = class { onBegin() { console.log('FROM_ADDED_REPORTER'); } };
+ `,
+ 'playwright.config.ts': `module.exports = { reporter: [['./configured-reporter.js']] };`,
+ 'a.spec.js': `
+ const { test } = require('@playwright/test');
+ test('test', () => {});
+ `,
+ }, { 'workers': 1 }, undefined, { additionalArgs: ['--add-reporter=./added-reporter.js'] });
+
+ expect(result.exitCode).toBe(0);
+ expect(result.output).toContain('FROM_CONFIGURED_REPORTER');
+ expect(result.output).toContain('FROM_ADDED_REPORTER');
+});