refactor(soap): reuses EntityResolver for the same WSDL file.

Author: outofcoffee

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

@@ -55,6 +55,7 @@ import org.jdom2.Document
 import org.jdom2.Element
 import org.jdom2.Namespace
 import org.jdom2.output.XMLOutputter
+import org.xml.sax.EntityResolver
 import java.io.File
 import javax.xml.namespace.QName
 
@@ -64,6 +65,7 @@ import javax.xml.namespace.QName
 abstract class AbstractWsdlParser(
     private val wsdlFile: File,
     protected val document: Document,
+    private val entityResolver: EntityResolver,
 ) : WsdlParser {
     protected val logger: Logger = LogManager.getLogger(this::class.java)
 
@@ -75,10 +77,15 @@ abstract class AbstractWsdlParser(
         val schemas = mutableListOf<SchemaDocument>()
         schemas += findEmbeddedTypesSchemas()
 
-        // TODO consider only those referenced by 'xs:import'
+        // TODO consider only those referenced by 'xs:import' or 'xs:include'
         val xsds = wsdlFile.parentFile.listFiles { _, name -> name.endsWith(".xsd") }?.toList() ?: emptyList()
         schemas += xsds.map { schemaFile ->
-            SchemaDocument.Factory.parse(schemaFile, XmlOptions().setLoadLineNumbers().setLoadMessageDigest())
+            val options = XmlOptions()
+                .setLoadLineNumbers()
+                .setLoadMessageDigest()
+                .setEntityResolver(entityResolver)
+
+            SchemaDocument.Factory.parse(schemaFile, options)
         }
 
         logger.debug("Discovered {} schema(s) for WSDL: {}", schemas.size, wsdlFile)
@@ -117,7 +124,9 @@ abstract class AbstractWsdlParser(
             throw IllegalStateException("Cannot build XSD from empty schema list")
         }
         val compileOptions = XmlOptions()
-            .setEntityResolver(WsdlRelativeXsdEntityResolver(wsdlFile.parentFile))
+            .setLoadLineNumbers()
+            .setLoadMessageDigest()
+            .setEntityResolver(entityResolver)
         try {
             return XmlBeans.compileXsd(schemas, XmlBeans.getBuiltinTypeSystem(), compileOptions)
         } catch (e: Exception) {

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

@@ -62,18 +62,17 @@ class VersionAwareWsdlParser(wsdlFile: File) : WsdlParser {
     private val delegate: WsdlParser
 
     init {
-        val document = SAXBuilder().apply {
-            entityResolver = WsdlRelativeXsdEntityResolver(wsdlFile.parentFile)
-        }.build(wsdlFile)
+        val entityResolver = WsdlRelativeXsdEntityResolver(wsdlFile.parentFile)
+        val document = SAXBuilder().apply { setEntityResolver(entityResolver) }.build(wsdlFile)
 
         val wsdlNamespaces = document.rootElement.namespacesInScope.filter {
             it.uri == Wsdl2Parser.wsdl2Namespace || it.uri == Wsdl1Parser.wsdl1Namespace
         }
         delegate = when (wsdlNamespaces.size) {
             0 -> throw IllegalStateException("No WSDL namespace found on root element")
             1 -> when (wsdlNamespaces.first().uri) {
-                Wsdl1Parser.wsdl1Namespace -> Wsdl1Parser(wsdlFile, document)
-                Wsdl2Parser.wsdl2Namespace -> Wsdl2Parser(wsdlFile, document)
+                Wsdl1Parser.wsdl1Namespace -> Wsdl1Parser(wsdlFile, document, entityResolver)
+                Wsdl2Parser.wsdl2Namespace -> Wsdl2Parser(wsdlFile, document, entityResolver)
                 else -> throw IllegalStateException("Unsupported WSDL namespace on root element")
             }
             else -> throw IllegalStateException("More than one WSDL namespace found on root element: $wsdlNamespaces")

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

@@ -43,12 +43,18 @@
 
 package io.gatehill.imposter.plugin.soap.parser
 
-import io.gatehill.imposter.plugin.soap.model.*
+import io.gatehill.imposter.plugin.soap.model.BindingType
+import io.gatehill.imposter.plugin.soap.model.WsdlBinding
+import io.gatehill.imposter.plugin.soap.model.WsdlEndpoint
+import io.gatehill.imposter.plugin.soap.model.WsdlInterface
+import io.gatehill.imposter.plugin.soap.model.WsdlOperation
+import io.gatehill.imposter.plugin.soap.model.WsdlService
 import io.gatehill.imposter.plugin.soap.util.SoapUtil
 import io.gatehill.imposter.util.BodyQueryUtil
 import org.jdom2.Document
 import org.jdom2.Element
 import org.jdom2.Namespace
+import org.xml.sax.EntityResolver
 import java.io.File
 import java.net.URI
 import javax.xml.namespace.QName
@@ -61,7 +67,8 @@ import javax.xml.namespace.QName
 class Wsdl1Parser(
     wsdlFile: File,
     document: Document,
-) : AbstractWsdlParser(wsdlFile, document) {
+    entityResolver: EntityResolver,
+) : AbstractWsdlParser(wsdlFile, document, entityResolver) {
 
     override val version = WsdlParser.WsdlVersion.V1
 

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

@@ -43,11 +43,17 @@
 
 package io.gatehill.imposter.plugin.soap.parser
 
-import io.gatehill.imposter.plugin.soap.model.*
+import io.gatehill.imposter.plugin.soap.model.BindingType
+import io.gatehill.imposter.plugin.soap.model.WsdlBinding
+import io.gatehill.imposter.plugin.soap.model.WsdlEndpoint
+import io.gatehill.imposter.plugin.soap.model.WsdlInterface
+import io.gatehill.imposter.plugin.soap.model.WsdlOperation
+import io.gatehill.imposter.plugin.soap.model.WsdlService
 import io.gatehill.imposter.util.BodyQueryUtil
 import org.jdom2.Document
 import org.jdom2.Element
 import org.jdom2.Namespace
+import org.xml.sax.EntityResolver
 import java.io.File
 import java.net.URI
 import javax.xml.namespace.QName
@@ -59,8 +65,9 @@ import javax.xml.namespace.QName
  */
 class Wsdl2Parser(
     wsdlFile: File,
-    document: Document
-) : AbstractWsdlParser(wsdlFile, document) {
+    document: Document,
+    entityResolver: EntityResolver,
+) : AbstractWsdlParser(wsdlFile, document, entityResolver) {
 
     override val version = WsdlParser.WsdlVersion.V2
 

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

@@ -95,6 +95,8 @@ class SoapExampleService {
             val errors = mutableListOf<XmlError>()
 
             val compileOptions = XmlOptions()
+                .setLoadLineNumbers()
+                .setLoadMessageDigest()
                 .setEntityResolver(WsdlRelativeXsdEntityResolver(wsdlDir))
                 .setErrorListener(errors)
 

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

@@ -64,7 +64,8 @@ class Wsdl1Soap11ParserTest {
     fun setUp() {
         val wsdlFile = File(Wsdl1Soap11ParserTest::class.java.getResource("/wsdl1-soap11/service.wsdl")!!.toURI())
         val document = SAXBuilder().build(wsdlFile)
-        parser = Wsdl1Parser(wsdlFile, document)
+        val entityResolver = WsdlRelativeXsdEntityResolver(wsdlFile.parentFile)
+        parser = Wsdl1Parser(wsdlFile, document, entityResolver)
     }
 
     @Test

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

@@ -64,7 +64,8 @@ class Wsdl1Soap12ParserTest {
     fun setUp() {
         val wsdlFile = File(Wsdl1Soap12ParserTest::class.java.getResource("/wsdl1-soap12/service.wsdl")!!.toURI())
         val document = SAXBuilder().build(wsdlFile)
-        parser = Wsdl1Parser(wsdlFile, document)
+        val entityResolver = WsdlRelativeXsdEntityResolver(wsdlFile.parentFile)
+        parser = Wsdl1Parser(wsdlFile, document, entityResolver)
     }
 
     @Test

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

@@ -64,7 +64,8 @@ class Wsdl2Soap12ParserTest {
     fun setUp() {
         val wsdlFile = File(Wsdl2Soap12ParserTest::class.java.getResource("/wsdl2-soap12/service.wsdl")!!.toURI())
         val document = SAXBuilder().build(wsdlFile)
-        parser = Wsdl2Parser(wsdlFile, document)
+        val entityResolver = WsdlRelativeXsdEntityResolver(wsdlFile.parentFile)
+        parser = Wsdl2Parser(wsdlFile, document, entityResolver)
     }
 
     @Test