org.uncommons.reportng

Class ReportMetadata

java.lang.Object

org.uncommons.reportng.ReportMetadata

public final class ReportMetadata
extends Object

Provides access to static information useful when generating a report.

Author:

Daniel Dyer

Constructor Summary

Constructors

Constructor and Description
ReportMetadata()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	allowSkippedTestsInXML() If the XML dialect has been set to "junit", we will render all skipped tests as failed tests in the XML.
String	getCoverageLink()
String	getJavaInfo()
Locale	getLocale()
String	getPlatform()
String	getReportDate()
String	getReportTime()
String	getReportTitle()
File	getStylesheetPath() If a custom CSS file has been specified, returns the path.
String	getUser()
boolean	shouldEscapeOutput() Returns true (the default) if log text should be escaped when displayed in a report.
boolean	shouldGenerateVelocityLog()
boolean	shouldShowExpectedExceptions() Returns false (the default) if stack traces should not be shown for expected exceptions.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportMetadata

public ReportMetadata()

Method Detail

getReportDate

public String getReportDate()

Returns:

A String representation of the report date.

See Also:

getReportTime()

getReportTime

public String getReportTime()

Returns:

A String representation of the report time.

See Also:

getReportDate()

getReportTitle

public String getReportTitle()

getCoverageLink

public String getCoverageLink()

Returns:

The URL (absolute or relative) of an HTML coverage report associated with the test run. Null if there is no coverage report.

getStylesheetPath

public File getStylesheetPath()

If a custom CSS file has been specified, returns the path. Otherwise returns null.

Returns:

A File pointing to the stylesheet, or null if no stylesheet is specified.

shouldShowExpectedExceptions

public boolean shouldShowExpectedExceptions()

Returns false (the default) if stack traces should not be shown for expected exceptions.

Returns:

True if stack traces should be shown even for expected exceptions, false otherwise.

shouldEscapeOutput

public boolean shouldEscapeOutput()

Returns true (the default) if log text should be escaped when displayed in a report. Turning off escaping allows you to do something link inserting link tags into HTML reports, but it also means that other output could accidentally corrupt the mark-up.

Returns:

True if reporter log output should be escaped when displayed in a report, false otherwise.

allowSkippedTestsInXML

public boolean allowSkippedTestsInXML()

If the XML dialect has been set to "junit", we will render all skipped tests as failed tests in the XML. Otherwise we use TestNG's extended version of the XML format that allows for "" elements.

shouldGenerateVelocityLog

public boolean shouldGenerateVelocityLog()

Returns:

True if Velocity should generate a log file, false otherwise.

getUser

public String getUser()
               throws UnknownHostException

Returns:

The user account used to run the tests and the host name of the test machine.

Throws:

UnknownHostException - If there is a problem accessing the machine's host name.

getJavaInfo

public String getJavaInfo()

getPlatform

public String getPlatform()

getLocale

public Locale getLocale()

Returns:

The locale specified by the System properties, or the platform default locale if none is specified.