Authentification avec Playwright
Ce chapitre présente comment gérer l'authentification dans Playwright, en évitant les connexions répétées pour chaque test tout en maintenant l'isolation des tests.
Le problème central de l'authentification
La plupart des tests d'applications web nécessitent la connexion de l'utilisateur.
Si chaque test exécute le flux de connexion depuis le début, cela ralentira considérablement l'exécution des tests.
La solution de Playwright est :Authentifiez-vous une fois, enregistrez l'état et faites en sorte que tous les tests le réutilisent.。
Préparation : répertoire .auth
Exemple
mkdir -p playwright/.auth
# Ajouter à .gitignore (l'état d'authentification contient des informations sensibles)
echo 'playwright/.auth' >> .gitignore
.authLe fichier contient des cookies sensibles et des jetons d'authentification,et ne doit jamais être commité dans le dépôt de code.。
Approche de base : compte partagé + projet de configuration
Il s'agit de l'approche d'authentification recommandée par Playwright, adaptée aux scénarios où tous les tests partagent le même compte de test.
Étape 1 : Créer la configuration d'authentification
Exemple
import { test as setup } from '@playwright/test';
// Spécifier le chemin de sauvegarde de l'état d'authentification
const authFile = 'playwright/.auth/user.json';
setup('authenticate', async ({ page }) => {
// Effectuer l'opération de connexion
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();
// Attendre la fin de la connexion (confirmer la navigation de la page ou l'apparition des informations utilisateur)
await page.waitForURL(/dashboard/);
// Enregistrer l'état d'authentification actuel (cookies, localStorage) dans un fichier
await page.context().storageState({ path: authFile });
});
Étape 2 : Configurer le projet d'installation
Exemple
import { defineConfig } from '@playwright/test';
export default defineConfig({
projects: [
// Projet setup — ne s'exécute qu'une seule fois, génère le fichier d'état d'authentification
{
name: 'setup',
testMatch: /auth\.setup\.ts/,
},
// Projet de test réel — réutilise l'état d'authentification
{
name: 'chromium',
use: {
storageState: 'playwright/.auth/user.json',
},
dependencies: ['setup'], // Dépend du projet setup, garantissant que setup s'exécute en premier
},
],
});
Étape 3 : Les tests utilisent directement l'état d'authentification
Exemple
import { test, expect } from '@playwright/test';
test('Voir le tableau de bord', async ({ page }) => {
// Accéder directement à une page qui nécessite une connexion ; la page porte déjà l'état d'authentification
await page.goto('/dashboard');
await expect(page.getByText('Welcome back, testuser')).toBeVisible();
});
Scénario multi-comptes
Si différents tests doivent utiliser différents comptes, vous pouvez créer plusieurs fichiers d'état d'authentification.
Exemple
test.describe('Admin features', () => {
test.use({ storageState: 'playwright/.auth/admin.json' });
test('Manage users', async ({ page }) => {
// Effectuer des actions en tant qu'administrateur
});
});
// Test utilisateur standard
test.describe('Regular user features', () => {
test.use({ storageState: 'playwright/.auth/user.json' });
test('Parcourir le contenu', async ({ page }) => {
// Effectuer des actions en tant qu'utilisateur standard
});
});
Authentification via requête API (recommandé)
L'exécution du flux de connexion via l'UI est lente ; une méthode plus efficace consiste à appeler directement l'API de connexion.
Exemple
import { test as setup } from '@playwright/test';
const authFile = 'playwright/.auth/user.json';
setup('Authentification via API', async ({ request }) => {
// Appeler directement l'API de connexion, et non via l'interface utilisateur du navigateur
const response = await request.post('https://www.example.com/api/login', {
data: {
username: 'testuser',
password: 'password123',
},
});
// Confirmer la réussite de la connexion
const json = await response.json();
console.log('Connexion réussie, jeton :', json.token);
// Enregistrer le jeton en tant que cookie (simulation de l'état d'authentification du navigateur)
// Remarque : storageState doit être enregistré dans le contexte du navigateur
});
L'authentification API est plus rapide et plus fiable que l'authentification UI, et il est recommandé de l'utiliser en priorité dans les projets réels.
Résumé des scénarios applicables pour les approches d'authentification
| Scénario | Approche recommandée |
|---|---|
| Tous les tests utilisent le même compte de test | Projet de configuration + storageState |
| Différents types de tests nécessitent différents comptes | Plusieurs storageState + test.use |
| Chaque test nécessite un compte indépendant | Créer un compte et se connecter via API dans chaque test |
| Ressources de compte limitées | S'authentifier une fois dans le projet Setup, réutiliser pour tous |