Package org.xmlunit.assertj3

Class CompareAssert

java.lang.Object

org.assertj.core.api.AbstractAssert<CompareAssert,Object>

org.xmlunit.assertj3.CustomAbstractAssert<CompareAssert,Object>

org.xmlunit.assertj3.CompareAssert

All Implemented Interfaces:

org.assertj.core.api.Assert<CompareAssert,Object>, org.assertj.core.api.Descriptable<CompareAssert>, org.assertj.core.api.ExtensionPoints<CompareAssert,Object>, DifferenceEngineConfigurer<CompareAssert>

public class CompareAssert
extends CustomAbstractAssert<CompareAssert,Object>
implements DifferenceEngineConfigurer<CompareAssert>

Assertion methods for XMLs comparison.

Simple Example

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

 final String control = "<a><b attr=\"abc\"></b></a>";
 final String test = "<a><b attr=\"xyz\"NodeAssertFactory></b></a>";

 assertThat(test).and(control).areIdentical();
 assertThat(test).and(control).areNotSimilar();
 

Since:

XMLUnit 2.8.1

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static enum	CompareAssert.ComparisonContext

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	COMPARISON_FAILURE_PATTERN
private ComparisonController	customComparisonController
private final DiffBuilder	diffBuilder
private static final String	EXPECTING_NOT_NULL
private ComparisonFormatter	formatter
private boolean	formatXml
private static final DifferenceEvaluator	IgnoreNodeListSequence

Fields inherited from class org.assertj.core.api.AbstractAssert

actual, info, myself, objects, throwUnsupportedExceptionOnEquals

Constructor Summary

Constructors

Modifier	Constructor	Description
private	CompareAssert(Object actual, DiffBuilder diffBuilder)

Method Summary

Modifier and Type	Method	Description
CompareAssert	areIdentical()	Check if actual and control XMLs are identical.
CompareAssert	areNotIdentical()	Check if actual and control XMLs are not identical.
CompareAssert	areNotSimilar()	Check if actual and control XMLs are not similar.
CompareAssert	areSimilar()	Check if actual and control XMLs are similar.
private void	compare(CompareAssert.ComparisonContext context)
(package private) static CompareAssert	create(Object actual, Object control, XmlAssertConfig config)
private void	failComparison(String type, String controlSystemId, String testSystemId, Comparison difference, ComparisonFormatter formatter, boolean formatXml)
CompareAssert	ignoreChildNodesOrder()	Equivalent for
CompareAssert	ignoreComments()
CompareAssert	ignoreCommentsUsingXSLTVersion(String xsltVersion)
CompareAssert	ignoreElementContentWhitespace()
CompareAssert	ignoreWhitespace()
CompareAssert	normalizeWhitespace()
CompareAssert	withAttributeFilter(Predicate<Attr> attributeFilter)	Registers a filter for attributes.
CompareAssert	withComparisonController(ComparisonController comparisonController)	Replace the invalid reference ComparisonControllers#Default with your own ComparisonController.
CompareAssert	withComparisonFormatter(ComparisonFormatter formatter)	Sets a non-default formatter for the differences found.
CompareAssert	withComparisonListeners(ComparisonListener... comparisonListeners)	Registers listeners that are notified of each comparison.
CompareAssert	withDifferenceEvaluator(DifferenceEvaluator differenceEvaluator)	Provide your own custom DifferenceEvaluator implementation.
CompareAssert	withDifferenceListeners(ComparisonListener... comparisonListeners)	Registers listeners that are notified of each comparison with outcome other than invalid reference ComparisonResult#EQUAL .
CompareAssert	withDocumentBuilderFactory(DocumentBuilderFactory f)
CompareAssert	withNamespaceContext(Map<String,String> prefix2Uri)	Establish a namespace context that will be used in Comparison.Detail#getXPath.
CompareAssert	withNodeFilter(Predicate<Node> nodeFilter)	Registers a filter for nodes.
CompareAssert	withNodeMatcher(NodeMatcher nodeMatcher)	Sets the strategy for selecting nodes to compare.

Methods inherited from class org.xmlunit.assertj3.CustomAbstractAssert

isElementOfCustomAssert

Methods inherited from class org.assertj.core.api.AbstractAssert

