codeception-wiremock-extension

This Codeception Extension allows developers and testers to use WireMock to mock external services when running codeception tests.

codeception-wiremock-extension connects to an already running instance of WireMock or can also run automatically a local standalone one. And, it is able to download the version of wiremock you preffer and run it too. After the tests are finished it will close the connection and turn wiremock service off (when it started it).

See also

• WireMock PHP library
• Stubbing using WireMock
• Verifying using WireMock

Note

If you need an application with a functionality that is similar to the one offered by WireMock and is 100% PHP, please give Phiremock a try: Phiremock, it also has a nice codeception extension.

Installation

Composer:

From console:

composer require --dev mcustiel/codeception-wiremock-extension

This project is published in packagist, so you just need to add it as a dependency in your composer.json:

    "require-dev": {
        // ...
        "mcustiel/codeception-wiremock-extension": "*"
    }

If you want to access directly to this repo, adding this to your composer.json should be enough:

{
    "repositories": [
        {
            "type": "vcs",
            "url": "https://github.com/mcustiel/codeception-wiremock-extension"
        }
    ],
    "require-dev": {
        "mcustiel/codeception-wiremock-extension": "dev-master"
    }
}

Or just download the release and include it in your path.

Configuration Examples

Module

The module allow you to connect to a WireMock instance, it can be the one ran by the extension or an already running one.

# acceptance.suite.yml
modules:
    enabled:
        - WireMock:
            host: my.wiremock.host # defaults to 127.0.0.1
            port: 80 # defaults to 8080

Extension

Default configuration

This configuration will download WireMock version 1.57 and run it on port 8080, writing logs to codeception tests _output dir.

# codeception.yml
extensions:
    enabled:
        - Codeception\Extension\WireMock    

Connect to a running WireMock instance

# codeception.yml
extensions:
    enabled:
        - Codeception\Extension\WireMock
    config:     
        Codeception\Extension\WireMock:
            host: my.wiremock.server
            port: 8080

Start a local WireMock instance and run it with given command line arguments

# codeception.yml
extensions:
    enabled:
        - Codeception\Extension\WireMock
    config:     
        Codeception\Extension\WireMock:
            jar-path: /opt/wiremock/bin/wiremock-standalone.jar
            port: 18080
            https-port: 18443
            verbose: true
            root-dir: /opt/wiremock/root
            

Download a WireMock instance and run it with given command line arguments

# codeception.yml
extensions:
    enabled:
        - Codeception\Extension\WireMock
    config:     
        Codeception\Extension\WireMock:
            download-version: 1.57
            port: 18080
            https-port: 18443
            verbose: true
            root-dir: /opt/wiremock/root
            logs-path: /var/log/wiremock 

How to use

Prepare your application

First of all, configure your application so when it is being tested it will replace its external services with WireMock. For instance, if you make some requests to a REST service located under http://your.rest.interface, replace that url in configuration with the url where WireMock runs, for instance: http://localhost:8080/rest_interface.

Write your tests

// YourCest.php
class YourCest extends \Codeception\TestCase\Test
{
    public function _after(\AcceptanceTester $I)
    {
        $I->cleanAllPreviousRequestsToWireMock();
    }

    // tests
    public function tryToTest(\AcceptanceTester $I)
    {
        $I->expectRequestToWireMock(
            WireMock::get(WireMock::urlEqualTo('/some/url'))
                ->willReturn(WireMock::aResponse()
                ->withHeader('Content-Type', 'text/plain')
                ->withBody('Hello world!'))
        );
        // Here you should execute your application in a way it requests wiremock. I do this directly to show it. 
        $response = file_get_contents('http://localhost:18080/some/url');
        
        $I->assertEquals('Hello world!', $response);
        $I->receivedRequestInWireMock(
            WireMock::getRequestedFor(WireMock::urlEqualTo('/some/url'))
        );
    }
    
    // Also, you can access wiremock-php library directly
    public function moreComplexTest()
    {
        $wiremockPhp = Codeception\Extension\WiremockConnection::get();
        // Now you can use wiremock-php library
    }
}