Wallogit.com
2017 © Pedro Peláez
Client library to communicate with Phiremock server
Phiremock client provides a nice API to interact with Phiremock Server, allowing developers to setup expectations, clear state, scenarios etc. Through a fluent interface., (*1)
This project is published in packagist, so you just need to add it as a dependency in your composer.json:, (*3)
"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., (*4)
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:, (*5)
<?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., (*6)
Create the Client Facade by requesting it from the factory object:, (*7)
<?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., (*8)
Note: Phiremock will by default listen for http (unsecured) connections., (*9)
If phiremock-server is listening for https connections. You can pass the scheme to use as a third argument:, (*10)
<?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());
<?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:, (*11)
<?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., (*12)
You can see the list of shortcuts here: https://github.com/mcustiel/phiremock-client/blob/master/src/helper_functions.php, (*13)
The listExpecatations method returns an array of instances of the Expectation class containing all the current expectations checked by Phiremock Server., (*14)
<?php $expectations = $phiremockClient->listExpectations();
This will remove all expectations checked, causing Phiremock Server to return 404 for every non-phiremock-api request., (*15)
<?php $phiremockClient->clearExpectations();
Use this method to get a list of Psr-compatible Requests received by Phiremock Server., (*16)
Lists all requests:, (*17)
<?php $phiremockClient->listExecutions();
Lists requests matching condition:, (*18)
<?php
$phiremockClient->listExecutions(getRequest()->andUrl(isEqualTo('/test'));
Note: Phiremock's API request are excluded from this list., (*19)
Provides an integer >= 0 representing the amount of requests received by Phiremock Server., (*20)
Count all requests:, (*21)
<?php $phiremockClient->countExecutions();
Count requests matching condition:, (*22)
<?php
$phiremockClient->countExecutions(getRequest()->andUrl(isEqualTo('/test'));
Note: Phiremock's API request are excluded from this list., (*23)
This will clean the list of requests saved on Phiremock Server and resets the counter to 0., (*24)
<?php $phiremockClient->clearRequests();
Force a scenario to have certain state on Phiremock Server., (*25)
<?php
$phiremockClient->setScenarioState('myScenario', 'loginExecuted');
Reset all scenarios to the initial state (Scenario.START)., (*26)
<?php $phiremockClient->resetScenarios();
Sets Phiremock Server to its initial state. This will cause Phiremock Server to: 1. clear all expectations. 2. clear the stored requests. 3. reset all the scenarios. 4. reload all expectations stored in files., (*27)
<?php $phiremockClient->reset();
Just submit a pull request. Don't forget to run tests and php-cs-fixer first and write documentation., (*28)
And everyone who submitted their Pull Requests., (*29)
Client library to communicate with Phiremock server
GPL-3.0+ GPL-3.0-or-later
mock server http tests external acceptance
Client library to communicate with Phiremock server
GPL-3.0+
mock server http tests external acceptance