XMLUnit

https://github.com/xmlunit/xmlunit
Admin
XMLUnit is a library that supports testing XML output through XPath, schema validation, and XML...
Tokens:7,737
Snippets:130
Trust Score:6
License:Apache-2.0
Update:4 months ago
Show doc for...
Tokens:
Raw
### XML Input Example

Source: https://github.com/xmlunit/xmlunit/wiki/XMLUnit-with-Java-9-and-above

An example XML structure used as input for transformation.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<notification>
    <to>jhon@email.com</to>
    <info><![CDATA[update]]></info>
</notification>
```

--------------------------------

### Restore NuGet Packages for .NET Framework

Source: https://github.com/xmlunit/xmlunit/wiki/Building-XMLUnit

Restore NuGet packages for the .NET Framework compatible version of XMLUnit before building. Requires NuGet and msbuild/xbuild to be installed.

```sh
$ nuget restore XMLUnit.NET.NetFramework.sln
```

--------------------------------

### Compare XML Documents using AssertJ XmlAssert (xmlunit-assertj)

Source: https://github.com/xmlunit/xmlunit/blob/main/README.md

Compares XML documents using AssertJ's XmlAssert. This example checks for identical XML content. Requires the xmlunit-assertj module.

```java

import static org.xmlunit.assertj.XmlAssert.assertThat;
...

assertThat(createTestDocument())
            .and(Input.fromFile("test-data/good.xml"))
            .areIdentical();
```

--------------------------------

### Compare XML Documents using AssertJ XmlAssert (xmlunit-assertj3)

Source: https://github.com/xmlunit/xmlunit/blob/main/README.md

Compares XML documents using AssertJ's XmlAssert from the xmlunit-assertj3 module. This example checks for identical XML content.

```java

import static org.xmlunit.assertj3.XmlAssert.assertThat;
...

assertThat(createTestDocument())
            .and(Input.fromFile("test-data/good.xml"))
            .areIdentical();