areEqual, asInstanceOf, asList, assertionError, asString, describedAs, descriptionText, doesNotHave, doesNotHaveSameClassAs, doesNotHaveSameHashCodeAs, doesNotHaveToString, equals, extracting, extracting, failure, failureWithActualExpected, failWithActualExpectedAndMessage, failWithMessage, getWritableAssertionInfo, has, hashCode, hasSameClassAs, hasSameHashCodeAs, hasToString, inBinary, inHexadecimal, is, isEqualTo, isExactlyInstanceOf, isIn, isIn, isInstanceOf, isInstanceOfAny, isInstanceOfSatisfying, isNot, isNotEqualTo, isNotExactlyInstanceOf, isNotIn, isNotIn, isNotInstanceOf, isNotInstanceOfAny, isNotNull, isNotOfAnyClassIn, isNotSameAs, isNull, isOfAnyClassIn, isSameAs, matches, matches, newListAssertInstance, overridingErrorMessage, overridingErrorMessage, satisfies, satisfies, satisfies, satisfiesAnyOf, satisfiesAnyOf, satisfiesAnyOfForProxy, satisfiesForProxy, setCustomRepresentation, setDescriptionConsumer, setPrintAssertionsDescription, throwAssertionError, usingComparator, usingComparator, usingDefaultComparator, usingRecursiveAssertion, usingRecursiveAssertion, usingRecursiveComparison, usingRecursiveComparison, withFailMessage, withFailMessage, withRepresentation, withThreadDumpOnError

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.assertj.core.api.Descriptable

as, as, as, describedAs

Field Details

EXPECTING_NOT_NULL

private static final String EXPECTING_NOT_NULL

See Also:

• Constant Field Values

IgnoreNodeListSequence

private static final DifferenceEvaluator IgnoreNodeListSequence

diffBuilder

private final DiffBuilder diffBuilder

customComparisonController

private ComparisonController customComparisonController

formatXml

private boolean formatXml

formatter

private ComparisonFormatter formatter

COMPARISON_FAILURE_PATTERN

private static final String COMPARISON_FAILURE_PATTERN

See Also:

• Constant Field Values

Constructor Details

CompareAssert

private CompareAssert(Object actual,
 DiffBuilder diffBuilder)

Method Details

create

static CompareAssert create(Object actual,
 Object control,
 XmlAssertConfig config)

withNodeMatcher

public CompareAssert withNodeMatcher(NodeMatcher nodeMatcher)

Sets the strategy for selecting nodes to compare.

Example with DefaultNodeMatcher:

 .withNodeMatcher(new DefaultNodeMatcher(ElementSelectors.byNameAndText))
 

This overwrites any NodeMatcher set via earlier invocations of withNodeMatcher.

Specified by:

withNodeMatcher in interface DifferenceEngineConfigurer<CompareAssert>

See Also:

• DiffBuilder.withNodeMatcher(NodeMatcher)

withDifferenceEvaluator

public CompareAssert withDifferenceEvaluator(DifferenceEvaluator differenceEvaluator)

Provide your own custom DifferenceEvaluator implementation.

This overwrites the Default DifferenceEvaluator.

If you want use your custom DifferenceEvaluator in combination with the default or another DifferenceEvaluator you should use

invalid reference

DifferenceEvaluators#chain(DifferenceEvaluator...)

or

invalid reference

DifferenceEvaluators#first(DifferenceEvaluator...)

to combine them:

         .withDifferenceEvaluator(
             DifferenceEvaluators.chain(
                 DifferenceEvaluators.Default,
                 new MyCustomDifferenceEvaluator()))
         ....
 

This overwrites any DifferenceEvaluator set via earlier invocations of withDifferenceEvaluator.

Specified by:

withDifferenceEvaluator in interface DifferenceEngineConfigurer<CompareAssert>

See Also:

• DiffBuilder.withDifferenceEvaluator(DifferenceEvaluator)

withComparisonController

public CompareAssert withComparisonController(ComparisonController comparisonController)

Replace the

invalid reference

ComparisonControllers#Default

with your own ComparisonController.

Example use:

      .withComparisonController(ComparisonControllers.StopWhenDifferent)
 

This overwrites any ComparisonController set via earlier invocations of withComparisonController.

Specified by:

withComparisonController in interface DifferenceEngineConfigurer<CompareAssert>

See Also:

• DiffBuilder.withComparisonController(ComparisonController)

withComparisonListeners

public CompareAssert withComparisonListeners(ComparisonListener... comparisonListeners)

Registers listeners that are notified of each comparison.

Specified by:

withComparisonListeners in interface DifferenceEngineConfigurer<CompareAssert>

See Also:

• DiffBuilder.withComparisonListeners(ComparisonListener...)

withDifferenceListeners

public CompareAssert withDifferenceListeners(ComparisonListener... comparisonListeners)

Registers listeners that are notified of each comparison with outcome other than

invalid reference

ComparisonResult#EQUAL

.

This overwrites any ComparisonListeners set via earlier invocations of withDifferenceListeners.

Specified by:

withDifferenceListeners in interface DifferenceEngineConfigurer<CompareAssert>

See Also:

• DiffBuilder.withDifferenceListeners(ComparisonListener...)

withNamespaceContext

public CompareAssert withNamespaceContext(Map<String,String> prefix2Uri)

Establish a namespace context that will be used in Comparison.Detail#getXPath.

Without a namespace context (or with an empty context) the XPath expressions will only use local names for elements and attributes.

