php-behat-context-wiremock

This package provides a seamless integration between Behat tests and Wiremock, offering a straightforward method for mocking HTTP requests. It acts as a conduit between Behat scenarios and a Wiremock instance, enabling the creation of HTTP request expectations and mock responses without sacrificing Wiremock's inherent flexibility.

Configuration Example

Below is an example of how to configure the Wiremock context within your Behat setup:

- Auto1\BehatContext\Wiremock\WiremockContext:
      baseUrl: 'http://wiremock'
      stubsDirectory: '%paths.base%/features/stubs'
      cleanWiremockBeforeEachScenario: false # Optional, defaults to false
      allStubsMatchedAfterEachScenario: false # Optional, defaults to false
      stubsDirectoryIsFeatureDirectory: false # Optional, defaults to false

• baseUrl: The URL of your Wiremock instance.
• stubsDirectory: The base directory for Wiremock stubs. This cannot be specified if stubsDirectoryIsFeatureDirectory is enabled.
• cleanWiremockBeforeEachScenario: If true, Wiremock will be cleared before each scenario.
• allStubsMatchedAfterEachScenario: If true, ensures that all stubs are matched after each scenario.
• stubsDirectoryIsFeatureDirectory: If true, stubs will be sourced from the directory of a Behat feature file. This can only be enabled if stubsDirectory is not specified.
• Note: stubsDirectory and stubsDirectoryIsFeatureDirectory cannot be used simultaneously.

Docker Integration

For those running Behat within Docker, integrating a Wiremock container is straightforward. The following configuration ensures that your tests wait for Wiremock to be fully initialized before running:

  php-fpm:
    depends_on:
      wiremock:
        condition: service_healthy

  wiremock:
    image: wiremock/wiremock:latest
    healthcheck:
      test: ["CMD", "curl", "-f", "http://localhost:80/__admin/mappings"]
      interval: 10s
      timeout: 10s
      retries: 5

Context Steps

Defining Wiremock Stubs

• Given wiremock stub: This step allows you to define a Wiremock stub directly within your scenario.

  Example:

      Given wiremock stub:
      """
        {
          "request": {
            "method": "GET",
            "url": "/some/thing"
          },
  
          "response": {
            "status": 200,
            "body": "Hello, world!",
            "headers": {
                "Content-Type": "text/plain"
            }
          }
        }
      ```
  

• Given wiremock stubs from {file}: This step loads stubs from a specified file or directory and sends them to Wiremock.

  Example:

      Given wiremock stubs from "dir/awesome-stub.json"
      And wiremock stubs from "dir2"

• Given wiremock stubs from {file} should be called {count} times: This step loads stubs from a specified file or directory, sends them to WireMock and also allows you to verify that the stub is called the specified number of times.

  Example:

      Given wiremock stubs from "dir/awesome-stub.json" should be called 2 times
      And wiremock stubs from "dir2" should be called 2 times

• Given wiremock stubs from {file} should be called once: This step loads stubs from a specified file or directory, sends them to WireMock and also allows you to verify that the stub is called once.

  Example:

      Given wiremock stubs from "dir/awesome-stub.json" should be called once
      And wiremock stubs from "dir2" should be called once

• Given wiremock stubs from {file} should be called at least {count} times: This step loads stubs from a specified file or directory, sends them to WireMock and also allows you to verify that the stub is called at least the specified number of times.

  Example:

      Given wiremock stubs from "dir/awesome-stub.json" should be called at least 2 times
      And wiremock stubs from "dir2" should be called at least 2 times

• Given wiremock stubs from {file} should be called at most {count} times: This step loads stubs from a specified file or directory, sends them to WireMock and also allows you to verify that the stub is not called more than the specified number of times.

  Example:

      Given wiremock stubs from "dir/awesome-stub.json" and should be called at most 2 times
      And wiremock stubs from "dir2" and should be called at most 2 times

Managing Wiremock State

• Given clean wiremock: Resets Wiremock to its initial state.

  Example:

      Given clean wiremock

Validating Stubs

• Then all stubs should be matched: Ensures that all added stubs were matched at least once and fails if there were any unexpected (unmatched) calls to Wiremock.

  Example:

      Then all stubs should be matched

This integration aims to simplify the process of testing HTTP interactions within your Behat scenarios, leveraging Wiremock's powerful mocking capabilities to enhance your testing suite.