php vcr

Dies ist eine Portierung der VCR-Ruby-Bibliothek nach PHP.

Zeichnen Sie die HTTP-Interaktionen Ihrer Testsuite auf und geben Sie sie bei zukünftigen Testläufen wieder, um schnelle, deterministische und genaue Tests zu ermöglichen. Eine kleine Dokumentation finden Sie auf der php-vcr-Website.

Haftungsausschluss: Dies ist in PHP nicht so einfach wie in Programmiersprachen, die Monkey-Patching unterstützen (ich schaue auf dich, Ruby).

Merkmale

• Zeichnet Ihre HTTP(s)-Interaktionen automatisch auf und gibt sie mit minimalem Setup-/Konfigurationscode wieder.
• Unterstützt gängige http-Funktionen und -Erweiterungen
  • alles mit streamWrapper: fopen(), fread(), file_get_contents(), ... ohne jegliche Modifikation (außer $http_response_header siehe #96)
  • SoapClient durch Hinzufügen von VCRVCR::turnOn(); in deiner tests/bootstrap.php
  • curl(), durch Hinzufügen von VCRVCR::turnOn(); in deiner tests/bootstrap.php
• Die gleiche Anfrage kann in verschiedenen Tests unterschiedliche Antworten erhalten – verwenden Sie einfach unterschiedliche Kassetten.
• Deaktiviert alle HTTP-Anfragen, die Sie nicht explizit zulassen, indem Sie den Aufnahmemodus festlegen
• Der Anforderungsabgleich ist basierend auf HTTP-Methode, URI, Host, Pfad, Text und Headern konfigurierbar. Alternativ können Sie ganz einfach einen benutzerdefinierten Anforderungsabgleicher implementieren, um alle Anforderungen zu erfüllen.
• Die aufgezeichneten Anfragen und Antworten werden in einem Serialisierungsformat Ihrer Wahl auf der Festplatte gespeichert (derzeit sind YAML und JSON integriert, und Sie können ganz einfach Ihren eigenen benutzerdefinierten Serialisierer implementieren).
• Unterstützt PHPUnit-Annotationen.

Anwendungsbeispiel

Verwendung statischer Methodenaufrufe:

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

Sie können Anmerkungen in PHPUnit verwenden, indem Sie phpunit-testlistener-vcr verwenden:

 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

Führen Sie einfach den folgenden Befehl aus:

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

Abhängigkeiten

PHP-VCR hängt ab von:

• PHP 8
• Lockenverlängerung
• Symfony/Event-Dispatcher
• Symfony/Yaml
• beberlei/assert

Composer installiert alle Abhängigkeiten außer Erweiterungen wie Curl.

Führen Sie Tests durch

Um alle Tests auszuführen, müssen Sie Entwicklungsabhängigkeiten mit Composer abrufen:

composer install
composer test

Änderungsprotokoll

Das Änderungsprotokoll wurde auf die PHP-VCR-Releases-Seite verschoben.

Alte Changelog-Einträge

Copyright

Copyright (c) 2013-2023 Adrian Philipp. Veröffentlicht unter den Bedingungen der MIT-Lizenz. Einzelheiten finden Sie unter LIZENZ. Mitwirkende