XMLUnit for Java 2.9.1 API

XMLUnit helps testing code that creates XML.

XMLUnit for Java is separated into several jars:

• xmlunit-core contains all algorithms and classes needed to validate XML, perform XPath queries or compare two pieces of XML.
• xmlunit-matchers contains Hamcrest matchers on top of xmlunit-core. While the code is compiled against Hamcrest 1.x the resulting artifact is supposed to work with Hamcrest 2.x as well.
• xmlunit-assertj contains AssertJ assertions on top of xmlunit-core that work with AssertJ 2.x and 3.x.
• xmlunit-assertj3 contains AssertJ 3.x assertions on top of xmlunit-core that work with AssertJ 3.18.1 and later.
• xmlunit-placeholders - an experimental component that uses an extensible DSL inside of the control document to simplify certain special cases for comparisons.
• xmlunit-jakarta-jaxb-impl provides a JAXB Input builder that uses version 3.x of Jakarta XML Binding rather than it predecessor that uses the javax.xml.bind package (and is supported by xmlunit-core directly).

While XMLUnit is focussed on testing, parts of it may be useful in different contexts as well. The DifferenceEngine may be the driver behind a visual XML diff tool for example.

The main use case of XMLUnit is comparing XML generated by the code under test with some known source of "good XML". This is the responsibility of the DifferenceEngine and its main (currently sole) implementation DOMDifferenceEngine.

Sometimes a full comparison is more than is needed in which case only parts of the generated document are validated using XPaths. This is the responsibility of XPathEngine and its implementation JAXPXPathEngine.

The validation package contains everything needed to validate documents against XML Schema (or even the schema document itself) or a DTD. Based of JAXP's validation package the JAXPValidator class should be able to validate against different schema languages as well if you provided it with the needed implementations.

The builder package contains fluent builders that may provide an API that is more convenient to use in many cases.

xmlunit-legacy provides an API compatible to XMLUnit for Java 1.x that is implemented on top of XMLUnit Core.

XMLUnit for Java 2.6.0 adds a new experimental component xmlunit-placeholders that aims to provide a small DSL for configuring the test engine via the control XML document rather than code. The initial code base only supports a placeholder of ${xmlunit.ignore} to be used in order to make XMLUnit ignore the element containing this sequence.

• XMLUnit's home page
• Source Code
• Contributing Guide
• Reporting Issues
• User Guide
• Developer Wiki

XMLUnit for Java is licensed under the Apache License, Version 2.0. The legacy jar uses the three clause BSD license, the same license as XMLUnit for Java 1.x did.

Package	Description
org.custommonkey.xmlunit	Root of the XMLUnit 1.x compatibility layer.
org.custommonkey.xmlunit.examples
org.custommonkey.xmlunit.exceptions
org.custommonkey.xmlunit.jaxp13
org.custommonkey.xmlunit.util
org.xmlunit	XMLUnit helps testing code that creates XML.
org.xmlunit.assertj	AssertJ assertions on top of XMLUnit's core.
org.xmlunit.assertj.error	Contains internal classes of XMLUnit's AssertJ support that are only public as an implementation detail.
org.xmlunit.assertj3	AssertJ 3.x assertions on top of XMLUnit's core.
org.xmlunit.assertj3.error	Contains internal classes of XMLUnit's AssertJ 3.x support that are only public as an implementation detail.
org.xmlunit.builder	Provides fluent builders for core parts of XMLUnit.
org.xmlunit.builder.jakarta_jaxb	This package contains the JAXB builder using the jakarta.xml.bind package.
org.xmlunit.builder.javax_jaxb	This package contains the JAXB builder using the javax.xml.bind package.
org.xmlunit.diff	Contains XMLUnit DifferenceEngine that is at the heart of all comparisons as well as supporting interfaces and implementations.
org.xmlunit.input	Some useful Source implementations.
org.xmlunit.matchers	Hamcrest matchers on top of XMLUnit's core.
org.xmlunit.placeholder	This package contains experimental support for configuring parts of the test engine by using ${xmlunit.KEYWORD} sequences inside the control document.
org.xmlunit.transform	XSLT convenience layer.
org.xmlunit.util	Internal utilities hiding the differences between .NET and Java implementations.
org.xmlunit.validation	Validation of XML documents and schemas.
org.xmlunit.xpath	XPath convenience layer.