org.uncommons.reportng

Class ReportNGUtils

java.lang.Object

org.uncommons.reportng.ReportNGUtils

public class ReportNGUtils
extends Object

Utility class that provides various helper methods that can be invoked from a Velocity template.

Author:

Daniel Dyer

Constructor Summary

Constructors

Constructor and Description
ReportNGUtils()

Method Summary

Methods

Modifier and Type	Method and Description
String	escapeHTMLString(String s) Works like escapeString(String) but also replaces line breaks with <br /> tags and preserves significant whitespace.
String	escapeString(String s) Replace any angle brackets, quotes, apostrophes or ampersands with the corresponding XML/HTML entities to avoid problems displaying the String in an XML document.
String	formatDuration(long elapsed)
String	formatDuration(long startMillis, long endMillis)
List<String>	getAllOutput() Retieves the output from all calls to org.testng.Reporter#log(String) across all tests.
String	getArguments(ITestResult result)
List<Throwable>	getCauses(Throwable t) Convert a Throwable into a list containing all of its causes.
String	getDependentGroups(ITestResult result)
String	getDependentMethods(ITestResult result)
long	getDuration(ITestContext context) Returns the aggregate of the elapsed times for each test result.
long	getEndTime(ISuite suite, IInvokedMethod method, List<IInvokedMethod> methods)
String	getSkipExceptionMessage(ITestResult result)
long	getStartTime(List<IInvokedMethod> methods) Find the earliest start time of the specified methods.
List<String>	getTestOutput(ITestResult result) Retrieves all log messages associated with a particular test result.
boolean	hasArguments(ITestResult result)
boolean	hasDependentGroups(ITestResult result)
boolean	hasDependentMethods(ITestResult result)
boolean	hasGroups(ISuite suite)
boolean	hasSkipException(ITestResult result)
String	stripThreadName(String threadId) TestNG returns a compound thread ID that includes the thread name and its numeric ID, separated by an 'at' sign.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportNGUtils

public ReportNGUtils()

Method Detail

getDuration

public long getDuration(ITestContext context)

Returns the aggregate of the elapsed times for each test result.

Parameters:

context - The test results.

Returns:

The sum of the test durations.

formatDuration

public String formatDuration(long startMillis,
                    long endMillis)

formatDuration

public String formatDuration(long elapsed)

getCauses

public List<Throwable> getCauses(Throwable t)

Convert a Throwable into a list containing all of its causes.

Parameters:

t - The throwable for which the causes are to be returned.

Returns:

A (possibly empty) list of Throwables.

getTestOutput

public List<String> getTestOutput(ITestResult result)

Retrieves all log messages associated with a particular test result.

Parameters:

result - Which test result to look-up.

Returns:

A list of log messages.

getAllOutput

public List<String> getAllOutput()

Retieves the output from all calls to org.testng.Reporter#log(String) across all tests.

Returns:

A (possibly empty) list of log messages.

hasArguments

public boolean hasArguments(ITestResult result)

getArguments

public String getArguments(ITestResult result)

hasDependentGroups

public boolean hasDependentGroups(ITestResult result)

Parameters:

result - The test result to be checked for dependent groups.

Returns:

True if this test was dependent on any groups, false otherwise.

getDependentGroups

public String getDependentGroups(ITestResult result)

Returns:

A comma-separated string listing all dependent groups. Returns an empty string it there are no dependent groups.

hasDependentMethods

public boolean hasDependentMethods(ITestResult result)

Parameters:

result - The test result to be checked for dependent methods.

Returns:

True if this test was dependent on any methods, false otherwise.

getDependentMethods

public String getDependentMethods(ITestResult result)

Returns:

A comma-separated string listing all dependent methods. Returns an empty string it there are no dependent methods.

hasSkipException

public boolean hasSkipException(ITestResult result)

getSkipExceptionMessage

public String getSkipExceptionMessage(ITestResult result)

hasGroups

public boolean hasGroups(ISuite suite)

escapeString

public String escapeString(String s)

Replace any angle brackets, quotes, apostrophes or ampersands with the corresponding XML/HTML entities to avoid problems displaying the String in an XML document. Assumes that the String does not already contain any entities (otherwise the ampersands will be escaped again).

Parameters:

s - The String to escape.

Returns:

The escaped String.

escapeHTMLString

public String escapeHTMLString(String s)

Works like escapeString(String) but also replaces line breaks with <br /> tags and preserves significant whitespace.

Parameters:

s - The String to escape.

Returns:

The escaped String.

stripThreadName

public String stripThreadName(String threadId)

TestNG returns a compound thread ID that includes the thread name and its numeric ID, separated by an 'at' sign. We only want to use the thread name as the ID is mostly unimportant and it takes up too much space in the generated report.

Parameters:

threadId - The compound thread ID.

Returns:

The thread name.

getStartTime

public long getStartTime(List<IInvokedMethod> methods)

Find the earliest start time of the specified methods.

Parameters:

methods - A list of test methods.

Returns:

The earliest start time.

getEndTime

public long getEndTime(ISuite suite,
              IInvokedMethod method,
              List<IInvokedMethod> methods)