timitao / behatwiremockextension

Behat Wiremock Extension

A Behat Extension that manage over Wiremock as a test for API calls.

Compatibility with Behat 3.0.*

This extension helps configure remote server, when we need to take control over thirds part services. Over each scenario, the API will be automatically reset.

Installing extension

The easiest way to install is by using Composer:

$> curl -sS https://getcomposer.org/installer | php
$> php composer.phar require timitao/behat-wiremock-extension='1.0.*'

or composer.json

"require": {
    "timitao/behat-wiremock-extension": "1.0.*"
},

Configuration

We can define services and map files by:

extensions:
    Behat\WiremockExtension\ServiceContainer\Extension:
        wiremock:
            services:
                  client1:
                        base_url: http://192.168.205.11
                        mappings_path: %paths.base%/data/mapping.json
                  client2:
                        base_url: http://192.168.205.12
                        mappings_path: %paths.base%/data/mapping2.json

Example

Look at this wiremock.feature

If you want this to test, will need recipe Vagrant for BehatWiremockExtension i tested over. Then run tests on server node. The IP is hard coded in recipe for test purpose.

Reset strategies

Default

By default, before each scenario - all services will be reset. By default it looks like:

Behat\WiremockExtension\ServiceContainer\Extension:
  wiremock:
    reset_strategy:
      name: always

By Tags

Second option is to manage by tags. Then config file should look like:

Behat\WiremockExtension\ServiceContainer\Extension:
  wiremock:
    reset_strategy:
      name: by_tags
      options:
        services:
          client1: wiremockService1Reset
          client2: wiremockService2Reset
    services:
      client1:
        base_url: http://192.168.205.11
        mappings_path: %paths.base%/data/mapping.json
      client2:
        base_url: http://192.168.205.12
        mappings_path: %paths.base%/data/mapping2.json

Then scenario we can manage this by:

Feature:
    @wiremockService1Reset
    Scenario:
        Given I send GET request to "192.168.205.11/hello/world" expect "Tests tags"

    @wiremockService2Reset
    Scenario:
        Given I send GET request to "192.168.205.12/hello/mark" expect "Tests tags 2"

Versioning

Staring version 1.0.0, will follow Semantic Versioning v2.0.0.

Contributors

• Tomasz Kunicki TimiTao [lead developer]