Api Platform Conférence 2024 : " Comment tester une API externe en ayant 0 mocks ? " Par Imen Ezzine

Dans cet article, nous découvrons comment simplifier les tests d'API externes sans recourir aux mocks, grâce à PHP-VCR, un outil qui enregistre les requêtes HTTP et permet de les rejouer.

Comment tester une API externe en ayant 0 mocks ?

Présenté par Imen Ezzine

×

Contexte de la conférence : Les défis des tests d'API externes

Lors du développement d'applications faisant appel à des API externes, il est important d'assurer des tests d'intégration fiables et efficaces. Évaluer les interactions avec ces API s'avére souvent complexe et coûteux. Les défis liés aux dépendances réseau, aux limitations de disponibilité et aux variations des réponses rendent cette tâche particulièrement exigeante.

L'Importance des tests d'intégration

Les tests d'intégration jouent un rôle crucial dans la vérification de l'interaction entre différents composants d'une application. Lorsqu'une API externe est impliquée, des défis spécifiques surgissent, comme les coûts élevés liés aux requêtes fréquentes, les restrictions d'utilisation, ou encore les problèmes de réseau tels que des interruptions de service. Maîtriser ces défis est essentiel pour garantir la stabilité des tests.

Afin de dépasser ces défis, il est souvent avantageux d'adopter des méthodes de test qui allient robustesse et flexibilité, permettant ainsi de mieux anticiper et de gérer les aléas des environnements externes.

Dans cette présentation, nous explorerons différentes approches pour tester les API externes sans recourir aux mocks, en mettant l'accent sur PHP-VCR, une solution permettant d'enregistrer et de rejouer les requêtes HTTP. Grâce à PHP-VCR, les tests deviennent non seulement plus simples, mais aussi plus fiables, ce qui réduit le temps et les efforts nécessaires à leur maintenance.

Imen Ezzine a brillamment présenté les avantages et les limites des différentes méthodes de test. Nous allons explorer comment PHP-VCR simplifie les tests d'intégration tout en augmentant l'indépendance vis-à-vis des API externes.

Comparaison des approches de test pour les API externes

Lors de la conférence, plusieurs méthodes de test ont été examinées, chacune avec ses points forts et ses faiblesses. Voici un aperçu des principales approches, telles qu'exposées par Imen Ezzine.

Analyse des méthodes

1 . Sandbox : Bien que les environnements de test isolés offrent une bonne fiabilité, il est parfois difficile de reproduire fidèlement la fonctionnalité de l'API réelle.

2. Mock : Les mocks permettent un contrôle total, mais leur utilisation peut s'éloigner de la réalité. De plus, maintenir ces mocks peut devenir lourd, surtout si l'API évolue fréquemment.

3. Conteneurisation Locale : Cette méthode peut offrir un haut degré de réalisme, mais elle nécessite souvent une configuration complexe et une gestion des ressources locales.

L'objectif principal est de trouver un équilibre optimal entre efficacité, fiabilité et simplicité dans les tests d'intégration. Ce que l'on cherche à atteindre, c'est avant tout un code plus facile à maintenir grâce à sa simplification, ainsi qu'une réduction de la configuration afin de limiter les risques d'erreurs. Il s'agit également de diminuer les besoins en maintenance pour concentrer les efforts sur l'amélioration continue de l'application. Enfin, la décorrélation des dépendances est essentielle pour garantir des tests plus robustes, moins sensibles aux échecs provoqués par des facteurs externes.

Introduction à PHP-VCR

Pour atteindre ces objectifs, PHP-VCR se présente comme une solution idéale. Il fonctionne comme un magnétoscope, en enregistrant et en rejouant les requêtes HTTP, ce qui simplifie nos processus de test.

×

PHP-VCR en action : Un exemple Symfony

Prenons un exemple concret pour illustrer l'utilisation de PHP-VCR dans un projet Symfony:

use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
use VCR\VCR;
use GuzzleHttp\Client;

/**
 * Class ApiTest.
 */
class ApiTest extends WebTestCase
{

    public function setUp()
    : void
    {
        // Configure PHP-VCR pour utiliser un chemin de cassette spécifique
        VCR::configure()->setCassettePath(__DIR__ . '/cassettes');
        // Spécifer le format de stockage // par défaut PHP-VCR utilis YAML storage.
        VCR::configure()->setStorage('json');
        // On initialise PHP-VCR avant chaque test
        VCR::turnOn();
    }

    public function tearDown()
    : void
    {
        // On désactive PHP-VCR après chaque test
        VCR::turnOff();
    }

    public function testApiCall()
    {
        // On configure PHP-VCR pour enregistrer les requêtes HTTP
        VCR::insertCassette('testApiCall');

        // Votre code de test qui effectue une requête HTTP à une API
        $httpClient =  new Client();
        $response   = $httpClient->request('GET', 'https://jsonplaceholder.typicode.com/todos/1');

        // Assertions sur la réponse de l'API
        $this->assertEquals(200, $response->getStatusCode());

        // On arrête l'enregistrement de PHP-VCR
        VCR::eject();
    }
}

Dans cet exemple, PHP-VCR enregistre l’appel d'API lors de la première exécution, puis rejoue cette réponse lors des tests suivants. Cela permet d'améliorer la rapidité et la fiabilité des tests, tout en réduisant la dépendance aux services externes.

Pour explorer plus d'exemples, je vous invite à visiter le dépôt officiel de BÉPO : php-vcr-examples.

Modes de fonctionnement de PHP-VCR

×

