Skip to content

Commit 3c12c79

Browse files
manikmagarmanikmagar
authored
feat: mule HTTP Mockserver v1 (#1)
1 parent 60abcf1 commit 3c12c79

22 files changed

+1819
-18
lines changed

‎.github/workflows/build.yml

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
name: Maven Build and Release for Mule-Plugin
2+
3+
on:
4+
push:
5+
branches:
6+
- 'main'
7+
- 'chore/**'
8+
- 'feat/**'
9+
- 'fix/**'
10+
pull_request:
11+
branches:
12+
- 'main'
13+
14+
jobs:
15+
Build-Maven:
16+
uses: avioconsulting/shared-workflows/.github/workflows/maven-build.yml@main
17+
secrets: inherit
18+
with:
19+
include-mule-ee-repo: true
20+
# java-distribution: adopt-hotspot
21+
# java-version: 8
22+
# include-test-results: true
23+
# maven-args: -X
24+
25+
Release-Maven:
26+
needs: Build-Maven
27+
uses: avioconsulting/shared-workflows/.github/workflows/maven-release.yml@main
28+
secrets: inherit
29+
with:
30+
app-version: ${{ needs.Build-Maven.outputs.app-version }}
31+
publish-maven-central: true
32+
# java-distribution: adopt-hotspot
33+
# java-version: 8
34+
# maven-args: -X
35+
# main-branch: main
36+
37+
Post-Release-Maven:
38+
needs: [Build-Maven, Release-Maven]
39+
uses: avioconsulting/shared-workflows/.github/workflows/maven-post-release.yml@main
40+
secrets: inherit
41+
with:
42+
app-version: ${{ needs.Build-Maven.outputs.app-version }}
43+
# java-distribution: adopt-hotspot
44+
# java-version: 8
45+
# maven-args: -X
46+
# main-branch: main
47+
# pr-reviewers: adesjardin, manikmagar, kkingavio

‎.gitignore

+5-16
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,6 @@
1-
target/
2-
pom.xml.tag
3-
pom.xml.releaseBackup
4-
pom.xml.versionsBackup
5-
pom.xml.next
6-
release.properties
7-
dependency-reduced-pom.xml
8-
buildNumber.properties
9-
.mvn/timing.properties
10-
# https://github.com/takari/maven-wrapper#usage-without-binary-jar
11-
.mvn/wrapper/maven-wrapper.jar
1+
/.mule/
2+
/.idea/
3+
/target/
4+
.flattened-pom.xml
125

13-
# Eclipse m2e generated files
14-
# Eclipse Core
15-
.project
16-
# JDT-specific (Eclipse Java Development Tools)
17-
.classpath
6+
*.iml

‎.mvn/wrapper/maven-wrapper.jar

58.5 KB
Binary file not shown.

‎.mvn/wrapper/maven-wrapper.properties

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Licensed to the Apache Software Foundation (ASF) under one
2+
# or more contributor license agreements. See the NOTICE file
3+
# distributed with this work for additional information
4+
# regarding copyright ownership. The ASF licenses this file
5+
# to you under the Apache License, Version 2.0 (the
6+
# "License"); you may not use this file except in compliance
7+
# with the License. You may obtain a copy of the License at
8+
#
9+
# https://www.apache.org/licenses/LICENSE-2.0
10+
#
11+
# Unless required by applicable law or agreed to in writing,
12+
# software distributed under the License is distributed on an
13+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14+
# KIND, either express or implied. See the License for the
15+
# specific language governing permissions and limitations
16+
# under the License.
17+
distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.6.3/apache-maven-3.6.3-bin.zip
18+
wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.1/maven-wrapper-3.1.1.jar

‎README.md

+83-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,83 @@
1-
# mule-http-mockserver
2-
HTTP MockServer for Mule Munit Testing of HTTP APIs
1+
# HTTP MockServer Extension
2+
3+
HTTP MockServer Extension for MUnit.
4+
5+
This extension allows to use [MockServer](https://www.mock-server.com/#what-is-mockserver) in MUnit Testing for mocking and verifying HTTP invocations from the application flows.
6+
7+
## Installation
8+
9+
Add this dependency to your application pom.xml
10+
11+
```
12+
<groupId>com.avioconsulting.munit</groupId>
13+
<artifactId>munit-http-mockserver</artifactId>
14+
<version>${munit-http-mockserver.version}</version>
15+
<classifier>mule-plugin</classifier>
16+
<scope>test</scope>
17+
```
18+
19+
See latest version on [Maven Central](https://central.sonatype.com/search?namespace=com.avioconsulting.munit&name=munit-http-mockserver).
20+
21+
## Usage
22+
23+
Consider a Mule app with following HTTP Request configuration and usage -
24+
25+
```xml
26+
27+
<http:request-config name="HTTP_Request_configuration">
28+
<http:request-connection host="0.0.0.0" port="8081" />
29+
</http:request-config>
30+
31+
<flow name="munit-http-mockserver-demoFlow">
32+
<http:request method="GET" config-ref="HTTP_Request_configuration" path="/api/info"/>
33+
</flow>
34+
35+
```
36+
37+
To use MockServer for above request configuration, create a global configuration in your MUnit Test suite -
38+
39+
```xml
40+
<http-mockserver:config name="HTTP_MockServer_Config">
41+
<http-mockserver:connection port="8081" />
42+
</http-mockserver:config>
43+
```
44+
45+
For advanced configuration of the MockServer, [system properties approach](https://www.mock-server.com/mock_server/configuration_properties.html) can be used to define a custom `src/test/resources/mockserver.properties` file.
46+
47+
Following test uses above configuration to set an expectation and verification using module operations -
48+
49+
```xml
50+
<munit:test name="http-mock-valid-expectation-test" doc:id="faf60afd-0a61-415f-aab0-3f0565e49432" description="Set Valid expectation">
51+
<munit:behavior >
52+
<http-mockserver:set-expectation config-ref="HTTP_MockServer_Config">
53+
<http-mockserver:expectation ><![CDATA[#[output application/json
54+
---
55+
{
56+
"id": "valid-expectation-id-1",
57+
"httpRequest" : {
58+
"method" : "GET",
59+
"path" : "/api/info"
60+
},
61+
"httpResponse" : {
62+
"body" : "some_response_body",
63+
"statusCode": 201
64+
}
65+
}]]]></http-mockserver:expectation>
66+
</http-mockserver:set-expectation>
67+
</munit:behavior>
68+
<munit:execution>
69+
<flow-ref name="munit-http-mockserver-demoFlow"/>
70+
</munit:execution>
71+
<munit:validation>
72+
<munit-tools:assert-equals actual="#[attributes.statusCode]" expected="#[201]"/>
73+
<http-mockserver:verify-expectation comparison="AT_LEAST" config-ref="HTTP_MockServer_Config" expectationId="valid-expectation-id-1" count="1"/>
74+
</munit:validation>
75+
</munit:test>
76+
```
77+
78+
To reduce the HTTP logging from MockServer, you may set `org.mockserver.log.MockServerEventLog` category to `WARN`.
79+
80+
See [modules tests](./src/test/munit/) for more examples and [connector documentation](./docs/1.0.x/munit-http-mockserver-documentation.adoc) for supported operations.
81+
82+
Resources to learn about MockServer usage -
83+
- https://github.com/mock-server/mockserver/blob/master/mockserver-examples/json_examples.md

0 commit comments

Comments
 (0)