Download the PHP package phiremock/phiremock-codeception-extension without Composer
On this page you can find all versions of the php package phiremock/phiremock-codeception-extension. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download phiremock/phiremock-codeception-extension
More information about phiremock/phiremock-codeception-extension
Files in phiremock/phiremock-codeception-extension
Package phiremock-codeception-extension
Short Description Codeception extension for PhireMock. Allows to stub remote services for HTTP requests.
License GPL-3.0-or-later
Informations about the package phiremock-codeception-extension
phiremock-codeception-extension
Codeception extension and module to make working with Phiremock even easier. It allows to start a Phiremock server specifically for the acceptance tests to run or to connect to an already running Phiremock server.
Installation
Composer:
This project is published in packagist, so you just need to add it as a dependency in your composer.json:
NOTE Phiremock uses a dev-master version of react/http to work. Because of this, until reactphp guys tag a new version you will need to set your project's minimum stability to dev.
How to use
Extension
The extension provides an easy way to start a Phiremock server with configured host, port, debug mode and logs path.
Configuration
In codeception.yml you will need to enable Phiremock extension and configure it in a proper way:
Note: Since Codeception version 2.2.7, extensions configuration can be added directly in the suite configuration file. That will avoid phiremock to be started for every suite.
Phiremock uses annotations internally. To be able to run the extension, the annotations autoloader must be activated. To do this, you must add the next lines in the bootstrap file where you include your composer autoloader:
Parameters
- listen: Specifies the interface and port where phiremock must listen for requests
- bin_path: Path where Phiremock "binary" is located
- logs_path: Path where to write the output
- debug: Where to write debug data to log files
- startDelay: Time to wait after Phiremock was started to start running the tests (used to give time to Phiremock to boot)
- expectations_path: Specifies a directory to search for json files defining expectations to load by default.
Module
The 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.
Configuration
You need to enable Phiremock module in your suite's configuration file:
Use
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:
haveACleanSetupInRemoteService
Cleans the server of all configured expectations, scenarios and requests history, and reloads expectation files.
dontExpectRequestsInRemoteService
Cleans all previously configured expectations and requests history.
haveCleanScenariosInRemoteService
Cleans the state of all scenarios (sets all of them to inital state).
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.
didNotReceiveRequestsInRemoteService
Resets the requests counter for the verifier in Phiremock.
Use case
Yii2-Curl
Yii2-Curl uses phiremock-codeception-extension for functional testing. You can see the configuration for the extension and the module, as well as how Phiremock is configured in the tests.
All versions of phiremock-codeception-extension with dependencies
phiremock/phiremock Version ^1.8
codeception/codeception Version ^2.2
symfony/process Version ^3.1|^2.7.15|^4.0