Package org.testng.reporters

Class SuiteHTMLReporter

java.lang.Object

org.testng.reporters.SuiteHTMLReporter

All Implemented Interfaces:

IReporter, ITestNGListener

public class SuiteHTMLReporter
extends java.lang.Object
implements IReporter

This class implements an HTML reporter for suites.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	AFTER	Generate information about the methods that were run
static java.lang.String	BEFORE
static java.lang.String	CLASSES
private static java.lang.String	CLOSE_TD
static java.lang.String	GROUPS
private java.util.Map<java.lang.String,ITestClass>	m_classes
private java.lang.String	m_outputDirectory
static java.lang.String	METHODS_ALPHABETICAL
static java.lang.String	METHODS_CHRONOLOGICAL
static java.lang.String	METHODS_NOT_RUN
static java.lang.String	REPORTER_OUTPUT
private static java.lang.String	SP
private static java.lang.String	SP2
private static java.lang.String	TD_A_TARGET_MAIN_FRAME_HREF
static java.lang.String	TESTNG_XML

Constructor Summary

Constructors

Constructor	Description
SuiteHTMLReporter()

Method Summary

Modifier and Type	Method	Description
private java.lang.String	createColor(ITestNGMethod tm)	Generate a HTML color based on the class of the method
private java.lang.String	dumpMethods(ITestNGMethod[] testMethods)
private java.lang.String	generateClass(ITestClass cls)
private void	generateClasses(XmlSuite xmlSuite)
private void	generateExcludedMethodsReport(XmlSuite xmlSuite, ISuite suite)
private void	generateIndex(java.util.List<ISuite> suites)	Generate the main index.html file that lists all the suites and their result
private void	generateIndex(XmlSuite xmlSuite, ISuite sr)
private void	generateMain(XmlSuite xmlSuite, ISuite sr)
private void	generateMethodsAndGroups(XmlSuite xmlSuite, ISuite suite)	Generate information about methods and groups
private void	generateMethodsChronologically(XmlSuite xmlSuite, ISuite suite, java.lang.String outputFileName, boolean alphabetical)
protected java.lang.String	generateOutputDirectoryName(java.lang.String outputDirectory)	Overridable by subclasses to create different directory names (e.g.
void	generateReport(java.util.List<XmlSuite> xmlSuites, java.util.List<ISuite> suites, java.lang.String outputDirectory)	Generate a report for the given suites into the specified output directory.
private void	generateReporterOutput(XmlSuite xmlSuite)
private void	generateSuiteResult(java.lang.String suiteName, ISuiteResult sr, java.lang.String cssClass, java.lang.StringBuilder tableOfContents)
private void	generateSuites(XmlSuite xmlSuite, ISuite suite)	Writes a property file for each suite result.
private void	generateTableOfContents(XmlSuite xmlSuite, ISuite suite)
private void	generateXmlFile(XmlSuite xmlSuite)
private static java.lang.String	getMethodName(java.lang.String name)
private java.lang.String	getOutputDirectory(XmlSuite xmlSuite)
private java.lang.String	makeTitle(ISuite suite)
private java.lang.String	pluralize(int count, java.lang.String singular)
private ISuiteResult[]	sortResults(java.util.Collection<ISuiteResult> r)
private java.lang.String	td(java.lang.String s)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.testng.IReporter

getConfig

Field Detail

METHODS_CHRONOLOGICAL

public static final java.lang.String METHODS_CHRONOLOGICAL

See Also:

Constant Field Values

METHODS_ALPHABETICAL

public static final java.lang.String METHODS_ALPHABETICAL

See Also:

Constant Field Values

GROUPS

public static final java.lang.String GROUPS

See Also:

Constant Field Values

CLASSES

public static final java.lang.String CLASSES

See Also:

Constant Field Values

REPORTER_OUTPUT

public static final java.lang.String REPORTER_OUTPUT

See Also:

Constant Field Values

METHODS_NOT_RUN

public static final java.lang.String METHODS_NOT_RUN

See Also:

Constant Field Values

TESTNG_XML

public static final java.lang.String TESTNG_XML

See Also:

Constant Field Values

TD_A_TARGET_MAIN_FRAME_HREF

private static final java.lang.String TD_A_TARGET_MAIN_FRAME_HREF

See Also:

Constant Field Values

CLOSE_TD

private static final java.lang.String CLOSE_TD

See Also:

Constant Field Values

m_classes

private java.util.Map<java.lang.String,ITestClass> m_classes

m_outputDirectory

private java.lang.String m_outputDirectory

SP

private static final java.lang.String SP

See Also:

Constant Field Values

SP2

private static final java.lang.String SP2

See Also:

Constant Field Values

AFTER

public static final java.lang.String AFTER

Generate information about the methods that were run

See Also:

Constant Field Values

BEFORE

public static final java.lang.String BEFORE

See Also:

Constant Field Values

Constructor Detail

SuiteHTMLReporter

public SuiteHTMLReporter()

Method Detail

generateReport

public void generateReport(java.util.List<XmlSuite> xmlSuites,
                           java.util.List<ISuite> suites,
                           java.lang.String outputDirectory)

Description copied from interface: IReporter

Generate a report for the given suites into the specified output directory.

Specified by:

generateReport in interface IReporter

Parameters:

xmlSuites - The list of XmlSuite

suites - The list of ISuite

outputDirectory - The output directory

generateOutputDirectoryName

protected java.lang.String generateOutputDirectoryName(java.lang.String outputDirectory)

Overridable by subclasses to create different directory names (e.g. with timestamps).

Parameters:

outputDirectory - the output directory specified by the user

Returns:

the name of the output directory of the report

generateXmlFile

private void generateXmlFile(XmlSuite xmlSuite)

generateIndex

private void generateIndex(java.util.List<ISuite> suites)

Generate the main index.html file that lists all the suites and their result

generateExcludedMethodsReport

private void generateExcludedMethodsReport(XmlSuite xmlSuite,
                                           ISuite suite)

generateReporterOutput

private void generateReporterOutput(XmlSuite xmlSuite)

generateClasses

private void generateClasses(XmlSuite xmlSuite)

generateClass

private java.lang.String generateClass(ITestClass cls)

dumpMethods

private java.lang.String dumpMethods(ITestNGMethod[] testMethods)

getMethodName

private static java.lang.String getMethodName(java.lang.String name)

generateMethodsChronologically

private void generateMethodsChronologically(XmlSuite xmlSuite,
                                            ISuite suite,
                                            java.lang.String outputFileName,
                                            boolean alphabetical)

createColor

private java.lang.String createColor(ITestNGMethod tm)

Generate a HTML color based on the class of the method

td

private java.lang.String td(java.lang.String s)

generateMethodsAndGroups

private void generateMethodsAndGroups(XmlSuite xmlSuite,
                                      ISuite suite)

Generate information about methods and groups

generateIndex

private void generateIndex(XmlSuite xmlSuite,
                           ISuite sr)

makeTitle

private java.lang.String makeTitle(ISuite suite)

generateMain

private void generateMain(XmlSuite xmlSuite,
                          ISuite sr)

generateTableOfContents

private void generateTableOfContents(XmlSuite xmlSuite,
                                     ISuite suite)

pluralize

private java.lang.String pluralize(int count,
                                   java.lang.String singular)

getOutputDirectory

private java.lang.String getOutputDirectory(XmlSuite xmlSuite)

sortResults

private ISuiteResult[] sortResults(java.util.Collection<ISuiteResult> r)

generateSuiteResult

private void generateSuiteResult(java.lang.String suiteName,
                                 ISuiteResult sr,
                                 java.lang.String cssClass,
                                 java.lang.StringBuilder tableOfContents)

generateSuites

private void generateSuites(XmlSuite xmlSuite,
                            ISuite suite)

Writes a property file for each suite result.

Parameters:

xmlSuite - - The XmlSuite suite.

suite - - The ISuite object.