Einführung

Bei der Arbeit mit End-to-End-Test-Frameworks wie Playwright ist die Bearbeitung von Netzwerkanfragen oft eine komplexe Aufgabe. Tests, die auf externen APIs basieren, können langsam und inkonsistent sein und zu unnötigen Unzulänglichkeiten führen. Netzwerkaufrufe, die in einem Testlauf erfolgreich sind, können im nächsten aufgrund eines langsamen oder unzuverlässigen Servers fehlschlagen, was zu inkonsistenten Ergebnissen führt. Um dieses Problem zu lösen, greifen Entwickler oft auf das Verspotten von Netzwerkanfragen zurück, was eine weitere Herausforderung mit sich bringt: die Verwaltung von Mocks.

Wäre es nicht großartig, eine automatisierte Möglichkeit zu haben, das Caching und die Wiederverwendung von Netzwerkantworten zu verwalten, ohne komplexe Spottstrategien einzurichten? Ich habe bestehende Ansätze untersucht und ein Tool entwickelt, das ich vorstellen möchte. Es löst genau diese Probleme, indem es Netzwerkanfragen im Dateisystem zwischenspeichert und so schnellere und zuverlässigere Playwright-Tests ermöglicht.

Das Problem mit Netzwerkanfragen in Tests

Netzwerkanfragen sind oft der langsamste Teil der Testausführung. Beim Ausführen mehrerer Testsuiten kann die wiederholte Abfrage externer APIs die Testdauer erheblich verlängern. Darüber hinaus können reale APIs instabil sein und gelegentlich zu Zeitüberschreitungen führen, was Ihre Tests anfällig und unzuverlässig macht.

Ein gängiger Ansatz zur Abmilderung dieses Problems besteht darin, API-Antworten vorzutäuschen. Mocking ist zwar nützlich, erfordert aber manuelles Eingreifen – Sie müssen Scheinantworten sorgfältig erstellen, sie auf dem neuesten Stand halten und sicherstellen, dass jedes potenzielle Netzwerkszenario berücksichtigt wird. Dies kann zu einem enormen Wartungsaufwand werden, wenn sich die API weiterentwickelt oder sich Ihre Testfälle ändern. Playwright unterstützt HAR-Dateien zum Erfassen und Wiedergeben des Netzwerkverkehrs, aber die Arbeit mit HAR kann mühsam sein und es mangelt an Flexibilität, um Antworten im Handumdrehen zu ändern.

Geben Sie den Playwright-Network-Cache ein

playwright-network-cache wurde entwickelt, um den Prozess des Zwischenspeicherns von Netzwerkantworten in Playwright-Tests zu optimieren, sodass keine manuellen Mocks oder starren HAR-Dateien erforderlich sind. Mit dieser Bibliothek werden Netzwerkantworten beim ersten Testlauf automatisch im Dateisystem gespeichert und können in nachfolgenden Läufen wiederverwendet werden, was die Testausführung erheblich beschleunigt. Darüber hinaus werden die Antworten in einer übersichtlichen, organisierten Ordnerstruktur gespeichert, sodass sie bei Bedarf leicht überprüft und geändert werden können.

Wie es das Problem löst

1. Automatisches Caching: Die Bibliothek speichert Netzwerkantworten automatisch zwischen, wenn Tests zum ersten Mal ausgeführt werden. Das bedeutet, dass Ihre Tests bei zukünftigen Durchläufen nicht auf die Antwort externer APIs warten müssen – stattdessen werden die zwischengespeicherten Daten verwendet, was zu schnelleren und zuverlässigeren Tests führt.

2. Dynamische Änderungen: Müssen Sie eine Antwort für einen bestimmten Testfall optimieren? Mit dem Playwright-Network-Cache können Sie zwischengespeicherte Antworten dynamisch ändern. Unabhängig davon, ob Sie den Statuscode, die Header oder den Antworttext ändern möchten, bietet die Bibliothek Optionen zum spontanen Anpassen der zwischengespeicherten Daten, ohne dass separate Mocks manuell gepflegt werden müssen.

3. Flexible Struktur: Das Caching-System organisiert Dateien basierend auf Hostname, Anforderungsmethode und URL-Pfad und stellt so sicher, dass Sie einfach durch die zwischengespeicherten Daten navigieren und diese verwalten können. Für komplexere Fälle können Sie Cache-Dateien sogar nach Anforderungsabfrageparametern, Anforderungstexten oder anderen benutzerdefinierten Feldern aufteilen und so vollständige Flexibilität bei der Speicherung und Wiederverwendung von Daten gewährleisten.

