Playwright Best Practices

Dieses Kapitel fasst die wichtigsten Best Practices beim Schreiben und Pflegen von Playwright-Tests zusammen und hilft Ihnen, stabile und wartbare Tests zu schreiben.


Testphilosophie

Benutzersichtbares Verhalten testen

Automatisierte Tests sollten überprüfen, was Endbenutzer sehen und womit sie interagieren können, anstatt Implementierungsdetails des Codes zu überprüfen.

Tests sollten beispielsweise überprüfen, dass der richtige Text auf der Seite angezeigt wird, Schaltflächen anklickbar sind und das Absenden des Formulars zur richtigen Seite navigiert, anstatt den Rückgabewert einer JavaScript-Funktion oder die interne Struktur des DOM zu überprüfen.

Beispiel

// Nicht empfohlen: Testen von Implementierungsdetails
expect(await page.evaluate(() => window.__store.getState().user.name))
  .toBe⟦⟧'example'('example');

// Empfohlen: Testen, was Nutzer sehen
await expect⟦⟧page.(page.getByText('Welcome, example')).toBeVisible();

Testisolation

Jeder Test solltevollständig unabhängigvon anderen Tests sein und nicht vom Zustand eines vorherigen Tests abhängen.

Playwright stellt standardmäßig einen unabhängigen Kontext bereit, aber Sie sollten auch sicherstellen, dass Sie sich nicht auf die Ausführungsreihenfolge von Tests verlassen.

Beispiel

// Nicht empfohlen: Tests hängen voneinander ab
let createdId;
test('Create resource', async ({ request }) => {
  const resp = await request.post('/api/items');
  createdId = (await resp.json()).id;  // Gemeinsamer Zustand
});
test('Use created resource', async ({ page }) => {
  await page.goto(`/items/${createdId}`);  // Hängt vom Ergebnis des vorherigen Tests ab
});

// Empfohlen: Jeder Test ist eigenständig
test('Create and use resource', async ({ request, page }) => {
  const resp = await request.post('/api/items');
  const id = (await resp.json()).id;
  await page.goto(`/items/${id}`);
  await expect(page.getByText('Resource details')).toBeVisible();
});

Prinzipien der Locator-Priorität

Die Verwendung von Locators in der empfohlenen Reihenfolge kann die Teststabilität verbessern.

PrioritätMethodeAnwendungsszenario
1getByRole()Element hat eine klare ARIA-Rolle
2getByLabel()Formularelement, das mit einem Label verknüpft ist
3getByPlaceholder()Eingabefeld hat einen Platzhalter
4getByText()Element hat expliziten Text
5getByAltText()Bild hat alt-Attribut
6getByTitle()Element hat title-Attribut
7getByTestId()Fallback
8locator()CSS/XPath, letztes Mittel

Versuchen Sie, die Verwendung von CSS-Klassennamen als Locators zu vermeiden.

Klassennamen ändern sich häufig durch Style-Refactoring, was zu massenhaften Testfehlern führt.


Unnötige Wartezeiten vermeiden

Nutzen Sie den Auto-Wait-Mechanismus von Playwright, vermeiden Sie manuelles CodierensleepoderwaitForTimeout。

Beispiel

// Nicht empfohlen: hartkodierte Wartezeiten
await page.waitForTimeout(3000);
await page.getByText('Data loading complete').click();

// Empfohlen: auf automatisches Warten und Assertions verlassen
await expect(page.getByText('Loading data...')).toBeHidden({ timeout: 10000 });
await page.getByText('Data loading complete').click();

Testen Sie keine Dienste von Drittanbietern

Testen Sie nur, was Sie kontrollieren können; verlassen Sie sich nicht auf die Verfügbarkeit von Diensten von Drittanbietern.

Beispiel

// Nicht empfohlen: von externem CDN oder API abhängig sein
await page.goto('https://www.example.com/');
// Die Seite kann Google Analytics, externe Schriftarten usw. laden.

// Empfohlen: Drittanbieter-Anfragen abfangen, externe Dienste mocken
await page.route('**/*analytics*', route => route.abort());
await page.route('**/external-api/**', route => {
  route.fulfill({ json: { status: 'ok' } });
});

Verwenden Sie expect.soft() für Soft Assertions

Wenn Sie mehrere unabhängige Bedingungen prüfen, können Soft Assertions alle Fehler auf einmal melden, anstatt beim ersten Fehler abzubrechen.

Beispiel

// Empfohlen: Soft Assertions prüfen alle Felder auf einmal
await expect.soft(page.getByLabel('Username')).toBeVisible();
await expect.soft(page.getByLabel('Password')).toBeVisible();
await expect.soft(page.getByLabel('Email')).toBeVisible();
await expect.soft(page.getByRole('button', { name: 'Register' })).toBeEnabled();
// Wenn mehrere Felder fehlen, alle auf einmal melden

Testdateien sinnvoll organisieren

ÜbungBeschreibung
Dateien nach Funktionsmodul aufteilenlogin.spec.ts、checkout.spec.tswarten
describe zum Gruppieren verwendenZusammengehörige Tests ablegen intest.describe()Mittel
beforeEach richtig verwendenWiederholte Navigations- und Einrichtungsschritte auslagern inbeforeEach
Beschreibende TestnamenGute Namen erklären "was getan wurde" und "was erwartet wird"
Gemeinsamen Code extrahierenHilfsfunktionen, die in mehr als 3 Dateien verwendet werden, sollten in ein gemeinsames Modul ausgelagert werden
Nicht übertrieben DRY anwenden2-3 Zeilen Wiederholung sind leichter zu warten als Überabstraktion

Allgemeine Fehlerbehebung

Flaky Tests

Ursachen und Lösungen für Flaky Tests:

UrsacheLösung
Hartcodiertes Sleep ist nicht lang genugAuto-Wait-Mechanismus statt fester Wartezeiten verwenden
Abhängigkeit von Drittanbieter-DienstenVerwenden Sieroute()Externe Anfragen mocken
Animationen verursachen Änderungen der ElementpositionIn der Konfigurationanimations: 'disabled'
Datenreste zwischen TestsSicherstellen, dass jeder Test unabhängig Daten anlegt und aufräumt
Zeitbezogene LogikVerwenden Siepage.clockFeste Zeit

Locator kann Element nicht finden

Schritte zur Fehlerbehebung:

  • Prüfen, ob sich das Element im DOM befindet (verwenden SietoBeAttached()statttoBeVisible())
  • Prüfen, ob sich das Element im Viewport befindet
  • Prüfen, ob es in einem iframe verschachtelt ist
  • Verwenden Sie Pick Locator im UI-Modus, um den Locator zu prüfen
  • Prüfen, ob mehrere passende Elemente vorhanden sind (Locator erfordert standardmäßig den Strict Mode)
Weitere Erweiterungen