Introduction

Lorsque vous travaillez avec des frameworks de test de bout en bout comme Playwright, la gestion des requêtes réseau est souvent une tâche complexe. Les tests qui s'appuient sur des API externes peuvent être lents et incohérents, introduisant des irrégularités inutiles. Les appels réseau qui réussissent lors d'un test peuvent échouer lors du suivant en raison d'un serveur lent ou peu fiable, ce qui entraîne des résultats incohérents. Pour résoudre ce problème, les développeurs ont souvent recours à des requêtes réseau moqueuses, ce qui introduit un autre défi : la gestion des simulations.

Ne serait-il pas formidable de disposer d'un moyen automatisé de gérer la mise en cache et de réutiliser les réponses réseau sans mettre en place de stratégies de moquerie complexes ? J'ai étudié les approches existantes et développé un outil que je souhaite présenter. Il résout ces problèmes précis en mettant en cache les requêtes réseau sur le système de fichiers, permettant ainsi des tests Playwright plus rapides et plus fiables.

Le problème avec les requêtes réseau dans les tests

Les requêtes réseau sont souvent la partie la plus lente de l'exécution des tests. Lors de l'exécution de plusieurs suites de tests, les requêtes répétées d'API externes peuvent augmenter considérablement la durée des tests. De plus, les API du monde réel peuvent être instables, avec des délais d'attente occasionnels, rendant vos tests fragiles et peu fiables.

Une approche courante pour atténuer ce problème consiste à simuler les réponses de l'API. Bien qu'utile, la simulation nécessite une intervention manuelle : vous devez soigneusement construire des réponses fictives, les tenir à jour et vous assurer que chaque scénario de réseau potentiel est géré. Cela peut devenir un énorme fardeau de maintenance à mesure que l'API évolue ou que vos cas de test changent. Playwright prend en charge les fichiers HAR pour capturer et relire le trafic réseau, mais travailler avec HAR peut être fastidieux et manque de flexibilité pour modifier les réponses à la volée.

Entrez le cache du réseau du dramaturge

playwright-network-cache est conçu pour rationaliser le processus de mise en cache des réponses réseau dans les tests Playwright, éliminant ainsi le besoin de simulations manuelles ou de fichiers HAR rigides. Avec cette bibliothèque, les réponses réseau sont automatiquement stockées sur le système de fichiers lors de la première exécution du test et peuvent être réutilisées lors des exécutions suivantes, accélérant considérablement l'exécution des tests. De plus, les réponses sont enregistrées dans une structure de dossiers claire et organisée, ce qui facilite leur inspection et leur modification selon les besoins.

Comment cela résout le problème

1. Mise en cache automatique : la bibliothèque met automatiquement en cache les réponses du réseau lorsque les tests sont exécutés pour la première fois. Cela signifie que vos tests n'auront pas besoin d'attendre la réponse des API externes lors des exécutions futures : les données mises en cache seront utilisées à la place, ce qui entraînera des tests plus rapides et plus fiables.

2. Modifications dynamiques : Besoin de modifier une réponse pour un scénario de test spécifique ? playwright-network-cache vous permet de modifier dynamiquement les réponses mises en cache. Que vous souhaitiez modifier le code d'état, les en-têtes ou le corps de la réponse, la bibliothèque propose des options pour ajuster les données mises en cache à la volée sans gérer manuellement des simulations séparées.

3. Structure flexible : le système de mise en cache organise les fichiers en fonction du nom d'hôte, de la méthode de requête et du chemin de l'URL, garantissant que vous pouvez facilement naviguer et gérer les données mises en cache. Pour les cas plus complexes, vous pouvez même diviser les fichiers cache par paramètres de requête, corps de requête ou autres champs personnalisés, garantissant ainsi une flexibilité totale dans la manière dont les données sont stockées et réutilisées.

4. Speed ​​Boost : en réutilisant les réponses mises en cache, vos tests n'ont plus besoin d'attendre la fin des appels réseau, ce qui les rend considérablement plus rapides. Ceci est particulièrement utile lorsque vous travaillez avec de grandes suites de tests ou lors de l'exécution de tests dans des environnements CI où la vitesse est critique.

5. Plus de Mock Hell : Oubliez la maintenance manuelle des simulations. La bibliothèque gère tout pour vous, de la mise en cache à la relecture et même à la modification des réponses. Vous n'aurez plus besoin de créer manuellement des réponses fictives pour chaque scénario de test et vous pourrez vous concentrer davantage sur votre logique de test.

6. Pas de complexité HAR : les fichiers HAR peuvent être utiles pour enregistrer et rejouer les interactions réseau, mais ils deviennent rapidement encombrants, surtout lorsque vous devez modifier les réponses. playwright-network-cache offre une alternative plus propre et plus flexible à HAR en vous permettant de gérer les réponses individuelles sous forme de simples fichiers JSON.

Exemple

Imaginez que vous testez une application qui récupère une liste de chats à partir d'une API. Sans mise en cache, chaque exécution de test nécessiterait une requête en direct à l'API, ajoutant ainsi de la latence et des points d'échec potentiels à vos tests.

Avec playwright-network-cache, vous pouvez facilement mettre en cache la réponse de l'API :

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

Lors de la première exécution, la réponse est mise en cache dans le répertoire .network-cache, avec une structure comme celle-ci :

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

Lors des exécutions suivantes, la réponse mise en cache est réutilisée, ce qui rend le test plus rapide et élimine le besoin d'accéder à l'API réelle.

Vous pouvez modifier la réponse mise en cache pour les besoins particuliers du test :

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...
});

Pour que la variable cacheRoute soit disponible dans vos tests, instanciez-la comme n'importe quel autre appareil Playwright :

// 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);
  },
});

Il existe de nombreux autres exemples et cas d'utilisation dans la documentation de la bibliothèque.

Plus qu'une simple mise en cache

playwright-network-cache ne concerne pas seulement la mise en cache. Il offre des fonctionnalités avancées telles que :

• Modification des réponses : ajustez dynamiquement les données dans les réponses mises en cache à l'aide de fonctions personnalisées.
• Gestion des codes d'état : mettez en cache les réponses basées sur des codes d'état HTTP spécifiques, y compris les erreurs.
• Structure de répertoire flexible : personnalisez la manière et l'emplacement de stockage des fichiers de cache, ce qui vous permet d'adapter les stratégies de mise en cache à vos besoins.
• Désactiver ou mettre à jour le cache : désactivez temporairement la mise en cache pour des tests spécifiques ou forcez les mises à jour du cache si nécessaire.

Grâce à ces puissantes fonctionnalités, vous pouvez contrôler finement la manière dont les requêtes réseau sont gérées dans vos tests.

Résumer

Si vous souhaitez rendre vos tests Playwright plus rapides et plus fiables, essayez playwright-network-cache. En mettant en cache les réponses du réseau sur le système de fichiers et en permettant des modifications dynamiques, il élimine le besoin de simulations manuelles et fournit une alternative flexible et facile à utiliser aux fichiers HAR.

Merci d'avoir lu ❤️