fix(soap): sets namespace of RPC root response element from WSDL target namespace.

Author: outofcoffee

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

@@ -59,6 +59,7 @@ import io.gatehill.imposter.plugin.soap.model.ParsedRawBody
 import io.gatehill.imposter.plugin.soap.model.ParsedSoapMessage
 import io.gatehill.imposter.plugin.soap.model.WsdlBinding
 import io.gatehill.imposter.plugin.soap.model.WsdlOperation
+import io.gatehill.imposter.plugin.soap.model.WsdlService
 import io.gatehill.imposter.plugin.soap.parser.VersionAwareWsdlParser
 import io.gatehill.imposter.plugin.soap.parser.WsdlParser
 import io.gatehill.imposter.plugin.soap.service.SoapExampleService
@@ -130,7 +131,7 @@ class SoapPluginImpl @Inject constructor(
 
                     when (binding.type) {
                         BindingType.SOAP, BindingType.HTTP -> {
-                            handleBindingOperations(router, config, wsdlParser, path, binding)
+                            handleBindingOperations(router, config, wsdlParser, path, service, binding)
                         }
 
                         else -> LOGGER.debug("Ignoring unsupported binding: ${binding.name}")
@@ -154,6 +155,7 @@ class SoapPluginImpl @Inject constructor(
         config: SoapPluginConfig,
         parser: WsdlParser,
         path: String,
+        service: WsdlService,
         binding: WsdlBinding,
     ) {
         val fullPath = (config.path ?: "") + path
@@ -191,7 +193,7 @@ class SoapPluginImpl @Inject constructor(
                 }
 
                 LOGGER.debug("Matched operation: ${operation.name} in binding ${binding.name}")
-                return@build handle(config, parser, binding, operation, httpExchange, bodyHolder, soapAction)
+                return@build handle(config, parser, service, binding, operation, httpExchange, bodyHolder, soapAction)
             }
         )
     }
@@ -210,6 +212,7 @@ class SoapPluginImpl @Inject constructor(
     private fun handle(
         pluginConfig: SoapPluginConfig,
         parser: WsdlParser,
+        service: WsdlService,
         binding: WsdlBinding,
         operation: WsdlOperation,
         httpExchange: HttpExchange,
@@ -226,7 +229,7 @@ class SoapPluginImpl @Inject constructor(
                 .setStatusCode(responseBehaviour.statusCode)
 
             operation.outputRef?.let {
-                LOGGER.trace("Using output schema type: ${operation.outputRef}")
+                LOGGER.trace("Using output schema type: {}", operation.outputRef)
 
                 if (!responseBehaviour.responseHeaders.containsKey(HttpUtil.CONTENT_TYPE)) {
                     responseBehaviour.responseHeaders[HttpUtil.CONTENT_TYPE] = when (bodyHolder) {
@@ -246,6 +249,7 @@ class SoapPluginImpl @Inject constructor(
                         httpExchange,
                         parser.schemas,
                         wsdlDir,
+                        service,
                         operation.outputRef,
                         bodyHolder
                     )

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

@@ -47,6 +47,7 @@ import java.net.URI
 
 data class WsdlService(
     val name: String,
+    val targetNamespace: String?,
     val endpoints: List<WsdlEndpoint>,
 )
 

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

@@ -77,11 +77,15 @@ class Wsdl1Parser(
 
     override val services: List<WsdlService>
         get() {
+            val tns = selectSingleNode(document, "/wsdl:definitions")
+                ?.getAttribute("targetNamespace")?.value
+
             val services = selectNodes(document, "/wsdl:definitions/wsdl:service")
 
             return services.map { element ->
                 WsdlService(
                     name = element.getAttributeValue("name"),
+                    targetNamespace = tns,
                     endpoints = getPorts(element),
                 )
             }

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

@@ -74,11 +74,15 @@ class Wsdl2Parser(
 
     override val services: List<WsdlService>
         get() {
+            val tns = selectSingleNode(document, "/wsdl:description")
+                ?.getAttribute("targetNamespace")?.value
+
             val services = selectNodes(document, "/wsdl:description/wsdl:service")
 
             return services.map { element ->
                 WsdlService(
                     name = element.getAttributeValue("name"),
+                    targetNamespace = tns,
                     endpoints = getEndpoints(element),
                 )
             }

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

@@ -50,6 +50,7 @@ import io.gatehill.imposter.plugin.soap.model.OperationMessage
 import io.gatehill.imposter.plugin.soap.model.ParsedRawBody
 import io.gatehill.imposter.plugin.soap.model.ParsedSoapMessage
 import io.gatehill.imposter.plugin.soap.model.TypeOperationMessage
+import io.gatehill.imposter.plugin.soap.model.WsdlService
 import io.gatehill.imposter.plugin.soap.parser.WsdlRelativeXsdEntityResolver
 import io.gatehill.imposter.plugin.soap.util.SchemaGenerator
 import io.gatehill.imposter.plugin.soap.util.SoapUtil
@@ -80,18 +81,20 @@ class SoapExampleService {
         httpExchange: HttpExchange,
         schemas: Array<SchemaDocument>,
         wsdlDir: File,
+        service: WsdlService,
         outputMessage: OperationMessage,
         bodyHolder: MessageBodyHolder,
     ): Boolean {
         logger.debug("Generating example for {}", outputMessage)
-        val example = generateInstanceFromSchemas(schemas, wsdlDir, outputMessage)
+        val example = generateInstanceFromSchemas(schemas, wsdlDir, service, outputMessage)
         transmitExample(httpExchange, example, bodyHolder)
         return true
     }
 
     private fun generateInstanceFromSchemas(
         schemas: Array<SchemaDocument>,
         wsdlDir: File,
+        service: WsdlService,
         message: OperationMessage,
     ): String {
         when (message) {
@@ -108,11 +111,12 @@ class SoapExampleService {
 
             is TypeOperationMessage -> {
                 // by convention, the suffix 'Response' is added to the operation name
-                val rootElement = QName(
-                    message.typeName.namespaceURI,
-                    message.operationName + "Response",
-                    "tns"
-                )
+                val elementName = message.operationName + "Response"
+                val rootElement = if (service.targetNamespace?.isNotBlank() == true) {
+                    QName(service.targetNamespace, elementName, "tns")
+                } else {
+                    QName(elementName)
+                }
 
                 val parts = mutableMapOf<String, QName>()
                 parts[message.partName] = message.typeName
@@ -126,7 +130,8 @@ class SoapExampleService {
                 return SampleXmlUtil.createSampleForType(elem)
             }
 
-            else -> throw UnsupportedOperationException("Unsupported output message parts: ${message::class.java.canonicalName}")
+            // TODO support CompositeOperationMessage
+            else -> throw UnsupportedOperationException("Unsupported output message: ${message::class.java.canonicalName}")
         }
     }
 

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

@@ -56,7 +56,9 @@ object SchemaGenerator {
 
     fun createElementSchema(rootElement: QName, parts: Map<String, QName>): SchemaDocument {
         val namespaces = mutableMapOf<String, String>()
-        namespaces[rootElement.prefix] = rootElement.namespaceURI
+        if (rootElement.namespaceURI?.isNotBlank() == true) {
+            namespaces[rootElement.prefix] = rootElement.namespaceURI
+        }
         namespaces += parts.values.associate { it.prefix to it.namespaceURI }
 
         val namespacesXml = namespaces.entries.joinToString(separator = "\n") { (prefix, nsUri) ->