bigfoot90/phpacto

Contract testing tool integrated with Guzzle and Phpunit

1.0.0 2024-10-28 15:55 UTC

Requires

• php: >=8.2
• http-interop/http-factory-discovery: ^1.5
• symfony/console: >=2.5
• symfony/finder: >=2.1
• symfony/routing: >=2.1
• symfony/serializer: >=6.4
• symfony/serializer-pack: *
• symfony/yaml: >=2.0

Requires (Dev)

• ext-json: *
• guzzlehttp/guzzle: >=6.0
• laminas/laminas-diactoros: ^2.0|^3.0
• mikey179/vfsstream: ^1.6.7
• namshi/cuzzle: >=2.0.1
• nyholm/psr7: ^1.8
• phpunit/phpunit: ^9.5
• symfony/psr-http-message-bridge: ^2.3
• yoast/phpunit-polyfills: ^2.0

Suggests

• namshi/cuzzle: Generates cUrl command out of you PHPacto contracts
• phpunit/phpunit: Integration with PHPUnit testing framework

GPL-3.0

• Damian Długosz

README

Contract testing solution for your API's and microservices

If you want to know more about Contract Testing please read more here and here.

DISCLAIMER: This is a work in progress. The code can be subject to any changes without BC until the release version 1.0.0. Please use the issue tracker to report any enhancements or issues you encounter.

You can find some contract examples in examples directory.

Usage standalone CLI

First of all clone this repository git clone [e-mail]:PHPacto/PHPacto.git and install vendors with composer composer install.

Validate

Validate your contracts with

bin/phpacto validate path-to/directory-or-single-file

cURL command generator

Generate cURL commands from contracts with

bin/phpacto curl path-to/directory-or-single-file

SUGGESTION: Can use phpdotenv to load environment variables from file.

Usage with Docker

Validate

Validate your contracts with

docker run -it --rm \
    -v $PWD/contracts:/srv/data \
    -e CONTRACTS_DIR=data \
    -p 8000:8000 \
    phpacto/mock-server \
    validate

cURL command generator

Generate cURL commands from contracts with

docker run -it --rm \
    -v $PWD/contracts:/srv/data \
    -e CONTRACTS_DIR=data \
    -p 8000:8000 \
    phpacto/mock-server \
    curl

Server Mock

See https://github.com/PHPacto/mock-server

Mock Proxy Recorder

See https://github.com/PHPacto/recorder

Testing your application

Compatibility table

If your project satisfies these requirements, you can run composer require --dev bigfoot90/phpacto and test your contracts with phpunit, else you need to run contracts testing with PHPacto's CLI wich is slower but works with any kind of application.

Integration with PHPUnit

If your test ends with too much verbose tracelog maybe your TestCase is not extending from Bigfoot\PHPacto\Test\PHPUnit\PHPactoTestCase, so add this line in your setUp method:

PHPUnit\Util\Blacklist\Blacklist::$blacklistedClassNames[__CLASS__] = 1;

See this Gist https://gist.github.com/bigfoot90/d4f146bacad359329d219a804f6cd12a There are two different test files ConsumerTest.php and ProviderTest.php

Mastering with PHPacto contract Rules

Read the dedicated page here

Contributing

Feel free to contribute by opening a pull request. Bug fixes or feature suggestions are always welcome.