跳到主要内容

身份验证

简介​

Playwright 在称为浏览器上下文的隔离环境中执行测试。这种隔离模型提高了可重现性并防止级联测试失败。测试可以加载现有的身份验证状态。这消除了在每个测试中进行身份验证的需要，并加快了测试执行速度。

核心概念​

无论您选择哪种身份验证策略，您都可能将经过身份验证的浏览器状态存储在文件系统中。

我们建议创建 playwright/.auth 目录并将其添加到您的 .gitignore 中。您的身份验证例程将生成经过身份验证的浏览器状态，并将其保存到此 playwright/.auth 目录中的文件中。稍后，测试将重用此状态并以已验证身份开始。

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

在每个测试之前登录​

Playwright API 可以自动化与登录表单的交互。

以下示例登录到 GitHub。一旦执行这些步骤，浏览器上下文将被验证。

page = context.new_page()
page.goto('https://github.com/login')

# Interact with login form
page.get_by_label("Username or email address").fill("username")
page.get_by_label("Password").fill("password")
page.get_by_role("button", name="Sign in").click()
# Continue with the test

为每个测试重新登录可能会减慢测试执行速度。为了缓解这种情况，请改为重用现有的身份验证状态。

重用已登录状态​

Playwright 提供了一种在测试中重用已登录状态的方法。这样，您只需登录一次，然后跳过所有测试的登录步骤。

Web 应用程序使用基于 cookie 或基于令牌的身份验证，其中身份验证状态存储为 cookie、本地存储或 IndexedDB。Playwright 提供了 browser_context.storage_state() 方法，可用于从经过身份验证的上下文中检索存储状态，然后创建具有预填充状态的新上下文。

Cookies、本地存储和 IndexedDB 状态可以在不同的浏览器之间使用。它们取决于您的应用程序的身份验证模型，该模型可能需要 cookies、本地存储或 IndexedDB 的某种组合。

以下代码片段从经过身份验证的上下文中检索状态，并使用该状态创建一个新的上下文。

# Save storage state into the file.
storage = context.storage_state(path="state.json")

# Create a new context with the saved storage state.
context = browser.new_context(storage_state="state.json")

高级场景​

会话存储​

重用身份验证状态涵盖了基于 cookies、本地存储和 IndexedDB 的身份验证。极少数情况下，会话存储用于存储与已登录状态相关的信息。会话存储特定于特定域，并且不会跨页面加载持久保存。Playwright 不提供 API 来持久保存会话存储，但可以使用以下代码片段来保存/加载会话存储。

import os
# Get session storage and store as env variable
session_storage = page.evaluate("() => JSON.stringify(sessionStorage)")
os.environ["SESSION_STORAGE"] = session_storage

# Set session storage in a new context
session_storage = os.environ["SESSION_STORAGE"]
context.add_init_script("""(storage => {
  if (window.location.hostname === 'example.com') {
    const entries = JSON.parse(storage)
    for (const [key, value] of Object.entries(entries)) {
      window.sessionStorage.setItem(key, value)
    }
  }
})('""" + session_storage + "')")