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

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 static io.probedock.client.common.config.Configuration	configuration Probe Dock configuration
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
void	addExctractor(TestMetaDataExtratctor extractor) Add an extractor to the list of extractors
protected String	createAndlogStackTrace(org.junit.runner.notification.Failure failure) Build a stack trace string
protected io.probedock.client.common.model.v1.TestResult	createTestResult(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(io.probedock.client.annotations.ProbeTestClass classAnnotation, io.probedock.client.annotations.ProbeTest methodAnnotation) Retrieve the category to apply to the test
protected io.probedock.client.annotations.ProbeTestClass	getClassAnnotation(org.junit.runner.Description description) Try to retrieve the ProbeTestClass annotation of the test class
protected io.probedock.client.annotations.ProbeTest	getMethodAnnotation(org.junit.runner.Description description) Try to retrieve the ProbeTest annotation of the test method
protected String	getTechnicalName(org.junit.runner.Description description) Build the technical name
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

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.

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

addExctractor

public void addExctractor(TestMetaDataExtratctor extractor)

Add an extractor to the list of extractors

Parameters:

extractor - Extractor to add

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

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(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:

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

getCategory

protected String getCategory(io.probedock.client.annotations.ProbeTestClass classAnnotation,
                 io.probedock.client.annotations.ProbeTest methodAnnotation)

Retrieve the category to apply to the test

Parameters:

classAnnotation - The roxable class annotation to get the override category

methodAnnotation - The roxable annotation to get the override category

Returns:

The category found

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

getTechnicalName

protected String getTechnicalName(org.junit.runner.Description description)

Build the technical name

Parameters:

description - The description to retrieve the unique name of a test

Returns:

The technical name