Pact PHP

Fast, easy and reliable testing for your APIs and microservices.

Documentation

Need Help

Installation

composer require pact-foundation/pact-php --dev# 🚀 now write some tests!

Requirements

Do Not Track

Usage

Writing a Consumer test

namespaceApp\Tests;useApp\Service\HttpClientService;usePhpPact\Consumer\InteractionBuilder;usePhpPact\Consumer\Matcher\Matcher;usePhpPact\Consumer\Model\ConsumerRequest;usePhpPact\Consumer\Model\ProviderResponse;usePhpPact\Standalone\MockService\MockServerConfig;usePHPUnit\Framework\TestCase;class ConsumerServiceHelloTestextends TestCase{publicfunctiontestGetHelloString():void    {$matcher =newMatcher();// Create your expected request from the consumer.$request =newConsumerRequest();$request            ->setMethod('GET')            ->setPath('/hello/Bob')            ->addHeader('Content-Type','application/json');// Create your expected response from the provider.$response =newProviderResponse();$response            ->setStatus(200)            ->addHeader('Content-Type','application/json')            ->setBody(['message' =>$matcher->term('Hello, Bob','(Hello, )[A-Za-z]+')            ]);// Create a configuration that reflects the server that was started. You can create a custom MockServerConfigInterface if needed.$config =newMockServerConfig();$config            ->setConsumer('jsonConsumer')            ->setProvider('jsonProvider')            ->setPactDir(__DIR__.'/../../../pacts');if ($logLevel =\getenv('PACT_LOGLEVEL')) {$config->setLogLevel($logLevel);        }$builder =newInteractionBuilder($config);$builder            ->uponReceiving('A get request to /hello/{name}')            ->with($request)            ->willRespondWith($response);// This has to be last. This is what makes FFI calls to register the interaction and start the mock server.$service =newHttpClientService($config->getBaseUri());// Pass in the URL to the Mock Server.$helloResult =$service->getHelloString('Bob');// Make the real API request against the Mock Server.$verifyResult =$builder->verify();// This will verify that the interactions took place.$this->assertTrue($verifyResult);// Make your assertions.$this->assertEquals('Hello, Bob',$helloResult);    }}

Verifying a Provider

namespaceApp\Tests;useGuzzleHttp\Psr7\Uri;usePhpPact\Standalone\ProviderVerifier\Model\VerifierConfig;usePhpPact\Standalone\ProviderVerifier\Verifier;usePhpPactTest\Helper\PhpProcess;usePHPUnit\Framework\TestCase;class PactVerifyTestextends TestCase{privatePhpProcess$process;protectedfunctionsetUp():void    {$this->process =newPhpProcess(__DIR__ .'/path/to/public/');$this->process->start();    }protectedfunctiontearDown():void    {$this->process->stop();    }/**     * This test will run after the web server is started.     */publicfunctiontestPactVerifyConsumer()    {$config =newVerifierConfig();$config->getProviderInfo()            ->setName('jsonProvider')// Providers name to fetch.            ->setHost('localhost')            ->setPort($this->process->getPort());$config->getProviderState()            ->setStateChangeUrl(newUri(sprintf('http://localhost:%d/pact-change-state',$this->process->getPort())))        ;if ($level =\getenv('PACT_LOGLEVEL')) {$config->setLogLevel($level);        }$verifier =newVerifier($config);$verifier->addFile(__DIR__ .'/path/to/pacts/jsonConsumer-jsonProvider.json');$verifyResult =$verifier->verify();$this->assertTrue($verifyResult);    }}

Compatibility

Roadmap

Contributing