XMLTestCase (XMLUnit Documentation)

java.lang.Object
- junit.framework.Assert
- - junit.framework.TestCase
  - - org.custommonkey.xmlunit.XMLTestCase

All Implemented Interfaces:

junit.framework.Test, XMLConstants, XSLTConstants
```
public abstract class XMLTestCase
extends junit.framework.TestCase
implements XSLTConstants
```
JUnit TestCase subclass: extend this to add XML assertion facilities to your test suites. Available assertions are provided by static methods of the XMLAssert class. NB: All underlying similarity and difference testing is done using Diff instances which can be instantiated and evaluated independently of an XMLTestCase.

See Also:
Diff.similar(), Examples and more atxmlunit.sourceforge.net

Field Summary
- Fields inherited from interface org.custommonkey.xmlunit.XSLTConstants
  JAVA5_XSLTC_FACTORY_NAME, XSLT_END, XSLT_IDENTITY_TEMPLATE, XSLT_START, XSLT_START_NO_VERSION, XSLT_STRIP_COMMENTS_TEMPLATE, XSLT_STRIP_WHITESPACE, XSLT_XML_OUTPUT_NOINDENT
- Fields inherited from interface org.custommonkey.xmlunit.XMLConstants
  CLOSE_NODE, END_CDATA, END_COMMENT, END_PROCESSING_INSTRUCTION, NULL_NS_URI, OPEN_END_NODE, OPEN_START_NODE, START_CDATA, START_COMMENT, START_DOCTYPE, START_PROCESSING_INSTRUCTION, W3C_XML_SCHEMA_INSTANCE_NO_NAMESPACE_SCHEMA_LOCATION_ATTR, W3C_XML_SCHEMA_INSTANCE_NS_URI, W3C_XML_SCHEMA_INSTANCE_SCHEMA_LOCATION_ATTR, W3C_XML_SCHEMA_INSTANCE_TYPE_ATTR, W3C_XML_SCHEMA_NS_URI, XML_DECLARATION, XMLNS_ATTRIBUTE_URI, XMLNS_PREFIX, XPATH_ATTRIBUTE_IDENTIFIER, XPATH_CHARACTER_NODE_IDENTIFIER, XPATH_COMMENT_IDENTIFIER, XPATH_NODE_INDEX_END, XPATH_NODE_INDEX_START, XPATH_PROCESSING_INSTRUCTION_IDENTIFIER, XPATH_SEPARATOR

Constructor Summary

Constructors
Constructor and Description

XMLTestCase()
Construct a new XML test case.

XMLTestCase(java.lang.String name)
Construct a new test case.

