跳到主要内容

报告器

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

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

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 注释

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

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

方法​

onBegin​

添加于：v1.10 reporter.onBegin

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

用法

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

      测试运行开始挂钟时间。

    • 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 进行报告。当不使用时，Playwright Test 可能会添加一些输出以增强用户体验。如果你的报告器不向终端打印任何内容，强烈建议返回 false。

用法

reporter.printsToStdio();

返回

  • boolean#