igaster / php-vcr
记录您的测试套件的HTTP交互,并在未来的测试运行中回放它们,以实现快速、确定性和精确的测试。
1.5.4
2021-08-02 09:45 UTC
Requires
- php: >=7.2
- ext-curl: *
- beberlei/assert: ^3.2.5
- symfony/event-dispatcher: ^2.4|^3.0|^4.0|^5.0
- symfony/yaml: ~2.1|^3.0|^4.0|^5.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^2.16
- mikey179/vfsstream: ^1.6
- phpstan/phpstan: ^0.12
- phpstan/phpstan-beberlei-assert: ^0.12.0
- phpunit/phpunit: ^8.4.0
- sebastian/version: ^1.0.3|^2.0
- thecodingmachine/phpstan-strict-rules: ^0.12
- dev-master
- 1.5.x-dev
- 1.5.4
- 1.5.3
- 1.5.2
- 1.5.1
- 1.5.0
- 1.5.0alpha1
- 1.5.0alpha0
- 1.4.x-dev
- 1.4.5
- 1.4.4
- 1.4.3
- 1.4.2
- 1.4.1
- 1.4.0
- 1.3.4
- 1.3.3
- 1.3.2
- 1.3.1
- 1.3.0
- 1.2.8
- 1.2.7
- 1.2.6
- 1.2.5
- 1.2.4
- 1.2.3
- 1.2.2
- 1.2.1
- 1.2
- 1.1.8
- 1.1.7
- 1.1.6
- 1.1.5
- 1.1.4
- 1.1.3
- 1.1.2
- 1.1.1
- 1.1.0
- 1.0.7
- 1.0.6
- 1.0.5
- 1.0.4
- 1.0.3
- 1.0.2
- 1.0.1
- 1.0.0
- dev-dev
- dev-github-actions
- dev-phpstan-for-tests
- dev-2021-update
- dev-1.5-improve-event-dispatcher-detection
This package is auto-updated.
Last update: 2024-08-29 06:01:44 UTC
README
这是将VCR Ruby库移植到PHP的一个例子。
记录您的测试套件的HTTP交互,并在未来的测试运行中回放它们,以实现快速、确定性和精确的测试。有关文档,请访问php-vcr网站。
免责声明:在PHP中这样做并不像在支持猴子补丁的编程语言(我在看你,Ruby)中那样容易。
功能
- 自动记录和回放您的HTTP(s)交互,配置和设置代码最少。
- 支持常见的http功能和扩展
- 使用streamWrapper的所有内容:fopen(),fread(),file_get_contents()等,无需任何修改(除了
$http_response_header
,见#96) - SoapClient通过在您的
tests/bootstrap.php
中添加\VCR\VCR::turnOn();
实现 - curl(),通过在您的
tests/bootstrap.php
中添加\VCR\VCR::turnOn();
实现
- 使用streamWrapper的所有内容:fopen(),fread(),file_get_contents()等,无需任何修改(除了
- 相同的请求可以在不同的测试中接收不同的响应 - 只需使用不同的磁带。
- 通过设置记录模式禁用您未明确允许的所有HTTP请求
- 根据HTTP方法、URI、主机、路径、正文和头信息进行请求匹配是可配置的,或者您可以轻松实现一个自定义请求匹配器来处理任何需求。
- 记录的请求和响应以您选择的序列化格式存储在磁盘上(目前内置了YAML和JSON,您可以轻松实现自己的自定义序列化器)
- 支持PHPUnit注解。
使用示例
使用静态方法调用
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'); } }
您可以通过使用phpunit-testlistener-vcr在PHPUnit中使用注解
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. } }
安装
只需运行以下命令
$ composer require --dev php-vcr/php-vcr
依赖关系
PHP-VCR依赖于以下内容
- PHP 7.2+
- Curl扩展
- symfony/event-dispatcher
- symfony/yaml
- beberlei/assert
Composer安装所有依赖项,除了curl之类的扩展。
运行测试
要运行所有测试,您需要使用composer获取开发依赖项
composer install composer test
变更日志
变更日志已移至PHP-VCR版本发布页面。
版权
版权所有(c)2013-2016 Adrian Philipp。在MIT许可的条款下发布。有关详细信息,请参阅LICENSE。贡献者