Playwright-Projektstruktur
Nach erfolgreicher Initialisierung eines Playwright-Projekts werden in Ihrem Projektverzeichnis eine Reihe von Dateien und Ordnern generiert. Dieses Kapitel erklärt detailliert den Zweck jedes einzelnen Teils.
Überblick über die initialisierte Projektstruktur
Führen Sienpm init playwright@latestDanach wird die folgende Struktur im Projektverzeichnis generiert:
your-project/ ├── playwright.config.ts # Playwright 配置文件 ├── package.json # 项目依赖与脚本 ├── package-lock.json # 依赖锁定文件 ├── tests/ # 测试文件目录 │ └── example.spec.ts # 示例测试文件 ├── tests-examples/ # 更多示例测试(可选) │ └── demo-todo-app.spec.ts ├── .github/ # GitHub Actions 配置(可选) │ └── workflows/ │ └── playwright.yml └── node_modules/ # npm 依赖包
playwright.config.ts — Konfigurationsdatei
Dies ist die zentrale Konfigurationsdatei für Playwright, die alle Aspekte des Testlaufs steuert.
Beispiel
import { defineConfig, devices } from '@playwright/test';
export default defineConfig({
// Verzeichnis für Testdateien, relativ zu dieser Konfigurationsdatei
testDir: './tests',
// Alle Tests vollständig parallel ausführen
fullyParallel: true,
// Wenn test.only im Quellcode verbleibt, schlägt der Build in CI fehl
forbidOnly: !!process.env.CI,
// Bei Fehler in der CI-Umgebung 2-mal wiederholen, lokal nicht wiederholen
retries: process.env.CI ? 2 : 0,
// In der CI-Umgebung einen einzelnen Worker verwenden und lokal standardmäßig mehrere Worker
workers: process.env.CI ? 1 : undefined,
// Den HTML-Reporter verwenden
reporter: 'html',
// Gemeinsame Konfiguration für alle Tests
Verwenden Sie: {
// Basis-URL, in Tests einfach relative Pfade verwenden
baseURL: 'http://localhost:3000',
// Trace bei Wiederholung nach Fehler sammeln
trace: 'on-first-retry',
},
// Projektkonfiguration für mehrere Browser/Geräte
projects: [
{
name: 'chromium',
use: { ...devices['Desktop Chrome'] },
},
{
name: 'firefox',
use: { ...devices['Desktop Firefox'] },
},
{
name: 'webkit',
use: { ...devices['Desktop Safari'] },
},
],
// Starte einen lokalen Entwicklungsserver, bevor die Tests beginnen (optional)
// webServer: {
// command: 'npm run start',
// url: 'http://localhost:3000',
// reuseExistingServer: !process.env.CI,
// },
});
playwright.config.tsEs ist der zentrale Einstiegspunkt, der das Verhalten von Playwright steuert. Kapitel 15 wird jede Konfigurationsoption im Detail erklären.
package.json — Abhängigkeiten und Skripte
Nach der Initialisierung,package.jsonPlaywright-bezogene Inhalte werden hinzugefügt:
Beispiel
"devDependencies": {
"@playwright/test": "^1.52.0" // Playwright Test als Entwicklungsabhängigkeit
},
"scripts": {
"test": "playwright test" // Du kannst direkt npm test ausführen
}
}
Du kannst auch weitere benutzerdefinierte Skripte hinzufügen:
Beispiel
"scripts": {
"test": "playwright test",
"test:ui": "playwright test --ui",
"test:headed": "playwright test --headed",
"test:chromium": "playwright test --project=chromium",
"test:debug": "playwright test --debug",
"codegen": "playwright codegen"
}
}
tests/-Verzeichnis — Testdateien
tests/Dieses Verzeichnis ist der Standardort für Testdateien (angegeben durchtestDirdie Konfiguration).
Die initialisierte Beispiel-Testdatei sieht wie folgt aus:
Beispiel
import { test, expect } from '@playwright/test';
test('has title', async ({ page }) => {
// Navigiere zur Playwright-Website
await page.goto('https://playwright.dev/');
// Stelle sicher, dass der Seitentitel "Playwright" enthält
await expect(page).toHaveTitle(/Playwright/);
});
test('get started link', async ({ page }) => {
// Navigiere zur Playwright-Website
await page.goto('https://playwright.dev/');
// Klicke auf den Link "Get started"
await page.getByRole('link', { name: 'Get started' }).click();
// Stelle sicher, dass die Überschrift "Installation" auf der Seite erscheint
await expect(page.getByRole('heading', { name: 'Installation' })).toBeVisible();
});
Namenskonvention für Testdateien: Verwende.spec.ts(TypeScript) oder.spec.js(JavaScript)-Suffix.
tests-examples/ Verzeichnis — Weitere Beispiele
Wenn Sie sich entschieden haben, während der Initialisierung Beispieltests einzufügen,tests-examples/dann enthält das Verzeichnis ein vollständigeres Testbeispiel:
demo-todo-app.spec.tsEs demonstriert vollständige Testszenarien für eine echte Todo-Anwendung, einschließlich des Hinzufügens von Aufgaben, Umschalten des Abschlussstatus, Filterfunktionalität und mehr.
Dies ist eine großartige Lernreferenz. Sie können es ausführen, um den Effekt zu sehen:
npx playwright test tests-examples/
.github/workflows/ — CI-Konfiguration
Wenn Sie sich entschieden haben, GitHub Actions während der Initialisierung hinzuzufügen,.github/workflows/playwright.ymlwird die Datei automatisch generiert.
Dieser Workflow führt automatisch Playwright-Tests aus, jedes Mal wenn Code gepusht oder eine PR erstellt wird.
Speicherort des Browsers
Die von Playwright installierten Browser-Binärdateien befinden sich nicht im Projektverzeichnis, sondern werden im Cache-Verzeichnis des Betriebssystems gespeichert:
| Betriebssystem | Browser-Speicherpfad |
|---|---|
| macOS | ~/Library/Caches/ms-playwright/ |
| Windows | %USERPROFILE%\AppData\Local\ms-playwright\ |
| Linux | ~/.cache/ms-playwright/ |
Sie können auch einen benutzerdefinierten Speicherpfad festlegen:
# 设置浏览器安装路径 export PLAYWRIGHT_BROWSERS_PATH=/your/custom/path npx playwright install
node_modules/ — Abhängigkeitspakete
Playwrights Kernabhängigkeiten@playwright/testsind installiertnode_modules/im Verzeichnis node_modules/.
Die Abhängigkeit enthält intern die vollständige Laufzeitumgebung von Playwright, einschließlich der Protokollschicht für die Kommunikation mit Browsern.
Weitere ErweiterungenZusätzlich zu den über npm installierten Node.js-Paketen ist Playwright auch auf Browser-Binärdateien angewiesen (die im System-Cache gespeichert sind); beide sind unverzichtbar.