- before(HookFunction) - Static method in class org.forgerock.cuppa.Cuppa
-
Registers the given function to be executed once, before any tests in the current and nested blocks.
- before(String, HookFunction) - Static method in class org.forgerock.cuppa.Cuppa
-
Registers the given function to be executed once, before any tests in the current and nested blocks.
- before(HookFunction) - Method in enum org.forgerock.cuppa.internal.TestContainer
-
Registers a 'before' block to be run.
- before(String, HookFunction) - Method in enum org.forgerock.cuppa.internal.TestContainer
-
Registers a 'before' block to be run.
- beforeEach(HookFunction) - Static method in class org.forgerock.cuppa.Cuppa
-
Registers the given function to be executed before each test in the current and nested blocks.
- beforeEach(String, HookFunction) - Static method in class org.forgerock.cuppa.Cuppa
-
Registers the given function to be executed before each test in the current and nested blocks.
- beforeEach(HookFunction) - Method in enum org.forgerock.cuppa.internal.TestContainer
-
Registers a 'beforeEach' block to be run.
- beforeEach(String, HookFunction) - Method in enum org.forgerock.cuppa.internal.TestContainer
-
Registers a 'beforeEach' block to be run.
- Behaviour - Enum in org.forgerock.cuppa.model
-
Controls the behaviour of a test or collection of tests.
- behaviour - Variable in class org.forgerock.cuppa.model.Test
-
Controls how the test behaves.
- behaviour - Variable in class org.forgerock.cuppa.model.TestBlock
-
Controls how the test block and its descendants behave.
- blockHookFail(Hook, List<TestBlock>, Throwable) - Method in class org.forgerock.cuppa.reporters.CompositeReporter
-
- blockHookFail(Hook, List<TestBlock>, Throwable) - Method in class org.forgerock.cuppa.reporters.DefaultReporter
-
- blockHookFail(Hook, List<TestBlock>, Throwable) - Method in interface org.forgerock.cuppa.reporters.Reporter
-
Called when a before or after hook failed due to it throwing an exception.
- blockHookPass(Hook, List<TestBlock>) - Method in class org.forgerock.cuppa.reporters.CompositeReporter
-
- blockHookPass(Hook, List<TestBlock>) - Method in interface org.forgerock.cuppa.reporters.Reporter
-
Called after a before or after hook has successfully executed without throwing an exception.
- blockHookStart(Hook, List<TestBlock>) - Method in class org.forgerock.cuppa.reporters.CompositeReporter
-
- blockHookStart(Hook, List<TestBlock>) - Method in interface org.forgerock.cuppa.reporters.Reporter
-
Called before a before or after hook is run.
- build() - Method in class org.forgerock.cuppa.model.HookBuilder
-
Constructs a
Hook
using the values set on this builder.
- build() - Method in class org.forgerock.cuppa.model.TestBlockBuilder
-
Constructs a
TestBlock
using the values set on this builder.
- build() - Method in class org.forgerock.cuppa.model.TestBuilder
-
Constructs a
Test
using the values set on this builder.
- only() - Static method in class org.forgerock.cuppa.Cuppa
-
Mark a test or block of tests as the only tests that should be run.
- only() - Method in enum org.forgerock.cuppa.internal.TestContainer
-
Mark a test or block of tests as the only tests that should be run.
- only() - Method in interface org.forgerock.cuppa.TestBuilder
-
Mark a test or block of tests as the only tests that should be run.
- OnlyTestBlockFilter - Class in org.forgerock.cuppa.internal.filters
-
Filters out all tests that are not marked as "only" if any test is marked as "only".
- OnlyTestBlockFilter() - Constructor for class org.forgerock.cuppa.internal.filters.OnlyTestBlockFilter
-
- Option<T> - Class in org.forgerock.cuppa.model
-
An option stores a value of the given type.
- Option(T) - Constructor for class org.forgerock.cuppa.model.Option
-
Create a new option.
- Options - Class in org.forgerock.cuppa.model
-
A set of options.
- options - Variable in class org.forgerock.cuppa.model.Test
-
The set of options applied to the test.
- options - Variable in class org.forgerock.cuppa.model.TestBlock
-
The set of options applied to the test block.
- OrCondition - Class in org.forgerock.cuppa.transforms.expression
-
A condition that composes other conditions with a logical OR.
- org.forgerock.cuppa - package org.forgerock.cuppa
-
A testing framework for Java 8.
- org.forgerock.cuppa.functions - package org.forgerock.cuppa.functions
-
Functional interfaces for test definitions.
- org.forgerock.cuppa.internal - package org.forgerock.cuppa.internal
-
Cuppa internals.
- org.forgerock.cuppa.internal.filters - package org.forgerock.cuppa.internal.filters
-
Internal test block filters.
- org.forgerock.cuppa.model - package org.forgerock.cuppa.model
-
Model for the structure of Cuppa tests.
- org.forgerock.cuppa.reporters - package org.forgerock.cuppa.reporters
-
Reporters control the output of Cuppa.
- org.forgerock.cuppa.transforms - package org.forgerock.cuppa.transforms
-
Test block filters.
- org.forgerock.cuppa.transforms.expression - package org.forgerock.cuppa.transforms.expression
-
Classes related to the expression group filter.
- set(Option<T>) - Method in class org.forgerock.cuppa.model.Options
-
Set an option.
- setAdditionalReporter(Reporter) - Method in class org.forgerock.cuppa.Configuration
-
Register a reporter that will be used in addition to the primary reporter given to the runner.
- setBehaviour(Behaviour) - Method in class org.forgerock.cuppa.model.TestBlockBuilder
-
Sets the behaviour of the test block.
- setBehaviour(Behaviour) - Method in class org.forgerock.cuppa.model.TestBuilder
-
Sets the behaviour, which controls how the test behaves.
- setDescription(Optional<String>) - Method in class org.forgerock.cuppa.model.HookBuilder
-
Sets the description of the hook.
- setDescription(String) - Method in class org.forgerock.cuppa.model.TestBlockBuilder
-
Sets the description of the test block.
- setDescription(String) - Method in class org.forgerock.cuppa.model.TestBuilder
-
Sets the description of the test.
- setFunction(HookFunction) - Method in class org.forgerock.cuppa.model.HookBuilder
-
Sets the function to be executed.
- setFunction(Optional<TestFunction>) - Method in class org.forgerock.cuppa.model.TestBuilder
-
Sets the body of the test.
- setHooks(List<Hook>) - Method in class org.forgerock.cuppa.model.TestBlockBuilder
-
Sets the hooks defined by the test block.
- setOptions(Options) - Method in class org.forgerock.cuppa.model.TestBlockBuilder
-
Sets the options applied to the test block.
- setOptions(Options) - Method in class org.forgerock.cuppa.model.TestBuilder
-
Sets the options applied to the test.
- setTestBlocks(List<TestBlock>) - Method in class org.forgerock.cuppa.model.TestBlockBuilder
-
Sets the nested test blocks.
- setTestClass(Class<?>) - Method in class org.forgerock.cuppa.model.HookBuilder
-
Sets the class that the hook was defined in.
- setTestClass(Class<?>) - Method in class org.forgerock.cuppa.model.TestBlockBuilder
-
Sets the class that the test block was defined in.
- setTestClass(Class<?>) - Method in class org.forgerock.cuppa.model.TestBuilder
-
Sets the class that the test was defined in.
- setTestInstantiator(TestInstantiator) - Method in class org.forgerock.cuppa.Configuration
-
Sets the class that will be used to instantiate test classes.
- setTests(List<Test>) - Method in class org.forgerock.cuppa.model.TestBlockBuilder
-
Sets the tests defined by the test block.
- setType(HookType) - Method in class org.forgerock.cuppa.model.HookBuilder
-
Sets the type of the hook.
- setType(TestBlockType) - Method in class org.forgerock.cuppa.model.TestBlockBuilder
-
Set the type of the test block.
- shouldRun(Collection<String>) - Method in class org.forgerock.cuppa.transforms.expression.AndCondition
-
- shouldRun(Collection<String>) - Method in interface org.forgerock.cuppa.transforms.expression.Condition
-
Check if the list of tags is compliant with the condition.
- shouldRun(Collection<String>) - Method in class org.forgerock.cuppa.transforms.expression.ContainsCondition
-
- shouldRun(Collection<String>) - Method in class org.forgerock.cuppa.transforms.expression.NotCondition
-
- shouldRun(Collection<String>) - Method in class org.forgerock.cuppa.transforms.expression.OrCondition
-
- skip() - Static method in class org.forgerock.cuppa.Cuppa
-
Mark a test or block of tests to be skipped.
- skip() - Method in enum org.forgerock.cuppa.internal.TestContainer
-
Mark a test or block of tests to be skipped.
- skip() - Method in interface org.forgerock.cuppa.TestBuilder
-
Mark a test or block of tests to be skipped.
- start(TestBlock) - Method in class org.forgerock.cuppa.reporters.CompositeReporter
-
- start(TestBlock) - Method in class org.forgerock.cuppa.reporters.DefaultReporter
-
- start(TestBlock) - Method in interface org.forgerock.cuppa.reporters.Reporter
-
Called before any tests are run.
- tags(String...) - Static method in class org.forgerock.cuppa.Cuppa
-
Decorates tests with a set of tags.
- tags(String...) - Method in enum org.forgerock.cuppa.internal.TestContainer
-
Decorates tests with a set of tags.
- Tags - Class in org.forgerock.cuppa.model
-
Encapsulates the tags to be used to filter which tests to be run as a part of the test run.
- Tags(Set<String>, Set<String>, String) - Constructor for class org.forgerock.cuppa.model.Tags
-
Constructs a Tags
instance with the specified tags and anti-tags (excluded tags).
- tags - Variable in class org.forgerock.cuppa.model.Tags
-
The set of tags which tests must be tagged with to be included in the test run.
- tags(Set<String>) - Static method in class org.forgerock.cuppa.model.Tags
-
Constructs a Tags
instance with the specified tags.
- TagsOption - Class in org.forgerock.cuppa.model
-
An option for tagging tests and test blocks.
- TagsOption(Set<String>) - Constructor for class org.forgerock.cuppa.model.TagsOption
-
Create a new tags option.
- TagsRunOption(Tags) - Constructor for class org.forgerock.cuppa.Runner.TagsRunOption
-
Create a new option.
- TagTestBlockFilter - Class in org.forgerock.cuppa.transforms
-
Filters the test tree to only include tests that have tags that match the given run tags, excluding any tests
that have the given excluded run tags.
- TagTestBlockFilter(Tags) - Constructor for class org.forgerock.cuppa.transforms.TagTestBlockFilter
-
Creates a new filter.
- Test - Class in org.forgerock.cuppa.model
-
Models a single test.
- Test - Annotation Type in org.forgerock.cuppa
-
Identifies a class as containing Cuppa tests.
- TestBlock - Class in org.forgerock.cuppa.model
-
Models a collection of tests and/or nested test blocks.
- TestBlockBuilder - Class in org.forgerock.cuppa.model
-
A mutable builder that constructs
TestBlock
instances.
- TestBlockBuilder() - Constructor for class org.forgerock.cuppa.model.TestBlockBuilder
-
- testBlockEnd(TestBlock, List<TestBlock>) - Method in class org.forgerock.cuppa.reporters.CompositeReporter
-
- testBlockEnd(TestBlock, List<TestBlock>) - Method in class org.forgerock.cuppa.reporters.DefaultReporter
-
- testBlockEnd(TestBlock, List<TestBlock>) - Method in interface org.forgerock.cuppa.reporters.Reporter
-
Called after all tests in a test block have completed.
- TestBlockFunction - Interface in org.forgerock.cuppa.functions
-
Implement this interface to define tests within a describe or when block.
- TestBlockRunner - Class in org.forgerock.cuppa.internal
-
Runs the tests within a test block.
- TestBlockRunner(TestBlock, List<TestBlockRunner>, Reporter) - Constructor for class org.forgerock.cuppa.internal.TestBlockRunner
-
Constructs a new test block runner.
- testBlocks - Variable in class org.forgerock.cuppa.model.TestBlock
-
Nested test blocks.
- testBlockStart(TestBlock, List<TestBlock>) - Method in class org.forgerock.cuppa.reporters.CompositeReporter
-
- testBlockStart(TestBlock, List<TestBlock>) - Method in class org.forgerock.cuppa.reporters.DefaultReporter
-
- testBlockStart(TestBlock, List<TestBlock>) - Method in interface org.forgerock.cuppa.reporters.Reporter
-
Called before any tests are run in a test block.
- TestBlockType - Enum in org.forgerock.cuppa.model
-
Models the type of a test block.
- TestBuilder - Class in org.forgerock.cuppa.model
-
A mutable builder that constructs
Test
instances.
- TestBuilder() - Constructor for class org.forgerock.cuppa.model.TestBuilder
-
- TestBuilder - Interface in org.forgerock.cuppa
-
A builder for defining a test or block of tests.
- testClass - Variable in class org.forgerock.cuppa.model.Hook
-
The class that the hook was defined in.
- testClass - Variable in class org.forgerock.cuppa.model.Test
-
The class that the test was defined in.
- testClass - Variable in class org.forgerock.cuppa.model.TestBlock
-
The class that the test block was defined in.
- TestContainer - Enum in org.forgerock.cuppa.internal
-
Singleton container for user-defined tests.
- TestCuppaSupport - Class in org.forgerock.cuppa
-
A collection of static methods for facilitating the writing of tests for Cuppa and its extensions (such as test block
transforms).
- testEnd(Test, List<TestBlock>) - Method in class org.forgerock.cuppa.reporters.CompositeReporter
-
- testEnd(Test, List<TestBlock>) - Method in interface org.forgerock.cuppa.reporters.Reporter
-
Called after a test is run.
- testFail(Test, List<TestBlock>, Throwable) - Method in class org.forgerock.cuppa.reporters.CompositeReporter
-
- testFail(Test, List<TestBlock>, Throwable) - Method in class org.forgerock.cuppa.reporters.DefaultReporter
-
- testFail(Test, List<TestBlock>, Throwable) - Method in interface org.forgerock.cuppa.reporters.Reporter
-
Called after a test has failed due to it throwing an exception.
- TestFunction - Interface in org.forgerock.cuppa.functions
-
Implement this interface to define a test.
- testHookFail(Hook, List<TestBlock>, Test, List<TestBlock>, Throwable) - Method in class org.forgerock.cuppa.reporters.CompositeReporter
-
- testHookFail(Hook, List<TestBlock>, Test, List<TestBlock>, Throwable) - Method in class org.forgerock.cuppa.reporters.DefaultReporter
-
- testHookFail(Hook, List<TestBlock>, Test, List<TestBlock>, Throwable) - Method in interface org.forgerock.cuppa.reporters.Reporter
-
Called when a beforeEach or afterEach hook failed due to it throwing an exception.
- testHookPass(Hook, List<TestBlock>, Test, List<TestBlock>) - Method in class org.forgerock.cuppa.reporters.CompositeReporter
-
- testHookPass(Hook, List<TestBlock>, Test, List<TestBlock>) - Method in interface org.forgerock.cuppa.reporters.Reporter
-
Called after a beforeEach or afterEach hook has successfully executed without throwing an exception.
- testHookStart(Hook, List<TestBlock>, Test, List<TestBlock>) - Method in class org.forgerock.cuppa.reporters.CompositeReporter
-
- testHookStart(Hook, List<TestBlock>, Test, List<TestBlock>) - Method in interface org.forgerock.cuppa.reporters.Reporter
-
Called before a beforeEach or afterEach hook is run.
- TestInstantiator - Interface in org.forgerock.cuppa
-
Instantiates test classes.
- testPass(Test, List<TestBlock>) - Method in class org.forgerock.cuppa.reporters.CompositeReporter
-
- testPass(Test, List<TestBlock>) - Method in class org.forgerock.cuppa.reporters.DefaultReporter
-
- testPass(Test, List<TestBlock>) - Method in interface org.forgerock.cuppa.reporters.Reporter
-
Called after a test has successfully executed without throwing an exception.
- testPending(Test, List<TestBlock>) - Method in class org.forgerock.cuppa.reporters.CompositeReporter
-
- testPending(Test, List<TestBlock>) - Method in class org.forgerock.cuppa.reporters.DefaultReporter
-
- testPending(Test, List<TestBlock>) - Method in interface org.forgerock.cuppa.reporters.Reporter
-
Called when a test cannot be run as it has not yet been implemented.
- tests - Variable in class org.forgerock.cuppa.model.TestBlock
-
Tests defined by the test block.
- testSkip(Test, List<TestBlock>) - Method in class org.forgerock.cuppa.reporters.CompositeReporter
-
- testSkip(Test, List<TestBlock>) - Method in class org.forgerock.cuppa.reporters.DefaultReporter
-
- testSkip(Test, List<TestBlock>) - Method in interface org.forgerock.cuppa.reporters.Reporter
-
Called when a test has been skipped.
- testStart(Test, List<TestBlock>) - Method in class org.forgerock.cuppa.reporters.CompositeReporter
-
- testStart(Test, List<TestBlock>) - Method in interface org.forgerock.cuppa.reporters.Reporter
-
Called before a test is run.
- toBuilder() - Method in class org.forgerock.cuppa.model.Test
-
Creates a
TestBuilder
and initialises it's properties to this
Test
.
- toBuilder() - Method in class org.forgerock.cuppa.model.TestBlock
-
- toString() - Method in class org.forgerock.cuppa.model.Hook
-
- toString() - Method in class org.forgerock.cuppa.model.Option
-
- toString() - Method in class org.forgerock.cuppa.model.Options
-
- toString() - Method in class org.forgerock.cuppa.model.Test
-
- toString() - Method in class org.forgerock.cuppa.model.TestBlock
-
- type - Variable in class org.forgerock.cuppa.model.Hook
-
The type of the hook.
- type - Variable in class org.forgerock.cuppa.model.TestBlock
-
The type of the test block.