Use XMLUnit 2 for RequestMatcher and ResponseMatcher.

Implement newer versions of PayloadDiffMatcher and SoapEnvelopematcher based on XMLUnit 2. Deprecate the prior versions of these supporting types so they can be removed in a future release. XMLUnit 2 eases the testing of MockWebServiceServer.

Resolves #1193.

Author: AlbericMartel

pom.xml

@@ -125,7 +125,7 @@
         <xmlsec.version>3.0.1</xmlsec.version>
         <xml-schema-core.version>2.2.2</xml-schema-core.version>
         <xmlunit1.version>1.6</xmlunit1.version>
-        <xmlunit.version>2.7.0</xmlunit.version>
+        <xmlunit.version>2.9.0</xmlunit.version>
         <xom.version>1.3.7</xom.version>
         <spring-asciidoctor-backends.version>0.0.3</spring-asciidoctor-backends.version>
     </properties>

spring-ws-test/pom.xml

@@ -40,6 +40,12 @@
 			<version>${xmlunit1.version}</version>
 		</dependency>
 
+		<dependency>
+			<groupId>org.xmlunit</groupId>
+			<artifactId>xmlunit-core</artifactId>
+			<version>${xmlunit.version}</version>
+		</dependency>
+
 		<dependency>
 			<groupId>org.springframework</groupId>
 			<artifactId>spring-test</artifactId>
@@ -76,4 +82,4 @@
 		</profile>
 	</profiles>
 
-</project>
+</project>

spring-ws-test/src/main/java/org/springframework/ws/test/client/MockSenderConnection.java

