com.oracle.bedrock.junit

Class JUnitTextReporter

java.lang.Object

com.oracle.bedrock.junit.JUnitReporter

com.oracle.bedrock.junit.JUnitTextReporter

All Implemented Interfaces:

JUnitTestListener

public class JUnitTextReporter
extends JUnitReporter

An implementation of a JUnitReporter that produces a text based report in the same format as that produced by the Maven Surefire plugin.

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 class com.oracle.bedrock.junit.JUnitReporter

JUnitReporter.TestResults

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

JUnitTestListener.Event

Field Summary

Fields

Modifier and Type	Field and Description
static String	DASHES A line of dashes used on reports.

Constructor Summary

Constructors

Constructor and Description
JUnitTextReporter() Create a JUnitTextReporter that prints the report to System.out.
JUnitTextReporter(File reportFolder) Create a JUnitTextReporter that prints the report to a file in the specified folder.

Method Summary

Modifier and Type	Method and Description
static com.oracle.bedrock.Option	at(File folder) Obtain a JUnitTextReporter as an Option that will print test reports to the specified folder.
String	getReportFileName(Class testClass) Obtain the file name that will be used to print a test report for the specified Class.
String	getReportFileName(String className) Obtain the file name to use for the test report for the specified class name.
static com.oracle.bedrock.Option	toConsole() Obtain a JUnitTextReporter as an Option that will print test reports to System.out.
void	writeReport(PrintStream out, JUnitReporter.TestResults test) Write the test report for the specified JUnitReporter.TestResults to the specified PrintStream.

Methods inherited from class com.oracle.bedrock.junit.JUnitReporter

asOption, ensureTest, getReportFolder, getTestProperties, junitCompleted, junitStarted, testAssumptionFailure, testClassFinished, testClassStarted, testError, testFailed, testIgnored, testRunFinished, testRunStarted, testStarted, testSucceeded

Methods inherited from class java.lang.Object

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

Field Detail

DASHES

public static final String DASHES

A line of dashes used on reports.

See Also:

Constant Field Values

Constructor Detail

JUnitTextReporter

public JUnitTextReporter()

Create a JUnitTextReporter that prints the report to System.out.

JUnitTextReporter

public JUnitTextReporter(File reportFolder)

Create a JUnitTextReporter that prints the report to a file in the specified folder.

Parameters:

reportFolder - the folder to print the report file to

Method Detail

writeReport

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

Description copied from class: JUnitReporter

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

Specified by:

writeReport in class JUnitReporter

Parameters:

out - the PrintStream to write the test to

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

getReportFileName

public String getReportFileName(String className)

Description copied from class: JUnitReporter

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

Specified by:

getReportFileName in class JUnitReporter

Parameters:

className - the name of the test class

Returns:

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

getReportFileName

public String getReportFileName(Class testClass)

Obtain the file name that will be used to print a test report for the specified Class.

Parameters:

testClass - the Class to obtain the file name for

Returns:

the file name that will be used to print a test report

at

public static com.oracle.bedrock.Option at(File folder)

Obtain a JUnitTextReporter as an Option that will print test reports to the specified folder.

Parameters:

folder - the folder to print test reports to

Returns:

a JUnitTextReporter as an Option that will print test reports to the specified folder

toConsole

public static com.oracle.bedrock.Option toConsole()

Obtain a JUnitTextReporter as an Option that will print test reports to System.out.

Returns:

a JUnitTextReporter as an Option that will print test reports to System.out