```

--------------------------------

### Build XMLUnit .NET Framework Version

Source: https://github.com/xmlunit/xmlunit/wiki/Building-XMLUnit

Build the .NET Framework compatible version of XMLUnit and run NUnit tests using msbuild or xbuild.

```sh
$ xbuild /p:Configuration=Debug XMLUnit.NET.sln
```

--------------------------------

### Build and Deploy Java Artifacts

Source: https://github.com/xmlunit/xmlunit/wiki/Releasing-XMLUnit

Builds and deploys Maven artifacts to the Sonatype Central repository for release. Includes options for GPG signing.

```bash
mvn clean deploy -Psonatype-central-release,release [-Dgpg.keyname=localKeyId]
```

--------------------------------

### Build XMLUnit .NET Standard 2.0 Version

Source: https://github.com/xmlunit/xmlunit/wiki/Building-XMLUnit

Build the .NET Standard 2.0 compatible version of XMLUnit using the dotnet CLI.

```sh
> dotnet build XMLUnit.NET.sln -c Debug
```

--------------------------------

### Build and Test .NET Projects

Source: https://github.com/xmlunit/xmlunit/wiki/Releasing-XMLUnit

Builds and tests various .NET projects and solutions, including specific configurations for different .NET Framework and Core versions, and NUnit constraints.

```powershell
msbuild XMLUnit.NET.NetFramework.sln
msbuild src/main/net-constraints-nunit4/NetFramework/XMLUnit.NUnit4.Constraints.NetFramework.csproj
export DOTNET_ROLL_FORWARD=Major # on ps $env:DOTNET_ROLL_FORWARD = "Major"
dotnet restore XMLUnit.NET.sln
dotnet build XMLUnit.NET.sln
dotnet build src/main/net-constraints-nunit4/XMLUnit.NUnit4.Constraints.csproj
dotnet test src/tests/net-core/XMLUnit.Core.Tests.csproj
dotnet test src/tests/net-constraints-nunit3/XMLUnit.NUnit3.Constraints.Test.csproj
dotnet test src/tests/net-placeholders/XMLUnit.Placeholders.Tests.csproj
dotnet test src/tests/net-constraints-nunit4/XMLUnit.NUnit4.Constraints.Test.csproj
```

--------------------------------

### Build XMLUnit for Java

Source: https://github.com/xmlunit/xmlunit/wiki/Building-XMLUnit

Use this command to build the Java version of XMLUnit using Apache Maven.

```sh
$ mvn install
```

--------------------------------

### Create Java Binary Distribution

Source: https://github.com/xmlunit/xmlunit/wiki/Releasing-XMLUnit

Creates binary distribution tarballs for the Java version of XMLUnit.

```bash
./create-bin-dist.sh 2.0.0-alpha-02
```

--------------------------------

### Create .NET Distribution Tarballs

Source: https://github.com/xmlunit/xmlunit/wiki/Releasing-XMLUnit

Creates conventional distribution tarballs for the .NET version of XMLUnit.

```bash
./create-dist.sh 2.0.0-alpha-02
```

--------------------------------

### Generate Java API Documentation

Source: https://github.com/xmlunit/xmlunit/wiki/Building-XMLUnit

Generate aggregated Javadocs for all three modules of XMLUnit for Java using Maven.

```sh
$ mvn javadoc:aggregate
```

--------------------------------

### Run XMLUnit .NET Standard 2.0 Tests

Source: https://github.com/xmlunit/xmlunit/wiki/Building-XMLUnit

Execute unit tests for the .NET Standard 2.0 compatible version of XMLUnit using the dotnet CLI.

```sh
> dotnet test src/tests/net-core/XMLUnit.Core.Tests.csproj
```

```sh
> dotnet test src/tests/net-constraints-nunit3/XMLUnit.NUnit3.Constraints.Test.csproj
```

```sh
> dotnet test src/tests/net-placeholders/XMLUnit.Placeholders.Tests.csproj
```

--------------------------------

### Restore NuGet Packages for .NET Standard 2.0

Source: https://github.com/xmlunit/xmlunit/wiki/Building-XMLUnit

Restore NuGet packages for the .NET Standard 2.0 compatible version of XMLUnit. Requires the dotnet CLI.

```sh
$ dotnet restore XMLUnit.NET.sln
```

--------------------------------

### Maven Repository for SNAPSHOT Builds

Source: https://github.com/xmlunit/xmlunit/blob/main/README.md

Configure your Maven settings to use this repository for SNAPSHOT builds of XMLUnit.

```xml
<repository>
  <name>Central Portal Snapshots</name>
  <id>central-portal-snapshots</id>
  <url>https://central.sonatype.com/repository/maven-snapshots/</url>
  <releases><enabled>false</enabled></releases>
  <snapshots><enabled>true</enabled></snapshots>
</repository>
```

--------------------------------

### Set Java Project Version

Source: https://github.com/xmlunit/xmlunit/wiki/Releasing-XMLUnit

Sets the new version number for Java projects using Maven. Use -DgenerateBackupPoms=false to avoid creating backup POM files.

```bash
mvn versions:set -DnewVersion=2.0.0-alpha-02 -DgenerateBackupPoms=false
mvn versions:set -DnewVersion=2.0.0-alpha-02 -DgenerateBackupPoms=false -f xmlunit-bom/pom.xml
```

--------------------------------

### Compare Two XML Documents using DOMDifferenceEngine

Source: https://github.com/xmlunit/xmlunit/blob/main/README.md

Compares two XML documents using the DOMDifferenceEngine and adds a listener to fail on any difference found. This is a low-level comparison approach.

```java
Source control = Input.fromFile("test-data/good.xml").build();
Source test = Input.fromByteArray(createTestDocument()).build();
DifferenceEngine diff = new DOMDifferenceEngine();
diff.addDifferenceListener(new ComparisonListener() {
        public void comparisonPerformed(Comparison comparison, ComparisonResult outcome) {
            Assert.fail("found a difference: " + comparison);
        }
    });
diff.compare(control, test);
```

--------------------------------

### Transforming XML with Java Transformer

Source: https://github.com/xmlunit/xmlunit/wiki/XMLUnit-with-Java-9-and-above

Demonstrates how to use Java's Transformer to process an XML string. Ensure the input string is correctly formatted.

```java
StreamSource source = new StreamSource(new StringReader(input));
Transformer transformer = TransformerFactory
  .newInstance()
  .newTransformer();