This overwrites any Map set via earlier invocations of withNamespaceContext.

Specified by:

withNamespaceContext in interface DifferenceEngineConfigurer<CompareAssert>

Parameters:

prefix2Uri - mapping between prefix and namespace URI

See Also:

• DiffBuilder.withNamespaceContext(Map)

withAttributeFilter

public CompareAssert withAttributeFilter(Predicate<Attr> attributeFilter)

Registers a filter for attributes.

Only attributes for which the predicate returns true are part of the comparison. By default all attributes are considered.

The "special" namespace, namespace-location and schema-instance-type attributes can not be ignored this way. If you want to suppress comparison of them you'll need to implement DifferenceEvaluator.

This overwrites any Predicate set via earlier invocations of withAttributeFilter.

Specified by:

withAttributeFilter in interface DifferenceEngineConfigurer<CompareAssert>

See Also:

• DiffBuilder.withAttributeFilter(Predicate)

withNodeFilter

public CompareAssert withNodeFilter(Predicate<Node> nodeFilter)

Registers a filter for nodes.

Only nodes for which the predicate returns true are part of the comparison. By default nodes that are not document types are considered.

This overwrites any Predicate set via earlier invocations of withNodeFilter.

Specified by:

withNodeFilter in interface DifferenceEngineConfigurer<CompareAssert>

See Also:

• DiffBuilder.withNodeFilter(Predicate)

withComparisonFormatter

public CompareAssert withComparisonFormatter(ComparisonFormatter formatter)

Sets a non-default formatter for the differences found.

This overwrites any ComparisonFormatter set via earlier invocations of withComparisonFormatter.

Specified by:

withComparisonFormatter in interface DifferenceEngineConfigurer<CompareAssert>

See Also:

• DiffBuilder.withComparisonFormatter(ComparisonFormatter)

withDocumentBuilderFactory

public CompareAssert withDocumentBuilderFactory(DocumentBuilderFactory f)

See Also:

• DiffBuilder.withDocumentBuilderFactory(DocumentBuilderFactory)

ignoreWhitespace

public CompareAssert ignoreWhitespace()

See Also:

• DiffBuilder.ignoreWhitespace()

normalizeWhitespace

public CompareAssert normalizeWhitespace()

See Also:

• DiffBuilder.normalizeWhitespace()

ignoreElementContentWhitespace

public CompareAssert ignoreElementContentWhitespace()

See Also:

• DiffBuilder.ignoreElementContentWhitespace()

ignoreComments

public CompareAssert ignoreComments()

See Also:

• DiffBuilder.ignoreComments()

ignoreCommentsUsingXSLTVersion

public CompareAssert ignoreCommentsUsingXSLTVersion(String xsltVersion)

See Also:

• DiffBuilder.ignoreCommentsUsingXSLTVersion(String)

ignoreChildNodesOrder

public CompareAssert ignoreChildNodesOrder()

Equivalent for

     .withNodeMatcher(new DefaultNodeMatcher(ElementSelectors.byNameAndText))
     .withDifferenceEvaluator(
          chain(
              Default,
              DifferenceEvaluators.downgradeDifferencesToEqual(ComparisonType.CHILD_NODELIST_SEQUENCE)));
 

See Also:

• DiffBuilder.withNodeMatcher(NodeMatcher)

areIdentical

public CompareAssert areIdentical()

Check if actual and control XMLs are identical. If custom comparison controller wasn't defined then ComparisonControllers.StopWhenSimilar is used.

Throws:

AssertionError - if the test value is invalid

AssertionError - if the control value is invalid

See Also:

• DiffBuilder.checkForIdentical()

areNotIdentical

public CompareAssert areNotIdentical()

Check if actual and control XMLs are not identical. If custom comparison controller wasn't defined then ComparisonControllers.StopWhenSimilar is used.

Throws:

AssertionError - if the test value is invalid

AssertionError - if the control value is invalid

See Also:

• DiffBuilder.checkForSimilar()

areSimilar

public CompareAssert areSimilar()

Check if actual and control XMLs are similar. If custom comparison controller wasn't defined then ComparisonControllers.StopWhenDifferent is used.

Throws:

AssertionError - if the test value is invalid

AssertionError - if the control value is invalid

See Also:

• DiffBuilder.checkForSimilar()

areNotSimilar

public CompareAssert areNotSimilar()

Check if actual and control XMLs are not similar. If custom comparison controller wasn't defined then ComparisonControllers.StopWhenDifferent is used.

Throws:

AssertionError - if the test value is invalid

AssertionError - if the control value is invalid

See Also:

• DiffBuilder.checkForSimilar()

compare

private void compare(CompareAssert.ComparisonContext context)

failComparison

private void failComparison(String type,
 String controlSystemId,
 String testSystemId,
 Comparison difference,
 ComparisonFormatter formatter,
 boolean formatXml)