90bigfoot/phpacto repository overview

⁠PHPacto

Contract testing solution for your applications

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

You can find some contract examples in examples directory.

⁠Usage standalone CLI

First of all clone this repository git clone [email protected]:bigfoot90/phpacto.git and install vendors with composer composer install. Can use phpdotenv⁠ to load environment variables from file.

⁠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

⁠Server Mock

You can use this server mock to provide mocked responses to your clients.

export ALLOW_ORIGIN=all # This adds CORS headers to the response
export CONTRACTS_DIR='where-are/your-contracts/stored'
php -S 0.0.0.0:8000 bin/server_mock.php

If there are not a Contract matching your request, the server cannot generate a response. So a special Response with status code 418 will be returned.

⁠Mock Proxy Recorder

You can create new contract file from an already working client-server application.

export CONTRACTS_DIR='where/new-contracts/will-be-stored/'
php -S 0.0.0.0:8000 bin/mock_proxy_recorder.php

⁠Usage standalone CLI with Docker

⁠Validate

Validate your contracts with

docker run -it --rm \
    -v $PWD/contracts:/srv/data \
    -e CONTRACTS_DIR=data \
    -p 8000:8000 \
    90bigfoot/phpacto \
    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 \
    90bigfoot/phpacto \
    curl

⁠Server Mock

You can use this server mock to provide mocked responses to your clients.

docker run -it --rm \
    -v $PWD/contracts:/srv/data \
    -e CONTRACTS_DIR=data \
    -p 8000:8000 \
    90bigfoot/phpacto \
    server_mock

If there are not a Contract matching your request, the server cannot generate a response. So a special Response with status code 418 will be returned.

⁠Mock Proxy Recorder

You can create new contract file from an already working client-server application.

docker run -it --rm \
	-v $PWD/contracts:/srv/data \
	-e CONTRACTS_DIR=data \
	-e RECORDER_PROXY_TO=http://localhost/ \
	-p 8000:8000 \
	90bigfoot/phpacto \
	mock_proxy_recorder

⁠Testing your application with PHPUnit and PHPacto

PHPacto is compatible with PHP ^7.1, PHPUnit ^7.0, Guzzle ^5.3.1|^6.0|^7.0.

If your project satisfies this requirements, you can run composer req --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 so 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.