Constructors
Constructor and Description
`XMLTestCase()` Construct a new XML test case.
`XMLTestCase(java.lang.String name)` Construct a new test case.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`assertNodeTestPasses(org.xml.sax.InputSource xml, NodeTester tester, short nodeType)` Execute a `NodeTest for a single node type and assert that it passes`
`void`	`assertNodeTestPasses(NodeTest test, NodeTester tester, short[] nodeTypes, boolean assertion)` Execute a `NodeTest for multiple node types and make an assertion about it whether it is expected to pass`
`void`	`assertNodeTestPasses(java.lang.String xmlString, NodeTester tester, short nodeType)` Execute a `NodeTest for a single node type and assert that it passes`
`void`	`assertXMLEqual(Diff diff, boolean assertion)` Assert that the result of an XML comparison is or is not similar.
`void`	`assertXMLEqual(org.w3c.dom.Document control, org.w3c.dom.Document test)` Assert that two XML documents are similar
`void`	`assertXMLEqual(org.xml.sax.InputSource control, org.xml.sax.InputSource test)` Assert that two XML documents are similar
`void`	`assertXMLEqual(java.io.Reader control, java.io.Reader test)` Assert that two XML documents are similar
`void`	`assertXMLEqual(java.lang.String msg, Diff diff, boolean assertion)` Assert that the result of an XML comparison is or is not similar.
`void`	`assertXMLEqual(java.lang.String err, org.w3c.dom.Document control, org.w3c.dom.Document test)` Assert that two XML documents are similar
`void`	`assertXMLEqual(java.lang.String err, org.xml.sax.InputSource control, org.xml.sax.InputSource test)` Assert that two XML documents are similar
`void`	`assertXMLEqual(java.lang.String err, java.io.Reader control, java.io.Reader test)` Assert that two XML documents are similar
`void`	`assertXMLEqual(java.lang.String control, java.lang.String test)` Assert that two XML documents are similar
`void`	`assertXMLEqual(java.lang.String err, java.lang.String control, java.lang.String test)` Assert that two XML documents are similar
`void`	`assertXMLIdentical(Diff diff, boolean assertion)` Assert that the result of an XML comparison is or is not identical
`void`	`assertXMLIdentical(java.lang.String msg, Diff diff, boolean assertion)` Assert that the result of an XML comparison is or is not identical
`void`	`assertXMLNotEqual(org.w3c.dom.Document control, org.w3c.dom.Document test)` Assert that two XML documents are NOT similar
`void`	`assertXMLNotEqual(org.xml.sax.InputSource control, org.xml.sax.InputSource test)` Assert that two XML documents are NOT similar
`void`	`assertXMLNotEqual(java.io.Reader control, java.io.Reader test)` Assert that two XML documents are NOT similar
`void`	`assertXMLNotEqual(java.lang.String err, org.w3c.dom.Document control, org.w3c.dom.Document test)` Assert that two XML documents are NOT similar
`void`	`assertXMLNotEqual(java.lang.String err, org.xml.sax.InputSource control, org.xml.sax.InputSource test)` Assert that two XML documents are NOT similar
`void`	`assertXMLNotEqual(java.lang.String err, java.io.Reader control, java.io.Reader test)` Assert that two XML documents are NOT similar
`void`	`assertXMLNotEqual(java.lang.String control, java.lang.String test)` Assert that two XML documents are NOT similar
`void`	`assertXMLNotEqual(java.lang.String err, java.lang.String control, java.lang.String test)` Assert that two XML documents are NOT similar
`void`	`assertXMLValid(org.xml.sax.InputSource xml)` Assert that a piece of XML contains valid XML: the input must contain a DOCTYPE declaration to be validated
`void`	`assertXMLValid(org.xml.sax.InputSource xml, java.lang.String systemId)` Assert that a piece of XML contains valid XML: the document must contain a DOCTYPE to be validated, but the validation will use the systemId to obtain the DTD
`void`	`assertXMLValid(org.xml.sax.InputSource xml, java.lang.String systemId, java.lang.String doctype)` Assert that a piece of XML contains valid XML: the document will be given a DOCTYPE to be validated with the name and systemId specified regardless of whether it already contains a doctype declaration.
`void`	`assertXMLValid(java.lang.String xmlString)` Assert that a String containing XML contains valid XML: the String must contain a DOCTYPE declaration to be validated
`void`	`assertXMLValid(java.lang.String xmlString, java.lang.String systemId)` Assert that a String containing XML contains valid XML: the String must contain a DOCTYPE to be validated, but the validation will use the systemId to obtain the DTD
`void`	`assertXMLValid(java.lang.String xmlString, java.lang.String systemId, java.lang.String doctype)` Assert that a String containing XML contains valid XML: the String will be given a DOCTYPE to be validated with the name and systemId specified regardless of whether it already contains a doctype declaration.
`void`	`assertXMLValid(Validator validator)` Assert that a Validator instance returns `isValid() == true`
`void`	`assertXpathEvaluatesTo(java.lang.String expectedValue, java.lang.String xpathExpression, org.w3c.dom.Document inDocument)` Assert the value of an Xpath expression in an DOM Document
`void`	`assertXpathEvaluatesTo(java.lang.String expectedValue, java.lang.String xpathExpression, org.xml.sax.InputSource control)` Assert the value of an Xpath expression in an XML String
`void`	`assertXpathEvaluatesTo(java.lang.String expectedValue, java.lang.String xpathExpression, java.lang.String inXMLString)` Assert the value of an Xpath expression in an XML String
`void`	`assertXpathExists(java.lang.String xPathExpression, org.w3c.dom.Document inDocument)` Assert that a specific XPath exists in some given XML
`void`	`assertXpathExists(java.lang.String xPathExpression, org.xml.sax.InputSource xml)` Assert that a specific XPath exists in some given XML
`void`	`assertXpathExists(java.lang.String xPathExpression, java.lang.String inXMLString)` Assert that a specific XPath exists in some given XML
`void`	`assertXpathNotExists(java.lang.String xPathExpression, org.w3c.dom.Document inDocument)` Assert that a specific XPath does NOT exist in some given XML
`void`	`assertXpathNotExists(java.lang.String xPathExpression, org.xml.sax.InputSource xml)` Assert that a specific XPath does NOT exist in some given XML
`void`	`assertXpathNotExists(java.lang.String xPathExpression, java.lang.String inXMLString)` Assert that a specific XPath does NOT exist in some given XML
`void`	`assertXpathsEqual(java.lang.String controlXpath, org.w3c.dom.Document controlDocument, java.lang.String testXpath, org.w3c.dom.Document testDocument)` Assert that the node lists of two Xpaths in two documents are equal
`void`	`assertXpathsEqual(java.lang.String controlXpath, org.xml.sax.InputSource control, java.lang.String testXpath, org.xml.sax.InputSource test)` Assert that the node lists of two Xpaths in two XML pieces are equal
`void`	`assertXpathsEqual(java.lang.String controlXpath, java.lang.String testXpath, org.w3c.dom.Document document)` Assert that the node lists of two Xpaths in the same document are equal
`void`	`assertXpathsEqual(java.lang.String controlXpath, java.lang.String testXpath, org.xml.sax.InputSource document)` Assert that the node lists of two Xpaths in the same document are equal
`void`	`assertXpathsEqual(java.lang.String controlXpath, java.lang.String testXpath, java.lang.String inXMLString)` Assert that the node lists of two Xpaths in the same XML string are equal
`void`	`assertXpathsEqual(java.lang.String controlXpath, java.lang.String inControlXMLString, java.lang.String testXpath, java.lang.String inTestXMLString)` Assert that the node lists of two Xpaths in two XML strings are equal
`void`	`assertXpathsNotEqual(java.lang.String controlXpath, org.w3c.dom.Document controlDocument, java.lang.String testXpath, org.w3c.dom.Document testDocument)` Assert that the node lists of two Xpaths in two documents are NOT equal
`void`	`assertXpathsNotEqual(java.lang.String controlXpath, org.xml.sax.InputSource control, java.lang.String testXpath, org.xml.sax.InputSource test)` Assert that the node lists of two Xpaths in two pieces of XML are NOT equal
`void`	`assertXpathsNotEqual(java.lang.String controlXpath, java.lang.String testXpath, org.w3c.dom.Document document)` Assert that the node lists of two Xpaths in the same document are NOT equal
`void`	`assertXpathsNotEqual(java.lang.String controlXpath, java.lang.String testXpath, org.xml.sax.InputSource control)` Assert that the node lists of two Xpaths in the same XML are NOT equal
`void`	`assertXpathsNotEqual(java.lang.String controlXpath, java.lang.String testXpath, java.lang.String inXMLString)` Assert that the node lists of two Xpaths in the same XML string are NOT equal
`void`	`assertXpathsNotEqual(java.lang.String controlXpath, java.lang.String inControlXMLString, java.lang.String testXpath, java.lang.String inTestXMLString)` Assert that the node lists of two Xpaths in two XML strings are NOT equal
`void`	`assertXpathValuesEqual(java.lang.String controlXpath, org.w3c.dom.Document controlDocument, java.lang.String testXpath, org.w3c.dom.Document testDocument)` Assert that the evaluation of two Xpaths in two documents are equal
`void`	`assertXpathValuesEqual(java.lang.String controlXpath, org.xml.sax.InputSource control, java.lang.String testXpath, org.xml.sax.InputSource test)` Assert that the evaluation of two Xpaths in two XML strings are equal
`void`	`assertXpathValuesEqual(java.lang.String controlXpath, java.lang.String testXpath, org.w3c.dom.Document document)` Assert that the evaluation of two Xpaths in the same document are equal
`void`	`assertXpathValuesEqual(java.lang.String controlXpath, java.lang.String testXpath, org.xml.sax.InputSource control)` Assert that the evaluation of two Xpaths in the same XML are equal
`void`	`assertXpathValuesEqual(java.lang.String controlXpath, java.lang.String testXpath, java.lang.String inXMLString)` Assert that the evaluation of two Xpaths in the same XML string are equal
`void`	`assertXpathValuesEqual(java.lang.String controlXpath, java.lang.String inControlXMLString, java.lang.String testXpath, java.lang.String inTestXMLString)` Assert that the evaluation of two Xpaths in two XML strings are equal
`void`	`assertXpathValuesNotEqual(java.lang.String controlXpath, org.w3c.dom.Document controlDocument, java.lang.String testXpath, org.w3c.dom.Document testDocument)` Assert that the evaluation of two Xpaths in two documents are NOT equal
`void`	`assertXpathValuesNotEqual(java.lang.String controlXpath, org.xml.sax.InputSource control, java.lang.String testXpath, org.xml.sax.InputSource test)` Assert that the evaluation of two Xpaths in two XML strings are NOT equal
`void`	`assertXpathValuesNotEqual(java.lang.String controlXpath, java.lang.String testXpath, org.w3c.dom.Document document)` Assert that the evaluation of two Xpaths in the same document are NOT equal
`void`	`assertXpathValuesNotEqual(java.lang.String controlXpath, java.lang.String testXpath, org.xml.sax.InputSource control)` Assert that the evaluation of two Xpaths in the same XML string are NOT equal
`void`	`assertXpathValuesNotEqual(java.lang.String controlXpath, java.lang.String testXpath, java.lang.String inXMLString)` Assert that the evaluation of two Xpaths in the same XML string are NOT equal
`void`	`assertXpathValuesNotEqual(java.lang.String controlXpath, java.lang.String inControlXMLString, java.lang.String testXpath, java.lang.String inTestXMLString)` Assert that the evaluation of two Xpaths in two XML strings are NOT equal
`Diff`	`compareXML(org.w3c.dom.Document control, org.w3c.dom.Document test)` Compare two XML documents provided as strings
`Diff`	`compareXML(org.xml.sax.InputSource control, org.xml.sax.InputSource test)` Compare XML documents provided by two InputSource classes
`Diff`	`compareXML(java.io.Reader control, java.io.Reader test)` Compare XML documents provided by two Reader classes
`Diff`	`compareXML(java.io.Reader control, java.lang.String test)` Compare XML documents provided by two Reader classes
`Diff`	`compareXML(java.lang.String control, java.io.Reader test)` Compare XML documents provided by two Reader classes
`Diff`	`compareXML(java.lang.String control, java.lang.String test)` Compare two XML documents provided as strings

