org.forgerock.cuppa

Class TestCuppaSupport

java.lang.Object

org.forgerock.cuppa.TestCuppaSupport

public final class TestCuppaSupport
extends java.lang.Object

A collection of static methods for facilitating the writing of tests for Cuppa and its extensions (such as test block transforms).

Method Summary

Modifier and Type	Method and Description
static TestBlock	defineTests(java.lang.Runnable testDefiner) Define some Cuppa tests.
static Hook	findHook(TestBlock testBlock, java.lang.String description) Finds the first hook with the given description.
static Test	findTest(TestBlock testBlock, java.lang.String description) Finds the first test with the given description.
static TestBlock	findTestBlock(TestBlock testBlock, java.lang.String description) Finds the first test block with the given description.
static void	runTests(TestBlock testBlock, Reporter reporter) Helper method to simplify running tests.
static void	runTests(TestBlock testBlock, Reporter reporter, Tags tags) Helper method to simplify running tests.

Methods inherited from class java.lang.Object

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

Method Detail

defineTests

public static TestBlock defineTests(java.lang.Runnable testDefiner)

Define some Cuppa tests. Use this in a test to avoid declaring a new class for your test's tests.

Parameters:

testDefiner - A function which will call Cuppa methods to define tests.

Returns:

the root test block containing all the tests defined by the given function.

runTests

public static void runTests(TestBlock testBlock,
                            Reporter reporter)

Helper method to simplify running tests.

Parameters:

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

reporter - The reporter to use to report test results.

runTests

public static void runTests(TestBlock testBlock,
                            Reporter reporter,
                            Tags tags)

Helper method to simplify running tests.

Parameters:

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

reporter - The reporter to use to report test results.

tags - Tags to filter the tests on.

findTest

public static Test findTest(TestBlock testBlock,
                            java.lang.String description)

Finds the first test with the given description.

Parameters:

testBlock - the root test block to search under.

description - The description.

Returns:

The test.

Throws:

java.util.NoSuchElementException - If no test was found with the given description.

findTestBlock

public static TestBlock findTestBlock(TestBlock testBlock,
                                      java.lang.String description)

Finds the first test block with the given description.

Parameters:

testBlock - the root test block to search under.

description - The description.

Returns:

The test block.

Throws:

java.util.NoSuchElementException - If no test block was found with the given description.

findHook

public static Hook findHook(TestBlock testBlock,
                            java.lang.String description)

Finds the first hook with the given description.

Hooks are searched breadth-first, i.e. going through a test block's before, after, beforeEach and afterEach hooks before searching in nested test blocks.

Parameters:

testBlock - the root test block to search under.

description - The description.

Returns:

The hook.

Throws:

java.util.NoSuchElementException - If no hook was found with the given description.