Reporter
测试运行器在测试执行期间向报告器通知各种事件。报告器的所有方法都是可选的。
你可以通过实现一个包含部分报告器方法的类来创建自定义报告器。请确保将此类的默认导出。
- TypeScript
- JavaScript
import type {
Reporter, FullConfig, Suite, TestCase, TestResult, FullResult
} from '@playwright/test/reporter';
class MyReporter implements Reporter {
constructor(options: { customOption?: string } = {}) {
console.log(`my-awesome-reporter setup with customOption set to ${options.customOption}`);
}
onBegin(config: FullConfig, suite: Suite) {
console.log(`Starting the run with ${suite.allTests().length} tests`);
}
onTestBegin(test: TestCase) {
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;
// @ts-check
/** @implements {import('@playwright/test/reporter').Reporter} */
class MyReporter {
constructor(options) {
console.log(`my-awesome-reporter setup with customOption set to ${options.customOption}`);
}
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}`);
}
}
module.exports = MyReporter;
现在,将此报告器与 testConfig.reporter 一起使用。了解更多关于使用报告器的信息。
import { defineConfig } from '@playwright/test';
export default defineConfig({
reporter: [['./my-awesome-reporter.ts', { customOption: 'some value' }]],
});
以下是报告器调用的典型顺序
- reporter.onBegin() 会被调用一次,带有一个包含所有其他套件和测试的根套件。了解更多关于套件层次结构的信息。
- reporter.onTestBegin() 在每次测试运行时被调用。它会得到一个正在执行的 TestCase 和一个几乎为空的 TestResult。TestResult 将在测试运行期间被填充(例如,包含步骤和标准输入输出),并在测试结束时获得最终的
status
。 - reporter.onStepBegin() 和 reporter.onStepEnd() 会在测试中的每个执行步骤被调用。当步骤执行时,测试运行尚未结束。
- reporter.onTestEnd() 在测试运行结束时调用。此时,TestResult 已完成,你可以使用 testResult.status、testResult.error 等。
- reporter.onEnd() 在所有应该运行的测试都结束后调用一次。
- reporter.onExit() 在测试运行器退出前立即调用。
此外,当工作进程中产生标准输出时(可能在测试执行期间),会调用 reporter.onStdOut() 和 reporter.onStdErr();当测试执行外部出现问题时,会调用 reporter.onError()。
如果你的自定义报告器不向终端打印任何内容,请实现 reporter.printsToStdio() 并返回 false
。这样,Playwright 将除了你的自定义报告器之外,还会使用其中一个标准终端报告器来增强用户体验。
合并报告 API 注意事项
通过 merge-reports
CLI 命令合并多个 blob
报告时,会调用相同的 Reporter API 来生成最终报告,所有现有报告器都应该无需任何更改即可工作。但是,可能会有一些细微的差异,这可能会影响某些自定义报告器。
- 来自不同分片的项目总是作为独立的 TestProject 对象保存。例如,如果项目“桌面 Chrome”跨 5 台机器进行分片,那么在传递给 reporter.onBegin() 的配置中将有 5 个同名项目实例。
方法
onBegin
新增于: v1.10在运行测试之前调用一次。所有测试都已发现并放入 Suite 的层次结构中。
用法
reporter.onBegin(config, suite);
参数
-
config
FullConfig#已解析的配置。
-
包含所有项目、文件和测试用例的根套件。
onEnd
新增于: v1.10在所有测试运行完毕或测试中断后调用。请注意,此方法可能返回一个 Promise,Playwright Test 将等待它。报告器可以覆盖状态,从而影响测试运行器的退出代码。
用法
await reporter.onEnd(result);
参数
-
-
status
"passed" | "failed" | "timedout" | "interrupted"测试运行状态。
-
startTime
Date测试运行开始的实际时间。
-
duration
number测试运行持续时间,以毫秒为单位。
完整测试运行的结果,
status
可以是以下之一'passed'
- 一切正常。'failed'
- 任何测试失败。'timedout'
- 达到了 testConfig.globalTimeout。'interrupted'
- 被用户中断。
-
返回
onError
新增于: v1.10在发生一些全局错误时调用,例如工作进程中未处理的异常。
用法
reporter.onError(error);
参数
onExit
新增于:v1.33在测试运行器退出之前立即调用。此时,所有报告器都已收到 reporter.onEnd() 信号,因此所有报告都应已构建。你可以在此钩子中运行上传报告的代码。
用法
await reporter.onExit();
返回
onStdErr
新增于: v1.10当在 worker 进程中向标准错误写入内容时调用。
用法
reporter.onStdErr(chunk, test, result);
参数
-
输出块。
-
正在运行的测试。请注意,输出可能在没有测试运行时发生,在这种情况下,这将是 void。
-
result
void | TestResult#测试运行的结果,此对象会在测试运行期间填充。
onStdOut
新增于: v1.10当在 worker 进程中向标准输出写入内容时调用。
用法
reporter.onStdOut(chunk, test, result);
参数
-
输出块。
-
正在运行的测试。请注意,输出可能在没有测试运行时发生,在这种情况下,这将是 void。
-
result
void | TestResult#测试运行的结果,此对象会在测试运行期间填充。
onStepBegin
新增于: v1.10当 worker 进程中的测试步骤开始时调用。
用法
reporter.onStepBegin(test, result, step);
参数
onStepEnd
新增于: v1.10当 worker 进程中的测试步骤结束时调用。
用法
reporter.onStepEnd(test, result, step);
参数
onTestBegin
新增于: v1.10在 worker 进程中测试开始后调用。
用法
reporter.onTestBegin(test, result);
参数
-
已开始的测试。
-
result
TestResult#测试运行的结果,此对象会在测试运行期间填充。
onTestEnd
新增于: v1.10在 worker 进程中测试结束后调用。
用法
reporter.onTestEnd(test, result);
参数
-
已结束的测试。
-
result
TestResult#测试运行的结果。
printsToStdio
新增于: v1.10此报告器是否使用标准输入输出进行报告。如果不使用,Playwright Test 可能会添加一些输出以增强用户体验。如果你的报告器不打印到终端,强烈建议返回 false
。
用法
reporter.printsToStdio();
返回