com.tridion.util.xml

Class XMLResultAggregator

java.lang.Object

com.tridion.util.xml.XMLResultAggregator

public class XMLResultAggregator
extends Object

Aggregates all <junit> XML formatter testsuite data under a specific directory.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_DIR The default directory: ..
static String	DEFAULT_FILENAME the default file name: TESTS-TestSuites.xml.

Constructor Summary

Constructors

Constructor and Description
XMLResultAggregator()

Method Summary

Modifier and Type	Method and Description
protected void	addTestSuite(Element root, Element testsuite) Add a new testsuite node to the document.
protected Element	createDocument() Create a DOM tree.
void	execute() Aggregate all testsuites into a single document and write it to the specified directory and file.
protected File	getDestinationFile() Get the full destination file where to write the result.
protected File[]	getFiles() Get all .xml files in the fileset.
static void	main(String[] args)
void	setInputFolder(String folder)
void	setOutputFilename(String name)
void	setTodir(File value) Set the destination directory where the results should be written.
void	setTofile(String value) Set the name of the aggregegated results file.
protected void	writeDOMTree(Document doc, File file) Write the DOM tree to a file.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DIR

public static final String DEFAULT_DIR

The default directory: .. It is resolved from the project directory.

See Also:

Constant Field Values

DEFAULT_FILENAME

public static final String DEFAULT_FILENAME

the default file name: TESTS-TestSuites.xml.

See Also:

Constant Field Values

Constructor Detail

XMLResultAggregator

public XMLResultAggregator()

Method Detail

setInputFolder

public void setInputFolder(String folder)

setOutputFilename

public void setOutputFilename(String name)

setTofile

public void setTofile(String value)

Set the name of the aggregegated results file. It must be relative from the todir attribute. If not set it will use DEFAULT_FILENAME.

Parameters:

value - the name of the file.

See Also:

setTodir(File)

setTodir

public void setTodir(File value)

Set the destination directory where the results should be written. If not set if will use DEFAULT_DIR. When given a relative directory it will resolve it from the project directory.

Parameters:

value - the directory where to write the results, absolute or relative.

execute

public void execute()

Aggregate all testsuites into a single document and write it to the specified directory and file.

getDestinationFile

protected File getDestinationFile()

Get the full destination file where to write the result. It is made of the todir and tofile attributes.

Returns:

the destination file where should be written the result file.

getFiles

protected File[] getFiles()

Get all .xml files in the fileset.

Returns:

all files in the fileset that end with a '.xml'.

writeDOMTree

protected void writeDOMTree(Document doc,
                            File file)
                     throws IOException

Write the DOM tree to a file.

Parameters:

doc - the XML document to dump to disk.

file - the filename to write the document to. Should obviouslly be a .xml file.

Throws:

IOException - thrown if there is an error while writing the content.

createDocument

protected Element createDocument()

Create a DOM tree. Has 'testsuites' as firstchild and aggregates all testsuite results that exists in the base directory.

Returns:

the root element of DOM tree that aggregates all testsuites.

addTestSuite

protected void addTestSuite(Element root,
                            Element testsuite)

Add a new testsuite node to the document. The main difference is that it split the previous fully qualified name into a package and a name.

For example: org.apache.Whatever will be split into org.apache and Whatever.

Parameters:

root - the root element to which the testsuite node should be appended.

testsuite - the element to append to the given root. It will slightly modify the original node to change the name attribute and add a package one.

main

public static void main(String[] args)