Wiremock module for Codeception

1.0 2022-11-30 21:34 UTC

This package is auto-updated.

Last update: 2024-02-29 04:06:39 UTC


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


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.



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

$ composer require lamoda/codeception-wiremock-extension

Configuration Examples


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
        - WireMock:
            host: # defaults to
            port: 80 # defaults to 8080

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

    // tests
    public function tryToTest(\AcceptanceTester $I)
                ->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);
    // Also, you can access wiremock-php library directly
    public function moreComplexTest()
        $wiremockPhp = Codeception\Extension\WiremockConnection::get();
        // Now you can use wiremock-php library