com.oracle.bedrock.junit

Class SimpleJUnitTestListener

java.lang.Object

com.oracle.bedrock.junit.SimpleJUnitTestListener

All Implemented Interfaces:

JUnitTestListener

public class SimpleJUnitTestListener
extends Object
implements JUnitTestListener

A simple implementation of a JUnitTestListener.

This implementation will maintain a count of tests, skipped tests, failures and errors as well as capturing the test JVM's System properties.

This implementation has the functionality to await completion of a test run.

Copyright (c) 2016. All Rights Reserved. Oracle Corporation.
Oracle is a registered trademark of Oracle Corporation and/or its affiliates.

Author:

Jonathan Knight

Nested Class Summary

Nested classes/interfaces inherited from interface com.oracle.bedrock.junit.JUnitTestListener

JUnitTestListener.Event

Constructor Summary

Constructors

Constructor and Description
SimpleJUnitTestListener() Create a SimpleJUnitTestListener.

Method Summary

Modifier and Type	Method and Description
com.oracle.bedrock.Option	asOption() Obtain the current SimpleJUnitTestListener as an Option.
boolean	awaitCompletion(long timeout, TimeUnit unit) Causes the current thread to wait until the JUnit application has completed the entire test run, unless the thread is interrupted, or the specified waiting time elapses.
int	getErrorCount() The number of errors running tests.
int	getFailureCount() The number of test failures.
int	getSkipCount() The number of tests skipped.
int	getTestCount() The number of tests executed.
Properties	getTestProperties() Obtain the System properties of the JVM running the tests.
boolean	hasTestFailures() Determine whether there were any failures or errors in the test run.
void	junitCompleted(JUnitTestListener.Event event) Indicates the end of a JUnit application
void	junitStarted(JUnitTestListener.Event event) Indicates the start of a JUnit application
void	testAssumptionFailure(JUnitTestListener.Event event) Event fired when a test assumption failure was encountered.
void	testClassFinished(JUnitTestListener.Event event) Indicates end of a given test-set
void	testClassStarted(JUnitTestListener.Event event) Indicates the start of a given test-set
void	testError(JUnitTestListener.Event event) Event fired when a test ended with an error (non anticipated problem)
void	testFailed(JUnitTestListener.Event event) Event fired when a test ended with a failure (anticipated problem)
void	testIgnored(JUnitTestListener.Event event) Event fired when a test is skipped
void	testRunFinished(JUnitTestListener.Event event) Indicates end of a given test-set
void	testRunStarted(JUnitTestListener.Event event) Indicates the start of a given test-set
void	testStarted(JUnitTestListener.Event event) Event fired when a test is about to start
void	testSucceeded(JUnitTestListener.Event event) Event fired when a test ended successfully

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleJUnitTestListener

public SimpleJUnitTestListener()

Create a SimpleJUnitTestListener.

Method Detail

getTestProperties

public Properties getTestProperties()

Obtain the System properties of the JVM running the tests.

Returns:

the System properties of the JVM running the tests

getTestCount

public int getTestCount()

The number of tests executed.

This figure only includes tests actually started so will not include tests annotated with Ignore but will include tests skipped due to an Assume exception.

Returns:

the number of tests executed

getSkipCount

public int getSkipCount()

The number of tests skipped.

This figure includes both tests annotated with Ignore and tests skipped due to an Assume exception.

Returns:

the number of tests skipped

getFailureCount

public int getFailureCount()

The number of test failures.

This is the number of tests that failed due to an AssertionError.

Returns:

the number of test failures

getErrorCount

public int getErrorCount()

The number of errors running tests.

This is the number of tests that failed due to an exception other than an AssertionError.

Returns:

the number of errors running tests

hasTestFailures

public boolean hasTestFailures()

Determine whether there were any failures or errors in the test run.

Returns:

true if there were any failures or errors in the test run, or returns false if all tests completed successfully

awaitCompletion

public boolean awaitCompletion(long timeout,
                               TimeUnit unit)
                        throws InterruptedException

Causes the current thread to wait until the JUnit application has completed the entire test run, unless the thread is interrupted, or the specified waiting time elapses.

