Cuppa (cuppa 1.5.0 API)

java.lang.Object
- org.forgerock.cuppa.Cuppa

public final class Cuppa
extends java.lang.Object

Use the methods of this class to define your tests.

Annotate your class with Test.


 public class ListTest {
   {
     describe("List", () -> {
       describe("#indexOf", () -> {
         it("returns -1 when the value is not present", () -> {
           List<Integer> list = Arrays.asList(1, 2, 3);
           assertThat(list.indexOf(5)).isEqualTo(-1);
         });
       });
     });
   }
 }

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`after(HookFunction function)` Registers the given function to be executed once, after all tests in the current and nested blocks.
`static void`	`after(java.lang.String description, HookFunction function)` Registers the given function to be executed once, after all tests in the current block.
`static void`	`afterEach(HookFunction function)` Registers the given function to be executed after each test in the current and nested blocks.
`static void`	`afterEach(java.lang.String description, HookFunction function)` Registers the given function to be executed after each test in the current and nested blocks.
`static void`	`before(HookFunction function)` Registers the given function to be executed once, before any tests in the current and nested blocks.
`static void`	`before(java.lang.String description, HookFunction function)` Registers the given function to be executed once, before any tests in the current and nested blocks.
`static void`	`beforeEach(HookFunction function)` Registers the given function to be executed before each test in the current and nested blocks.
`static void`	`beforeEach(java.lang.String description, HookFunction function)` Registers the given function to be executed before each test in the current and nested blocks.
`static void`	`describe(java.lang.String description, TestBlockFunction function)` Registers a 'describe' block of tests.
`static void`	`it(java.lang.String description)` Registers a pending test.
`static void`	`it(java.lang.String description, TestFunction function)` Registers a test function to be run.
`static TestBuilder`	`only()` Mark a test or block of tests as the only tests that should be run.
`static TestBuilder`	`skip()` Mark a test or block of tests to be skipped.
`static Option`	`tags(java.lang.String... tags)` Decorates tests with a set of tags.
`static void`	`when(java.lang.String description, TestBlockFunction function)` Registers a 'when' block of tests.
`static TestBuilder`	`with(Option<?>... options)` Decorate a test or block of tests with additional options.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - describe
```
public static void describe(java.lang.String description,
                            TestBlockFunction function)
```
    Registers a 'describe' block of tests.
    Use 'describe' blocks to group together tests that describe the same thing. Blocks may be nested within other blocks.
    
    Parameters:
    
    description - The description of the 'describe' block. Used solely for reporting.
    
    function - A function that will define tests and/or test blocks. This function will be executed immediately.
  - when
```
public static void when(java.lang.String description,
                        TestBlockFunction function)
```
    Registers a 'when' block of tests.
    Use 'when' blocks to group together tests that share some context. Blocks may be nested within other blocks.
    
    Parameters:
    
    description - The description of the 'when' block. Used solely for reporting.
    
    function - A function that will define tests and/or test blocks. This function will be executed immediately.
  - before
```
public static void before(HookFunction function)
```
    Registers the given function to be executed once, before any tests in the current and nested blocks.
    
    Parameters:
    
    function - The 'before' block.
  - before
```
public static void before(java.lang.String description,
                          HookFunction function)
```
    Registers the given function to be executed once, before any tests in the current and nested blocks.
    
    Parameters:
    
    description - A description of the function. Displayed when the function throws an exception.
    
    function - The function to execute.
  - after
```
public static void after(HookFunction function)
```
    Registers the given function to be executed once, after all tests in the current and nested blocks.
    
    Parameters:
    
    function - The function to execute.
  - after
```
public static void after(java.lang.String description,
                         HookFunction function)
```
    Registers the given function to be executed once, after all tests in the current block.
    
    Parameters:
    
    description - A description of the function. Displayed when the function throws an exception.
    
    function - The function to execute.
  - beforeEach
```
public static void beforeEach(HookFunction function)
```
    Registers the given function to be executed before each test in the current and nested blocks.
    
    Parameters:
    
    function - The function to execute.
  - beforeEach
```
public static void beforeEach(java.lang.String description,
                              HookFunction function)
```
    Registers the given function to be executed before each test in the current and nested blocks.
    
    Parameters:
    
    description - A description of the function. Displayed when the function throws an exception.
    
    function - The function to execute.
  - afterEach
```
public static void afterEach(HookFunction function)
```
    Registers the given function to be executed after each test in the current and nested blocks.
    
    Parameters:
    
    function - The function to execute.
  - afterEach
```
public static void afterEach(java.lang.String description,
                             HookFunction function)
```
    Registers the given function to be executed after each test in the current and nested blocks.
    
    Parameters:
    
    description - A description of the function. Displayed when the function throws an exception.
    
    function - The function to execute.
  - it
```
public static void it(java.lang.String description,
                      TestFunction function)
```
    Registers a test function to be run.
    
    Parameters:
    
    description - A description of the behaviour that the function will assert.
    
    function - The function to execute.
  - it
```
public static 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 - A description of the behaviour that this test will assert.
  - with
```
public static TestBuilder with(Option<?>... options)
```
    Decorate a test or block of tests with additional options. Options are constructed via factory methods. For example, see 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:
    
    An object for building a test or test block with the given options.
    
    See Also:
    
    tags(String...)
  - skip
```
public static 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:
    
    An object for building the test or test block that will be skipped.
  - only
```
public static 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:
    
    An object for building the test or test block that will be run.
  - tags
```
public static 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.
    Apply to a test or block of tests by passing the result of this method to with(Option...).
```
 with(tags("slow")).
 it("takes a long time to start", () -> {
   // ...
 });
 
```
    Parameters:
    
    tags - String identifiers that can be used when running Cuppa to include or exclude a test/block.
    
    Returns:
    
    An option, which can be passed to with(Option...).
    
    See Also:
    
    with(Option...)

Class Cuppa

Method Summary

Methods inherited from class java.lang.Object

Method Detail

describe

when

before

before

after

after

beforeEach

beforeEach

afterEach

afterEach

it

it

with

skip

only

tags