1. Enregistrement des appels
   La première fois qu'un test est exécuté, PHP-VCR intercepte l'appel à l'API et l'enregistre dans une cassette. Cette cassette contient à la fois la requête et la réponse, ce qui permet de conserver une trace de toutes les interactions.

×

2. Utilisation de la cassette
   Pour les exécutions suivantes, si la cassette existe déjà, PHP-VCR renvoie directement la réponse enregistrée, évitant ainsi l'appel réel à l'API.

3. Modes de fonctionnement
   PHP-VCR propose plusieurs modes pour gérer les enregistrements :
   - `VCR::MODE_NEW_EPISODES` : Enregistre de nouvelles interactions si aucune cassette n’est disponible. Sinon, il lit la cassette existante.
   - `VCR::MODE_ONCE` : Utilise la cassette existante une seule fois, et tous les appels suivants se basent sur la réponse enregistrée.
   - `VCR::MODE_NONE` : Aucune lecture ni enregistrement n'est effectué, ce qui signifie que tous les appels s'exécutent normalement, comme si PHP-VCR n'était pas activé.

Personnalisation et flexibilité

PHP-VCR est également extrêmement flexible et peut être personnalisé selon vos besoins :

Configuration des matchers de requêtes

PHP-VCR permet une personnalisation avancée des requêtes en activant les "matchers" souhaités avec la méthode enableRequestMatchers() . Cela permet de contrôler comment les requêtes sont associées et traitées.

\VCR\VCR::configure()->enableRequestMatchers(['method', 'url', 'host']);

Création de matchers personnalisés

Il est également possible de définir des matchers de requêtes sous forme de fonctions de rappel, permettant ainsi de les combiner avec les matchers existants via addRequestMatcher() .

\VCR\VCR::configure()
    ->addRequestMatcher(
        'custom_matcher',
        function (\VCR\Request $first, \VCR\Request $second) {
            // custom request matching
            return true;
        }
    )
    ->enableRequestMatchers(['method', 'url', 'custom_matcher']);

Library Hooks avec VCR

Les library hooks permettent à PHP-VCR d'intercepter les requêtes HTTP issues de ces libraries. Lorsque cURL est utilisé pour faire des requêtes HTTP, il est possible de demander à VCR de les surveiller avec une configuration très simple :

\VCR\VCR::configure()->enableLibraryHooks(['curl'])

Dès que c'est activé, VCR capture toutes les requêtes cURL. Il est ensuite possible de les rejouer autant de fois que nécessaire, sans avoir besoin que l’API soit toujours accessible. Fini les tests qui dépendent des services externes en direct !

Voici les principaux hooks les plus utilisés que vous pouvez activer selon les besoins de votre projet :

1. StreamWrapper : Idéal pour les requêtes effectuées avec file_get_contents ou fopen. En utilisant ces fonctions pour les appels HTTP, ce hook permettra de les intercepter.
2. SoapClient : Pour ceux qui travaillent avec des services SOAP, l'activation de ce hook permettra de capturer les appels via SoapClient.
3. cURL : Le grand classique ! Si cURL est ta méthode de prédilection pour faire des requêtes, ce hook est fait pour vous.

Emplacement des cassettes

Les cassettes peuvent être enregistrées dans le répertoire de votre choix grâce à la méthode setCassettePath() . De plus, PHP-VCR stocke les interactions HTTP au format YAML ou JSON. Par défaut, le format YAML est utilisé, mais ce choix peut être modifié selon les préférences en utilisant la fonction setStorage() .

Exemple de configuration

Pour illustrer ces concepts, voici un exemple de configuration complète pour PHP-VCR :

\VCR\VCR::configure()    
    ->addRequestMatcher(
        'custom_body_matcher',
        new CustomBodyMatcher()
    )
    ->enableRequestMatchers(['method', 'url', 'query_string', 'custom_body_matcher', 'post_fields'])
    ->enableLibraryHooks(['curl'])
    ->setCassettePath(dirname(__DIR__, 2).'/tests/Environment/IO/cassettes')
    ->setStorage('yaml')
    ->setMode(VCR::MODE_ONCE);

Les avantages clés de PHP-VCR

En optant pour PHP-VCR, plusieurs avantages peuvent être observés :

• Tests rapides : L'exécution des tests est considérablement accélérée, ce qui favorise un développement plus fluide.
• Indépendance de l'API : Les tests ne dépendent pas de la disponibilité de l'API réelle, réduisant ainsi les risques d'échecs imprévus.
• Inspection des requêtes HTTP : PHP-VCR permet d’examiner facilement les requêtes envoyées et reçues, facilitant le débogage.
• Tests déterministes : Évite les problèmes liés aux limites de taux ou aux erreurs externes, garantissant ainsi des résultats cohérents.
• Aucun mock manuel : Fini les efforts de simulation manuelle, PHP-VCR gère tout ça de manière automatique, rendant le processus plus simple et moins sujet à erreurs.

Optimisation et entretien des cassettes

Pour garantir un usage optimal de PHP-VCR et maintenir la qualité de vos tests au fil du temps, il est essentiel d'adopter des bonnes pratiques pour l'optimisation et l'entretien des cassettes.

• Versionning régulier : Mettre à jour les cassettes régulièrement, idéalement une fois par mois ou lorsque des tests échouent, afin de rester aligné avec les évolutions des API.
• Nommage sémantique : Utiliser des noms clairs et explicites pour identifier facilement le contenu et le contexte de chaque cassette, ce qui simplifie leur gestion.

Conclusion