4. Geschwindigkeitssteigerung: Durch die Wiederverwendung zwischengespeicherter Antworten müssen Ihre Tests nicht mehr auf den Abschluss von Netzwerkaufrufen warten, wodurch sie erheblich schneller werden. Dies ist besonders nützlich, wenn Sie mit großen Testsuiten arbeiten oder Tests in CI-Umgebungen ausführen, in denen Geschwindigkeit von entscheidender Bedeutung ist.

5. Keine Mock-Hölle mehr: Vergessen Sie die manuelle Pflege von Mocks. Die Bibliothek übernimmt alles für Sie – vom Caching über die Wiedergabe bis hin zur Änderung von Antworten. Sie müssen nicht mehr manuell Scheinantworten für jedes Testszenario erstellen und können sich mehr auf Ihre Testlogik konzentrieren.

6. Keine HAR-Komplexität: HAR-Dateien können zum Aufzeichnen und Wiedergeben von Netzwerkinteraktionen nützlich sein, werden jedoch schnell umständlich, insbesondere wenn Sie Antworten ändern müssen. playwright-network-cache bietet eine sauberere, flexiblere Alternative zu HAR, indem Sie einzelne Antworten als einfache JSON-Dateien verwalten können.

Beispiel

Stellen Sie sich vor, Sie testen eine Anwendung, die eine Liste von Katzen von einer API abruft. Ohne Caching würde jeder Testlauf eine Live-Anfrage an die API erfordern, was zu Latenz und potenziellen Fehlerquellen bei Ihren Tests führen würde.

Mit playwright-network-cache können Sie die API-Antwort einfach zwischenspeichern:

test('test', async ({ page, cacheRoute }) => {
  await cacheRoute.GET('https://example.com/api/cats');
  // Perform usual test actions...
});

Beim ersten Durchlauf wird die Antwort im .network-cache-Verzeichnis zwischengespeichert, mit einer Struktur wie dieser:

.network-cache
└── example.com
    └── api-cats
        └── GET
            ├── headers.json
            └── body.json

Bei nachfolgenden Läufen wird die zwischengespeicherte Antwort wiederverwendet, wodurch der Test schneller wird und die eigentliche API nicht mehr aufgerufen werden muss.

Sie können die zwischengespeicherte Antwort für die jeweiligen Testanforderungen ändern:

test('test', async ({ page, cacheRoute }) => {
  await cacheRoute.GET('https://example.com/api/cats', {
    modify: async (route, response) => {
      const json = await response.json();
      json[0].name = 'Kitty-1';
      await route.fulfill({ json });
    }
  });
  // Perform usual test actions...
});

Um die Variable „cacheRoute“ in Ihren Tests verfügbar zu machen, instanziieren Sie sie wie jedes andere Playwright-Gerät:

// fixtures.js
import { test as base } from '@playwright/test';
import { CacheRoute } from 'playwright-network-cache';

export const test = base.extend({
  cacheRoute: async ({ page }, use) => {
    const cacheRoute = new CacheRoute(page, { /* cache options */ });
    await use(cacheRoute);
  },
});

Es gibt viele weitere Beispiele und Anwendungsfälle in der Bibliotheksdokumentation.

Mehr als nur Caching

playwright-network-cache geht es nicht nur um Caching. Es bietet erweiterte Funktionen wie:

• Antworten ändern: Passen Sie die Daten in den zwischengespeicherten Antworten dynamisch mithilfe benutzerdefinierter Funktionen an.
• Verarbeitung von Statuscodes: Cache-Antworten basierend auf bestimmten HTTP-Statuscodes, einschließlich Fehlern.
• Flexible Verzeichnisstruktur: Passen Sie an, wie und wo Cache-Dateien gespeichert werden, sodass Sie Caching-Strategien an Ihre Bedürfnisse anpassen können.
• Cache deaktivieren oder aktualisieren: Deaktivieren Sie vorübergehend das Caching für bestimmte Tests oder erzwingen Sie bei Bedarf Aktualisierungen des Caches.

Mit diesen leistungsstarken Funktionen können Sie genau steuern, wie Netzwerkanfragen in Ihren Tests verwaltet werden.

Rekapitulieren

Wenn Sie Ihre Playwright-Tests schneller und zuverlässiger machen möchten, probieren Sie playwright-network-cache aus. Durch das Zwischenspeichern von Netzwerkantworten im Dateisystem und das Ermöglichen dynamischer Änderungen macht es manuelle Mocks überflüssig und bietet eine flexible, benutzerfreundliche Alternative zu HAR-Dateien.

Danke fürs Lesen ❤️