报告器

简介

Playwright Test 提供了一些内置报告器以满足不同需求，并支持自定义报告器。试用内置报告器最简单的方法是传递 --reporter 命令行选项。

npx playwright test --reporter=line

为了更好地控制，您可以在配置文件中以编程方式指定报告器。

playwright.config.ts

import { defineConfig } from '@playwright/test';

export default defineConfig({
  reporter: 'line',
});

多个报告器

您可以同时使用多个报告器。例如，您可以使用 'list' 生成漂亮的终端输出，并使用 'json' 获取包含测试结果的综合 JSON 文件。

playwright.config.ts

import { defineConfig } from '@playwright/test';

export default defineConfig({
  reporter: [
    ['list'],
    ['json', {  outputFile: 'test-results.json' }]
  ],
});

CI 上的报告器

您可以在本地和 CI 上使用不同的报告器。例如，使用简洁的 'dot' 报告器可以避免过多的输出。这是 CI 上的默认设置。

playwright.config.ts

import { defineConfig } from '@playwright/test';

export default defineConfig({
  // Concise 'dot' for CI, default 'list' when running locally
  reporter: process.env.CI ? 'dot' : 'list',
});

内置报告器

所有内置报告器都显示有关故障的详细信息，主要区别在于成功运行时的冗长程度。

列表报告器

列表报告器是默认的（除了 CI 上默认使用 dot 报告器）。它为每个正在运行的测试打印一行。

npx playwright test --reporter=list

playwright.config.ts

import { defineConfig } from '@playwright/test';

export default defineConfig({
  reporter: 'list',
});

以下是测试运行中途的示例输出。故障将在最后列出。

npx playwright test --reporter=list
Running 124 tests using 6 workers

 1  ✓ should access error in env (438ms)
 2  ✓ handle long test names (515ms)
 3  x 1) render expected (691ms)
 4  ✓ should timeout (932ms)
 5    should repeat each:
 6  ✓ should respect enclosing .gitignore (569ms)
 7    should teardown env after timeout:
 8    should respect excluded tests:
 9  ✓ should handle env beforeEach error (638ms)
10    should respect enclosing .gitignore:

您可以通过传递以下配置选项来选择步骤渲染

playwright.config.ts

import { defineConfig } from '@playwright/test';

export default defineConfig({
  reporter: [['list', { printSteps: true }]],
});

列表报告支持以下配置选项和环境变量

环境变量名称	报告器配置选项	描述	默认值
PLAYWRIGHT_LIST_PRINT_STEPS	printSteps	是否将每个步骤打印到单独的行。	false
PLAYWRIGHT_FORCE_TTY		是否生成适合实时终端的输出。支持 true、1、false、0、[WIDTH] 和 [WIDTH]x[HEIGHT]。[WIDTH] 和 [WIDTH]x[HEIGHT] 指定 TTY 尺寸。	当终端处于 TTY 模式时为 true，否则为 false。
FORCE_COLOR		是否生成彩色输出。	当终端处于 TTY 模式时为 true，否则为 false。

行报告器

行报告器比列表报告器更简洁。它使用单行报告最后完成的测试，并在发生故障时打印故障。行报告器对于大型测试套件很有用，因为它显示进度但不会通过列出所有测试来占用输出。

npx playwright test --reporter=line

playwright.config.ts

import { defineConfig } from '@playwright/test';

export default defineConfig({
  reporter: 'line',
});

以下是测试运行中途的示例输出。故障会内联报告。

npx playwright test --reporter=line
Running 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

行报告支持以下配置选项和环境变量

环境变量名称	报告器配置选项	描述	默认值
PLAYWRIGHT_FORCE_TTY		是否生成适合实时终端的输出。支持 true、1、false、0、[WIDTH] 和 [WIDTH]x[HEIGHT]。[WIDTH] 和 [WIDTH]x[HEIGHT] 指定 TTY 尺寸。	当终端处于 TTY 模式时为 true，否则为 false。
FORCE_COLOR		是否生成彩色输出。	当终端处于 TTY 模式时为 true，否则为 false。

