Pact PHP 使用教程

Pact PHP 使用教程

pact-phpPHP version of Pact. Enables consumer driven contract testing, providing a mock service and DSL for the consumer project, and interaction playback and verification for the service provider project项目地址:https://gitcode.com/gh_mirrors/pa/pact-php

项目介绍

Pact PHP 是 Pact 基金会提供的一个 PHP 版本的消费者驱动契约测试工具。Pact 是一个事实上的 API 契约测试工具，它通过替换昂贵且脆弱的端到端集成测试，提供快速、可靠且易于调试的单元测试。Pact PHP 支持 HTTP/REST 和事件驱动系统，配置灵活的模拟服务器，强大的匹配规则防止测试变得脆弱，并与 Pact Broker / PactFlow 集成，以实现强大的 CI/CD 工作流程。

项目快速启动

安装

首先，克隆 Pact PHP 仓库：

git clone git@github.com:pact-foundation/pact-php.git
cd pact-php

安装所有依赖：

composer install

运行示例

进入示例文件夹并运行示例：

cd examples/json
phpunit

应用案例和最佳实践

消费者测试

编写一个消费者测试：

namespace App\Tests;

use App\Service\HttpClientService;
use PhpPact\Consumer\InteractionBuilder;
use PhpPact\Consumer\Matcher\Matcher;
use PhpPact\Consumer\Model\ConsumerRequest;
use PhpPact\Consumer\Model\ProviderResponse;

class ExampleConsumerTest extends \PHPUnit\Framework\TestCase
{
    public function testExample()
    {
        // 设置请求和响应
        $request = new ConsumerRequest();
        $request->setMethod('GET');
        $request->setPath('/example');

        $response = new ProviderResponse();
        $response->setStatus(200);

        // 构建交互
        $interactionBuilder = new InteractionBuilder();
        $interactionBuilder->given('Example state')
            ->uponReceiving('Example request')
            ->with($request)
            ->willRespondWith($response);

        // 运行测试
        $client = new HttpClientService();
        $result = $client->sendRequest($request);

        $this->assertEquals(200, $result->getStatus());
    }
}

提供者测试

验证提供者：

namespace App\Tests;

use PhpPact\Standalone\ProviderVerifier\ProviderVerifier;

class ExampleProviderTest extends \PHPUnit\Framework\TestCase
{
    public function testExample()
    {
        $verifier = new ProviderVerifier();
        $verifier->verify('path/to/pact/file', 'provider_base_url');
    }
}

典型生态项目

Pact PHP 可以与以下生态项目集成：

• Pact Broker: 用于管理契约文件和 CI/CD 工作流程。
• PactFlow: Pact Broker 的商业版本，提供更多高级功能。
• PHPUnit: PHP 的单元测试框架，用于运行 Pact PHP 测试。

通过这些集成，Pact PHP 可以实现从前端到后端的全栈集成测试，确保 API 和微服务的可靠性和一致性。

pact-phpPHP version of Pact. Enables consumer driven contract testing, providing a mock service and DSL for the consumer project, and interaction playback and verification for the service provider project项目地址:https://gitcode.com/gh_mirrors/pa/pact-php