分離

はじめに

Playwright で書かれたテストは、ブラウザコンテキストと呼ばれる隔離されたまっさらな環境で実行されます。この分離モデルにより、再現性が向上し、連鎖的なテストの失敗を防ぎます。

テスト分離とは？

テスト分離とは、各テストが他のテストから完全に隔離されている状態を指します。すべてのテストは、他のテストとは独立して実行されます。これは、各テストが独自のローカルストレージ、セッションストレージ、Cookie などを持つことを意味します。Playwright は、インコグニートのようなプロファイルに相当するBrowserContextを使用してこれを実現します。これらは、作成が高速で安価であり、単一のブラウザで実行されている場合でも完全に隔離されています。Playwright は各テストにコンテキストを作成し、そのコンテキスト内にデフォルトのPageを提供します。

テスト分離が重要な理由

• 失敗の持ち越しがない。1つのテストが失敗しても、他のテストに影響を与えません。
• エラーや不安定さのデバッグが簡単です。なぜなら、単一のテストを何度でも実行できるからです。
• 並行実行やシャーディングなどを行う際に、順序を考慮する必要がありません。

テスト分離の2つの方法

テスト分離には、最初からやり直すか、途中でクリーンアップするかの2つの異なる戦略があります。テスト間にクリーンアップを行うことの問題点は、クリーンアップを忘れやすく、「訪問済みリンク」のようにクリーンアップできないものがあることです。あるテストの状態が次のテストに漏れ出し、テストが失敗したり、問題が別のテストから発生するためデバッグが困難になる可能性があります。最初からやり直すということはすべてが新しいということなので、テストが失敗しても、そのテスト内だけを調べればデバッグできます。

Playwright がテスト分離を実現する方法

Playwright はブラウザコンテキストを使用してテスト分離を実現します。各テストには独自のブラウザコンテキストがあります。テストを実行するたびに新しいブラウザコンテキストが作成されます。Playwright をテストランナーとして使用する場合、ブラウザコンテキストはデフォルトで作成されます。それ以外の場合は、ブラウザコンテキストを手動で作成できます。

同期

browser = playwright.chromium.launch()
context = browser.new_context()
page = context.new_page()

非同期

browser = await playwright.chromium.launch()
context = await browser.new_context()
page = await context.new_page()

ブラウザコンテキストは、モバイルデバイス、権限、ロケール、配色を含むマルチページシナリオをエミュレートするためにも使用できます。詳細については、エミュレーションガイドをご覧ください。

単一テスト内の複数のコンテキスト

Playwright は、単一のシナリオ内で複数のブラウザコンテキストを作成できます。これは、チャットのようなマルチユーザー機能をテストする場合に便利です。

同期

from playwright.sync_api import sync_playwright, Playwright

def run(playwright: Playwright):
    # create a chromium browser instance
    chromium = playwright.chromium
    browser = chromium.launch()

    # create two isolated browser contexts
    user_context = browser.new_context()
    admin_context = browser.new_context()

    # create pages and interact with contexts independently

with sync_playwright() as playwright:
    run(playwright)

非同期

import asyncio
from playwright.async_api import async_playwright, Playwright

async def run(playwright: Playwright):
    # create a chromium browser instance
    chromium = playwright.chromium
    browser = await chromium.launch()

    # create two isolated browser contexts
    user_context = await browser.new_context()
    admin_context = await browser.new_context()

    # create pages and interact with contexts independently

async def main():
    async with async_playwright() as playwright:
        await run(playwright)
asyncio.run(main())