fix(soap): respond with custom fault if status is 500 and content set.

Author: outofcoffee

mock/soap/src/main/java/io/gatehill/imposter/plugin/soap/SoapPluginImpl.kt

@@ -72,10 +72,9 @@ import io.gatehill.imposter.service.ResponseRoutingService
 import io.gatehill.imposter.service.ResponseService
 import io.gatehill.imposter.service.ResponseService.ResponseSender
 import io.gatehill.imposter.util.HttpUtil
-import io.gatehill.imposter.util.LogUtil
+import io.gatehill.imposter.util.LogUtil.describeRequestShort
 import io.gatehill.imposter.util.ResourceUtil
 import io.gatehill.imposter.util.completedUnitFuture
-import io.gatehill.imposter.util.makeFuture
 import io.vertx.core.Vertx
 import org.apache.logging.log4j.LogManager
 import java.io.File
@@ -229,26 +228,25 @@ class SoapPluginImpl @Inject constructor(
 
         val defaultBehaviourHandler: DefaultBehaviourHandler = { responseBehaviour: ResponseBehaviour ->
             // set status code regardless of response strategy
-            val response = httpExchange.response
-                .setStatusCode(responseBehaviour.statusCode)
+            httpExchange.response.setStatusCode(responseBehaviour.statusCode)
 
-            determineResponseMessage(responseBehaviour, operation)?.let { message ->
-                LOGGER.trace("Using output schema type: {}", message)
+            // build a response from the XSD
+            val exampleSender = ResponseSender { httpExchange: HttpExchange, _: ResponseBehaviour ->
+                determineResponseMessage(responseBehaviour, operation)?.let { message ->
+                    LOGGER.trace("Using output schema type: {}", message)
 
-                if (!responseBehaviour.responseHeaders.containsKey(HttpUtil.CONTENT_TYPE)) {
-                    responseBehaviour.responseHeaders[HttpUtil.CONTENT_TYPE] = when (bodyHolder) {
-                        is ParsedSoapMessage -> when (parser.version) {
-                            WsdlParser.WsdlVersion.V1 -> SoapUtil.soap11ContentType
-                            WsdlParser.WsdlVersion.V2 -> SoapUtil.soap12ContentType
-                        }
+                    if (!responseBehaviour.responseHeaders.containsKey(HttpUtil.CONTENT_TYPE)) {
+                        responseBehaviour.responseHeaders[HttpUtil.CONTENT_TYPE] = when (bodyHolder) {
+                            is ParsedSoapMessage -> when (parser.version) {
+                                WsdlParser.WsdlVersion.V1 -> SoapUtil.soap11ContentType
+                                WsdlParser.WsdlVersion.V2 -> SoapUtil.soap12ContentType
+                            }
 
-                        is ParsedRawBody -> SoapUtil.textXmlContentType
-                        else -> throw IllegalStateException("Unsupported request body: ${bodyHolder::class.java.canonicalName}")
+                            is ParsedRawBody -> SoapUtil.textXmlContentType
+                            else -> throw IllegalStateException("Unsupported request body: ${bodyHolder::class.java.canonicalName}")
+                        }
                     }
-                }
 
-                // build a response from the XSD
-                val exampleSender = ResponseSender { httpExchange: HttpExchange, _: ResponseBehaviour ->
                     soapExampleService.serveExample(
                         httpExchange,
                         parser.schemaContext,
@@ -257,25 +255,18 @@ class SoapPluginImpl @Inject constructor(
                         message,
                         bodyHolder
                     )
-                }
-
-                // attempt to serve the example, falling back if not present
-                return@let responseService.sendResponse(
-                    pluginConfig,
-                    resourceConfig,
-                    httpExchange,
-                    responseBehaviour,
-                    exampleSender,
-                )
-
-            } ?: run {
-                LOGGER.warn(
-                    "No output or fault definition found in WSDL for {} and status code {}",
-                    LogUtil.describeRequestShort(httpExchange),
-                    responseBehaviour.statusCode,
-                )
-                makeFuture { response.end() }
+                } ?: return@ResponseSender false
             }
+
+            // attempt to serve the example, falling back if not present
+            responseService.sendResponse(
+                pluginConfig,
+                resourceConfig,
+                httpExchange,
+                responseBehaviour,
+                exampleSender,
+                this::fallback,
+            )
         }
 
         val context = mutableMapOf(
@@ -305,4 +296,21 @@ class SoapPluginImpl @Inject constructor(
             else -> operation.outputRef
         }
     }
+
+    /**
+     * Handles the scenario when no example is found.
+     *
+     * @param httpExchange    the HTTP exchange
+     * @param responseBehaviour the response behaviour
+     */
+    private fun fallback(httpExchange: HttpExchange, responseBehaviour: ResponseBehaviour): Boolean {
+        LOGGER.warn(
+            "No output or fault definition found in WSDL for {} with status code {} and no response file or content set - sending empty response",
+            describeRequestShort(httpExchange),
+            responseBehaviour.statusCode,
+        )
+        // should this be a 400, as it's not in the WSDL?
+        httpExchange.response.end()
+        return true
+    }
 }

mock/soap/src/test/java/io/gatehill/imposter/plugin/soap/FaultExampleTest.kt

@@ -99,6 +99,37 @@ class FaultExampleTest : BaseVerticleTest() {
             )
     }
 
+    @Test
+    fun `respond with a custom fault if status is 500 and content set`() {
+        val getPetByIdEnv = SoapUtil.wrapInEnv(
+            """
+<getPetByIdRequest xmlns="urn:com:example:petstore">
+  <id>2</id>
+</getPetByIdRequest>
+""".trim(), soapEnvNamespace
+        )
+
+        RestAssured.given()
+            .log().ifValidationFails()
+            .accept(soapContentType)
+            .contentType(soapContentType)
+            .`when`()
+            .body(getPetByIdEnv)
+            .post("/pets/")
+            .then()
+            .log().ifValidationFails()
+            .statusCode(HttpUtil.HTTP_INTERNAL_ERROR)
+            .body(
+                Matchers.allOf(
+                    Matchers.containsString("Envelope"),
+                    Matchers.containsString("soap:Fault"),
+                    Matchers.containsString("code"),
+                    Matchers.containsString("description"),
+                    Matchers.containsString("Custom fault"),
+                )
+            )
+    }
+
     @Test
     fun `respond with a fault generated from the schema if response configuration set`() {
         val getPetByIdEnv = SoapUtil.wrapInEnv(

mock/soap/src/test/resources/fault-example/imposter-config.yaml

@@ -7,6 +7,23 @@ resources:
     response:
       statusCode: 500
 
+  - binding: SoapBinding
+    operation: getPetById
+    requestBody:
+      xPath: //pets:id
+      value: 2
+    response:
+      statusCode: 500
+      content: |
+        <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
+          <soap:Body>
+            <soap:Fault>
+              <code>2</code>
+              <description>Custom fault</description>
+            </soap:Fault>
+          </soap:Body>
+        </soap:Envelope>
+
   - binding: SoapBinding
     operation: getPetById
     requestBody: