Package org.testng.reporters

Class XMLReporter

java.lang.Object

org.testng.reporters.XMLReporter

All Implemented Interfaces:

IReporter, ITestNGListener, ICustomizeXmlReport

public class XMLReporter
extends java.lang.Object
implements IReporter, ICustomizeXmlReport

The main entry for the XML generation operation

Field Summary

Fields

Modifier and Type	Field	Description
private XMLReporterConfig	config
private XMLStringBuffer	rootBuffer

Constructor Summary

Constructors

Constructor	Description
XMLReporter()

Method Summary

Modifier and Type	Method	Description
void	addCustomTagsFor(XMLStringBuffer xmlBuffer, ITestResult testResult)
static void	addDurationAttributes(XMLReporterConfig config, java.util.Properties attributes, java.util.Date minStartDate, java.util.Date maxEndDate)	Add started-at, finished-at and duration-ms attributes to the <suite> tag
java.lang.String	fileName()
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.
XMLReporterConfig	getConfig()	Get the reporter configuration object.
private java.util.Properties	getSuiteAttributes(ISuite suite)
private java.util.Set<ITestNGMethod>	getUniqueMethodSet(java.util.Collection<ITestNGMethod> methods)
private java.io.File	referenceSuite(XMLStringBuffer xmlBuffer, ISuite suite)
private void	writeReporterOutput(XMLStringBuffer xmlBuffer)
private void	writeSuite(ISuite suite)
private void	writeSuiteGroups(XMLStringBuffer xmlBuffer, ISuite suite)
private void	writeSuiteToBuffer(XMLStringBuffer xmlBuffer, ISuite suite)
private void	writeSuiteToFile(java.io.File suiteFile, ISuite suite)

Methods inherited from class java.lang.Object

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

Field Detail

config

private final XMLReporterConfig config

rootBuffer

private XMLStringBuffer rootBuffer

Constructor Detail

XMLReporter

public XMLReporter()

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

addCustomTagsFor

public void addCustomTagsFor(XMLStringBuffer xmlBuffer,
                             ITestResult testResult)

Specified by:

addCustomTagsFor in interface ICustomizeXmlReport

Parameters:

xmlBuffer - - An XMLStringBuffer object that represents the buffer to be used.

testResult - - An ITestResult object that represents a test method's result.

fileName

public java.lang.String fileName()

writeReporterOutput

private void writeReporterOutput(XMLStringBuffer xmlBuffer)

writeSuite

private void writeSuite(ISuite suite)

writeSuiteToFile

private void writeSuiteToFile(java.io.File suiteFile,
                              ISuite suite)

referenceSuite

private java.io.File referenceSuite(XMLStringBuffer xmlBuffer,
                                    ISuite suite)

writeSuiteToBuffer

private void writeSuiteToBuffer(XMLStringBuffer xmlBuffer,
                                ISuite suite)

writeSuiteGroups

private void writeSuiteGroups(XMLStringBuffer xmlBuffer,
                              ISuite suite)

getSuiteAttributes

private java.util.Properties getSuiteAttributes(ISuite suite)

addDurationAttributes

public static void addDurationAttributes(XMLReporterConfig config,
                                         java.util.Properties attributes,
                                         java.util.Date minStartDate,
                                         java.util.Date maxEndDate)

Add started-at, finished-at and duration-ms attributes to the <suite> tag

Parameters:

config - The reporter config

attributes - The properties

minStartDate - The minimum start date

maxEndDate - The maximum end date

getUniqueMethodSet

private java.util.Set<ITestNGMethod> getUniqueMethodSet(java.util.Collection<ITestNGMethod> methods)

getConfig

public XMLReporterConfig getConfig()

Description copied from interface: IReporter

Get the reporter configuration object.

NOTE: Reporter configuration objects must adhere to the JavaBean object conventions, providing getter and setter methods that conform to standard naming rules. This enables ReporterConfig to serialize, deserialize, and instantiate the reporter.

Specified by:

getConfig in interface IReporter

Returns:

reporter configuration object