メインコンテンツへスキップ

スナップショットテスト

概要​

Playwright のスナップショットテストを使用すると、ページのアクセシビリティツリーを事前に定義されたスナップショットテンプレートに対してアサートできます。

await page.GotoAsync("https://playwright.dokyumento.jp/");
await Expect(page.Locator("banner")).ToMatchAriaSnapshotAsync(@"
  - banner:
    - heading ""Playwright enables reliable end-to-end testing for modern web apps."" [level=1]
    - link ""Get started""
    - link ""Star microsoft/playwright on GitHub""
    - link /[\\d]+k\\+ stargazers on GitHub/
");

アサーションテスト vs スナップショットテスト​

スナップショットテストとアサーションテストは、テスト自動化において異なる目的を果たします。

アサーションテスト​

アサーションテストは、要素またはコンポーネントに関する特定の値または条件をアサートするターゲットを絞ったアプローチです。たとえば、Playwright では、Expect(Locator).ToHaveTextAsync() は要素に期待されるテキストが含まれていることを検証し、Expect(Locator).ToHaveValueAsync() は入力フィールドに期待される値があることを確認します。アサーションテストは具体的であり、一般的に要素またはプロパティの現在の状態を、期待される事前定義された状態に対してチェックします。これらは、予測可能で単一値のチェックには適していますが、より広範な構造やバリエーションをテストする場合には範囲が限られます。

利点

  • 明確さ: テストの意図は明確で理解しやすいです。
  • 具体性: テストは機能の特定のアスペクトに焦点を当てているため、無関係な変更に対してより堅牢になります。
  • デバッグ: エラーはターゲットを絞ったフィードバックを提供し、問題のあるアスペクトを直接示します。

欠点

  • 複雑な出力には冗長: 複雑なデータ構造または大きな出力のアサーションを記述するのは面倒で、エラーが発生しやすい可能性があります。
  • メンテナンスのオーバーヘッド: コードが進化するにつれて、アサーションを手動で更新するのは時間がかかる可能性があります。

スナップショットテスト​

スナップショットテストは、要素、コンポーネント、またはデータの全体的な状態の「スナップショット」または表現を特定の瞬間にキャプチャし、将来の比較のために保存されます。テストを再実行すると、現在の状態がスナップショットと比較され、違いがある場合はテストが失敗します。このアプローチは、複雑または動的な構造に特に役立ちます。そこでは、各詳細を手動でアサートすることは時間がかかりすぎます。スナップショットテストは、アサーションテストよりも広範囲で全体論的であり、時間の経過とともに、より複雑な変更を追跡できます。

利点

  • 複雑な出力を簡素化: たとえば、UI コンポーネントのレンダリングされた出力をテストすることは、従来のアサーションでは面倒な場合があります。スナップショットは、簡単な比較のために出力全体をキャプチャします。
  • 迅速なフィードバックループ: 開発者は、出力の意図しない変更を簡単に見つけることができます。
  • 一貫性を促進: コードが進化するにつれて、一貫した出力を維持するのに役立ちます。

欠点

  • 過度の依存: 完全に理解せずにスナップショットへの変更を受け入れてしまう誘惑に駆られ、バグを隠してしまう可能性があります。
  • 粒度: 大きなスナップショットは、特に小さな変更が出力の大部分に影響を与える場合、違いが発生したときに解釈するのが難しい場合があります。
  • 適合性: 出力が頻繁または予測不可能に変化する高度に動的なコンテンツには理想的ではありません。

いつ使用するか​

  • スナップショットテストは以下に最適です
    • ページとコンポーネント全体の UI テスト。
    • 複雑な UI コンポーネントの広範な構造チェック。
    • 構造がめったに変更されない出力のリグレッションテスト。
  • アサーションテストは以下に最適です
    • コアロジックの検証。
    • 計算値のテスト。
    • 正確な条件を必要とするきめ細かいテスト。

広範な構造チェックのためのスナップショットテストと、特定の機能のためのアサーションテストを組み合わせることで、バランスの取れたテスト戦略を実現できます。

Aria スナップショット​

Playwright では、aria スナップショットは、ページのアクセシビリティツリーの YAML 表現を提供します。これらのスナップショットを保存して後で比較し、ページ構造が一貫性を保っているか、定義された期待を満たしているかを確認できます。

YAML 形式は、ページ上のアクセス可能な要素の階層構造を記述し、ロール、属性、値、およびテキストコンテンツを詳細に示します。構造はツリー状の構文に従い、各ノードがアクセス可能な要素を表し、インデントはネストされた要素を示します。

ツリー内の各アクセス可能な要素は、YAML ノードとして表されます

- role "name" [attribute=value]
  • ロール: 要素の ARIA または HTML ロールを指定します (例: heading、list、listitem、button)。
  • "name": 要素のアクセス可能な名前。引用符で囲まれた文字列は正確な値を示し、/patterns/ は正規表現に使用されます。
  • [attribute=value]: 属性と値 (角括弧内) は、checked、disabled、expanded、level、pressed、または selected などの特定の ARIA 属性を表します。

これらの値は、ARIA 属性から派生するか、HTML セマンティクスに基づいて計算されます。ページのアクセシビリティツリー構造を検査するには、Chrome DevTools アクセシビリティパネルを使用します。

スナップショットマッチング​

Playwright の Expect(Locator).ToMatchAriaSnapshotAsync() アサーションメソッドは、ロケータースコープのアクセス可能な構造を事前に定義された aria スナップショットテンプレートと比較し、ページのステートをテスト要件に対して検証するのに役立ちます。

次の DOM の場合

<h1>title</h1>

次のスナップショットテンプレートを使用してマッチングできます

await Expect(page.Locator("body")).ToMatchAriaSnapshotAsync(@"
  - heading ""title""
");

マッチング時、スナップショットテンプレートはページの現在のアクセシビリティツリーと比較されます

  • ツリー構造がテンプレートと一致する場合、テストは合格します。それ以外の場合は失敗し、期待されるアクセシビリティ状態と実際のアクサシビリティ状態の不一致を示します。
  • 比較は大文字と小文字を区別し、空白を折りたたみます。そのため、インデントと改行は無視されます。
  • 比較は順序依存です。つまり、スナップショットテンプレート内の要素の順序は、ページのアクセシビリティツリー内の順序と一致する必要があります。

部分一致​

属性またはアクセス可能な名前を省略することで、ノードに対して部分一致を実行できます。これにより、正確な一致を必要とせずに、アクセシビリティツリーの特定の部分の検証が可能になります。この柔軟性は、動的または無関係な属性に役立ちます。

<button>Submit</button>

aria スナップショット

- button

この例では、button ロールが一致していますが、アクセス可能な名前 ("Submit") は指定されていないため、ボタンのラベルに関係なくテストは合格します。

checked や disabled などの ARIA 属性を持つ要素の場合、これらの属性を省略すると部分一致が可能になり、ロールと階層のみに焦点を当てることができます。

<input type="checkbox" checked>

部分一致の aria スナップショット

- checkbox

この部分一致では、checked 属性は無視されるため、チェックボックスの状態に関係なくテストは合格します。

同様に、特定リストアイテムまたはネストされた要素を省略することで、リストまたはグループ内の子を部分的に一致させることができます。

<ul>
  <li>Feature A</li>
  <li>Feature B</li>
  <li>Feature C</li>
</ul>

部分一致の aria スナップショット

- list
  - listitem: Feature B

部分一致を使用すると、特定のコンテンツまたは属性を強制することなく、本質的なページ構造を検証する柔軟なスナップショットテストを作成できます。

正規表現によるマッチング​

正規表現を使用すると、動的または可変テキストを持つ要素に対して柔軟なマッチングが可能になります。アクセス可能な名前とテキストは、正規表現パターンをサポートできます。

<h1>Issues 12</h1>

正規表現を使用した aria スナップショット

- heading /Issues \d+/

スナップショットの生成​

Playwright で aria スナップショットを作成すると、アプリケーションの構造を確実にし、維持するのに役立ちます。テストのセットアップとワークフローに応じて、さまざまな方法でスナップショットを生成できます。

Playwright コードジェネレーターを使用したスナップショットの生成​

Playwright の コードジェネレーターを使用している場合、aria スナップショットの生成は、そのインタラクティブなインターフェイスで合理化されています

  • "スナップショットをアサート" アクション: コードジェネレーターでは、"スナップショットをアサート" アクションを使用して、選択した要素のスナップショットアサーションを自動的に作成できます。これは、記録されたテストフローの一部として aria スナップショットをキャプチャする簡単な方法です。
  • "Aria スナップショット" タブ: コードジェネレーターインターフェイス内の "Aria スナップショット" タブは、選択されたロケーターの aria スナップショットを視覚的に表現し、要素のロール、属性、およびアクセス可能な名前を調べて、スナップショットの作成とレビューを支援できます。

Locator.ariaSnapshot メソッドの使用​

Locator.AriaSnapshotAsync() メソッドを使用すると、ロケータースコープ内のアクセス可能な要素の YAML 表現をプログラムで作成できます。これは、テスト実行中にスナップショットを動的に生成する場合に特に役立ちます。

例:

var snapshot = await page.Locator("body").AriaSnapshotAsync();
Console.WriteLine(snapshot);

このコマンドは、指定されたロケータースコープ内の aria スナップショットを YAML 形式で出力します。これは、必要に応じて検証または保存できます。

アクセシビリティツリーの例​

レベル属性を持つ見出し​

見出しには、見出しレベルを示す level 属性を含めることができます。

<h1>Title</h1>
<h2>Subtitle</h2>

aria スナップショット

- heading "Title" [level=1]
- heading "Subtitle" [level=2]

テキストノード​

スタンドアロンまたは説明的なテキスト要素は、テキストノードとして表示されます。

<div>Sample accessible name</div>

aria スナップショット

- text: Sample accessible name

インライン複数行テキスト​

段落などの複数行テキストは、aria スナップショットで正規化されます。

<p>Line 1<br>Line 2</p>

aria スナップショット

- paragraph: Line 1 Line 2

リンクは、テキストまたは疑似要素から構成されたコンテンツを表示します。

<a href="#more-info">Read more about Accessibility</a>

aria スナップショット

- link "Read more about Accessibility"

テキストボックス​

text タイプの入力要素は、value 属性の内容を表示します。

<input type="text" value="Enter your name">

aria スナップショット

- textbox: Enter your name

アイテム付きリスト​

順序付きリストと順序なしリストには、リストアイテムが含まれています。

<ul aria-label="Main Features">
  <li>Feature 1</li>
  <li>Feature 2</li>
</ul>

aria スナップショット

- list "Main Features":
  - listitem: Feature 1
  - listitem: Feature 2

グループ化された要素​

グループは、概要コンテンツを含む <details> 要素などのネストされた要素をキャプチャします。

<details>
  <summary>Summary</summary>
  <p>Detail content here</p>
</details>

aria スナップショット

- group: Summary

属性と状態​

checked、disabled、expanded、level、pressed、selected などの一般的に使用される ARIA 属性は、コントロールの状態を表します。

checked 属性を持つチェックボックス​

<input type="checkbox" checked>

aria スナップショット

- checkbox [checked]

pressed 属性を持つボタン​

<button aria-pressed="true">Toggle</button>

aria スナップショット

- button "Toggle" [pressed=true]