Class XMLTestSuiteRunner

java.lang.Object

org.apache.batik.test.xml.XMLTestSuiteRunner

All Implemented Interfaces:

XMLReflectConstants, XTRunConstants, XTSConstants

public class XMLTestSuiteRunner
extends Object
implements XTRunConstants, XTSConstants

This class can be used to build and run a TestSuite from an XML description following the "XML Test Run" and "XML Test Suite" formats, whose constants are defined in the XTRunConstants and XTSConstants interfaces. This class takes a "Test Run" XML description as an input. That description contains:
+ pointers to a number of "Test Suite" XML descriptions, which contain the definition of the set of Tests to be run and their configuration.
+ a description of the set of TestReportProcessor and their configuration that should be used to process the reports generated by the various TestSuites.

Version:

$Id$

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XMLTestSuiteRunner.AcceptAllTestsFilter	Test filter which accepts all tests
static class	XMLTestSuiteRunner.IdBasedTestFilter	Test filter which only accepts tests with ids matching the ones passed to its constructor.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CANNOT_CREATE_TEST_REPORT_PROCESSOR	An error happened while processing a TestreportProcessor description.
static final String	COULD_NOT_CONVERT_FILE_NAME_TO_URI	Displayed when the input file name cannot be turned into a URL
static final String	ERROR_RUNNING_TEST_SUITE	Error displayed when an error occurs while running the test suite
static final String	INVALID_DOCUMENT	Displayed when the input document cannot be parsed.
static final String	INVALID_URI	Displayed when the input argument does not represent a valid URI
static final String	MESSAGE_UNMATCHED_TEST_IDS	Displayed when no test or testSuite matching the input id was found.
static final String	NOT_A_FILE_TRY_URI	Displayed when the input argument does not represent an existing file to notify the user that the argument is going to be interpreted as a URI.
static final String	TEST_REPORT_PROCESSING_EXCEPTION	An error happened while processing the TestReport generated by the TestSuite {0} : TestReportProcessor class name.
static final String	TEST_SUITE_EXCEPTION	An error happened while running the TestSuite {0} : TestSuite name {1} : TestSuite class name.
static final String	USAGE	Displayed when the user passes no arguments to the command line.

Fields inherited from interface XMLReflectConstants

XR_ARG_TAG, XR_CLASS_ATTRIBUTE, XR_NAME_ATTRIBUTE, XR_PROPERTY_TAG, XR_VALUE_ATTRIBUTE

Fields inherited from interface XTRunConstants

XTRun_HREF_ATTRIBUTE, XTRun_ID_ATTRIBUTE, XTRun_NAME_ATTRIBUTE, XTRun_NAMESPACE_URI, XTRun_TEST_REPORT_PROCESSOR_TAG, XTRun_TEST_RUN_TAG, XTRun_TEST_SUITE_TAG

Fields inherited from interface XTSConstants

XTS_ID_ATTRIBUTE, XTS_NAME_ATTRIBUTE, XTS_NAMESPACE_URI, XTS_TEST_GROUP_TAG, XTS_TEST_SUITE_TAG, XTS_TEST_TAG

Constructor Summary

Constructors

Constructor	Description
XMLTestSuiteRunner()

Method Summary

Modifier and Type	Method	Description
protected TestReportProcessor	buildProcessor(Element element)	Builds a TestResultProcessor from an element.
protected DefaultTestSuite	buildTestRunTestSuite(Element element)	Builds a TestSuite from an input element.
protected TestReportProcessor[]	extractTestReportProcessor(Element element)	Builds an array of TestReportProcessor from the input element, assuming the input element is a <testSuite> instance,
protected Element[]	getChildrenByTagName(Element element, String tagName)	Gets all the children of a given type.
static void	main(String[] args)
protected void	processReport(TestReport report, TestReportProcessor[] processors)
TestReport	run(Document doc, String[] ids)	Runs the test suite described by the input Document object.
protected TestReport	run(Element testRunElement, String[] ids)
protected TestReport	runTest(Test test)