Methods inherited from class junit.framework.TestCase
countTestCases, createResult, getName, run, run, runBare, runTest, setName, setUp, tearDown, toString

Methods inherited from class junit.framework.Assert
assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertFalse, assertFalse, assertNotNull, assertNotNull, assertNotSame, assertNotSame, assertNull, assertNull, assertSame, assertSame, assertTrue, assertTrue, fail, fail, failNotEquals, failNotSame, failSame

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail
- XMLTestCase
```
public XMLTestCase()
```
  Construct a new XML test case.
- XMLTestCase
```
public XMLTestCase(java.lang.String name)
```
  Construct a new test case.
  
  Parameters:
  name - Name of test

Method Detail

compareXML
```
public Diff compareXML(org.xml.sax.InputSource control,
              org.xml.sax.InputSource test)
                throws org.xml.sax.SAXException,
                       java.io.IOException
```
Compare XML documents provided by two InputSource classes

Parameters:
control - Control document
test - Document to test

Returns:
Diff object describing differences in documents

Throws:

org.xml.sax.SAXException

java.io.IOException

compareXML
```
public Diff compareXML(java.io.Reader control,
              java.io.Reader test)
                throws org.xml.sax.SAXException,
                       java.io.IOException
```
Compare XML documents provided by two Reader classes