点报告器

点报告器非常简洁 - 它为每个成功的测试运行只生成一个字符。它是 CI 上的默认设置，在您不希望有大量输出时很有用。

npx playwright test --reporter=dot

playwright.config.ts

import { defineConfig } from '@playwright/test';

export default defineConfig({
  reporter: 'dot',
});

以下是测试运行中途的示例输出。故障将在最后列出。

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

每个已运行的测试都会显示一个字符，指示其状态

字符	描述
·	通过
F	失败
×	失败或超时 - 将重试
±	重试时通过（不稳定）
T	超时
°	跳过

点报告支持以下配置选项和环境变量

环境变量名称	报告器配置选项	描述	默认值
PLAYWRIGHT_FORCE_TTY		是否生成适合实时终端的输出。支持 true、1、false、0、[WIDTH] 和 [WIDTH]x[HEIGHT]。[WIDTH] 和 [WIDTH]x[HEIGHT] 指定 TTY 尺寸。	当终端处于 TTY 模式时为 true，否则为 false。
FORCE_COLOR		是否生成彩色输出。	当终端处于 TTY 模式时为 true，否则为 false。

HTML 报告器

HTML 报告器会生成一个自包含的文件夹，其中包含测试运行的报告，可以作为网页提供服务。

npx playwright test --reporter=html

默认情况下，如果某些测试失败，HTML 报告会自动打开。您可以通过 Playwright 配置中的 open 属性或 PLAYWRIGHT_HTML_OPEN 环境变量来控制此行为。该属性的可能值为 always、never 和 on-failure（默认）。

您还可以配置用于提供 HTML 报告的 host 和 port。

playwright.config.ts

import { defineConfig } from '@playwright/test';

export default defineConfig({
  reporter: [['html', { open: 'never' }]],
});

默认情况下，报告会写入当前工作目录中的 playwright-report 文件夹。可以使用 PLAYWRIGHT_HTML_OUTPUT_DIR 环境变量或报告器配置来覆盖该位置。

在配置文件中，直接传递选项

playwright.config.ts

import { defineConfig } from '@playwright/test';

export default defineConfig({
  reporter: [['html', { outputFolder: 'my-report' }]],
});

如果您将数据文件夹中的附件上传到其他位置，可以使用 attachmentsBaseURL 选项让 html 报告知道在哪里查找它们。

playwright.config.ts

import { defineConfig } from '@playwright/test';

export default defineConfig({
  reporter: [['html', { attachmentsBaseURL: 'https://external-storage.com/' }]],
});

打开上次测试运行报告的快速方法是

npx playwright show-report

或者如果有自定义文件夹名称

npx playwright show-report my-report

HTML 报告支持以下配置选项和环境变量

环境变量名称	报告器配置选项	描述	默认值
PLAYWRIGHT_HTML_TITLE	title	在生成的报告中显示的标题。	默认不显示标题
PLAYWRIGHT_HTML_OUTPUT_DIR	outputFolder	保存报告的目录。	playwright-report
PLAYWRIGHT_HTML_OPEN	open	何时在浏览器中打开 HTML 报告，可选值包括 'always'、'never' 或 'on-failure'	'on-failure'
PLAYWRIGHT_HTML_HOST	host	当报告在浏览器中打开时，它将绑定到此主机名提供服务。	localhost
PLAYWRIGHT_HTML_PORT	port	当报告在浏览器中打开时，它将在此端口提供服务。	9323 或当 9323 不可用时任何可用端口。
PLAYWRIGHT_HTML_ATTACHMENTS_BASE_URL	attachmentsBaseURL	data 子目录中附件的单独上传位置。仅当您将报告和 data 分别上传到不同位置时才需要。	data/
PLAYWRIGHT_HTML_NO_SNIPPETS	noSnippets	如果为 true，则禁用在操作日志中渲染代码片段。如果存在顶级错误，则包含代码片段的报告部分仍将渲染。支持 true、1、false 和 0。	false

