io.probedock.client.junit

Class AbstractProbeListener

java.lang.Object

org.junit.runner.notification.RunListener

io.probedock.client.junit.AbstractProbeListener

Direct Known Subclasses:

ProbeListener

public abstract class AbstractProbeListener
extends org.junit.runner.notification.RunListener

Shared code to create Junit Probe Dock listeners

Author:

Laurent Prevost, laurent.prevost@probedock.io

Nested Class Summary

Nested classes/interfaces inherited from class org.junit.runner.notification.RunListener

org.junit.runner.notification.RunListener.ThreadSafe

Field Summary

Fields

Modifier and Type	Field and Description
protected String	category Define the category of the test that are running.
protected static io.probedock.client.common.config.Configuration	configuration Probe Dock configuration
protected static String	DEFAULT_CATEGORY Default category when none is specified
protected Long	runStartedDate Store the date when the run started
protected Map<String,Long>	testStartDates Store the start date of a test to measure the approximative execution time of a each test.

Constructor Summary

Constructors

Constructor and Description
AbstractProbeListener() Constructor
AbstractProbeListener(String category) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
protected String	createAndlogStackTrace(org.junit.runner.notification.Failure failure) Build a stack trace string
protected io.probedock.client.common.model.v1.TestResult	createTestResult(String fingerprint, org.junit.runner.Description description, io.probedock.client.annotations.ProbeTest mAnnotation, io.probedock.client.annotations.ProbeTestClass cAnnotation, boolean passed, String message) Create a test based on the different information gathered from class, method and description
protected String	getCategory() Retrive the category
protected io.probedock.client.annotations.ProbeTestClass	getClassAnnotation(org.junit.runner.Description description) Try to retrieve the ProbeTestClass annotation of the test class
protected String	getFingerprint(org.junit.runner.Description description) Retrieve the fingerprint of a test based on its description
protected io.probedock.client.annotations.ProbeTest	getMethodAnnotation(org.junit.runner.Description description) Try to retrieve the ProbeTest annotation of the test method
protected String	getPackage(Class cls) Retrieve the package name if available, if not, default package name is used.
void	setFullStackTraces(Boolean fullStackTraces)
void	testFinished(org.junit.runner.Description description)
void	testRunStarted(org.junit.runner.Description description)
void	testStarted(org.junit.runner.Description description)

Methods inherited from class org.junit.runner.notification.RunListener

testAssumptionFailure, testFailure, testIgnored, testRunFinished

Methods inherited from class java.lang.Object

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

Field Detail

configuration

protected static final io.probedock.client.common.config.Configuration configuration

Probe Dock configuration

DEFAULT_CATEGORY

protected static final String DEFAULT_CATEGORY

Default category when none is specified

See Also:

Constant Field Values

runStartedDate

protected Long runStartedDate

Store the date when the run started

testStartDates

protected Map<String,Long> testStartDates

Store the start date of a test to measure the approximative execution time of a each test.

category

protected String category

Define the category of the test that are running. Will be use donly if no other is specified.

Constructor Detail

AbstractProbeListener

public AbstractProbeListener()

Constructor

AbstractProbeListener

public AbstractProbeListener(String category)

Constructor

Parameters:

category - The test category

Method Detail

testStarted

public void testStarted(org.junit.runner.Description description)
                 throws Exception

Overrides:

testStarted in class org.junit.runner.notification.RunListener

Throws:

Exception

testFinished

public void testFinished(org.junit.runner.Description description)
                  throws Exception

Overrides:

testFinished in class org.junit.runner.notification.RunListener

Throws:

Exception

setFullStackTraces

public void setFullStackTraces(Boolean fullStackTraces)

Parameters:

fullStackTraces - The full stack trace mode

testRunStarted

public void testRunStarted(org.junit.runner.Description description)
                    throws Exception

Overrides:

testRunStarted in class org.junit.runner.notification.RunListener

Throws:

Exception

getMethodAnnotation

protected io.probedock.client.annotations.ProbeTest getMethodAnnotation(org.junit.runner.Description description)
                                                                 throws NoSuchMethodException

Try to retrieve the ProbeTest annotation of the test method

Parameters:

description - The representation of the test

Returns:

The annotation found, or null if not found

Throws:

NoSuchMethodException - No method found

getClassAnnotation

protected io.probedock.client.annotations.ProbeTestClass getClassAnnotation(org.junit.runner.Description description)

Try to retrieve the ProbeTestClass annotation of the test class

Parameters:

description - The representation of the test

Returns:

The annotation found, or null if not found

createTestResult

protected io.probedock.client.common.model.v1.TestResult createTestResult(String fingerprint,
                                                              org.junit.runner.Description description,
                                                              io.probedock.client.annotations.ProbeTest mAnnotation,
                                                              io.probedock.client.annotations.ProbeTestClass cAnnotation,
                                                              boolean passed,
                                                              String message)

Create a test based on the different information gathered from class, method and description

Parameters:

fingerprint - The fingerprint of the test

description - jUnit test description

mAnnotation - Method annotation

cAnnotation - Class annotation

passed - Test passing or not

message - Message associated to the test result

Returns:

The test created from all the data available

createAndlogStackTrace

protected String createAndlogStackTrace(org.junit.runner.notification.Failure failure)

Build a stack trace string

Parameters:

failure - The failure to get the exceptions and so on

Returns:

The stack trace stringified

getFingerprint

protected final String getFingerprint(org.junit.runner.Description description)

Retrieve the fingerprint of a test based on its description

Parameters:

description - The description

Returns:

The fingerprint

getCategory

protected final String getCategory()

Retrive the category

Returns:

The category

getPackage

protected final String getPackage(Class cls)

Retrieve the package name if available, if not, default package name is used.

Parameters:

cls - The class to extract the package name

Returns:

The package name if found, "defaultPackage" if not found