org.forgerock.cuppa

Class ReporterSupport

java.lang.Object

org.forgerock.cuppa.ReporterSupport

public final class ReporterSupport
extends java.lang.Object

Provides utility methods for reporters.

Method Summary

Modifier and Type	Method and Description
static void	filterStackTrace(java.lang.Throwable throwable) Modify a Throwable's stacktrace by removing any stack elements that are not relevant to a test.
static java.lang.String	getDescription(Hook hook) Get a short human-readable description for the given hook.
static java.lang.String	getDescription(TestBlock testBlock) Get a short human-readable description for the given test block.
static java.lang.String	getFullDescription(Hook hook, java.util.List<TestBlock> parents) Get a full human-readable description for the given hook.
static java.lang.String	getFullDescription(TestBlock testBlock, java.util.List<TestBlock> parents) Get a full human-readable description for the given test block.
static java.lang.String	getFullDescription(Test test, java.util.List<TestBlock> parents) Get a full human-readable description for the given test.

Methods inherited from class java.lang.Object

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

Method Detail

getDescription

public static java.lang.String getDescription(TestBlock testBlock)

Get a short human-readable description for the given test block.

This description is only suitable for display where there is sufficient context to uniquely identify the test block.

Parameters:

testBlock - The test block.

Returns:

A description of the test block.

getDescription

public static java.lang.String getDescription(Hook hook)

Get a short human-readable description for the given hook.

This description is only suitable for display where there is sufficient context to uniquely identify the hook.

Parameters:

hook - The hook.

Returns:

A description of the hook.

getFullDescription

public static java.lang.String getFullDescription(TestBlock testBlock,
                                                  java.util.List<TestBlock> parents)

Get a full human-readable description for the given test block.

This description is verbose but is suitable for display where there is no context to help identify the test block.

Parameters:

testBlock - The test block.

parents - The ancestor test blocks, starting with the root block and ending with the immediate parent.

Returns:

A description of the test block.

getFullDescription

public static java.lang.String getFullDescription(Test test,
                                                  java.util.List<TestBlock> parents)

Get a full human-readable description for the given test.

This description is verbose but is suitable for display where there is no context to help identify the test.

Parameters:

test - The test.

parents - The ancestor test blocks, starting with the root block and ending with the immediate parent.

Returns:

A description of the test.

getFullDescription

public static java.lang.String getFullDescription(Hook hook,
                                                  java.util.List<TestBlock> parents)

Get a full human-readable description for the given hook.

This description is verbose but is suitable for display where there is no context to help identify the hook.

Parameters:

hook - Test hook.

parents - The ancestor test blocks, starting with the root block and ending with the immediate parent.

Returns:

A description of the hook.

filterStackTrace

public static void filterStackTrace(java.lang.Throwable throwable)

Modify a Throwable's stacktrace by removing any stack elements that are not relevant to a test. If the Throwable has a cause, it will also be modified. The modification is applied to all transitive causes.

Parameters:

throwable - a throwable to modify.