HTTP MockServer Extension

HTTP MockServer Extension for MUnit.

This extension allows to use MockServer in MUnit Testing for mocking and verifying HTTP invocations from the application flows.

Installation

Add this dependency to your application pom.xml

<dependency>
    <groupId>com.avioconsulting.munit</groupId>
    <artifactId>munit-http-mockserver</artifactId>
    <version>${munit-http-mockserver.version}</version>
    <classifier>mule-plugin</classifier>
    <scope>test</scope>
</dependency>

See latest version on Maven Central.

Usage

Consider a Mule app with following HTTP Request configuration and usage -

  <http:request-config name="HTTP_Request_configuration">
    <http:request-connection host="0.0.0.0" port="8081" />
  </http:request-config>

    <flow name="munit-http-mockserver-demoFlow">
        <http:request method="GET" config-ref="HTTP_Request_configuration" path="/api/info"/>
    </flow>

To use MockServer for above request configuration, create a global configuration in your MUnit Test suite -

  <http-mockserver:config name="HTTP_MockServer_Config">
    <http-mockserver:connection port="8081" />
  </http-mockserver:config>

For advanced configuration of the MockServer, system properties approach can be used to define a custom src/test/resources/mockserver.properties file.

Following test uses above configuration to set an expectation and verification using module operations -

<munit:test name="http-mock-valid-expectation-test" doc:id="faf60afd-0a61-415f-aab0-3f0565e49432" description="Set Valid expectation">
    <munit:behavior >
      <http-mockserver:set-expectation config-ref="HTTP_MockServer_Config">
        <http-mockserver:expectation ><![CDATA[#[output application/json
---
{
  "id": "valid-expectation-id-1",
  "httpRequest" : {
    "method" : "GET",
    "path" : "/api/info"
  },
  "httpResponse" : {
    "body" : "some_response_body",
    "statusCode": 201
  }
}]]]></http-mockserver:expectation>
      </http-mockserver:set-expectation>
    </munit:behavior>
    <munit:execution>
      <flow-ref name="munit-http-mockserver-demoFlow"/>
    </munit:execution>
    <munit:validation>
      <munit-tools:assert-equals actual="#[attributes.statusCode]" expected="#[201]"/>
      <http-mockserver:verify-expectation comparison="AT_LEAST" config-ref="HTTP_MockServer_Config" expectationId="valid-expectation-id-1" count="1"/>
    </munit:validation>
  </munit:test>

To reduce the HTTP logging from MockServer, you may set org.mockserver.log.MockServerEventLog category to WARN.

See modules tests for more examples and connector documentation for supported operations.

Resources to learn about MockServer usage -

• https://github.com/mock-server/mockserver/blob/master/mockserver-examples/json_examples.md