@@ -35,7 +35,7 @@
  */
 class MockSenderConnection implements WebServiceConnection, ResponseActions {
 
-	private final List<RequestMatcher> requestMatchers = new LinkedList<RequestMatcher>();
+	private final List<RequestMatcher> requestMatchers = new LinkedList<>();
 
 	private URI uri;
 

spring-ws-test/src/main/java/org/springframework/ws/test/client/RequestMatchers.java

@@ -25,11 +25,10 @@
 
 import org.springframework.core.io.Resource;
 import org.springframework.util.Assert;
-import org.springframework.ws.WebServiceMessage;
-import org.springframework.ws.test.support.matcher.PayloadDiffMatcher;
 import org.springframework.ws.test.support.matcher.SchemaValidatingMatcher;
-import org.springframework.ws.test.support.matcher.SoapEnvelopeDiffMatcher;
 import org.springframework.ws.test.support.matcher.SoapHeaderMatcher;
+import org.springframework.ws.test.support.matcher.xmlunit2.PayloadDiffMatcher;
+import org.springframework.ws.test.support.matcher.xmlunit2.SoapEnvelopeDiffMatcher;
 import org.springframework.xml.transform.ResourceSource;
 
 /**
@@ -49,9 +48,7 @@ private RequestMatchers() {}
 	 * @return the request matcher
 	 */
 	public static RequestMatcher anything() {
-		return new RequestMatcher() {
-			public void match(URI uri, WebServiceMessage request) throws IOException, AssertionError {}
-		};
+		return (uri, request) -> {};
 	}
 
 	// Payload

spring-ws-test/src/main/java/org/springframework/ws/test/server/ResponseMatchers.java

@@ -16,7 +16,7 @@
 
 package org.springframework.ws.test.server;
 
-import static org.springframework.ws.test.support.AssertionErrors.*;
+import static org.springframework.ws.test.support.AssertionErrors.fail;
 
 import java.io.IOException;
 import java.util.Locale;
@@ -30,10 +30,10 @@
 import org.springframework.ws.FaultAwareWebServiceMessage;
 import org.springframework.ws.WebServiceMessage;
 import org.springframework.ws.soap.SoapVersion;
-import org.springframework.ws.test.support.matcher.PayloadDiffMatcher;
 import org.springframework.ws.test.support.matcher.SchemaValidatingMatcher;
 import org.springframework.ws.test.support.matcher.SoapEnvelopeDiffMatcher;
 import org.springframework.ws.test.support.matcher.SoapHeaderMatcher;
+import org.springframework.ws.test.support.matcher.xmlunit2.PayloadDiffMatcher;
 import org.springframework.xml.transform.ResourceSource;
 
 /**

spring-ws-test/src/main/java/org/springframework/ws/test/support/matcher/DiffMatcher.java

@@ -16,7 +16,7 @@
 
 package org.springframework.ws.test.support.matcher;
 
-import static org.springframework.ws.test.support.AssertionErrors.*;
+import static org.springframework.ws.test.support.AssertionErrors.assertTrue;
 
 import org.custommonkey.xmlunit.Diff;
 import org.springframework.ws.WebServiceMessage;
@@ -26,6 +26,7 @@
  *
  * @author Arjen Poutsma
  * @since 2.0
+ * @deprecated Migrate to {@link org.springframework.ws.test.support.matcher.xmlunit2.DiffMatcher}.
  */
 public abstract class DiffMatcher implements WebServiceMessageMatcher {
 

spring-ws-test/src/main/java/org/springframework/ws/test/support/matcher/PayloadDiffMatcher.java

@@ -16,7 +16,7 @@
 
 package org.springframework.ws.test.support.matcher;
 
-import static org.springframework.ws.test.support.AssertionErrors.*;
+import static org.springframework.ws.test.support.AssertionErrors.fail;
 
 import javax.xml.transform.Source;
 import javax.xml.transform.TransformerException;
@@ -34,6 +34,7 @@
  * @author Arjen Poutsma
  * @author Lukas Krecan
  * @since 2.0
+ * @deprecated Migrate to {@link org.springframework.ws.test.support.matcher.xmlunit2.PayloadDiffMatcher}.s
  */
 public class PayloadDiffMatcher extends DiffMatcher {
 

spring-ws-test/src/main/java/org/springframework/ws/test/support/matcher/SoapEnvelopeDiffMatcher.java

@@ -16,7 +16,8 @@
 
 package org.springframework.ws.test.support.matcher;
 
-import static org.springframework.ws.test.support.AssertionErrors.*;
+import static org.springframework.ws.test.support.AssertionErrors.assertTrue;
+import static org.springframework.ws.test.support.AssertionErrors.fail;
 
 import java.io.IOException;
 
@@ -36,6 +37,7 @@
  *
  * @author Alexander Shutyaev
  * @since 2.1.1
+ * @deprecated Migrate to {@link org.springframework.ws.test.support.matcher.xmlunit2.SoapEnvelopeDiffMatcher}.
  */
 public class SoapEnvelopeDiffMatcher extends AbstractSoapMessageMatcher {
 

spring-ws-test/src/main/java/org/springframework/ws/test/support/matcher/xmlunit2/DiffMatcher.java

@@ -0,0 +1,50 @@
+/*
+ * Copyright 2005-2022 the original author or authors.
+ *
+ * Licensed 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.
+ */
+
+package org.springframework.ws.test.support.matcher.xmlunit2;
+
+import static org.springframework.ws.test.support.AssertionErrors.assertTrue;
+
+import org.springframework.ws.WebServiceMessage;
+import org.springframework.ws.test.support.matcher.WebServiceMessageMatcher;
+import org.xmlunit.diff.Diff;
+
+/**
+ * Implementation of {@link WebServiceMessageMatcher} based on XMLUnit's {@link Diff}.
+ *
+ * @author Greg Turnquist
+ * @since 4.0
+ */
+public abstract class DiffMatcher implements WebServiceMessageMatcher {
+
+	@Override
+	public final void match(WebServiceMessage message) throws AssertionError {
+
+		Diff diff = createDiff(message);
+		assertTrue("Messages are different, " + diff.toString(), !diff.hasDifferences(), "Payload",
+				message.getPayloadSource());
+	}
+
+	/**
+	 * Creates a {@link Diff} for the given message.
+	 *
+	 * @param message the message
+	 * @return the diff
+	 * @throws Exception in case of errors
+	 */
+	protected abstract Diff createDiff(WebServiceMessage message);
+
+}

spring-ws-test/src/main/java/org/springframework/ws/test/support/matcher/xmlunit2/PayloadDiffMatcher.java

@@ -0,0 +1,77 @@
+/*
+ * Copyright 2005-2022 the original author or authors.
+ *
+ * Licensed 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.
+ */
+
+package org.springframework.ws.test.support.matcher.xmlunit2;
+
+import static org.springframework.ws.test.support.AssertionErrors.fail;
+
+import javax.xml.transform.Source;
+import javax.xml.transform.TransformerException;
+import javax.xml.transform.dom.DOMResult;
+
+import org.springframework.util.Assert;
+import org.springframework.ws.WebServiceMessage;
+import org.springframework.xml.transform.TransformerHelper;
+import org.w3c.dom.Document;
+import org.xmlunit.builder.DiffBuilder;
+import org.xmlunit.diff.Diff;
+
+/**
+ * Matches {@link Source} payloads.
+ *
+ * @author Greg Turnquist
+ * @since 4.0
+ */
+public class PayloadDiffMatcher extends DiffMatcher {
+
+	private final Source expected;
+
+	private final TransformerHelper transformerHelper = new TransformerHelper();
+
+	public PayloadDiffMatcher(Source expected) {
+		Assert.notNull(expected, "'expected' must not be null");
+		this.expected = expected;
+	}
+
+	@Override
+	protected final Diff createDiff(WebServiceMessage message) {
+		Source payload = message.getPayloadSource();
+		if (payload == null) {
+			fail("Request message does not contain payload");
+		}
+		return createDiff(payload);
+	}
+
+	protected Diff createDiff(Source payload) {
+		Document expectedDocument = createDocumentFromSource(expected);
+		Document actualDocument = createDocumentFromSource(payload);
+		return DiffBuilder.compare(expectedDocument) //
+				.withTest(actualDocument) //
+				.checkForSimilar() //
+				.build();
+	}
+
+	private Document createDocumentFromSource(Source source) {
+		try {
+			DOMResult result = new DOMResult();
+			transformerHelper.transform(source, result);
+			return (Document) result.getNode();
+		} catch (TransformerException ex) {
+			fail("Could not transform source to DOMResult" + ex.getMessage());
+			return null;
+		}
+	}
+}