Playwright Codegen テスト生成器
この章では、Playwright のコマンドラインテスト生成ツール Codegen を紹介します。ブラウザ操作によってテストコードを自動生成します。
Codegen とは
Codegen(コードジェネレーター)は、Playwright に組み込まれたインタラクティブなテスト生成ツールです。
あなたが通常のユーザーのようにブラウザを操作すると、Codegen はその操作を自動的に Playwright テストコードに変換します。
Codegen を起動
# 基本用法:打开一个 URL 并开始录制 npx playwright codegen https://www.example.com/ # 指定代码生成的语言(默认 TypeScript) npx playwright codegen --target=javascript https://www.example.com/ npx playwright codegen --target=python https://www.example.com/
起動すると、2つのウィンドウが開きます。
- ブラウザウィンドウ:このウィンドウでページを操作します。
- Playwright Inspector ウィンドウ:生成されたコードをリアルタイムに表示します。
操作の記録
ブラウザウィンドウで任意の操作を行うと、Codegen は対応する Playwright コードを自動生成します。
ナビゲーション
アドレスバーに新しい URL を入力して Enter キーを押すと、page.goto()ステートメントが生成されます。
クリック
任意の要素(ボタン、リンク、メニュー)をクリックすると、page.getByRole(...).click()または類似の位置特定+クリックコードが生成されます。
入力
入力ボックスにテキストを入力すると、生成されます。page.getByLabel(...).fill(...) 或 page.getByPlaceholder(...).fill(...)。
選択
ドロップダウンメニューでオプションを選択すると、生成されます。page.getByLabel(...).selectOption(...)。
チェックボックス
チェックボックスをチェックまたはチェック解除すると、生成されます。page.getByLabel(...).check() 或 .uncheck()。
最適な Locator を自動選択
Codegen はページ要素の属性を分析し、以下の優先順位で Locator を生成します。
getByRole()—— 要素に明確な ARIA ロールがあるgetByText()—— 要素に明確なテキスト内容があるgetByLabel()—— フォーム要素にラベルが関連付けられているgetByPlaceholder()—— 入力ボックスにプレースホルダーがあるgetByAltText()—— 画像に alt 属性があるgetByTestId()—— 要素に data-testid があるgetByTitle()—— 要素に title 属性があるlocator()—— CSS セレクター(最終手段)
Codegen が複数の一致する要素を見つけた場合、ターゲット要素を一意に特定できるまで Locator を自動的に最適化します。
アサーションの生成
Inspector ウィンドウのツールバーでは、アサーションボタンをクリックしてアサーションコードを生成できます。
- Assert Visibility—— クリック後、要素を選択して生成します。
await expect(locator).toBeVisible() - Assert Text—— 生成します
await expect(locator).toHaveText(...) - Assert Value—— 生成します
await expect(locator).toHaveValue(...) - Assert Snapshot—— 生成します
await expect(locator).toHaveScreenshot()
よく使う Codegen オプション
| オプション | 説明 |
|---|---|
--target=javascript | JavaScript コードを生成(デフォルトは TypeScript) |
--target=python | Python コードを生成 |
--target=java | Java コードを生成 |
--target=csharp | C# コードを生成 |
--save-storage=auth.json | 記録終了後に認証状態を保存 |
--load-storage=auth.json | 既存の認証状態を読み込んでから記録 |
-o tests/test.spec.ts | 出力ファイルを指定(デフォルトはターミナルに出力) |
--viewport-size=375,812 | ビューポートサイズをカスタマイズ(モバイル端末をシミュレート) |
--device="iPhone 15" | デバイスプリセットを使用 |
--color-scheme=dark | カラースキーム(配色)を指定 |
Codegen vs VS Code 記録の選択
| 方法 | 適用シナリオ |
|---|---|
| VS Code Record New | 日常のテスト開発。コードが直接エディタに入り、すぐに修正できる。 |
| Codegen コマンドライン | クイックプロトタイプ、言語をまたいだコード生成、IDE に依存しない。 |