org.forgerock.cuppa.reporters

Class DefaultReporter

java.lang.Object

org.forgerock.cuppa.reporters.DefaultReporter

All Implemented Interfaces:

Reporter

public final class DefaultReporter
extends java.lang.Object
implements Reporter

An RSpec-like reporter.

Constructor Summary

Constructors

Constructor and Description
DefaultReporter() Constructs a reporter that writes to standard out.
DefaultReporter(java.io.OutputStream stream) Constructs a reporter that writes to the specified stream, using the JVM's default charset.
DefaultReporter(java.io.OutputStream stream, java.nio.charset.Charset charset) Constructs a reporter that writes to the specified stream.

Method Summary

Modifier and Type	Method and Description
void	blockHookFail(Hook hook, java.util.List<TestBlock> parents, java.lang.Throwable cause) Called when a before or after hook failed due to it throwing an exception.
void	end() Called after all tests have been run.
void	start(TestBlock rootBlock) Called before any tests are run.
void	testBlockEnd(TestBlock testBlock, java.util.List<TestBlock> parents) Called after all tests in a test block have completed.
void	testBlockStart(TestBlock testBlock, java.util.List<TestBlock> parents) Called before any tests are run in a test block.
void	testFail(Test test, java.util.List<TestBlock> parents, java.lang.Throwable cause) Called after a test has failed due to it throwing an exception.
void	testHookFail(Hook hook, java.util.List<TestBlock> hookParents, Test test, java.util.List<TestBlock> testParents, java.lang.Throwable cause) Called when a beforeEach or afterEach hook failed due to it throwing an exception.
void	testPass(Test test, java.util.List<TestBlock> parents) Called after a test has successfully executed without throwing an exception.
void	testPending(Test test, java.util.List<TestBlock> parents) Called when a test cannot be run as it has not yet been implemented.
void	testSkip(Test test, java.util.List<TestBlock> parents) Called when a test has been skipped.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.forgerock.cuppa.reporters.Reporter

blockHookPass, blockHookStart, hookFail, testEnd, testHookPass, testHookStart, testStart

Constructor Detail

DefaultReporter

public DefaultReporter()

Constructs a reporter that writes to standard out.

DefaultReporter

public DefaultReporter(java.io.OutputStream stream)

Constructs a reporter that writes to the specified stream, using the JVM's default charset.

Parameters:

stream - A stream to write to.

DefaultReporter

public DefaultReporter(java.io.OutputStream stream,
                       java.nio.charset.Charset charset)
                throws java.io.UnsupportedEncodingException

Constructs a reporter that writes to the specified stream.

Parameters:

stream - A stream to write to.

charset - The charset to convert the output to.

Throws:

java.io.UnsupportedEncodingException - If the charset is not supported by the JVM.

Method Detail

start

public void start(TestBlock rootBlock)

Description copied from interface: Reporter

Called before any tests are run.

Specified by:

start in interface Reporter

Parameters:

rootBlock - The root test block containing all the tests that will be run.

end

public void end()

Description copied from interface: Reporter

Called after all tests have been run.

Specified by:

end in interface Reporter

testBlockStart

public void testBlockStart(TestBlock testBlock,
                           java.util.List<TestBlock> parents)

Description copied from interface: Reporter

Called before any tests are run in a test block.

Specified by:

testBlockStart in interface Reporter

Parameters:

testBlock - The test block.

parents - The ancestor test blocks, starting with the root block and ending with the immediate parent.

testBlockEnd

public void testBlockEnd(TestBlock testBlock,
                         java.util.List<TestBlock> parents)

Description copied from interface: Reporter

Called after all tests in a test block have completed.

Specified by:

testBlockEnd in interface Reporter

Parameters:

testBlock - The test block.

parents - The ancestor test blocks, starting with the root block and ending with the immediate parent.

testHookFail

public void testHookFail(Hook hook,
                         java.util.List<TestBlock> hookParents,
                         Test test,
                         java.util.List<TestBlock> testParents,
                         java.lang.Throwable cause)

Description copied from interface: Reporter

Called when a beforeEach or afterEach hook failed due to it throwing an exception.

Specified by:

testHookFail in interface Reporter

Parameters:

hook - The hook that threw an exception.

hookParents - The parent test blocks of the hook, starting with the root block and ending with the immediate parent.

test - The test that was associated with the beforeEach/afterEach.

testParents - The parent test blocks of the test, starting with the root block and ending with the immediate parent.

cause - The throwable that the hook threw.

blockHookFail

public void blockHookFail(Hook hook,
                          java.util.List<TestBlock> parents,
                          java.lang.Throwable cause)

Description copied from interface: Reporter

Called when a before or after hook failed due to it throwing an exception.

Specified by:

blockHookFail in interface Reporter

Parameters:

hook - The hook that threw an exception.

parents - The parent test blocks of the hook, starting with the root block and ending with the immediate parent.

cause - The throwable that the hook threw.

testPass

public void testPass(Test test,
                     java.util.List<TestBlock> parents)

Description copied from interface: Reporter

Called after a test has successfully executed without throwing an exception.

Specified by:

testPass in interface Reporter

Parameters:

test - The test that passed.

parents - The ancestor test blocks, starting with the root block and ending with the immediate parent.

testFail

public void testFail(Test test,
                     java.util.List<TestBlock> parents,
                     java.lang.Throwable cause)

Description copied from interface: Reporter

Called after a test has failed due to it throwing an exception.

Specified by:

testFail in interface Reporter

Parameters:

test - The test that failed.

parents - The ancestor test blocks, starting with the root block and ending with the immediate parent.

cause - The assertion error that the test threw.

testPending

public void testPending(Test test,
                        java.util.List<TestBlock> parents)

Description copied from interface: Reporter

Called when a test cannot be run as it has not yet been implemented.

Specified by:

testPending in interface Reporter

Parameters:

test - The pending test.

parents - The ancestor test blocks, starting with the root block and ending with the immediate parent.

testSkip

public void testSkip(Test test,
                     java.util.List<TestBlock> parents)

Description copied from interface: Reporter

Called when a test has been skipped.

Specified by:

testSkip in interface Reporter

Parameters:

test - The skipped test.

parents - The ancestor test blocks, starting with the root block and ending with the immediate parent.