org.forgerock.cuppa.reporters

Class CompositeReporter

java.lang.Object

org.forgerock.cuppa.reporters.CompositeReporter

All Implemented Interfaces:

Reporter

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

A reporter that delegates to list of other reporters.

Constructor Summary

Constructors

Constructor and Description
CompositeReporter(java.util.List<Reporter> reporters) Constructs a new composite reporter.

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	blockHookPass(Hook hook, java.util.List<TestBlock> parents) Called after a before or after hook has successfully executed without throwing an exception.
void	blockHookStart(Hook hook, java.util.List<TestBlock> parents) Called before a before or after hook is run.
void	end() Called after all tests have been run.
void	hookFail(Hook hook, java.util.List<TestBlock> parents, java.lang.Throwable cause) Called when a hook failed due to it throwing an exception.
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	testEnd(Test test, java.util.List<TestBlock> parents) Called after a test is run.
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	testHookPass(Hook hook, java.util.List<TestBlock> hookParents, Test test, java.util.List<TestBlock> testParents) Called after a beforeEach or afterEach hook has successfully executed without throwing an exception.
void	testHookStart(Hook hook, java.util.List<TestBlock> hookParents, Test test, java.util.List<TestBlock> testParents) Called before a beforeEach or afterEach hook is run.
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.
void	testStart(Test test, java.util.List<TestBlock> parents) Called before a test is run.

Methods inherited from class java.lang.Object

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

Constructor Detail

CompositeReporter

public CompositeReporter(java.util.List<Reporter> reporters)

Constructs a new composite reporter.

Parameters:

reporters - The reporters to delegate calls to.

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.

blockHookStart

public void blockHookStart(Hook hook,
                           java.util.List<TestBlock> parents)

Description copied from interface: Reporter

Called before a before or after hook is run.

Specified by:

blockHookStart 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.

blockHookPass

public void blockHookPass(Hook hook,
                          java.util.List<TestBlock> parents)

Description copied from interface: Reporter

Called after a before or after hook has successfully executed without throwing an exception.

Specified by:

blockHookPass 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.

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.

testHookStart

public void testHookStart(Hook hook,
                          java.util.List<TestBlock> hookParents,
                          Test test,
                          java.util.List<TestBlock> testParents)

Description copied from interface: Reporter

Called before a beforeEach or afterEach hook is run.

Specified by:

testHookStart 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.

testHookPass

public void testHookPass(Hook hook,
                         java.util.List<TestBlock> hookParents,
                         Test test,
                         java.util.List<TestBlock> testParents)

Description copied from interface: Reporter

Called after a beforeEach or afterEach hook has successfully executed without throwing an exception.

Specified by:

testHookPass 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.

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.

hookFail

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

Description copied from interface: Reporter

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

Specified by:

hookFail in interface Reporter

Parameters:

hook - The hook that threw an exception.

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

cause - The throwable that the hook threw.

testStart

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

Description copied from interface: Reporter

Called before a test is run.

Specified by:

testStart in interface Reporter

Parameters:

test - The test that is being run.

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

testEnd

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

Description copied from interface: Reporter

Called after a test is run.

Specified by:

testEnd in interface Reporter

Parameters:

test - The test that has been run.

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

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.