php vcr

Esta é uma porta da biblioteca VCR Ruby para PHP.

Registre as interações HTTP do seu conjunto de testes e reproduza-as durante futuras execuções de testes para obter testes rápidos, determinísticos e precisos. Um pouco de documentação pode ser encontrada no site php-vcr.

Isenção de responsabilidade: fazer isso em PHP não é tão fácil quanto em linguagens de programação que suportam monkey patching (estou olhando para você, Ruby)

Características

• Registra e reproduz automaticamente suas interações HTTP(s) com código mínimo de instalação/configuração.
• Suporta funções e extensões http comuns
  • tudo usando streamWrapper: fopen(), fread(), file_get_contents(), ... sem qualquer modificação (exceto $http_response_header veja #96)
  • SoapClient adicionando VCRVCR::turnOn(); em seus tests/bootstrap.php
  • curl(), adicionando VCRVCR::turnOn(); em seus tests/bootstrap.php
• A mesma solicitação pode receber respostas diferentes em testes diferentes – basta usar cassetes diferentes.
• Desativa todas as solicitações HTTP que você não permite explicitamente definindo o modo de gravação
• A correspondência de solicitações é configurável com base no método HTTP, URI, host, caminho, corpo e cabeçalhos, ou você pode implementar facilmente uma correspondência de solicitações personalizada para atender a qualquer necessidade.
• As solicitações e respostas registradas são armazenadas em disco em um formato de serialização de sua escolha (atualmente YAML e JSON estão integrados e você pode implementar facilmente seu próprio serializador personalizado)
• Suporta anotações PHPUnit.

Exemplo de uso

Usando chamadas de método estático:

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

Você pode usar anotações no PHPUnit usando 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.
    }
}

Instalação

Basta executar o seguinte comando:

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

Dependências

PHP-VCR depende de:

• PHP8
• Extensão de cachos
• symfony/event-dispatcher
• symfony/yaml
• beberlei/afirmar

O Composer instala todas as dependências, exceto extensões como curl.

Execute testes

Para executar todos os testes você precisa obter dependências de desenvolvimento usando o compositor:

composer install
composer test

Registro de alterações

O changelog foi movido para a página de lançamentos do PHP-VCR.

Entradas antigas do changelog

Direitos autorais

Direitos autorais (c) 2013-2023 Adrian Philipp. Lançado sob os termos da licença do MIT. Consulte LICENÇA para obter detalhes. Colaboradores