# phiremock-codeception-extension

**Repository Path**: mirrors_linslin/phiremock-codeception-extension

## Basic Information

- **Project Name**: phiremock-codeception-extension
- **Description**: Codeception extension and module to make working with phiremock even easier.
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-09
- **Last Updated**: 2026-05-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# phiremock-codeception-extension
Codeception extension and module to make working with [Phiremock](https://github.com/mcustiel/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:

```json
    "require-dev": {
        "mcustiel/phiremock-codeception-extension": "*"
    },
    "minimum-stability": "dev"
```

> *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:

```yaml
extensions:
    enabled:
        - \Codeception\Extension\Phiremock
    config:
        \Codeception\Extension\Phiremock:
            listen: 127.0.0.1:18080 # defaults to 0.0.0.0:8086
            bin_path: ../vendor/bin # defaults to codeception_dir/../vendor/bin 
            logs_path: /var/log/my_app/tests/logs # defaults to codeception's tests output dir
            debug: true # defaults to false
            startDelay: 1 # default to 0
```

## 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) 

### 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:

```yaml
modules:
    enabled:
        - Phiremock:
            host: 127.0.0.1
            port: 18080
```

#### 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:

```php
    $I->expectARequestToRemoteServiceWithAResponse(
        Phiremock::on(
            A::getRequest()->andUrl(Is::equalTo('/some/url'))
        )->then(
            Respond::withStatusCode(203)->andBody('I am a response')
        )
    );
```

#### haveACleanSetupInRemoteService
Cleans the server of all configured expectations, scenarios and requests history.

```php
    $I->haveACleanSetupInRemoteService();
```

#### dontExpectRequestsInRemoteService
Cleans all previously configured expectations and requests history.

```php
    $I->dontExpectRequestsInRemoteService();
```

#### haveCleanScenariosInRemoteService
Cleans the state of all scenarios (sets all of them to inital state).

```php
    $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.

```php
    $I->seeRemoteServiceReceived(1, A::getRequest()->andUrl(Is::equalTo('/some/url')));
```