org.uncommons.reportng

Class AbstractReporter

java.lang.Object

org.uncommons.reportng.AbstractReporter

Direct Known Subclasses:

HTMLReporter, JUnitXMLReporter

public abstract class AbstractReporter
extends Object

Convenient base class for the ReportNG reporters. Provides common functionality.

Author:

Daniel Dyer

Field Summary

Fields

Modifier and Type	Field and Description
protected static ReportMetadata	META
protected static String	TEMPLATE_EXTENSION

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractReporter(String classpathPrefix)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	copyClasspathResource(File outputDirectory, String resourceName, String targetFileName) Copy a single named resource from the classpath to the output directory.
protected void	copyFile(File outputDirectory, File sourceFile, String targetFileName) Copy a single named file to the output directory.
protected void	copyStream(File outputDirectory, InputStream stream, String targetFileName) Helper method to copy the contents of a stream to a file.
protected org.apache.velocity.VelocityContext	createContext() Helper method that creates a Velocity context and initialises it with a reference to the ReportNG utils, report metadata and localised messages.
protected void	generateFile(File file, String templateName, org.apache.velocity.VelocityContext context) Generate the specified output file by merging the specified Velocity template with the supplied context.
protected void	removeEmptyDirectories(File outputDirectory) Deletes any empty directories under the output directory.

Methods inherited from class java.lang.Object

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

Field Detail

TEMPLATE_EXTENSION

protected static final String TEMPLATE_EXTENSION

See Also:

Constant Field Values

META

protected static final ReportMetadata META

Constructor Detail

AbstractReporter

protected AbstractReporter(String classpathPrefix)

Parameters:

classpathPrefix - Where in the classpath to load templates from.

Method Detail

createContext

protected org.apache.velocity.VelocityContext createContext()

Helper method that creates a Velocity context and initialises it with a reference to the ReportNG utils, report metadata and localised messages.

Returns:

An initialised Velocity context.

generateFile

protected void generateFile(File file,
                String templateName,
                org.apache.velocity.VelocityContext context)
                     throws Exception

Generate the specified output file by merging the specified Velocity template with the supplied context.

Throws:

Exception

copyClasspathResource

protected void copyClasspathResource(File outputDirectory,
                         String resourceName,
                         String targetFileName)
                              throws IOException

Copy a single named resource from the classpath to the output directory.

Parameters:

outputDirectory - The destination directory for the copied resource.

resourceName - The filename of the resource.

targetFileName - The name of the file created in outputDirectory.

Throws:

IOException - If the resource cannot be copied.

copyFile

protected void copyFile(File outputDirectory,
            File sourceFile,
            String targetFileName)
                 throws IOException

Copy a single named file to the output directory.

Parameters:

outputDirectory - The destination directory for the copied resource.

sourceFile - The path of the file to copy.

targetFileName - The name of the file created in outputDirectory.

Throws:

IOException - If the file cannot be copied.

copyStream

protected void copyStream(File outputDirectory,
              InputStream stream,
              String targetFileName)
                   throws IOException

Helper method to copy the contents of a stream to a file.

Parameters:

outputDirectory - The directory in which the new file is created.

stream - The stream to copy.

targetFileName - The file to write the stream contents to.

Throws:

IOException - If the stream cannot be copied.

removeEmptyDirectories

protected void removeEmptyDirectories(File outputDirectory)

Deletes any empty directories under the output directory. These directories are created by TestNG for its own reports regardless of whether those reports are generated. If you are using the default TestNG reports as well as ReportNG, these directories will not be empty and will be retained. Otherwise they will be removed.

Parameters:

outputDirectory - The directory to search for empty directories.