mcustiel / phiremock-codeception-module
Codeception module for PhireMock. Allows to stub remote services for HTTP requests.
Installs: 289 754
Dependents: 2
Suggesters: 0
Security: 0
Stars: 6
Watchers: 3
Forks: 4
Open Issues: 0
Type:project
Requires
- php: ^8.0
- codeception/codeception: ^5.0
- codeception/lib-asserts: ^1.1|^2.0
- mcustiel/phiremock-client: ^1.0
Requires (Dev)
This package is auto-updated.
Last update: 2024-10-29 05:16:51 UTC
README
This codeception module allows you to connect to a Phiremock Server and to interact with it in a semantic way through the codeception actor in your tests.
Installation
Composer:
"require-dev": { "mcustiel/phiremock-codeception-module": "^1.0", "guzzlehttp/guzzle": "^6.0" }
Configuration
You need to enable Phiremock module in your suite's configuration file:
modules: enabled: - Phiremock: host: phiremock-myhost.dev # Defaults to localhost port: 18080 # Defaults to 8086 reset_before_each_test: false # if set to true, executes `$I->haveACleanSetupInRemoteService` before each test. Defaults to false expectations_path: /path/to/my/expectation/json/files # Defaults to codeception_dir/_data/phiremock-expectations client_factory: \My\ClientFactory # Defaults to 'default' secure: true # Default: false extra_connections: [] # Default: empty array
Options
host
Specifies the host where phiremock-server is listening for requests.
Default: localhost
port
Specifies the port where phiremock-server is listening for requests.
Default: 8086
reset_before_each_test
Determines whether or not phiremock-server must be reset before each test.
Default: false
expectations_path
Specifies the path where expectation json files are located. The files can then be referenced using annotations and will be loaded automatically.
Default: codeception_dir/_data/phiremock-expectations
secure
A boolean specifying if the connection is secure or not. If it's secure, the request is done through https, otherwise it's done through http.
Default: false. The requests to phiremock-client are done through http.
extra_connections
An list of objects specifying the parameters to request other phiremock-servers. This is useful if you want to have 2 phiremock instances, one listening for http connections, and the other listening for https connections.
Default: An empty list, meaning that no other phiremock servers are requested.
Example
modules: enabled: - Phiremock: host: phiremock-myhost.dev port: 18080 secure: false extra_connections: secure-host: host: phiremock-myhost.dev port: 18081 secure: true
Then in the code you can use each connection by name as follows:
<?php $I->takeConnection('secure-host')->reset();
The default connection is called 'default' and you can also take it:
$I->takeConnection('default')->reset();
client_factory
Specifies the fully qualified class name of a class which overrides default phiremock-client factory. This is useful if you want to avoid using Guzzle HttpClient v6 (the one supported by default in phiremock-client).
Default: default
Example
"require-dev": { "mcustiel/phiremock-codeception-module": "v1.0", "guzzlehttp/guzzle": "^7.0"
The you can create a factory as follows and provide the fully qualified class name in the module configuration:
<?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(['allow_redirects' => false]); } }
Any http client implementing psr18 can be provided.
Usage
The module provides the following handy methods to communicate with Phiremock server:
expectARequestToRemoteServiceWithAResponse
Allows you to setup an expectation in Phiremock, specifying the expected request and the response the server should give for it:
$I->expectARequestToRemoteServiceWithAResponse( on(getRequest()->andUrl(isEqualTo('/some/url'))) ->then(respond(203)->andBody('I am a response')) );
haveACleanSetupInRemoteService
Cleans the server of all configured expectations, scenarios and requests history, and reloads expectation files if they are present.
$I->haveACleanSetupInRemoteService();
dontExpectRequestsInRemoteService
Cleans all previously configured expectations and requests history.
$I->dontExpectRequestsInRemoteService();
haveCleanScenariosInRemoteService
Cleans the state of all scenarios (sets all of them to inital state).
$I->haveCleanScenariosInRemoteService();
seeRemoteServiceReceived
Allows you to verify that the server received a request a given amount of times. This request could or not be previously set up as an expectation.
$I->seeRemoteServiceReceived(1, getRequest()->andUrl(isEqualTo('/some/url')));
didNotReceiveRequestsInRemoteService
Resets the requests counter for the verifier in Phiremock.
$I->didNotReceiveRequestsInRemoteService();
grabRequestsMadeToRemoteService
Retrieves all the requests received by Phiremock server matching the one specified.
$I->grabRequestsMadeToRemoteService(getRequest()->andUrl(isEqualTo('/some/url')));
setScenarioState
Forces the state of a scenario.
$I->setScenarioState('scenarioName', 'newScenarioState');
takeConnection
Allows to use several connections to different phiremock servers.
$I->takeConnection('connectionName');
@expectation Annotations
Allows you to set up an expectation via a json file
/** * @expectation("get_client_timeout") */ public function test(FunctionalTester $I) { ... }
That will load by default the file at tests/_data/phiremock-expectations/get_client_timeout.json
. The path where to place the expectations is configurable.
You may use expectations placed in subdirectories
/** * @expectation("edge_cases/get_client_timeout") */ public function test(FunctionalTester $I) { ... }
Multiple annotation formats are accepted
* @expectation get_client_timeout
* @expectation get_client_timeout.json
* @expectation(get_client_timeout.json)
* @expectation(get_client_timeout)
* @expectation("get_client_timeout")
See also:
- Phiremock Client: https://github.com/mcustiel/phiremock-client
- Phiremock Codeception Extension: https://github.com/mcustiel/phiremock-codeception-extension
- Examples in tests: https://github.com/mcustiel/phiremock-codeception-module/tree/master/tests/acceptance