mcustiel / phiremock-client
Client library to communicate with Phiremock server
Installs: 472 722
Dependents: 4
Suggesters: 0
Security: 0
Stars: 14
Watchers: 4
Forks: 6
Open Issues: 1
Type:project
Requires
- php: ^7.2|^8.0
- ext-json: *
- mcustiel/phiremock-common: ^1.0
- psr/http-client: ^1.0
Requires (Dev)
- codeception/codeception: ^4.0
- codeception/module-asserts: ^1.0
- codeception/module-phpbrowser: ^1.0
- codeception/module-rest: ^1.0
- guzzlehttp/guzzle: ^6.0
- mcustiel/phiremock-server: ^1.0
- phpunit/phpunit: ~8.0
- symfony/process: ^3.0|^4.0|^5.0
Suggests
- guzzlehttp/guzzle: Provides default client for http requests execution.
This package is auto-updated.
Last update: 2024-11-25 00:05:04 UTC
README
Phiremock client provides a nice API to interact with Phiremock Server, allowing developers to setup expectations, clear state, scenarios etc. Through a fluent interface.
Installation
Default installation through composer
This project is published in packagist, so you just need to add it as a dependency in your composer.json:
"require-dev": { "mcustiel/phiremock-client": "^1.0", "guzzlehttp/guzzle": "^6.0" }
Phiremock Client requires guzzle client v6 to work. This dependency can be avoided and you can choose any psr18-compatible http client and overwrite Phiremock Client's factory to provide it.
Overwriting the factory class
If guzzle client v6 is provided as a dependency no extra configuration is needed. If you want to use a different http client you need to provide it to phiremock server as a psr18-compatible client. For instance, if you want to use guzzle client v7 you need to extend phiremock server's factory class:
<?php namespace My\Namespace; use Mcustiel\Phiremock\Client\Factory; use GuzzleHttp; use Psr\Http\Client\ClientInterface; class FactoryWithGuzzle7 extends Factory { public function createRemoteConnection(): ClientInterface { return new GuzzleHttp\Client(); } }
Then use this factory class to create the Phiremock Client Facade.
Usage
Creating the Client Facade
Create the Client Facade by requesting it from the factory object:
<?php use Mcustiel\Phiremock\Client\Connection\Host; use Mcustiel\Phiremock\Client\Connection\Port; $phiremockClient = Factory::createDefault()->createPhiremockClient(new Host('my.phiremock.host'), new Port('8080'));
Now you can use $phiremockClient
to access all the configuration options of Phiremock Server.
Note: Phiremock will by default listen for http (unsecured) connections.
Connection to a secure server
If phiremock-server is listening for https connections. You can pass the scheme to use as a third argument:
<?php use Mcustiel\Phiremock\Client\Connection\Host; use Mcustiel\Phiremock\Client\Connection\Port; use Mcustiel\Phiremock\Client\Connection\Scheme; $phiremockClient = Factory::createDefault()->createPhiremockClient(new Host('my.phiremock.host'), new Port('8443'), Scheme::createHttps());
Expectation creation
<?php use Mcustiel\Phiremock\Client\Phiremock; use Mcustiel\Phiremock\Client\Utils\A; use Mcustiel\Phiremock\Client\Utils\Is; use Mcustiel\Phiremock\Client\Utils\Respond; use Mcustiel\Phiremock\Domain\Options\Priority; // ... $phiremockClient->createExpectation( Phiremock::on( A::getRequest() ->andUrl(Is::equalTo('/potato/tomato')) ->andBody(Is::containing('42')) ->andHeader('Accept', Is::equalTo('application/banana')) ->andFormField('name', Is::equalTo('potato')) )->then( Respond::withStatusCode(418) ->andBody('Is the answer to the Ultimate Question of Life, The Universe, and Everything') ->andHeader('Content-Type', 'application/banana') )->setPriority(new Priority(5)) );
Also a cleaner/shorter way to create expectations is provided by using helper functions:
<?php use Mcustiel\Phiremock\Client\Phiremock; use function Mcustiel\Phiremock\Client\contains; use function Mcustiel\Phiremock\Client\getRequest; use function Mcustiel\Phiremock\Client\isEqualTo; use function Mcustiel\Phiremock\Client\request; use function Mcustiel\Phiremock\Client\respond; use function Mcustiel\Phiremock\Client\on; use Mcustiel\Phiremock\Domain\Options\Priority; // ... $phiremockClient->createExpectation( on( getRequest('/potato/tomato') ->andBody(contains('42')) ->andHeader('Accept', isEqualTo('application/banana')) ->andFormField('name', isEqualTo('potato')) )->then( respond(418) ->andBody('Is the answer to the Ultimate Question of Life, The Universe, and Everything') ->andHeader('Content-Type', 'application/banana') )->setPriority(new Priority(5)) );
This code is equivalent to the one in the previous example.
You can see the list of shortcuts here: https://github.com/mcustiel/phiremock-client/blob/master/src/helper_functions.php
Listing created expectations
The listExpecatations
method returns an array of instances of the Expectation class containing all the current expectations checked by Phiremock Server.
<?php $expectations = $phiremockClient->listExpectations();
Clear all configured expectations
This will remove all expectations checked, causing Phiremock Server to return 404 for every non-phiremock-api request.
<?php $phiremockClient->clearExpectations();
List requests received by Phiremock
Use this method to get a list of Psr-compatible Requests received by Phiremock Server.
Lists all requests:
<?php $phiremockClient->listExecutions();
Lists requests matching condition:
<?php $phiremockClient->listExecutions(getRequest()->andUrl(isEqualTo('/test'));
Note: Phiremock's API request are excluded from this list.
Count requests received by Phiremock
Provides an integer >= 0 representing the amount of requests received by Phiremock Server.
Count all requests:
<?php $phiremockClient->countExecutions();
Count requests matching condition:
<?php $phiremockClient->countExecutions(getRequest()->andUrl(isEqualTo('/test'));
Note: Phiremock's API request are excluded from this list.
Clear stored requests
This will clean the list of requests saved on Phiremock Server and resets the counter to 0.
<?php $phiremockClient->clearRequests();
Set Scenario State
Force a scenario to have certain state on Phiremock Server.
<?php $phiremockClient->setScenarioState('myScenario', 'loginExecuted');
Reset Scenarios States
Reset all scenarios to the initial state (Scenario.START).
<?php $phiremockClient->resetScenarios();
Reset all
Sets Phiremock Server to its initial state. This will cause Phiremock Server to:
- clear all expectations.
- clear the stored requests.
- reset all the scenarios.
- reload all expectations stored in files.
<?php $phiremockClient->reset();
Appendix
See also:
- Phiremock Server: https://github.com/mcustiel/phiremock-server
- Phiremock Codeception Module: https://github.com/mcustiel/phiremock-codeception-module
- Examples in tests: https://github.com/mcustiel/phiremock-client/tree/master/tests/acceptance/api
Contributing:
Just submit a pull request. Don't forget to run tests and php-cs-fixer first and write documentation.
Thanks to:
- Denis Rudoi (@drudoi)
- Henrik Schmidt (@mrIncompetent)
- Nils Gajsek (@linslin)
- Florian Levis (@Gounlaf)
And everyone who submitted their Pull Requests.