レポーター

テストランナーは、テスト実行中の様々なイベントについてレポーターに通知します。レポーターのすべてのメソッドはオプションです。

レポーターメソッドの一部を実装したクラスを作成することで、カスタムレポーターを作成できます。このクラスをデフォルトとしてエクスポートしてください。

TypeScript
JavaScript

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;

my-awesome-reporter.js
// @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 で使用します。詳細については、レポーターの使用方法を参照してください。

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

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

レポーター呼び出しの典型的な順序を以下に示します。

reporter.onBegin() は、他のすべてのスイートとテストを含むルートスイートとともに一度だけ呼び出されます。スイートの階層の詳細をご覧ください。
reporter.onTestBegin() は、各テストの実行ごとに呼び出されます。実行される TestCase と、ほぼ空の 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 の注意点

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);

引数

error TestError #

エラー。

onExit

追加: v1.33

reporter.onExit

テストランナーが終了する直前に呼び出されます。この時点で、すべてのレポーターが reporter.onEnd() シグナルを受信しているため、すべてのレポートが作成されているはずです。このフックでレポートをアップロードするコードを実行できます。

使用方法

await reporter.onExit();

戻り値

Promise<void>#

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);

引数

test TestCase #

ステップが属するテスト。
result TestResult #

テスト実行の結果。
step TestStep #

終了したテストステップインスタンス。

onTestBegin

追加: v1.10

reporter.onTestBegin

テストがワーカープロセスで開始された後に呼び出されます。

使用方法

reporter.onTestBegin(test, result);

引数

test TestCase #

開始されたテスト。
result TestResult #

テスト実行の結果。このオブジェクトはテストの実行中に入力されます。

onTestEnd

追加: v1.10

reporter.onTestEnd

テストがワーカープロセスで終了した後に呼び出されます。

使用方法

reporter.onTestEnd(test, result);

引数

test TestCase #

終了したテスト。
result TestResult #

テスト実行の結果。

printsToStdio

追加: v1.10

reporter.printsToStdio

このレポーターがレポートに stdio を使用するかどうか。使用しない場合、Playwright Test はユーザーエクスペリエンスを向上させるためにいくつかの出力を追加できます。レポーターがターミナルに出力しない場合は、false を返すことを強くお勧めします。

使用方法

reporter.printsToStdio();

戻り値

boolean #

メソッド​

onBegin​

onEnd​

onError​

onExit​

onStdErr​

onStdOut​

onStepBegin​

onStepEnd​

onTestBegin​

onTestEnd​

printsToStdio​

メソッド

onBegin

onEnd

onError

onExit

onStdErr

onStdOut

onStepBegin

onStepEnd

onTestBegin

onTestEnd

printsToStdio