org.forgerock.cuppa

Interface TestBuilder

public interface TestBuilder

A builder for defining a test or block of tests.

This class helps you decorate a test or block of tests with additional options. Test builders are obtained from various methods of Cuppa.

 with(tags("slow")).
 it("takes a long time to start", () -> {
   // ...
 });
 

See Also:

Cuppa

Method Summary

Modifier and Type	Method and Description
void	describe(java.lang.String description, TestBlockFunction function) Registers a described suite of tests 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.
TestBuilder	skip() Mark a test or block of tests to be skipped.
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.

Method Detail

with

TestBuilder with(Option<?>... options)

Decorate a test or block of tests with additional options. Options are constructed via factory methods. For example, see Cuppa.tags(String...).

Multiple options can be either passed as additional arguments or chained using the returned builder.

 with(tags("slow")).
 it("takes a long time to start", () -> {
   // ...
 });
 

Parameters:

options - Options to apply to the test/block.

Returns:

This, for chaining.

See Also:

Cuppa.with(Option...)

skip

TestBuilder skip()

Mark a test or block of tests to be skipped.

The test(s) may still be included in test reports, but marked as skipped.

 skip().it("does something", () -> {
   // Will not be run.
 });
 

Returns:

This, for chaining.

See Also:

Cuppa.skip()

only

TestBuilder only()

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

If at least one test is marked as only then all tests not marked as only will not be run.

 only().it("does something", () -> {
   // ...
 });
 

Returns:

This, for chaining.

See Also:

Cuppa.only()

describe

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

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.

it

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

Registers a test function to be run.

Parameters:

description - The description of the test.

function - The test function.

it

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.