Playwright-Konfiguration erklärt
Dieses Kapitel bietet eine ausführliche Einführung inplaywright.config.tsdie verschiedenen Konfigurationen darin, sodass Sie das Testverhalten flexibel an die Projektanforderungen anpassen können.
Übersicht über die Konfigurationsdatei
playwright.config.tsist die zentrale Konfigurationsdatei von Playwright, in der alle Laufzeitparameter für Tests definiert sind.
Beispiel
// Dateipfad: playwright.config.ts
import { defineConfig, devices } from '@playwright/test';
export default defineConfig({
// ===== Grundkonfiguration =====
testDir: './tests',
fullyParallel: true,
forbidOnly: !!process.env.CI,
retries: process.env.CI ? 2 : 0,
workers: process.env.CI ? 1 : undefined,
reporter: 'html',
timeout: 30000,
// ===== Globale gemeinsam genutzte Konfiguration =====
Verwenden Sie: {
baseURL: 'http://localhost:3000',
trace: 'on-first-retry',
screenshot: 'only-on-failure',
video: 'retain-on-failure',
},
// ===== Multi-Browser-Projekte =====
projects: [
{ name: 'chromium', use: { ...devices['Desktop Chrome'] } },
{ name: 'firefox', use: { ...devices['Desktop Firefox'] } },
{ name: 'webkit', use: { ...devices['Desktop Safari'] } },
],
// ===== Webserver =====
webServer: {
command: 'npm run start',
url: 'http://localhost:3000',
reuseExistingServer: !process.env.CI,
},
});
import { defineConfig, devices } from '@playwright/test';
export default defineConfig({
// ===== Grundkonfiguration =====
testDir: './tests',
fullyParallel: true,
forbidOnly: !!process.env.CI,
retries: process.env.CI ? 2 : 0,
workers: process.env.CI ? 1 : undefined,
reporter: 'html',
timeout: 30000,
// ===== Globale gemeinsam genutzte Konfiguration =====
Verwenden Sie: {
baseURL: 'http://localhost:3000',
trace: 'on-first-retry',
screenshot: 'only-on-failure',
video: 'retain-on-failure',
},
// ===== Multi-Browser-Projekte =====
projects: [
{ name: 'chromium', use: { ...devices['Desktop Chrome'] } },
{ name: 'firefox', use: { ...devices['Desktop Firefox'] } },
{ name: 'webkit', use: { ...devices['Desktop Safari'] } },
],
// ===== Webserver =====
webServer: {
command: 'npm run start',
url: 'http://localhost:3000',
reuseExistingServer: !process.env.CI,
},
});
Grundlegende Konfigurationsoptionen
| Konfigurationselement | Type | Standardwert | Beschreibung |
|---|---|---|---|
testDir | string | Tests | Verzeichnis, in dem sich die Testdateien befinden |
fullyParallel | boolesch | false | Ob alle Tests vollständig parallel ausgeführt werden sollen (einschließlich Tests innerhalb derselben Datei) |
workers | number | CPU-Kerne / 2 | Anzahl parallel laufender Worker |
retries | number | 0 | Anzahl der Wiederholungsversuche für fehlgeschlagene Tests |
timeout | number | 30000 | Gesamt-Timeout pro Test (Millisekunden) |
reporter | string/array | Liste | Typ des Test-Reporters |
forbidOnly | boolesch | false | Fehlschlagen, wenn test.only() in CI erkannt wird |
testMatch | string/RegExp | *.spec.(ts\|js) | Muster zum Abgleich von Testdateien |
testIgnore | string/RegExp | - | Ignorierte Testdateimuster |
Konfigurationsbeispiel
Beispiel
export default defineConfig({
// Tests im e2e-Verzeichnis finden
testDir: './e2e',
// Alle Tests vollständig parallel
fullyParallel: true,
// Worker-Anzahl automatisch zuweisen
workers: undefined,
// Keine Wiederholung bei Fehler (lokal) / 2 Wiederholungen (CI)
retries: process.env.CI ? 2 : 0,
// Sowohl Kommandozeilen- als auch HTML-Berichte verwenden
reporter: [
['list'],
['html', { open: 'never' }],
],
});
// Tests im e2e-Verzeichnis finden
testDir: './e2e',
// Alle Tests vollständig parallel
fullyParallel: true,
// Worker-Anzahl automatisch zuweisen
workers: undefined,
// Keine Wiederholung bei Fehler (lokal) / 2 Wiederholungen (CI)
retries: process.env.CI ? 2 : 0,
// Sowohl Kommandozeilen- als auch HTML-Berichte verwenden
reporter: [
['list'],
['html', { open: 'never' }],
],
});
Gemeinsame Konfiguration verwenden
useDie darin enthaltene Konfiguration gilt für alle Tests und Projekte:
| Konfigurationselement | Type | Beschreibung |
|---|---|---|
baseURL | string | Basis-URL, relative Pfade können in Tests verwendet werden (z. B.await page.goto('/login')) |
viewport | {width, height} | Browser-Viewport-Größe, Standard{ width: 1280, height: 720 } |
locale | string | Browsersprache, z. B.'zh-CN'、'en-US' |
timezone | string | Zeitzone, z. B.'Asia/Shanghai' |
colorScheme | string | Farbschema:'light'|'dark'|'no-preference' |
geolocation | {latitude, longitude} | Simulierte Geolokalisierung |
permissions | string[] | Gewährte Browser-Berechtigungen (z. B.['geolocation']) |
userAgent | string | Benutzerdefinierter User-Agent-String |
trace | string | Strategie zur Trace-Erfassung:'on'|'off'|'on-first-retry' |
screenshot | string | Screenshot-Strategie:'on'|'off'|'only-on-failure' |
video | string | Strategie für Videoaufzeichnung:'on'|'off'|'retain-on-failure' |
storageState | string | Pfad zur Datei mit dem Authentifizierungsstatus |
testIdAttribute | string | Benutzerdefinierter testId-Attributname, Standardwert'data-testid' |
actionTimeout | number | Timeout für jede Operation (click, fill) |
navigationTimeout | number | Timeout für jede Navigation |
webServer-Konfiguration
webServerDie Konfiguration ermöglicht es Playwright, automatisch deinen Entwicklungsserver zu starten, bevor Tests ausgeführt werden:
Beispiel
export default defineConfig({
webServer: {
// Startbefehl
command: 'npm run dev',
// Warten, bis diese URL erreichbar ist, bevor Tests ausgeführt werden
url: 'http://localhost:5173',
// Timeout-Wartedauer (Millisekunden)
timeout: 120000,
// Ob ein bereits laufender Server wiederverwendet werden soll (lokal wiederverwenden, auf CI neu starten)
reuseExistingServer: !process.env.CI,
},
});
webServer: {
// Startbefehl
command: 'npm run dev',
// Warten, bis diese URL erreichbar ist, bevor Tests ausgeführt werden
url: 'http://localhost:5173',
// Timeout-Wartedauer (Millisekunden)
timeout: 120000,
// Ob ein bereits laufender Server wiederverwendet werden soll (lokal wiederverwenden, auf CI neu starten)
reuseExistingServer: !process.env.CI,
},
});
globalSetup / globalTeardown Globale Hooks
Wird einmal vor/nach allen Testläufen ausgeführt, geeignet für Vorgänge wie die Datenbankinitialisierung.
Beispiel
export default defineConfig({
globalSetup: './global-setup.ts',
globalTeardown: './global-teardown.ts',
});
globalSetup: './global-setup.ts',
globalTeardown: './global-teardown.ts',
});
Beispiel
// Dateipfad: global-setup.ts
import { FullConfig } from '@playwright/test';
async function globalSetup(config: FullConfig) {
// Wird vor allen Testläufen ausgeführt
console.log('Starting global setup...');
// Zum Beispiel: Testdatenbank initialisieren, Testbenutzer erstellen usw.
}
export default globalSetup;
import { FullConfig } from '@playwright/test';
async function globalSetup(config: FullConfig) {
// Wird vor allen Testläufen ausgeführt
console.log('Starting global setup...');
// Zum Beispiel: Testdatenbank initialisieren, Testbenutzer erstellen usw.
}
export default globalSetup;