If the JUnit application has already completed then this method returns immediately with the value true.

If JUnit application has not yet completed then the current thread becomes disabled for thread scheduling purposes and lies dormant until one of three things happen:

• The JUnit application completes the test run; or
• Some other thread interrupts the current thread; or
• The specified waiting time elapses.

If the JUnit application completes the test run then the method returns with the value true.

If the current thread:

• has its interrupted status set on entry to this method; or
• is interrupted while waiting,

then InterruptedException is thrown and the current thread's interrupted status is cleared.

If the specified waiting time elapses then the value false is returned. If the time is less than or equal to zero, the method will not wait at all.

Parameters:

timeout - the maximum time to wait

unit - the time unit of the timeout argument

Returns:

true if the JUnit application completed the test run and false if the waiting time elapsed before the JUnit application completed

Throws:

InterruptedException - if the current thread is interrupted while waiting

asOption

public com.oracle.bedrock.Option asOption()

Obtain the current SimpleJUnitTestListener as an Option.

Returns:

the current SimpleJUnitTestListener as an Option

junitStarted

public void junitStarted(JUnitTestListener.Event event)

Description copied from interface: JUnitTestListener

Indicates the start of a JUnit application

Specified by:

junitStarted in interface JUnitTestListener

Parameters:

event - the event

junitCompleted

public void junitCompleted(JUnitTestListener.Event event)

Description copied from interface: JUnitTestListener

Indicates the end of a JUnit application

Specified by:

junitCompleted in interface JUnitTestListener

Parameters:

event - the event

testRunStarted

public void testRunStarted(JUnitTestListener.Event event)

Description copied from interface: JUnitTestListener

Indicates the start of a given test-set

Specified by:

testRunStarted in interface JUnitTestListener

Parameters:

event - the report entry describing the test suite

testRunFinished

public void testRunFinished(JUnitTestListener.Event event)

Description copied from interface: JUnitTestListener

Indicates end of a given test-set

Specified by:

testRunFinished in interface JUnitTestListener

Parameters:

event - the report entry describing the test suitet

testStarted

public void testStarted(JUnitTestListener.Event event)

Description copied from interface: JUnitTestListener

Event fired when a test is about to start

Specified by:

testStarted in interface JUnitTestListener

Parameters:

event - The report entry to log for

testClassStarted

public void testClassStarted(JUnitTestListener.Event event)

Description copied from interface: JUnitTestListener

Indicates the start of a given test-set

Specified by:

testClassStarted in interface JUnitTestListener

Parameters:

event - the report entry describing the test suite

testClassFinished

public void testClassFinished(JUnitTestListener.Event event)

Description copied from interface: JUnitTestListener

Indicates end of a given test-set

Specified by:

testClassFinished in interface JUnitTestListener

Parameters:

event - the report entry describing the test suite

testSucceeded

public void testSucceeded(JUnitTestListener.Event event)

Description copied from interface: JUnitTestListener

Event fired when a test ended successfully

Specified by:

testSucceeded in interface JUnitTestListener

Parameters:

event - The report entry to log for

testIgnored

public void testIgnored(JUnitTestListener.Event event)

Description copied from interface: JUnitTestListener

Event fired when a test is skipped

Specified by:

testIgnored in interface JUnitTestListener

Parameters:

event - The report entry to log for

testFailed

public void testFailed(JUnitTestListener.Event event)

Description copied from interface: JUnitTestListener

Event fired when a test ended with a failure (anticipated problem)

Specified by:

testFailed in interface JUnitTestListener

Parameters:

event - The report entry to log for

testError

public void testError(JUnitTestListener.Event event)

Description copied from interface: JUnitTestListener

Event fired when a test ended with an error (non anticipated problem)

Specified by:

testError in interface JUnitTestListener

Parameters:

event - The report entry to log for

testAssumptionFailure

public void testAssumptionFailure(JUnitTestListener.Event event)

Description copied from interface: JUnitTestListener

Event fired when a test assumption failure was encountered. An assumption failure indicates that the test is not relevant

Specified by:

testAssumptionFailure in interface JUnitTestListener

Parameters:

event - The report entry to log for