org.forgerock.cuppa.model

Class TestBlock

java.lang.Object

org.forgerock.cuppa.model.TestBlock

public final class TestBlock
extends java.lang.Object

Models a collection of tests and/or nested test blocks.

A TestBlock is usually created by calling Cuppa.describe(String, TestBlockFunction) or Cuppa.when(String, TestBlockFunction) but can be constructed using TestBlockBuilder.

TestBlocks form a tree, which together contain all the tests defined in the program. There is always a single root TestBlock, which has the type TestBlockType.ROOT.

For example, the following test code

     describe("a", () -> {
         beforeEach("a-be1", () -> {

         });

         it("a1");

         describe("b", () -> {
             it("b1");
             it("b3");
         });
     });
 

would result in a TestBlock tree of

      root (TestBlock)
       |
       +-- a (TestBlock)
           |
           +-- a1 (Test)
           +-- a-be1 (Hook)
           +-- b (TestBlock)
               |
               +-- b1 (Test)
               +-- b2 (Test)
 

Field Summary

Fields

Modifier and Type	Field and Description
Behaviour	behaviour Controls how the test block and its descendants behave.
java.lang.String	description The description of the test block.
java.util.List<Hook>	hooks Hooks defined by the test block.
Options	options The set of options applied to the test block.
java.util.List<TestBlock>	testBlocks Nested test blocks.
java.lang.Class<?>	testClass The class that the test block was defined in.
java.util.List<Test>	tests Tests defined by the test block.
TestBlockType	type The type of the test block.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
int	hashCode()
java.util.List<Hook>	hooksOfType(HookType type) Get all the registered hooks of the given type, in the order they were defined.
TestBlockBuilder	toBuilder() Creates a TestBlockBuilder and initialises it's properties to this TestBlock.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

type

public final TestBlockType type

The type of the test block.

behaviour

public final Behaviour behaviour

Controls how the test block and its descendants behave.

testClass

public final java.lang.Class<?> testClass

The class that the test block was defined in.

description

public final java.lang.String description

The description of the test block. Will be used for reporting.

testBlocks

public final java.util.List<TestBlock> testBlocks

Nested test blocks.

hooks

public final java.util.List<Hook> hooks

Hooks defined by the test block.

This list does not contain hooks from any of the nested blocks.

tests

public final java.util.List<Test> tests

Tests defined by the test block.

This list does not contain tests from any of the nested blocks.

options

public final Options options

The set of options applied to the test block.

Method Detail

toBuilder

public TestBlockBuilder toBuilder()

Creates a TestBlockBuilder and initialises it's properties to this TestBlock.

Returns:

a TestBlockBuilder.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hooksOfType

public java.util.List<Hook> hooksOfType(HookType type)

Get all the registered hooks of the given type, in the order they were defined.

Parameters:

type - The type of hook to filter on.

Returns:

An immutable list of hooks.