Blob 报告器

Blob 报告包含有关测试运行的所有详细信息，以后可用于生成任何其他报告。它们的主要功能是方便合并来自分片测试的报告。

npx playwright test --reporter=blob

默认情况下，报告写入 package.json 目录或当前工作目录（如果未找到 package.json）中的 blob-report 目录。报告文件名为 report-<hash>.zip，当使用分片时为 report-<hash>-<shard_number>.zip。哈希值是根据 --grep、--grepInverted、--project 和作为命令行参数传递的文件过滤器计算的可选值。哈希值保证使用不同命令行选项运行 Playwright 将生成不同但运行之间稳定的报告名称。输出文件名称可以在配置文件中覆盖，或作为 'PLAYWRIGHT_BLOB_OUTPUT_FILE' 环境变量传递。

playwright.config.ts

import { defineConfig } from '@playwright/test';

export default defineConfig({
  reporter: [['blob', { outputFile: `./blob-report/report-${os.platform()}.zip` }]],
});

Blob 报告支持以下配置选项和环境变量

环境变量名称	报告器配置选项	描述	默认值
PLAYWRIGHT_BLOB_OUTPUT_DIR	outputDir	保存输出的目录。写入新报告之前会删除现有内容。	blob-report
PLAYWRIGHT_BLOB_OUTPUT_NAME	fileName	报告文件名。	report-<project>-<hash>-<shard_number>.zip
PLAYWRIGHT_BLOB_OUTPUT_FILE	outputFile	输出文件的完整路径。如果定义，outputDir 和 fileName 将被忽略。	undefined

JSON 报告器

JSON 报告器会生成一个包含测试运行所有信息的对象。

您很可能希望将 JSON 写入文件。当使用 --reporter=json 运行时，使用 PLAYWRIGHT_JSON_OUTPUT_NAME 环境变量

Bash

PLAYWRIGHT_JSON_OUTPUT_NAME=results.json npx playwright test --reporter=json

PowerShell

$env:PLAYWRIGHT_JSON_OUTPUT_NAME="results.json"
npx playwright test --reporter=json

批处理

set PLAYWRIGHT_JSON_OUTPUT_NAME=results.json
npx playwright test --reporter=json

在配置文件中，直接传递选项

playwright.config.ts

import { defineConfig } from '@playwright/test';

export default defineConfig({
  reporter: [['json', { outputFile: 'results.json' }]],
});

JSON 报告支持以下配置选项和环境变量

环境变量名称	报告器配置选项	描述	默认值
PLAYWRIGHT_JSON_OUTPUT_DIR		保存输出文件的目录。如果指定了输出文件则忽略。	cwd 或配置目录。
PLAYWRIGHT_JSON_OUTPUT_NAME	outputFile	输出的基本文件名，相对于输出目录。	JSON 报告打印到 stdout。
PLAYWRIGHT_JSON_OUTPUT_FILE	outputFile	输出文件的完整路径。如果定义，PLAYWRIGHT_JSON_OUTPUT_DIR 和 PLAYWRIGHT_JSON_OUTPUT_NAME 将被忽略。	JSON 报告打印到 stdout。

JUnit 报告器

JUnit 报告器生成 JUnit 风格的 XML 报告。

您很可能希望将报告写入 XML 文件。当使用 --reporter=junit 运行时，使用 PLAYWRIGHT_JUNIT_OUTPUT_NAME 环境变量

Bash

PLAYWRIGHT_JUNIT_OUTPUT_NAME=results.xml npx playwright test --reporter=junit

PowerShell

$env:PLAYWRIGHT_JUNIT_OUTPUT_NAME="results.xml"
npx playwright test --reporter=junit