Parameters:
control - Control document
test - Document to test

Returns:
Diff object describing differences in documents

Throws:

org.xml.sax.SAXException

java.io.IOException

compareXML
```
public Diff compareXML(java.lang.String control,
              java.io.Reader test)
                throws org.xml.sax.SAXException,
                       java.io.IOException
```
Compare XML documents provided by two Reader classes

Parameters:
control - Control document
test - Document to test

Returns:
Diff object describing differences in documents

Throws:

org.xml.sax.SAXException

java.io.IOException

compareXML
```
public Diff compareXML(java.io.Reader control,
              java.lang.String test)
                throws org.xml.sax.SAXException,
                       java.io.IOException
```
Compare XML documents provided by two Reader classes

Parameters:
control - Control document
test - Document to test

Returns:
Diff object describing differences in documents

Throws:

org.xml.sax.SAXException

java.io.IOException

compareXML
```
public Diff compareXML(java.lang.String control,
              java.lang.String test)
                throws org.xml.sax.SAXException,
                       java.io.IOException
```
Compare two XML documents provided as strings

Parameters:
control - Control document
test - Document to test

Returns:
Diff object describing differences in documents

Throws:

org.xml.sax.SAXException

java.io.IOException

compareXML
```
public Diff compareXML(org.w3c.dom.Document control,
              org.w3c.dom.Document test)
```
Compare two XML documents provided as strings

Parameters:
control - Control document
test - Document to test

Returns:
Diff object describing differences in documents

assertXMLEqual
```
public void assertXMLEqual(Diff diff,
                  boolean assertion)
```
Assert that the result of an XML comparison is or is not similar.

Parameters:
diff - the result of an XML comparison
assertion - true if asserting that result is similar

assertXMLEqual
```
public void assertXMLEqual(java.lang.String msg,
                  Diff diff,
                  boolean assertion)
```
Assert that the result of an XML comparison is or is not similar.

Parameters:
msg - additional message to display if assertion fails
diff - the result of an XML comparison
assertion - true if asserting that result is similar

assertXMLIdentical
```
public void assertXMLIdentical(Diff diff,
                      boolean assertion)
```
Assert that the result of an XML comparison is or is not identical

Parameters:
diff - the result of an XML comparison
assertion - true if asserting that result is identical

assertXMLIdentical
```
public void assertXMLIdentical(java.lang.String msg,
                      Diff diff,
                      boolean assertion)
```
Assert that the result of an XML comparison is or is not identical

Parameters:
msg - Message to display if assertion fails
diff - the result of an XML comparison
assertion - true if asserting that result is identical