com.oracle.bedrock.junit

Class JUnitReporter

java.lang.Object

com.oracle.bedrock.junit.JUnitReporter

All Implemented Interfaces:

JUnitTestListener

Direct Known Subclasses:

JUnitTextReporter, JUnitXmlReporter

public abstract class JUnitReporter
extends Object
implements JUnitTestListener

A base class for generating JUnit reports.

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

Modifier and Type	Class and Description
static class	JUnitReporter.TestResults A holder for the results of the tests for a particular test class.

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

JUnitTestListener.Event

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JUnitReporter(File reportFolder) Create a JUnitReporter with the specified output folder.

Method Summary

Modifier and Type	Method and Description
com.oracle.bedrock.Option	asOption() Obtain this JUnitReporter instance as an Option
JUnitReporter.TestResults	ensureTest(String className) Ensure that an instance of JUnitReporter.TestResults results exists for the specified test class.
abstract String	getReportFileName(String className) Obtain the file name to use for the test report for the specified class name.
File	getReportFolder() Obtain the folder to use to write the test reports to.
Properties	getTestProperties() Obtain the System properties used by 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
abstract void	writeReport(PrintStream out, JUnitReporter.TestResults test) Write the test report for the specified JUnitReporter.TestResults to the specified PrintStream.

Methods inherited from class java.lang.Object

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

Constructor Detail

JUnitReporter

protected JUnitReporter(File reportFolder)

Create a JUnitReporter with the specified output folder.

If the output folder is null the report will be written to System.out.

Parameters:

reportFolder - the folder to write the report file to or null if the report should be written to System.out

Method Detail

getReportFolder

public File getReportFolder()

Obtain the folder to use to write the test reports to.

Returns:

the folder to use to write the test reports to

ensureTest

public JUnitReporter.TestResults ensureTest(String className)

Ensure that an instance of JUnitReporter.TestResults results exists for the specified test class.

Parameters:

className - the name of the class to obtain tests results for

Returns:

the JUnitReporter.TestResults instance for the specified test class name

getTestProperties

public Properties getTestProperties()

Obtain the System properties used by the test run.

Returns:

the System properties used by the test run

asOption

public com.oracle.bedrock.Option asOption()

Obtain this JUnitReporter instance as an Option

Returns:

this JUnitReporter instance as an Option

writeReport

public abstract void writeReport(PrintStream out,
                                 JUnitReporter.TestResults test)

Write the test report for the specified JUnitReporter.TestResults to the specified PrintStream.

Parameters:

out - the PrintStream to write the test to

test - the JUnitReporter.TestResults to use to write the report

getReportFileName

public abstract String getReportFileName(String className)

Obtain the file name to use for the test report for the specified class name.

Parameters:

className - the name of the test class

Returns:

the file name to use for the test report for the specified class name

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