XMLUnit 2.x support [SPR-14043]

[spring-projects-issues]

Brian Clozel opened SPR-14043 and commented

The XMLUnit project has a new home and the maintainers released a new 2.0 version.

---

Reference URL: http://www.xmlunit.org/

Issue Links:

• XmlExpectationsHelper.assertXmlEqual missing "regardless of order" case [SPR-15156] #19722 XmlExpectationsHelper.assertXmlEqual missing "regardless of order" case

Referenced from: commits 3635c9d

[spring-projects-issues]

Marius Grama commented

I've tried out to integrate library org.xmlunit:xmlunit-core:2.0.0 in the project, but due to the fact that the class org.custommonkey.xmlunit.XMLAssert is not anymore available in the current version of the library there are a series of convenience methods that have to be written by hand :

        private static void assertXMLEqual(Object expected, Object actual){
		assertXMLEqual(null, expected, actual);
	}
	
	private static void assertXMLEqual(String err, Object expected, Object actual){
		Diff diffSimilar = DiffBuilder.compare(expected).withTest(actual)
				.withNodeMatcher(new DefaultNodeMatcher(ElementSelectors.byName))
				.checkForSimilar()
				.build();
		assertFalse((err!= null ? err + ", " : "") + diffSimilar.toString(), diffSimilar.hasDifferences());
	}

	private static void assertXpathExists(String xPathExpression, String inXMLString){
		Source source = Input.fromString(inXMLString).build();
		Iterable<Node> nodes = new JAXPXPathEngine().selectNodes(xPathExpression, source);
		assertNotNull(nodes);
		int count = 0;

		for (Node node : nodes ) {
			count++;
		}
		assertTrue("Expecting to find matches for Xpath " + xPathExpression, count > 0);
	}


	private static void assertXpathNotExists(String xPathExpression, String inXMLString){
		Source source = Input.fromString(inXMLString).build();
		Iterable<Node> nodes = new JAXPXPathEngine().selectNodes(xPathExpression, source);
		assertNotNull(nodes);
		int count = 0;

		for (Node node : nodes ) {
			count++;
		}

		assertEquals("Should be zero matches for Xpath " + xPathExpression, 0, count);
	}

Without having XMLAssert utility methods available in a common utility class (prefferably from xmlunit library), they would need to be duplicated in the test code.
I've opened xmlunit/xmlunit#56 xmlunit issue for this purpose.

[spring-projects-issues]

Marius Grama commented

I've discovered that xmlunit library ships also xmlunit-matchers (a small suite of hamcrest matchers extensions) which can be used to perform what XMLAssert.assertXMLEqual is doing. The xpath exists/not exists checks are not present as matchers currently in xmlunit-matchers, but since they are used only in XStreamMarsallerTests, I think it is ok to have the utility methods that are doing the checks included in the test class.

[spring-projects-issues]

Marius Grama commented

Created pull request : #1004

[spring-projects-issues]

Brian Clozel commented

Thanks a lot Marius Grama for this PR!

Given that the xmlunit project changed both its maven coordinates and package names, I'll see if this requires a dual support or if we'll just schedule a requirement upgrade to xmlunit 2.0 for 4.3 - or even postpone this to 5.0, with other requirement upgrades. I'll discuss this with the team shortly. Last release of xmlunit was 1.6, in December 2014.

[spring-projects-issues]

Marius Grama commented

Brian Clozel you can take into account the fact that xmlunit keeps also in version 2.0 support for the legacy API (xmlunit-legacy), even though under the hood the xmlunit-core is used.
http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.xmlunit%22

[spring-projects-issues]

Brian Clozel commented

Hey Marius Grama,

I've just discussed this with the team, and we've decided to move this to 5.0 since it's a change of minimum dependency version - we'll add that change in the Migrating from earlier versions page.

For now, I've moved this to the backlog but I'll move this to the RC1 bucket as soon as it's created.
Your PR is in pretty good shape, so I'll definitely use it.

Thanks!

[spring-projects-issues]

Juergen Hoeller commented

Brian Clozel, since this is a baseline upgrade and we got a pull request going with it, it'd be great if we could address it for 5.0 M1 already...