transformer.setOutputProperty(OutputKeys.INDENT, "yes");
StreamResult result = new StreamResult(new StringWriter());
transformer.transform(source, result);
String output = result
  .getWriter()
  .toString();
```

--------------------------------

### Build and Package .NET Release Artifacts

Source: https://github.com/xmlunit/xmlunit/wiki/Releasing-XMLUnit

Builds release artifacts and NuGet packages for the .NET version of XMLUnit, specifying the version number.

```powershell
./scripts/build-and-package.ps1 -Version 2.11.1
```

--------------------------------

### Generate .NET SBOMs

Source: https://github.com/xmlunit/xmlunit/wiki/Releasing-XMLUnit

Generates Software Bill of Materials (SBOMs) for the .NET release, specifying the version number.

```powershell
./scripts/generate-sboms.ps1 -Version 2.11.1
```

--------------------------------

### Compare Two XML Documents using Fluent Builder API

Source: https://github.com/xmlunit/xmlunit/blob/main/README.md

Compares two XML documents using the fluent builder API. Asserts that there are no differences between the control and test documents.

```java
Diff d = DiffBuilder.compare(Input.fromFile("test-data/good.xml"))
             .withTest(createTestDocument()).build();
assert !d.hasDifferences();
```

--------------------------------

### Set Java Snapshot Version

Source: https://github.com/xmlunit/xmlunit/wiki/Releasing-XMLUnit

Bumps the version number for Java projects to the next snapshot release after a release has been made.

```bash
mvn versions:set -DnewVersion=2.0.0-alpha-03-SNAPSHOT -DgenerateBackupPoms=false
```

--------------------------------

### Validating XML Document Against Schema with AssertJ (xmlunit-assertj3)

Source: https://github.com/xmlunit/xmlunit/blob/main/README.md

This snippet demonstrates validating XML documents against schemas using the `xmlunit-assertj3` module, which is designed for AssertJ 3.x and JUnit 5.x.

```java
import static org.xmlunit.assertj3.XmlAssert.assertThat;
...

assertThat(createDocument()).isValidAgainst(Input.fromFile("local.xsd"));
```

--------------------------------

### Compare XML Documents using Hamcrest Matcher

Source: https://github.com/xmlunit/xmlunit/blob/main/README.md

Compares an XML document against a control file using Hamcrest's CompareMatcher. Requires the xmlunit-matchers module.

```java
import static org.xmlunit.matchers.CompareMatcher.isIdenticalTo;
...

assertThat(createTestDocument(), isIdenticalTo(Input.fromFile("test-data/good.xml")));
```

--------------------------------

### Comparing XML with xmlunit-assertj

Source: https://github.com/xmlunit/xmlunit/wiki/XMLUnit-with-Java-9-and-above

Compares two XML strings for similarity using the xmlunit-assertj library. Note potential differences in Java 9+ due to Transformer behavior.

```java
assertThat(input)
  .and(output)
  .areSimilar();
```

--------------------------------

### Validating XML Document Against Schema with XMLUnit Core

Source: https://github.com/xmlunit/xmlunit/blob/main/README.md

This snippet demonstrates validating an XML document against an XML schema using XMLUnit's core Java API. It requires setting schema sources and validating an instance.

```java
Validator v = Validator.forLanguage(Languages.W3C_XML_SCHEMA_NS_URI);
v.setSchemaSources(Input.fromUri("http://example.com/some.xsd").build(),
                   Input.fromFile("local.xsd").build());
ValidationResult result = v.validateInstance(Input.fromDocument(createDocument()).build());
boolean valid = result.isValid();
Iterable<ValidationProblem> problems = result.getProblems();
```

--------------------------------

### Asserting an XPath Value with AssertJ (xmlunit-assertj3)

Source: https://github.com/xmlunit/xmlunit/blob/main/README.md

This snippet shows how to assert XPath values using the `xmlunit-assertj3` module, which is designed for AssertJ 3.x and JUnit 5.x.

```java
import static org.xmlunit.assertj3.XmlAssert.assertThat;
...

