报告器

简介

Playwright 测试附带了一些内置报告器，用于不同的需求，并能够提供自定义报告器。尝试内置报告器的最简单方法是传递--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		是否生成适合实时终端的输出。如果指定了数字，它也将用作终端宽度。	当终端处于 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		是否生成适合实时终端的输出。如果指定了数字，它也将用作终端宽度。	当终端处于 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		是否生成适合实时终端的输出。如果指定了数字，它也将用作终端宽度。	当终端处于 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_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/

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 对象。

最有可能的是您想要将 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 报告被打印到标准输出。
PLAYWRIGHT_JSON_OUTPUT_FILE	outputFile	输出文件的完整路径。如果定义了，则会忽略PLAYWRIGHT_JSON_OUTPUT_DIR 和PLAYWRIGHT_JSON_OUTPUT_NAME。	JSON 报告被打印到标准输出。

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 报告被打印到标准输出。
PLAYWRIGHT_JUNIT_OUTPUT_FILE	outputFile	输出文件的完整路径。如果定义了，则会忽略PLAYWRIGHT_JUNIT_OUTPUT_DIR 和PLAYWRIGHT_JUNIT_OUTPUT_NAME。	JUnit 报告被打印到标准输出。
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
• Argos Visual Testing
• Currents
• GitHub Actions 报告器
• GitHub 拉取请求评论
• 邮件报告器
• Microsoft Teams 报告器
• Monocart
• ReportPortal
• Serenity/JS
• Testmo
• Testomat.io
• Tesults