Аутентификация в Playwright
В этой главе рассказывается, как обрабатывать аутентификацию в Playwright, избегая повторных входов для каждого теста, сохраняя при этом изоляцию тестов.
Основная проблема аутентификации
Большинство тестов веб-приложений требуют входа пользователя.
Если каждый тест выполняет процесс входа с нуля, это значительно замедлит выполнение тестов.
Решение Playwright:Аутентифицируйтесь один раз, сохраните состояние, и все тесты будут его повторно использовать.。
Подготовка: каталог .auth
Пример
mkdir -p playwright/.auth
# Добавить в .gitignore (состояние аутентификации содержит конфиденциальную информацию)
echo 'playwright/.auth' >> .gitignore
.authФайл содержит конфиденциальные cookies и токены аутентификации,и его никогда не следует коммитить в репозиторий кода.。
Базовый подход: общая учётная запись + проект настройки
Это рекомендуемый в Playwright подход к аутентификации, подходящий для сценариев, в которых все тесты используют одну и ту же тестовую учётную запись.
Шаг 1: Создание настройки аутентификации
Пример
import { test as setup } from '@playwright/test';
// Укажите путь сохранения состояния аутентификации
const authFile = 'playwright/.auth/user.json';
setup('authenticate', async ({ page }) => {
// Выполнить операцию входа
await page.goto('https://www.example.com/login');
await page.getByLabel('username').fill('testuser');
await page.getByLabel('password').fill('password123');
await page.getByRole('button', { name: 'Login' }).click();
// Ожидать завершения входа (подтвердить переход страницы или появление информации о пользователе)
await page.waitForURL(/dashboard/);
// Сохранить текущее состояние аутентификации (cookies, localStorage) в файл
await page.context().storageState({ path: authFile });
});
Шаг 2: Настройка проекта Setup
Пример
import { defineConfig } from '@playwright/test';
export default defineConfig({
projects: [
// Проект setup — выполняется только один раз, генерирует файл состояния аутентификации
{
name: 'setup',
testMatch: /auth\.setup\.ts/,
},
// Основной тестовый проект — повторно использует состояние аутентификации
{
name: 'chromium',
использовать: {
storageState: 'playwright/.auth/user.json',
},
dependencies: ['setup'], // Зависит от проекта setup, гарантируя, что setup выполнится первым
},
],
});
Шаг 3: Тесты напрямую используют состояние аутентификации
Пример
import { test, expect } from '@playwright/test';
test('Просмотр панели управления', async ({ page }) => {
// Прямой доступ к странице, требующей входа; страница уже содержит состояние аутентификации
await page.goto('/dashboard');
await expect(page.getByText('С возвращением, testuser')).toBeVisible();
});
Сценарий с несколькими учётными записями
Если разным тестам нужно использовать разные учётные записи, вы можете создать несколько файлов состояния аутентификации.
Пример
test.describe('Функции администратора', () => {
test.use({ storageState: 'playwright/.auth/admin.json' });
test('Управление пользователями', async ({ page }) => {
// Выполнить действия от имени администратора
});
});
// Тест обычного пользователя
test.describe('Функции обычного пользователя', () => {
test.use({ storageState: 'playwright/.auth/user.json' });
test('Просмотр контента', async ({ page }) => {
// Выполнять действия от имени обычного пользователя
});
});
Аутентификация через API-запрос (рекомендуется)
Выполнение процесса входа через UI медленное; более эффективный способ — напрямую вызвать API входа.
Пример
import { test as setup } from '@playwright/test';
const authFile = 'playwright/.auth/user.json';
setup('Аутентификация через API', async ({ request }) => {
// Вызвать API входа напрямую, а не через UI браузера
const response = await request.post('https://www.example.com/api/login', {
data: {
username: 'testuser',
password: 'password123',
},
});
// Убедиться в успешном входе
const json = await response.json();
console.log('Вход выполнен успешно, токен:', json.token);
// Сохранить токен как cookie (имитация состояния аутентификации браузера)
// Примечание: storageState необходимо сохранить в контексте браузера
});
Аутентификация через API быстрее и надёжнее, чем аутентификация через UI, и её рекомендуется использовать в первую очередь в реальных проектах.
Обзор применимых сценариев для подходов к аутентификации
| Сценарий | Рекомендуемый подход |
|---|---|
| Все тесты используют одну и ту же тестовую учётную запись | Проект настройки + storageState |
| Разным типам тестов требуются разные учётные записи | Несколько storageState + test.use |
| Каждому тесту нужна независимая учётная запись | Создавать учётную запись и выполнять вход через API в каждом тесте |
| Ограниченные ресурсы учетной записи | Аутентифицируйтесь один раз в проекте Setup и используйте повторно для всех |