Playwright Logbookでテストワークフローを強化する

テスト結果が赤色（失敗）になるとストレスを感じるものです。そして多くの疑問が生じます。どの試行が失敗したのか？アサーションは実際に何を出力していたのか？このテストは過去の実行でも失敗していたのか？この情報をチームメンバーやコーディングアシスタントとどのように共有すればよいのか？

本記事では、こうした課題に対処するツールであるPlaywright Logbookについて詳しく解説します。このオープンソースレポーターは、Playwrightを使用したテストにおけるデバッグとコラボレーションのプロセスを強化するために設計されています。ソフトウェア開発が進化し続ける中、ワークフローを合理化するツールの存在はこれまで以上に重要になっています。

Playwright Logbookとは？

Playwright Logbookは、テスト実行を追跡し、失敗や再試行、経時的な変化に関する有用な情報を記録するレポーターです。これらすべてのデータを単一のローカルHTMLレポートに統合し、開発者がインサイトを分析して共有しやすくします。

主な機能

• 包括的な失敗診断： Logbookは、エラーメッセージやスタックトレースなど、テストの失敗に関する詳細な情報をキャプチャします。
• 再試行の追跡： テストの再試行を監視および記録し、テストの安定性の把握を支援します。
• 実行履歴の管理： Logbookはテスト実行の履歴を保持し、変化の追跡やパターンの特定を可能にします。
• 焦点を絞ったデバッグパケット： コマンドラインインターフェース（CLI）により、特定のテストに関連するエビデンスを含んだ簡潔なパケットを生成できます。

Playwright Logbookのインストールと使用方法

ステップ1：レポーターのインストール

まずは、プロジェクトにPlaywright Logbookをインストールする必要があります。ターミナルで以下のコマンドを実行してください：

npm install --save-dev playwright-logbook

ステップ2：Playwrightの設定

次に、 playwright.config.ts ファイルでレポーターを設定する必要があります。設定方法は以下のとおりです：

import { defineConfig } from '@playwright/test';

export default defineConfig({
  reporter: [
    ['list'],
    // Opt-in: capture steps, output tails, and eligible image previews.
    ['playwright-logbook', { captureDetails: true }],
  ],
  use: {
    screenshot: 'only-on-failure',
    trace: 'on-first-retry',
  },
});

この captureDetails オプションにより、追加の診断情報を取得できます。また、 trace: 'on-first-retry' 設定は、最初の再試行が発生した場合にのみトレースを取得します。

ステップ3：テストの実行

これで、Playwrightのテストランナーを使用してテストを実行できるようになりました：

npx playwright test

ステップ4：レポートへのアクセス

テストの実行後、ブラウザで以下のファイルを開くことで生成されたレポートを確認できます：

.logbook/report/index.html

このファイルはサーバーを必要とせず、ローカルで直接アクセスできます。

デバッグ用CLIの活用

焦点を絞ったデバッグを行うために、LogbookのCLIを使用すると特定のテストに関して記録されたエビデンスを含むパケットを生成できます。便利なコマンドをいくつか紹介します：

npx playwright-logbook history --limit 10 --json
npx playwright-logbook summary --run latest --format json
npx playwright-logbook debug --run latest --test YOUR_TEST_ID --format json

必ず YOUR_TEST_ID の部分を、調査したい特定のテスト識別子に置き換えてください。

テスト失敗の調査

テストが失敗した際、Logbookは問題の原因を詳しく調査するのに役立ちます。ステータス、プロジェクト、タグで結果をフィルタリングできます。これにより、記録されたエラーやスタックトレースに加え、再試行前に何が失敗したのかの詳細も確認できます。

「Failures」タブでは類似した記録済みエラーがグループ化されるため、新たな失敗、修正済みのテスト、および依然として失敗しているテストの特定に役立ちます。この情報はデバッグ作業の指針となります。

まとめ

Playwright Logbookは、テストワークフローを強化する強力なツールです。テスト実行に関する詳細なインサイトを提供し、あなたとあなたのチームが問題をより効率的に診断できるよう支援します。

メリット

• 失敗の診断情報を単一のレポートに統合します。
• 再試行と実行履歴を追跡し、より深いインサイトを提供します。
• コーディングアシスタントとのコミュニケーションを円滑にします。
• 特定のテストに焦点を絞ったデバッグパケットを提供します。

デメリット

• インストールと設定が必要です。
• CIへの統合には手動のワークフローが必要になる場合があります。
• テストを自動的に修正したり、AIプロバイダーを呼び出したりすることはありません。

注意事項

この記事は教育目的で作成されています。プレースホルダーの値は実際のプロジェクトの詳細情報に置き換えてください。記述内容を参考にする前に、必ず元の情報源と照らし合わせて確認してください。

よくある質問

• Playwright Logbookとは何ですか？ — テスト実行を追跡し、詳細な失敗診断を提供するオープンソースのレポーターです。
• Playwright Logbookはどのようにインストールしますか？ — npmを使用し、次のコマンドでインストールできます： npm install --save-dev playwright-logbook.
• Playwright Logbookにはどのような機能がありますか？ — 包括的な失敗診断、再試行の追跡、実行履歴、焦点を絞ったデバッグパケットなどの機能を提供します。
• Logbookによって生成されたレポートはどのように表示できますか？ — 次のパスにある .logbook/report/index.html のレポートをブラウザで開くことができます。
• LogbookをCI/CDツールと一緒に使用できますか？ — はい、ただし統合にあたって手動のワークフローに従う必要がある場合があります。
• Logbookはテストの失敗を自動的に修正してくれますか？ — いいえ、LogbookはAIプロバイダーを呼び出したり、テストを自動的に修正したりすることはありません。

タグ

#playwright #testing #opensource #debugging #softwaredevelopment #devtools #automation #programming