跳到主要内容

Reporter

测试运行器在测试执行期间向报告器通知各种事件。报告器的所有方法都是可选的。

你可以通过实现一个包含报告器某些方法的类来创建自定义报告器。确保将此类作为默认导出。

my-awesome-reporter.ts
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;

现在使用此报告器和 testConfig.reporter。了解更多关于使用报告器的信息。

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  reporter: [['./my-awesome-reporter.ts', { customOption: 'some value' }]],
});

以下是报告器调用的一般顺序

此外，当工作进程中产生标准输出时（可能在测试执行期间），会调用 reporter.onStdOut() 和 reporter.onStdErr()；当测试执行之外发生错误时，会调用 reporter.onError()。

如果你的自定义报告器不向终端输出任何内容，请实现 reporter.printsToStdio() 并返回 false。这样，Playwright 将在你的自定义报告器之外使用一个标准终端报告器，以增强用户体验。

合并报告 API 说明

通过 merge-reports CLI 命令合并多个 blob 报告时，会调用相同的 Reporter API 来生成最终报告，并且所有现有报告器应该无需任何更改即可工作。但存在一些细微差异，可能会影响某些自定义报告器。

  • 来自不同分片的项目始终作为单独的 TestProject 对象保留。例如，如果项目 'Desktop Chrome' 被分片到 5 台机器上，那么传递给 reporter.onBegin() 的配置中将有 5 个同名项目实例。

方法​

onBegin​

添加于: v1.10 reporter.onBegin

在运行测试之前被调用一次。所有测试已被发现并放入套件层级结构中。

用法

reporter.onBegin(config, suite);

参数

  • config FullConfig#

    已解析的配置。

  • suite Suite#

    包含所有项目、文件和测试用例的根套件。

onEnd​

添加于: v1.10 reporter.onEnd

在所有测试运行完毕或测试已被中断后被调用。请注意，此方法可能返回一个 Promise，并且 Playwright Test 将等待其完成。报告器可以覆盖状态，从而影响测试运行器的退出代码。

用法

await reporter.onEnd(result);

参数

  • result Object#

    • status "passed" | "failed" | "timedout" | "interrupted"

      测试运行状态。

    • startTime Date

      测试运行开始的实际时间（wall time）。

    • duration number

      测试运行持续时间（毫秒）。

    完整测试运行的结果，status 可以是以下之一：
    • 'passed' - 一切按预期进行。
    • 'failed' - 任何测试失败。
    • 'timedout' - 达到了 testConfig.globalTimeout。
    • 'interrupted' - 被用户中断。

返回值

  • Promise<Object>#

    • status "passed" | "failed" | "timedout" | "interrupted" （可选）

onError​

添加于: v1.10 reporter.onError

在发生一些全局错误时被调用，例如工作进程中的未处理异常。

用法

reporter.onError(error);

参数

onExit​

添加于: v1.33 reporter.onExit

在测试运行器退出前立即被调用。此时所有报告器都已收到 reporter.onEnd() 信号，因此所有报告都应该已构建完成。你可以在此钩子中运行上传报告的代码。

用法

await reporter.onExit();

返回值

onStdErr​

添加于: v1.10 reporter.onStdErr

当工作进程中有内容写入标准错误时被调用。

用法

reporter.onStdErr(chunk, test, result);

参数

  • chunk string | Buffer#

    输出块。

  • test void | TestCase#

    正在运行的测试。请注意，当没有测试正在运行时也可能产生输出，在这种情况下，此参数将为 void。

  • result void | TestResult#

    测试运行的结果，此对象在测试运行时填充。

onStdOut​

添加于: v1.10 reporter.onStdOut

当工作进程中有内容写入标准输出时被调用。

用法

reporter.onStdOut(chunk, test, result);

参数

  • chunk string | Buffer#

    输出块。

  • test void | TestCase#

    正在运行的测试。请注意，当没有测试正在运行时也可能产生输出，在这种情况下，此参数将为 void。

  • result void | TestResult#

    测试运行的结果，此对象在测试运行时填充。

onStepBegin​

添加于: v1.10 reporter.onStepBegin

当工作进程中的测试步骤开始时被调用。

用法

reporter.onStepBegin(test, result, step);

参数

  • test TestCase#

    该步骤所属的测试用例。

  • result TestResult#

    测试运行的结果，此对象在测试运行时填充。

  • step TestStep#

    已开始的测试步骤实例。

onStepEnd​

添加于: v1.10 reporter.onStepEnd

当工作进程中的测试步骤结束时被调用。

用法

reporter.onStepEnd(test, result, step);

参数

onTestBegin​

添加于: v1.10 reporter.onTestBegin

在工作进程中的测试开始后被调用。

用法

reporter.onTestBegin(test, result);

参数

  • test TestCase#

    已开始的测试用例。

  • result TestResult#

    测试运行的结果，此对象在测试运行时填充。

onTestEnd​

添加于: v1.10 reporter.onTestEnd

在工作进程中的测试结束时被调用。

用法

reporter.onTestEnd(test, result);

参数

printsToStdio​

添加于: v1.10 reporter.printsToStdio

此报告器是否使用 stdio 进行报告。如果它不使用 stdio，Playwright Test 可以添加一些输出以增强用户体验。如果你的报告器不向终端打印内容，强烈建议返回 false。

用法

reporter.printsToStdio();

返回值