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

スナップショットテスト

概要​

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

page.goto('https://playwright.dokyumento.jp/')
expect(page.query_selector('banner')).to_match_aria_snapshot("""
  - banner:
    - heading /Playwright enables reliable end-to-end/ [level=1]
    - link "Get started"
    - link "Star microsoft/playwright on GitHub"
    - link /[\\d]+k\\+ stargazers on GitHub/
""")

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

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

アサーションテスト​

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

利点

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

欠点

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

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

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

利点

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

欠点

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

いつ使用するか​

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

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

Ariaスナップショット​

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

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

ツリー内の各アクセシブルな要素は YAML ノードとして表されます

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

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

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

Playwright の expect(locator).to_match_aria_snapshot() アサーションメソッドは、ロケータースコープのアクセシブルな構造を定義済みの aria スナップショットテンプレートと比較し、ページのstateがテスト要件に対して有効であることを検証するのに役立ちます。

次の DOM の場合

<h1>title</h1>

次のスナップショットテンプレートを使用して一致させることができます

expect(page.locator("body")).to_match_aria_snapshot("""
  - 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.aria_snapshot() メソッドを使用すると、特にテスト実行中にスナップショットを動的に生成する場合に役立ち、ロケータースコープ内のアクセシブルな要素の YAML 表現をプログラムで作成できます。

例:

snapshot = page.locator("body").aria_snapshot()
print(snapshot)

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

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

level 属性を持つ見出し​

見出しには、見出しレベルを示す 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 タイプの input 要素は、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]