org.forgerock.cuppa.internal

Enum TestContainer

java.lang.Object

java.lang.Enum<TestContainer>

org.forgerock.cuppa.internal.TestContainer

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TestContainer>

public enum TestContainer
extends java.lang.Enum<TestContainer>

Singleton container for user-defined tests.

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE The singleton.

Method Summary

Modifier and Type	Method and Description
void	after(HookFunction function) Registers a 'after' block to be run.
void	after(java.lang.String description, HookFunction function) Registers a 'after' block to be run.
void	afterEach(HookFunction function) Registers a 'afterEach' block to be run.
void	afterEach(java.lang.String description, HookFunction function) Registers a 'afterEach' block to be run.
void	before(HookFunction function) Registers a 'before' block to be run.
void	before(java.lang.String description, HookFunction function) Registers a 'before' block to be run.
void	beforeEach(HookFunction function) Registers a 'beforeEach' block to be run.
void	beforeEach(java.lang.String description, HookFunction function) Registers a 'beforeEach' block to be run.
TestBlock	defineTests(java.lang.Class<?> testClass, java.lang.Runnable testDefiner) Define tests within the context of a test class.
void	describe(java.lang.String description, TestBlockFunction function) Registers a described suite of tests to be run.
void	it(Behaviour behaviour, java.lang.String description, java.util.Optional<TestFunction> function, Options options) Registers a test function to be run.
void	it(java.lang.String description) Registers a pending test.
void	it(java.lang.String description, TestFunction function) Registers a test function to be run.
TestBuilder	only() Mark a test or block of tests as the only tests that should be run.
void	runTests(java.lang.Runnable testRunner) For internal use only.
TestBuilder	skip() Mark a test or block of tests to be skipped.
Option	tags(java.lang.String... tags) Decorates tests with a set of tags.
static TestContainer	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static TestContainer[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
void	when(java.lang.String description, TestBlockFunction function) Registers a 'when' block to be run.
TestBuilder	with(Option... options) Decorate a test or block of tests with additional options.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final TestContainer INSTANCE

The singleton.

Method Detail

values

public static TestContainer[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TestContainer c : TestContainer.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static TestContainer valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

describe

public void describe(java.lang.String description,
                     TestBlockFunction function)

Registers a described suite of tests to be run.

Parameters:

description - The description of the 'describe' block.

function - The 'describe' block.

when

public void when(java.lang.String description,
                 TestBlockFunction function)

Registers a 'when' block to be run.

Parameters:

description - The description of the 'when' block.

function - The 'when' block.

before

public void before(HookFunction function)

Registers a 'before' block to be run.

Parameters:

function - The 'before' block.

before

public void before(java.lang.String description,
                   HookFunction function)

Registers a 'before' block to be run.

Parameters:

description - The description of the 'before' block.

function - The 'before' block.

after

public void after(HookFunction function)

Registers a 'after' block to be run.

Parameters:

function - The 'after' block.

after

public void after(java.lang.String description,
                  HookFunction function)

Registers a 'after' block to be run.

Parameters:

description - The description of the 'after' block.

function - The 'after' block.

beforeEach

public void beforeEach(HookFunction function)

Registers a 'beforeEach' block to be run.

Parameters:

function - The 'beforeEach' block.

beforeEach

public void beforeEach(java.lang.String description,
                       HookFunction function)

Registers a 'beforeEach' block to be run.

Parameters:

description - The description of the 'beforeEach' block.

function - The 'beforeEach' block.

afterEach

public void afterEach(HookFunction function)

Registers a 'afterEach' block to be run.

Parameters:

function - The 'afterEach' block.

afterEach

public void afterEach(java.lang.String description,
                      HookFunction function)

Registers a 'afterEach' block to be run.

Parameters:

description - The description of the 'afterEach' block.

function - The 'afterEach' block.

it

public void it(java.lang.String description,
               TestFunction function)

Registers a test function to be run.

Parameters:

description - The description of the test function.

function - The test function.

it

public void it(java.lang.String description)

Registers a pending test.

A pending test has no implementation and acts as a reminder to the developer to write the implementation later.

Parameters:

description - The description of the test.

it

public void it(Behaviour behaviour,
               java.lang.String description,
               java.util.Optional<TestFunction> function,
               Options options)

Registers a test function to be run.

Parameters:

behaviour - If Behaviour.SKIP then this test will be skipped.

description - The description of the test function.

function - The test function.

options - The set of options applied to the test.

with

public TestBuilder with(Option... options)

Decorate a test or block of tests with additional options.

Parameters:

options - Options to apply to the test/block.

Returns:

An object for building a test or test block with the given options.

skip

public TestBuilder skip()

Mark a test or block of tests to be skipped.

Returns:

An object for building the test or test block that will be skipped.

only

public TestBuilder only()

Mark a test or block of tests as the only tests that should be run.

Returns:

An object for building the test or test block that will be run.

tags

public Option tags(java.lang.String... tags)

Decorates tests with a set of tags. Tags can be used to group tests together to be included or excluded from a test run.

Parameters:

tags - String identifiers that can be used when running Cuppa to include or exclude a test/block.

Returns:

An option.

runTests

public void runTests(java.lang.Runnable testRunner)

For internal use only. Code that executes Cuppa tests should be wrapped in this method, which will ensure that test code doesn't try to declare more tests.

Parameters:

testRunner - A function that will run tests.

defineTests

public TestBlock defineTests(java.lang.Class<?> testClass,
                             java.lang.Runnable testDefiner)

Define tests within the context of a test class. All code that may call Cuppa methods should be wrapped in this method.

Parameters:

testClass - The class that the tests are defined in.

testDefiner - A function that will define tests, usually by instantiating the given test class.

Returns:

A test block containing all the defined tests.