feat: mule HTTP Mockserver v1

.github/workflows/build.yml

@@ -0,0 +1,47 @@
+name: Maven Build and Release for Mule-Plugin
+
+on:
+  push:
+    branches:
+      - 'main'
+      - 'chore/**'
+      - 'feat/**'
+      - 'fix/**'
+  pull_request:
+    branches:
+      - 'main'
+
+jobs:
+  Build-Maven:
+    uses: avioconsulting/shared-workflows/.github/workflows/maven-build.yml@main
+    secrets: inherit
+    with:
+      include-mule-ee-repo: true
+    #   java-distribution: adopt-hotspot
+    #   java-version: 8
+    #   include-test-results: true
+    #   maven-args: -X
+
+  Release-Maven:
+    needs: Build-Maven
+    uses: avioconsulting/shared-workflows/.github/workflows/maven-release.yml@main
+    secrets: inherit
+    with:
+      app-version: ${{ needs.Build-Maven.outputs.app-version }}
+      publish-maven-central: true
+    #   java-distribution: adopt-hotspot
+    #   java-version: 8
+    #   maven-args: -X
+    #   main-branch: main
+
+  Post-Release-Maven:
+    needs: [Build-Maven, Release-Maven]
+    uses: avioconsulting/shared-workflows/.github/workflows/maven-post-release.yml@main
+    secrets: inherit
+    with:
+      app-version: ${{ needs.Build-Maven.outputs.app-version }}
+    #   java-distribution: adopt-hotspot
+    #   java-version: 8
+    #   maven-args: -X
+    #   main-branch: main
+    #   pr-reviewers: adesjardin, manikmagar, kkingavio

.gitignore

@@ -1,17 +1,6 @@
-target/
-pom.xml.tag
-pom.xml.releaseBackup
-pom.xml.versionsBackup
-pom.xml.next
-release.properties
-dependency-reduced-pom.xml
-buildNumber.properties
-.mvn/timing.properties
-# https://github.com/takari/maven-wrapper#usage-without-binary-jar
-.mvn/wrapper/maven-wrapper.jar
+/.mule/
+/.idea/
+/target/
+.flattened-pom.xml
 
-# Eclipse m2e generated files
-# Eclipse Core
-.project
-# JDT-specific (Eclipse Java Development Tools)
-.classpath
+*.iml

.mvn/wrapper/maven-wrapper.properties

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

README.md

@@ -1,2 +1,81 @@
-# mule-http-mockserver
-HTTP MockServer for Mule Munit Testing of HTTP APIs
+# HTTP MockServer Extension
+
+HTTP MockServer Extension for MUnit.
+
+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.
+
+## Installation
+
+Add this dependency to your application pom.xml
+
+```
+<groupId>com.avioconsulting</groupId>
+<artifactId>munit-http-mockserver</artifactId>
+<version>${munit-http-mockserver.version}</version>
+<classifier>mule-plugin</classifier>
+<scope>test</scope>
+```
+
+## Usage
+
+Consider a Mule app with following HTTP Request configuration and usage -
+
+```xml
+
+  <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 -
+
+```xml
+  <http-mockserver:config name="HTTP_MockServer_Config">
+    <http-mockserver:connection port="8081" />
+  </http-mockserver:config>
+```
+
+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.
+
+Following test uses above configuration to set an expectation and verification using module operations -
+
+```xml
+<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](./src/test/munit/) for more examples and  [connector documentation](./docs/1.0.x/http-mockserver-documentation.adoc) for supported operations.
+
+Resources to learn about MockServer usage -
+- https://github.com/mock-server/mockserver/blob/master/mockserver-examples/json_examples.md