org.forgerock.cuppa

Class Runner

java.lang.Object

org.forgerock.cuppa.Runner

public final class Runner
extends java.lang.Object

Runs Cuppa tests.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Runner.TagsRunOption Tag run state to perform tag based filtering with.

Constructor Summary

Constructors

Constructor and Description
Runner() Creates a new runner with no run tags and a configuration loaded from the classpath.
Runner(Configuration configuration) Creates a new runner with the given run state and configuration.
Runner(Options runOptions) Creates a new runner with the given run state and a configuration loaded from the classpath.
Runner(Tags runTags) Deprecated. Use @{link Runner(Options)} and provide runTags as runState instead and use state in ConfigurationProvider implementation to insert the TagTestBlockFilter in the appropriate order.
Runner(Tags runTags, Configuration configuration) Deprecated. Use @{link Runner(Configuration)} and provide runTags as runState instead and use state in ConfigurationProvider implementation to insert the TagTestBlockFilter in the appropriate order.

Method Summary

Modifier and Type	Method and Description
TestBlock	defineTests(java.lang.Iterable<java.lang.Class<?>> testClasses) Instantiates the test classes, which define tests as side effects, and return the root test block.
void	run(TestBlock rootBlock, Reporter reporter) Runs the tests contained in the provided test block and any nested test blocks, using the provided reporter.

Methods inherited from class java.lang.Object

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

Constructor Detail

Runner

public Runner()

Creates a new runner with no run tags and a configuration loaded from the classpath.

Runner

@Deprecated
public Runner(Tags runTags)

Deprecated. Use @{link Runner(Options)} and provide runTags as runState instead and use state in ConfigurationProvider implementation to insert the TagTestBlockFilter in the appropriate order.

Creates a new runner with the given run tags and a configuration loaded from the classpath.

Parameters:

runTags - Tags to filter the tests on.

Runner

@Deprecated
public Runner(Tags runTags,
                          Configuration configuration)

Deprecated. Use @{link Runner(Configuration)} and provide runTags as runState instead and use state in ConfigurationProvider implementation to insert the TagTestBlockFilter in the appropriate order.

Creates a new runner with the given run tags and configuration.

Parameters:

runTags - Tags to filter the tests on.

configuration - Cuppa configuration to control the behaviour of the runner.

Runner

public Runner(Options runOptions)

Creates a new runner with the given run state and a configuration loaded from the classpath.

Parameters:

runOptions - Any state information that should be used by test block transforms.

Runner

public Runner(Configuration configuration)

Creates a new runner with the given run state and configuration.

Parameters:

configuration - Cuppa configuration to control the behaviour of the runner.

Method Detail

defineTests

public TestBlock defineTests(java.lang.Iterable<java.lang.Class<?>> testClasses)

Instantiates the test classes, which define tests as side effects, and return the root test block.

Parameters:

testClasses - The test classes that contain the tests to be executed.

Returns:

The root block that contains all other test blocks and their tests.

run

public void run(TestBlock rootBlock,
                Reporter reporter)

Runs the tests contained in the provided test block and any nested test blocks, using the provided reporter.

Parameters:

rootBlock - The root test block that contains all tests to be run.

reporter - The reporter to use to report test results.