Skip to main content
Version: 1.15

Reporters

Using reporters#

Playwright Test comes with a few built-in reporters for different needs and ability to provide custom reporters. The easiest way to try out built-in reporters is to pass --reporter command line option.

npx playwright test --reporter=line

For more control, you can specify reporters programmatically in the configuration file.

// playwright.config.tsimport { PlaywrightTestConfig } from '@playwright/test';
const config: PlaywrightTestConfig = {  reporter: 'line',};export default config;

Multiple reporters#

You can use multiple reporters at the same time. For example you can use'list' for nice terminal output and 'json' to get a comprehensive json file with the test results.

// playwright.config.tsimport { PlaywrightTestConfig } from '@playwright/test';
const config: PlaywrightTestConfig = {  reporter: [    ['list'],    ['json', {  outputFile: 'test-results.json' }]  ],};export default config;

Reporters on CI#

You can use different reporters locally and on CI. For example, using concise 'dot' reporter avoids too much output.

// playwright.config.tsimport { PlaywrightTestConfig } from '@playwright/test';
const config: PlaywrightTestConfig = {  // Concise 'dot' for CI, default 'list' when running locally  reporter: process.env.CI ? 'dot' : 'list',};export default config;

Built-in reporters#

All built-in reporters show detailed information about failures, and mostly differ in verbosity for successful runs.

List reporter#

List reporter is default. It prints a line for each test being run.

npx playwright test --reporter=list
// playwright.config.tsimport { PlaywrightTestConfig } from '@playwright/test';
const config: PlaywrightTestConfig = {  reporter: 'list',};export default config;

Here is an example output in the middle of a test run. Failures will be listed at the end.

npx playwright test --reporter=listRunning 124 tests using 6 workers
  ✓ should access error in env (438ms)  ✓ handle long test names (515ms)  x 1) render expected (691ms)  ✓ should timeout (932ms)    should repeat each:  ✓ should respect enclosing .gitignore (569ms)    should teardown env after timeout:    should respect excluded tests:  ✓ should handle env beforeEach error (638ms)    should respect enclosing .gitignore:

Line reporter#

Line reporter is more concise than the list reporter. It uses a single line to report last finished test, and prints failures when they occur. Line reporter is useful for large test suites where it shows the progress but does not spam the output by listing all the tests.

npx playwright test --reporter=line
// playwright.config.tsimport { PlaywrightTestConfig } from '@playwright/test';
const config: PlaywrightTestConfig = {  reporter: 'line',};export default config;

Here is an example output in the middle of a test run. Failures are reported inline.

npx playwright test --reporter=lineRunning 124 tests using 6 workers  1) dot-reporter.spec.ts:20:1 › render expected ===================================================
    Error: expect(received).toBe(expected) // Object.is equality
    Expected: 1    Received: 0
[23/124] gitignore.spec.ts - should respect nested .gitignore

Dot reporter#

Dot reporter is very concise - it only produces a single character per successful test run. It is useful on CI where you don't want a lot of output.

npx playwright test --reporter=dot
// playwright.config.tsimport { PlaywrightTestConfig } from '@playwright/test';
const config: PlaywrightTestConfig = {  reporter: 'dot',};export default config;

Here is an example output in the middle of a test run. Failures will be listed at the end.

npx playwright test --reporter=dotRunning 124 tests using 6 workers······F·············································

JSON reporter#

JSON reporter produces an object with all information about the test run. It is usually used together with some terminal reporter like dot or line.

Most likely you want to write the JSON to a file. When running with --reporter=json, use PLAYWRIGHT_JSON_OUTPUT_NAME environment variable:

# Linux/macOSPLAYWRIGHT_JSON_OUTPUT_NAME=results.json npx playwright test --reporter=json,dot
# Windows with cmd.exeset PLAYWRIGHT_JSON_OUTPUT_NAME=results.jsonnpx playwright test --reporter=json,dot
# Windows with PowerShell$env:PLAYWRIGHT_JSON_OUTPUT_NAME="results.json"npx playwright test --reporter=json,dot

In configuration file, pass options directly:

// playwright.config.tsimport { PlaywrightTestConfig } from '@playwright/test';
const config: PlaywrightTestConfig = {  reporter: [ ['json', { outputFile: 'results.json' }] ],};export default config;

JUnit reporter#

JUnit reporter produces a JUnit-style xml report. It is usually used together with some terminal reporter like dot or line.

Most likely you want to write the report to an xml file. When running with --reporter=junit, use PLAYWRIGHT_JUNIT_OUTPUT_NAME environment variable:

# Linux/macOSPLAYWRIGHT_JUNIT_OUTPUT_NAME=results.xml npx playwright test --reporter=junit,line
# Windows with cmd.exeset PLAYWRIGHT_JUNIT_OUTPUT_NAME=results.xmlnpx playwright test --reporter=junit,line
# Windows with PowerShell$env:PLAYWRIGHT_JUNIT_OUTPUT_NAME="results.xml"npx playwright test --reporter=junit,line

In configuration file, pass options directly:

// playwright.config.tsimport { PlaywrightTestConfig } from '@playwright/test';
const config: PlaywrightTestConfig = {  reporter: [ ['junit', { outputFile: 'results.xml' }] ],};export default config;

Custom reporters#

You can create a custom reporter by implementing a class with some of the reporter methods. Learn more about the Reporter API.

// playwright.config.tsimport { Reporter } from '@playwright/test/reporter';
class MyReporter implements Reporter {  onBegin(config, suite) {    console.log(`Starting the run with ${suite.allTests().length} tests`);  }
  onTestBegin(test) {    console.log(`Starting test ${test.title}`);  }
  onTestEnd(test, result) {    console.log(`Finished test ${test.title}: ${result.status}`);  }
  onEnd(result) {    console.log(`Finished the run: ${result.status}`);  }}export default MyReporter;

Now use this reporter with testConfig.reporter.

// playwright.config.tsimport { PlaywrightTestConfig } from '@playwright/test';
const config: PlaywrightTestConfig = {  reporter: './my-awesome-reporter.ts',};export default config;

Third party showcase#

  • Allure reporter

    # Installnpm i -D allure-playwright
# Run testsnpx playwright test --reporter=line,allure-playwright
# Generate reportallure generate ./allure-results --clean && allure open ./allure-report