assertThat("<foo>bar</foo>").hasXPath("/foo");
assertThat("<foo>bar</foo>").valueByXPath("/foo/text()").isEqualTo("bar");
```

--------------------------------

### Asserting an XPath Value with Hamcrest

Source: https://github.com/xmlunit/xmlunit/blob/main/README.md

This snippet demonstrates asserting XPath values using Hamcrest matchers. It's useful for integrating XMLUnit assertions into Hamcrest test suites.

```java
assertThat("<foo>bar</foo>", HasXPathMatcher.hasXPath("/foo"));
assertThat("<foo>bar</foo>", EvaluateXPathMatcher.hasXPath("/foo/text()",
                                                           equalTo("bar")));
```

--------------------------------

### Validating XML Document Against Schema with Hamcrest

Source: https://github.com/xmlunit/xmlunit/blob/main/README.md

This snippet shows how to validate an XML document against a schema using Hamcrest's `ValidationMatcher`. It's suitable for integration into Hamcrest test suites.

```java
import static org.xmlunit.matchers.ValidationMatcher.valid;
...

assertThat(createDocument(), valid(Input.fromFile("local.xsd")));
```

--------------------------------

### Validating XML Document Against Schema with AssertJ (xmlunit-assertj)

Source: https://github.com/xmlunit/xmlunit/blob/main/README.md

Use this snippet for validating XML documents against schemas with AssertJ, using the `xmlunit-assertj` module. This is compatible with JUnit 4.x.

```java
import static org.xmlunit.assertj.XmlAssert.assertThat;
...

assertThat(createDocument()).isValidAgainst(Input.fromFile("local.xsd"));
```

--------------------------------

### Asserting an XPath Value with XMLUnit Core

Source: https://github.com/xmlunit/xmlunit/blob/main/README.md

Use this snippet to directly assert XPath values using XMLUnit's core Java API. It requires building a source and using an XPath engine.

```java
Source source = Input.fromString("<foo>bar</foo>").build();
XPathEngine xpath = new JAXPXPathEngine();
Iterable<Node> allMatches = xpath.selectNodes("/foo", source);
assert allMatches.iterator().hasNext();
String content = xpath.evaluate("/foo/text()", source);
assert "bar".equals(content);
```

--------------------------------

### Maven Dependency for XMLUnit Core

Source: https://github.com/xmlunit/xmlunit/blob/main/README.md

Add this dependency to your Maven project to include the core XMLUnit library.

```xml
<dependency>
  <groupId>org.xmlunit</groupId>
  <artifactId>xmlunit-core</artifactId>
  <version>x.y.z</version>
</dependency>
```

--------------------------------

### Asserting an XPath Value with AssertJ (xmlunit-assertj)

Source: https://github.com/xmlunit/xmlunit/blob/main/README.md

Use this snippet for asserting XPath values with AssertJ, leveraging the `xmlunit-assertj` module. This version is suitable for JUnit 4.x.

```java
import static org.xmlunit.assertj.XmlAssert.assertThat;
...

assertThat("<foo>bar</foo>").hasXPath("/foo");
assertThat("<foo>bar</foo>").valueByXPath("/foo/text()").isEqualTo("bar");
```

--------------------------------

### Remove Extra Newlines with Regex

Source: https://github.com/xmlunit/xmlunit/wiki/XMLUnit-with-Java-9-and-above

Mitigates issues with extra newlines and spaces between XML elements introduced by Java 9+ Transformer behavior. This regex targets lines that are empty or contain only whitespace.

```java
output.replaceAll("(?m)^[ \t]*\r?\n", "");
```

--------------------------------

### Remove Newline Before CDATA with Regex

Source: https://github.com/xmlunit/xmlunit/wiki/XMLUnit-with-Java-9-and-above

Mitigates issues with newlines and spaces around CDATA sections in XML output from Java 9+ Transformer. This regex specifically targets whitespace between a closing tag and a CDATA section.

```java
xml.replaceAll(">\s*(<\!\[CDATA\[.*?]]>)\s*</", ">$1</");
```
Tokens:
Raw