daycry/phpunit-extension-vcr

A library that allows you to easily use the PHP-VCR library in your PHPUnit tests.

v1.0.1 2024-10-18 13:53 UTC

Requires

• php: ^8.1
• php-vcr/php-vcr: ^1.7

Requires (Dev)

• friendsofphp/php-cs-fixer: *
• phpstan/phpstan: ^1.10
• phpunit/phpunit: ^10.0 || ^11.0
• squizlabs/php_codesniffer: ^3.10

MIT

• Daycry

• testing
• phpunit
• unit
• tests
• vcr
• php-vcr

README

PHP-VCR integration for PHPUnit

A library that allows you to easily use the PHP-VCR library in your PHPUnit tests.

Requirements

• PHP 8.2+
• PHPUnit 10+

Installation

composer require --dev daycry/phpunit-extension-vcr

Then, add the extension to your PHPUnit configuration file.

(All parameters are optional.)

    <extensions>
        <bootstrap class="\Daycry\PHPUnit\Vcr\Extension">
            <parameter name="cassettesPath" value="tests/fixtures" />
            <parameter name="storage" value="yaml" />                                   <!-- https://php-vcr.github.io/documentation/configuration/#storage -->
            <parameter name="libraryHooks" value="stream_wrapper, curl, soap" />        <!-- https://php-vcr.github.io/documentation/configuration/#library-hooks -->
            <parameter name="requestMatchers" value="method, url, query_string, ..." /> <!-- https://php-vcr.github.io/documentation/configuration/#request-matching -->
            <parameter name="whitelistedPaths" value="" />                              <!-- https://php-vcr.github.io/documentation/configuration/#white--and-blacklisting-paths -->
            <parameter name="blacklistedPaths" value="" />                              <!-- https://php-vcr.github.io/documentation/configuration/#white--and-blacklisting-paths -->
            <parameter name="mode" value="new_episodes" />                              <!-- https://php-vcr.github.io/documentation/configuration/#record-modes -->
        </bootstrap>
    </extensions>

Usage

The library provides an UseCassette attribute that can be declared on test classes or specific test methods. The attribute expects one string argument - the name of the cassette.

When running the tests, the library will automatically turn the recorder on and off, and insert the cassettes when needed.

Examples:

• When declared on a class, PHP-VCR will intercept the requests in all test methods in that class, and will store the responses in the given cassette.

  use Daycry\PHPUnit\Vcr\Attributes\UseCassette;
  use PHPUnit\Framework\Attributes\Test;
  use PHPUnit\Framework\TestCase;
  
  #[UseCassette("example_cassette.yml")]
  class ExampleTest extends TestCase
  {
      #[Test]
      public function example(): void { ... }
      
      #[Test]
      public function another(): void { ... }
  }

• When declared on a test method, only requests in that methods will be intercepted and stored in the given cassette. Note that it can be declared on multiple test methods with different cassettes.

  use Daycry\PHPUnit\Vcr\Attributes\UseCassette;
  use PHPUnit\Framework\Attributes\Test;
  use PHPUnit\Framework\TestCase;
  
  class ExampleTest extends TestCase
  {
      #[Test]
      #[UseCassette("example.yml")]
      public function example(): void { ... }
  
      #[Test]
      public function another(): void { ... }
  
      #[Test]
      #[UseCassette("example_2.yml")]
      public function recorded(): void { ... }
  }

• When declared both on the class and on a specific method, the name from the attribute declared on the method will be used for that method. In this example, the responses from the requests made in the example() method will be stored in example.yml and the ones from recorded() in example_2.yml.

  use Daycry\PHPUnit\Vcr\Attributes\UseCassette;
  use PHPUnit\Framework\Attributes\Test;
  use PHPUnit\Framework\TestCase;
  
  #[UseCassette("example.yml")]
  class ExampleTest extends TestCase
  {
      #[Test]
      public function example(): void { ... }
  
      #[Test]
      #[UseCassette("example_2.yml")]
      public function recorded(): void { ... }
  }