Playwright storageState 复用登录态:登录一次,多项目共享会话
问题场景
端到端测试中,如果每条用例都先打开登录页、填表单、等跳转,测试会变慢,也更容易受登录页抖动影响。Playwright 的 storageState 可以把浏览器上下文中的 cookies 与 localStorage 序列化到 JSON 文件。我们只需运行一次登录脚本生成 auth.json,再在 playwright.config.ts 中按项目注入,已登录用例直接复用会话;另外保留一个不注入登录态的项目,专门验证未登录访问会跳转登录页。
本文示例使用占位地址与占位账号,运行前替换成实际应用的选择器与路径。
最小工程结构
project/
scripts/login.mjs
tests/logged-in.spec.ts
tests/guest.spec.ts
playwright.config.ts
auth.json # 运行登录脚本后生成,不应提交
登录脚本:保存 cookies 与 localStorage
新建 scripts/login.mjs。脚本使用 @playwright/test 导出的 chromium,登录成功后调用 context.storageState({ path: 'auth.json' })。注意要等待登录后的页面元素出现,确保应用已经把登录信息写入 localStorage。
// scripts/login.mjs
import { chromium } from '@playwright/test';
const baseURL = process.env.BASE_URL ?? 'http://localhost:3000';
const username = process.env.E2E_USER ?? 'demo_user';
const password = process.env.E2E_PASS ?? 'demo_pass';
const browser = await chromium.launch();
const context = await browser.newContext();
const page = await context.newPage();
await page.goto(`${baseURL}/login`);
await page.getByLabel('用户名').fill(username);
await page.getByLabel('密码').fill(password);
await page.getByRole('button', { name: '登录' }).click();
// 等待登录完成,并等待一个只有登录后才出现的元素
await page.waitForURL('**/dashboard');
await page.getByRole('heading', { name: '工作台' }).waitFor();
// 同时保存 cookies 与当前 origin 下的 localStorage
await context.storageState({ path: 'auth.json' });
await browser.close();
console.log('已保存登录态到 auth.json');
如果应用登录后不会跳到 /dashboard,把 waitForURL 与等待元素换成实际登录成功标志即可。getByLabel('用户名') 等选择器也是占位,需按页面实际 DOM 调整。
配置文件:按项目注入 storageState
playwright.config.ts 中只在需要登录态的项目里设置 storageState: 'auth.json',不要让全局 use 默认注入,这样 guest 项目天然是干净上下文。
// playwright.config.ts
import { defineConfig, devices } from '@playwright/test';
export default defineConfig({
testDir: './tests',
timeout: 30_000,
use: {
baseURL: process.env.BASE_URL ?? 'http://localhost:3000',
trace: 'on-first-retry',
},
projects: [
{
name: 'authenticated',
use: {
...devices['Desktop Chrome'],
storageState: 'auth.json',
},
testMatch: '**/logged-in.spec.ts',
},
{
name: 'guest',
use: {
...devices['Desktop Chrome'],
},
testMatch: '**/guest.spec.ts',
},
],
});
如果全局 use 里已经设置了 storageState,guest 项目必须显式覆盖为空状态:storageState: { cookies: [], origins: [] },否则会继承登录态。
测试用例:已登录与未登录跳转
已登录用例只验证复用会话后能直接进入受保护页面:
// tests/logged-in.spec.ts
import { test, expect } from '@playwright/test';
test('已登录用户可直接进入工作台', async ({ page }) => {
await page.goto('/dashboard');
await expect(page).toHaveURL(/dashboard/);
await expect(page.getByRole('heading', { name: '工作台' })).toBeVisible();
});
未登录跳转用例放在 guest 项目,不注入 auth.json,访问受保护页面后断言 URL 与登录按钮:
// tests/guest.spec.ts
import { test, expect } from '@playwright/test';
test('未登录访问工作台会跳转登录页', async ({ page }) => {
await page.goto('/dashboard');
await page.waitForURL('**/login');
await expect(page).toHaveURL(/login/);
await expect(page.getByRole('button', { name: '登录' })).toBeVisible();
});
这就是验证未登录跳转的最小步骤:干净上下文打开受保护页面,等待重定向到登录页,再断言登录页元素可见。对于 SPA 客户端重定向,不要只检查 HTTP 状态码,应以最终 URL 和页面元素为准。
运行方法
先安装依赖与浏览器,再运行登录脚本,最后执行测试:
npm i -D @playwright/test
npx playwright install chromium
E2E_USER=demo_user E2E_PASS=demo_pass node scripts/login.mjs
npx playwright test --project=authenticated
npx playwright test --project=guest
也可以在 package.json 中串起来:
{
"scripts": {
"e2e": "node scripts/login.mjs && playwright test"
}
}
边界与限制
auth.json含 cookies 等敏感信息,不要提交到仓库,应加入.gitignore;CI 中通过密钥注入账号,运行后清理生成文件。storageState默认只保存 cookies 与 localStorage,不保存 sessionStorage、IndexedDB。如果登录态存在这些位置,需要自定义初始化脚本或 fixture。- 登录态会过期,服务端会话失效后测试会失败。应在失败时重新运行登录脚本,或在 setup 中先校验会话有效性。
- localStorage 按 origin 隔离,登录脚本访问的 origin 必须与测试
baseURL一致,否则注入后读不到。 - 多个测试共享同一个
auth.json时,若用例会修改账户状态,可能互相影响。建议使用独立测试账号,或对相关项目串行执行。 - 登录脚本中的账号密码不要硬编码,使用环境变量或 CI 密钥;示例中的值均为占位。
- 点赞
- 收藏
- 关注作者
评论(0)