Файл: XMLUnit-Java.pdf

<foo>bar baz</foo>

<foo> bar

baz</foo>

Note that this is not related to "normalizing" the document as a whole (see Section 3.8.2).

3.8.2"Normalizing" Documents

"Normalize" in this context corresponds to the normalize method in DOM’s Document class. It is the process of merging adjacent Text nodes and is not related to "normalizing whitespace" as described in the previous section.

Usually you don’t need to care about this option since the XML parser is required to normalize the Document when creating it. The only reason you may want to change the option via XMLUnit.setNormalize is that your Document instances have not been created by an XML parser but rather been put together in memory using the DOM API directly.

3.8.3Ignoring Comments

Using XMLUnit.setIgnoreComments you can make XMLUnit’s difference engine ignore comments completely.

When this option is set to true, Diff will use the XSLT transformer under the covers.

3.8.4Treating CDATA Sections and Text Nodes Alike

It is not always necessary to know whether a text has been put into a CDATA section or not. Using XMLUnit.setIgnoreDi ffBetweenTextAndCDATA you can make XMLUnit consider the following two pieces of XML identical:

<foo><bar></foo>

<foo><![CDATA[<bar>]]></foo>

3.8.5Entity Reference Expansion

Normally the XML parser will expand character references to their Unicode equivalents but for more complex entity definitions the parser may expand them or not. Using XMLUnit.setExpandEntityReferences you can control the parser’s setting.

3.8.6Comparison of Unmatched Elements

When XMLUnit cannot match a control Element to a test Element (the configured ElementQualifier - see Section 3.4 - doesn’t return true for any of the test Elements) it will try to compare it against the first unmatched test Element (if there is one). Starting with XMLUnit 1.3 one can use XMLUnit.setCompareUnmatched to disable this behavior and generate CHILD_NODE_N OT_FOUND differences instead.

If the control document is

<root>

<a/>

</root>

and the test document is

<root>

<b/>

</root>

the default setting will create a single ELEMENT_TAG_NAME Difference ("expected a but found b"). Setting XMLUnit.set CompareUnmatched to false will create two Differences of type CHILD_NODE_NOT_FOUND (one for "a" and one for "b") instead.

Example 4.4 Validating Against a DTD Using Apache’s XML Resolver and an XML Catalog

InputSource is = new InputSource(new FileInputStream(myXmlDocument));

XMLUnit.setControlEntityResolver(new CatalogResolver());

Validator v = new Validator(is); boolean isValid = v.isValid();

#CatalogManager.properties

verbosity=1 relative-catalogs=yes catalogs=/some/path/to/catalog prefer=public static-catalog=yes

catalog-class-name=org.apache.xml.resolver.Resolver

<!-- catalog file -->

<catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog"> <public publicId="-//Some//DTD V 1.1//EN"

uri="mydtd.dtd"/>

</catalog>

4.1.2XML Schema Validation

In order to validate against the XML Schema language Schema validation has to be enabled via the useXMLSchema method of

Validator.

By default the parser will try to resolve the location of Schema definition files via a schemaLocation attribute if it is present in the piece of XML or it will try to open the Schema’s URI as an URL and read from it.

The setJAXP12SchemaSource method of Validator allows you to override this behavior as long as the parser supports the http://java.sun.com/xml/jaxp/properties/schemaSource property in the way described in "JAXP 1.2 Approved CHANGES"12.

setJAXP12SchemaSource’s argument can be one of

•A String which contains an URI.

•An InputStream the Schema can be read from.

•An InputSource the Schema can be read from.

•A File the Schema can be read from.

•An array containing any of the above.

If the property has been set using a String, the Validator class will provide its systemId as specified in the constructor when asked to resolve it. You must only use the single argument constructors if you want to avoid this behavior. If no systemId has been specified, the configured EntityResolver may still be used.

Example 4.5 Validating Against a Local XML Schema

InputSource is = new InputSource(new FileInputStream(myXmlDocument));

Validator v = new Validator(is);

v.useXMLSchema(true);

v.setJAXP12SchemaSource(new File(myXmlSchemaFile)); boolean isValid = v.isValid();

12 http://java.sun.com/webservices/jaxp/change-requests-11.html

4.2JUnit 3.x Convenience Methods

Both XMLAssert and XMLTestCase provide an assertXMLValid(Validator) method that will fail if Validator’s isValid method returns false.

In addition several overloads of the assertXMLValid method are provided that directly correspond to similar overloads of Validator’s constructor. These overloads don’t support XML Schema validation at all.

Validator itself provides an assertIsValid method that will throw an AssertionFailedError if validation fails.

Neither method provides any control over the message of the AssertionFailedError in case of a failure.

4.3Configuration Options

•Validator uses a SAX parser created by the configured SAX parser factory (see Section 2.4.1).

•It will use the "control" EntityResolver if one has been specified (see Section 2.4.2).

•The location of a DTD can be specified via Validator’s systemId constructor argument or a custom EntityResolver (see Section 4.1.1).

•XML Schema validation is enabled via Validator.useXMLSchema(true).

•The location(s) of XML Schema document(s) can be specified via Validator.setJAXP12SchemaSource (see Section 4.1.2).

4.4JAXP 1.3 Validation

JAXP 1.3 - shipping with Java5 or better and available as a separate product for earlier Java VMs - introduces a new package javax.xml.validation designed for validations of snippets of XML against different schema languages. Any compliant implementation must support the W3C XML Schema language, but other languages like RELAX NG or Schematron may be supported as well.

The class org.custommonkey.xmlunit.jaxp13.Validator can be used to validate a piece of XML against a schema definition but also to validate the schema definition itself. By default Validator will assume your definition uses the W3C XML Schema language, but it provides a constructor that can be used to specify a different language via an URL supported by the SchemaFactory class. Alternatively you can specify the schema factory itself.

The schema definition itself can be given via Source elements, just like the pieces of XML to validate are specified as Source as well.

The following example uses org.custommonkey.xmlunit.jaxp13.Validator to perform the same type of validation shown in Example 4.5.

Example 4.6 Validating Against a Local XML Schema

Validator v = new Validator();

v.addSchemaSource(new StreamSource(new File(myXmlSchemaFile)));

StreamSource is = new StreamSource(new File(myXmlDocument)); boolean isValid = v.isInstanceValid(is);

Validating a schema definition is shown in the next example.

Example 4.7 Validating an XML Schema Definition

Validator v = new Validator();

v.addSchemaSource(new StreamSource(new File(myXmlSchemaFile)));

boolean isValid = v.isSchemaValid();

There is no explicit JUnit 3 support for org.custommonkey.xmlunit.jaxp13.Validator.