批处理

set PLAYWRIGHT_JUNIT_OUTPUT_NAME=results.xml
npx playwright test --reporter=junit

在配置文件中，直接传递选项

playwright.config.ts

import { defineConfig } from '@playwright/test';

export default defineConfig({
  reporter: [['junit', { outputFile: 'results.xml' }]],
});

JUnit 报告支持以下配置选项和环境变量

环境变量名称	报告器配置选项	描述	默认值
PLAYWRIGHT_JUNIT_OUTPUT_DIR		保存输出文件的目录。如果未指定输出文件则忽略。	cwd 或配置目录。
PLAYWRIGHT_JUNIT_OUTPUT_NAME	outputFile	输出的基本文件名，相对于输出目录。	JUnit 报告打印到 stdout。
PLAYWRIGHT_JUNIT_OUTPUT_FILE	outputFile	输出文件的完整路径。如果定义，PLAYWRIGHT_JUNIT_OUTPUT_DIR 和 PLAYWRIGHT_JUNIT_OUTPUT_NAME 将被忽略。	JUnit 报告打印到 stdout。
PLAYWRIGHT_JUNIT_STRIP_ANSI	stripANSIControlSequences	是否在将文本写入报告之前从文本中删除 ANSI 控制序列。	默认情况下，输出文本按原样添加。
PLAYWRIGHT_JUNIT_INCLUDE_PROJECT_IN_TEST_NAME	includeProjectInTestName	是否将 Playwright 项目名称作为名称前缀包含在每个测试用例中。	默认不包含。
PLAYWRIGHT_JUNIT_SUITE_ID		根 <testsuites/> 报告条目上 id 属性的值。	空字符串。
PLAYWRIGHT_JUNIT_SUITE_NAME		根 <testsuites/> 报告条目上 name 属性的值。	空字符串。

GitHub Actions 注释

在 GitHub Actions 中运行时，您可以使用内置的 github 报告器获取自动故障注释。

请注意，所有其他报告器在 GitHub Actions 上也有效，但不会提供注释。此外，如果使用矩阵策略运行测试，不建议使用此注释类型，因为堆栈跟踪故障会倍增并模糊 GitHub 文件视图。

playwright.config.ts

import { defineConfig } from '@playwright/test';

export default defineConfig({
  // 'github' for GitHub Actions CI to generate annotations, plus a concise 'dot'
  // default 'list' when running locally
  reporter: process.env.CI ? 'github' : 'list',
});

自定义报告器

您可以通过实现一个包含一些报告器方法的类来创建自定义报告器。了解有关 Reporter API 的更多信息。

my-awesome-reporter.ts

import type {
  FullConfig, FullResult, Reporter, Suite, TestCase, TestResult
} from '@playwright/test/reporter';

class MyReporter implements Reporter {
  onBegin(config: FullConfig, suite: Suite) {
    console.log(`Starting the run with ${suite.allTests().length} tests`);
  }

  onTestBegin(test: TestCase, result: TestResult) {
    console.log(`Starting test ${test.title}`);
  }

  onTestEnd(test: TestCase, result: TestResult) {
    console.log(`Finished test ${test.title}: ${result.status}`);
  }

  onEnd(result: FullResult) {
    console.log(`Finished the run: ${result.status}`);
  }
}

export default MyReporter;

现在将此报告器与 testConfig.reporter 一起使用。

playwright.config.ts

import { defineConfig } from '@playwright/test';

export default defineConfig({
  reporter: './my-awesome-reporter.ts',
});

或者直接将报告器文件路径作为 --reporter 命令行选项传递

npx playwright test --reporter="./myreporter/my-awesome-reporter.ts"

以下是一些开源报告器实现的简短列表，您在编写自己的报告器时可以参考：

• Allure 报告器
• Github Actions 报告器
• 邮件报告器
• ReportPortal
• Monocart