php vcr

Il s'agit d'un portage de la bibliothèque VCR Ruby vers PHP.

Enregistrez les interactions HTTP de votre suite de tests et relisez-les lors de futures exécutions de tests pour des tests rapides, déterministes et précis. Un peu de documentation peut être trouvée sur le site Web php-vcr.

Avis de non-responsabilité : faire cela en PHP n'est pas aussi simple que dans les langages de programmation prenant en charge les correctifs singe (je vous regarde, Ruby)

Caractéristiques

• Enregistre et rejoue automatiquement vos interactions HTTP avec un minimum de code d'installation/configuration.
• Prend en charge les fonctions et extensions http courantes
  • tout en utilisant streamWrapper : fopen(), fread(), file_get_contents(), ... sans aucune modification (sauf $http_response_header voir #96)
  • SoapClient en ajoutant VCRVCR::turnOn(); dans vos tests/bootstrap.php
  • curl(), en ajoutant VCRVCR::turnOn(); dans vos tests/bootstrap.php
• La même requête peut recevoir des réponses différentes dans différents tests : utilisez simplement des cassettes différentes.
• Désactive toutes les requêtes HTTP que vous n'autorisez pas explicitement en définissant le mode d'enregistrement
• La correspondance des requêtes est configurable en fonction de la méthode HTTP, de l'URI, de l'hôte, du chemin, du corps et des en-têtes, ou vous pouvez facilement implémenter un outil de correspondance de requêtes personnalisé pour répondre à tous les besoins.
• Les demandes et réponses enregistrées sont stockées sur le disque dans un format de sérialisation de votre choix (actuellement YAML et JSON sont intégrés et vous pouvez facilement implémenter votre propre sérialiseur personnalisé)
• Prend en charge les annotations PHPUnit.

Exemple d'utilisation

Utilisation d'appels de méthodes statiques :

 class VCRTest extends TestCase
{
    public function testShouldInterceptStreamWrapper ()
    {
        // After turning on the VCR will intercept all requests
         VCR  VCR :: turnOn ();

        // Record requests and responses in cassette file 'example'
         VCR  VCR :: insertCassette ( ' example ' );

        // Following request will be recorded once and replayed in future test runs
        $ result = file_get_contents ( ' http://example.com ' );
        $ this -> assertNotEmpty ( $ result );

        // To stop recording requests, eject the cassette
         VCR  VCR :: eject ();

        // Turn off VCR to stop intercepting requests
         VCR  VCR :: turnOff ();
    }

    public function testShouldThrowExceptionIfNoCasettePresent ()
    {
        $ this -> setExpectedException (
            ' BadMethodCallException ' ,
            " Invalid http request. No cassette inserted. Please make sure to insert "
            . " a cassette in your unit test using VCR::insertCassette('name'); "
        );
         VCR  VCR :: turnOn ();
        // If there is no cassette inserted, a request throws an exception
        file_get_contents ( ' http://example.com ' );
    }
}

Vous pouvez utiliser des annotations dans PHPUnit en utilisant phpunit-testlistener-vcr :

 class VCRTest extends TestCase
{
    /**
     * @vcr unittest_annotation_test
     */
    public function testInterceptsWithAnnotations ()
    {
        // Requests are intercepted and stored into  tests/fixtures/unittest_annotation_test.
        $ result = file_get_contents ( ' http://google.com ' );

        $ this -> assertEquals ( ' This is a annotation test dummy. ' , $ result , ' Call was not intercepted (using annotations). ' );

        // VCR is automatically turned on and off.
    }
}

Installation

Exécutez simplement la commande suivante :

$ composer require --dev php-vcr/php-vcr

Dépendances

PHP-VCR dépend de :

• PHP8
• Extension de boucles
• symfony/répartiteur d'événements
• symfony/yaml
• beberlei/affirmer

Composer installe toutes les dépendances à l'exception des extensions comme curl.

Exécuter des tests

Afin d'exécuter tous les tests, vous devez obtenir les dépendances de développement à l'aide de composer :

composer install
composer test

Journal des modifications

Le journal des modifications a été déplacé vers la page des versions de PHP-VCR.

Anciennes entrées du journal des modifications

Droit d'auteur

Copyright (c) 2013-2023 Adrian Philipp. Publié selon les termes de la licence MIT. Voir LICENCE pour plus de détails. Contributeurs