Methods inherited from class Object

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

Field Details

MESSAGE_UNMATCHED_TEST_IDS

public static final String MESSAGE_UNMATCHED_TEST_IDS

Displayed when no test or testSuite matching the input id was found. {0} : unmatched id set

See Also:

• Constant Field Values

CANNOT_CREATE_TEST_REPORT_PROCESSOR

public static final String CANNOT_CREATE_TEST_REPORT_PROCESSOR

An error happened while processing a TestreportProcessor description. {0} : the <testReportProcessor> "className" attribute value {1} : exception's class name {2} : exception's message {3} : exception's stack trace

See Also:

• Constant Field Values

TEST_SUITE_EXCEPTION

public static final String TEST_SUITE_EXCEPTION

An error happened while running the TestSuite {0} : TestSuite name {1} : TestSuite class name. {1} : exception's class name. {2} : exception's message {3} : exception's stack trace.

See Also:

• Constant Field Values

TEST_REPORT_PROCESSING_EXCEPTION

public static final String TEST_REPORT_PROCESSING_EXCEPTION

An error happened while processing the TestReport generated by the TestSuite {0} : TestReportProcessor class name. {1} : exception's class name. {2} : exception's message {3} : exception's stack trace.

See Also:

• Constant Field Values

USAGE

public static final String USAGE

Displayed when the user passes no arguments to the command line.

See Also:

• Constant Field Values

NOT_A_FILE_TRY_URI

public static final String NOT_A_FILE_TRY_URI

Displayed when the input argument does not represent an existing file to notify the user that the argument is going to be interpreted as a URI.

See Also:

• Constant Field Values

COULD_NOT_CONVERT_FILE_NAME_TO_URI

public static final String COULD_NOT_CONVERT_FILE_NAME_TO_URI

Displayed when the input file name cannot be turned into a URL

See Also:

• Constant Field Values

INVALID_URI

public static final String INVALID_URI

Displayed when the input argument does not represent a valid URI

See Also:

• Constant Field Values

INVALID_DOCUMENT

public static final String INVALID_DOCUMENT

Displayed when the input document cannot be parsed. {0} : uri of the invalid document. {1} : exception generated while parsing {2} : exception message

See Also:

• Constant Field Values

ERROR_RUNNING_TEST_SUITE

public static final String ERROR_RUNNING_TEST_SUITE

Error displayed when an error occurs while running the test suite

See Also:

• Constant Field Values

Constructor Details

XMLTestSuiteRunner

public XMLTestSuiteRunner()

Method Details

extractTestReportProcessor

protected TestReportProcessor[] extractTestReportProcessor(Element element)
                                                    throws TestException

Builds an array of TestReportProcessor from the input element, assuming the input element is a <testSuite> instance,

Throws:

TestException

buildProcessor

protected TestReportProcessor buildProcessor(Element element)
                                      throws TestException

Builds a TestResultProcessor from an element.

Throws:

TestException

buildTestRunTestSuite

protected DefaultTestSuite buildTestRunTestSuite(Element element)
                                          throws TestException

Builds a TestSuite from an input element. This method assumes that element is a <testRun> instance. The element is scanned for children <testSuite> elements which is loaded into a Test and composited into a TestSuite

Throws:

TestException

getChildrenByTagName

protected Element[] getChildrenByTagName(Element element,
 String tagName)

Gets all the children of a given type.

run

public TestReport run(Document doc,
 String[] ids)
               throws TestException

Runs the test suite described by the input Document object. If the input ids array is null or of zero length, then all the tests will be run. Otherwise, only the tests identified by the array will be run.

Throws:

TestException

runTest

protected TestReport runTest(Test test)
                      throws TestException

Throws:

TestException

processReport

protected void processReport(TestReport report,
 TestReportProcessor[] processors)
                      throws TestException

Throws:

TestException

run

protected TestReport run(Element testRunElement,
 String[] ids)
                  throws TestException

Throws:

TestException

main

public static void main(String[] args)