php-vcr / vcr-bundle
Integrates php-vcr into Symfony and its web profiler.
Installs: 25 583
Dependents: 0
Suggesters: 0
Security: 0
Stars: 12
Watchers: 7
Forks: 10
Open Issues: 4
Type:symfony-bundle
Requires
- php: ^7.2|^8
- php-vcr/php-vcr: ^1.5
- symfony/browser-kit: ^4|^5
- symfony/config: ^4|^5
- symfony/dependency-injection: ^4|^5
- symfony/event-dispatcher: ^4|^5
- symfony/filesystem: ^4|^5
- symfony/framework-bundle: ^4.4|^5.4
- symfony/http-foundation: ^4|^5
- symfony/http-kernel: ^4.4|^5
- symfony/polyfill-php80: ^1.16
- symfony/yaml: ^4|^5
Requires (Dev)
- dms/phpunit-arraysubset-asserts: ^0.4
- neutron/temporary-filesystem: ^3
- phpunit/phpunit: ^8.5|^9.5
- symfony/phpunit-bridge: ^4.4|^5.4
README
Integrates php-vcr into Symfony and its web profiler. It also provides a VideoRecorderBrowser for testing purpose with extra helper methods handling php-vcr recordings.
Installation
Install the behavior adding php-vcr/vcr-bundle
to your composer.json or
from CLI:
composer require php-vcr/vcr-bundle
And declare the bundle in your config/bundles.php
file:
<?php declare(strict_types = 1); return [ // ... VCR\VCRBundle\VCRBundle::class => ['test' => true], ];
Usage
Enable the required library hooks for your purpose and write test cases.
VideoRecorderBrowser (without Trait)
<?php declare(strict_types = 1); class ExampleTest extends \VCR\VCRBundle\Tests\Functional\WebTestCase { public function test(): void { $kernel = static::bootKernel(); /** @var \VCR\VCRBundle\VideoRecorderBrowser $client */ $client = $kernel->getContainer()->get('test.client.vcr'); $client->insertVideoRecorderCassette('my-test-cassette-name'); // this is an example, normally services inside you project do stuff like this and you trigger them by // execute requests via the KernelBrowser client file_get_contents('https://www.google.de'); // cassette.path is configured to '%kernel.project_dir%/tests/Fixtures' // recordings are written to %kernel.project_dir%/tests/Fixtures/my-test-cassette-name // cassette.path + cassetteName (done by inserting the cassette) } }
VideoRecorderBrowser (with Trait)
<?php declare(strict_types = 1); namespace MyCompany\MyProject\Tests\Functional; class ExampleTest extends \VCR\VCRBundle\Tests\Functional\WebTestCase { use \VCR\VCRBundle\Test\VCRTestCaseTrait; /** * Specify a namespace prefix which should be ignored while generating the base path for this test case. */ protected $ignoredTestSuiteNamespacePrefix = 'MyCompany\\MyProject\\Tests\\'; public function test(): void { /** @var \VCR\VCRBundle\VideoRecorderBrowser $client */ $client = static::createVideoRecorderClient(); // this is an example, normally services inside you project do stuff like this and you trigger them by // execute requests via the KernelBrowser client file_get_contents('https://www.google.de'); // cassette.path is configured to '%kernel.project_dir%/tests/Fixtures' // recordings are written to %kernel.project_dir%/tests/Fixtures/Functional/ExampleTest/test // cassette.path + TestCasePath (- ignoredTestSuiteNamespacePrefix) + TestName } }
Configuration reference
vcr: enabled: true library_hooks: stream_wrapper: false curl: false soap: false request_matchers: method: true url: true query_string: true host: true headers: true body: true post_fields: true cassette: type: json path: '%kernel.cache_dir%/vcr' name: vcr
Credits
- Kévin Gomez
- Ludovic Fleury - to whom I borrowed the design of the web profiler part from his GuzzleBundle.
- Simon Hübner - making the bundle SF 5.4 compatible
- Daniel Hürtgen - making the bundle PHP 8 compatible and providing extra TestCase helper
License
This bundle is released under the MIT license.