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

認証

はじめに​

Playwrightは、ブラウザコンテキストと呼ばれる分離された環境でテストを実行します。この分離モデルは再現性を向上させ、連鎖的なテスト失敗を防ぎます。テストは既存の認証済み状態をロードできます。これにより、すべてのテストで認証を行う必要がなくなり、テスト実行が高速化されます。

コアコンセプト​

選択する認証戦略に関係なく、認証されたブラウザの状態をファイルシステムに保存する可能性があります。

`playwright/.auth` ディレクトリを作成し、それを `.gitignore` に追加することをお勧めします。認証ルーチンは、認証されたブラウザの状態を生成し、この `playwright/.auth` ディレクトリ内のファイルに保存します。後で、テストはこの状態を再利用し、認証された状態で開始されます。

mkdir -p playwright/.auth
echo $'\nplaywright/.auth' >> .gitignore

各テストの前にサインインする​

Playwright APIは、ログインフォームとのインタラクションを自動化できます。

次の例はGitHubにログインします。これらのステップが実行されると、ブラウザコンテキストは認証されます。

Page page = context.newPage();
page.navigate("https://github.com/login");
// Interact with login form
page.getByLabel("Username or email address").fill("username");
page.getByLabel("Password").fill("password");
page.getByRole(AriaRole.BUTTON, new Page.GetByRoleOptions().setName("Sign in"))
    .click();
// Continue with the test

すべてのテストでログインをやり直すと、テストの実行速度が低下する可能性があります。それを軽減するために、代わりに既存の認証状態を再利用してください。

サインイン状態の再利用​

Playwrightは、テストでサインイン状態を再利用する方法を提供します。そうすることで、一度だけログインし、その後、すべてのテストでログインステップをスキップできます。

Webアプリは、Cookieベースまたはトークンベースの認証を使用しており、認証された状態はCookie、ローカルストレージ、またはIndexedDBに保存されます。Playwrightは、認証されたコンテキストからストレージ状態を取得し、事前設定された状態で新しいコンテキストを作成するために使用できるBrowserContext.storageState()メソッドを提供します。

Cookie、ローカルストレージ、およびIndexedDBの状態は、異なるブラウザ間で使用できます。これらは、Cookie、ローカルストレージ、またはIndexedDBの組み合わせが必要になる場合があるアプリケーションの認証モデルに依存します。

次のコードスニペットは、認証されたコンテキストから状態を取得し、その状態で新しいコンテキストを作成します。

// Save storage state into the file.
context.storageState(new BrowserContext.StorageStateOptions().setPath(Paths.get("state.json")));

// Create a new context with the saved storage state.
BrowserContext context = browser.newContext(
  new Browser.NewContextOptions().setStorageStatePath(Paths.get("state.json")));

高度なシナリオ​

セッションストレージ​

認証済み状態の再利用は、Cookie、ローカルストレージ、およびIndexedDBベースの認証をカバーします。まれに、セッションストレージがサインイン状態に関連付けられた情報を格納するために使用されます。セッションストレージは特定のドメインに固有であり、ページロード間で永続化されません。Playwrightはセッションストレージを永続化するためのAPIを提供していませんが、次のスニペットを使用してセッションストレージを保存/ロードできます。

// Get session storage and store as env variable
String sessionStorage = (String) page.evaluate("JSON.stringify(sessionStorage)");
System.getenv().put("SESSION_STORAGE", sessionStorage);

// Set session storage in a new context
String sessionStorage = System.getenv("SESSION_STORAGE");
context.addInitScript("(storage => {\n" +
  "  if (window.location.hostname === 'example.com') {\n" +
  "    const entries = JSON.parse(storage);\n" +
  "     for (const [key, value] of Object.entries(entries)) {\n" +
  "      window.sessionStorage.setItem(key, value);\n" +
  "    };\n" +
  "  }\n" +
  "})('" + sessionStorage + "')");