IkasanFlowTestRule (Ikasan Test Harness 3.0.0 API)

java.lang.Object
- org.ikasan.testharness.flow.rule.IkasanFlowTestRule

All Implemented Interfaces:

org.junit.rules.TestRule
```
public class IkasanFlowTestRule
extends Object
implements org.junit.rules.TestRule
```
JUnit Rule implementation allowing flow tests to be created and executed using a builder pattern.
The underlying Flow will be automatically stopped and checked when the rule is evaluated at the end of the test

Author:

Ikasan Development Team

Constructor Summary

Constructors
Constructor and Description

IkasanFlowTestRule()

Constructors
Constructor and Description
`IkasanFlowTestRule()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`org.junit.runners.model.Statement`	`apply(org.junit.runners.model.Statement base, org.junit.runner.Description description)` Applies the basic flow test rules: 1.
`void`	`assertIsSatisfied()`
`IkasanFlowTestRule`	`blockEnd()` Close the current block of repeated components
`IkasanFlowTestRule`	`blockStart()` Start a block of repeated components
`IkasanFlowTestRule`	`broker(String name)` Expect a broker
`IkasanFlowTestRule`	`consumer(String name)` Expect a consumer
`IkasanFlowTestRule`	`converter(String name)` Expect a converter
`IkasanFlowTestRule`	`filter(String name)` Expect a filter
`void`	`fireScheduledConsumer()` Invoke the scheduled consumer via its triggerSchedulerNow method
`void`	`fireScheduledConsumerSynchronously(org.quartz.JobExecutionContext jobExecutionContext)` Invoke the scheduled consumer with a given JobExecutionContext (can be mocked).
`Object`	`getComponent(String componentName)` Gets component of given name from this flow.
`<T> T`	`getComponentConfig(String componentName, Class<T> classType)` Gets configuration of component with given name from this flow.
`String`	`getFlowState()`
`IkasanFlowTestRule`	`multiRecipientRouter(String name)` Expect a MultiRecipientRouter
`void`	`pauseFlow()` Pause a running flow.
`IkasanFlowTestRule`	`producer(String name)` Expect a producer
`IkasanFlowTestRule`	`repeat(int n)` Repeat the current block n times;
`void`	`resumeFlow()` Resume a paused flow.
`IkasanFlowTestRule`	`router(String name)` Expect a SingleRecipientRouter
`IkasanFlowTestRule`	`scheduledConsumer(String name)` Expect a consumer
`IkasanFlowTestRule`	`sequencer(String name)` Expect a sequencer
`void`	`sleep(long time)` Sleep for a bit to let a flow execution complete
`IkasanFlowTestRule`	`splitter(String name)` Expect a splitter
`void`	`startFlow()` Setup the flow expectations and start the given flow.
`void`	`startFlow(FlowSubject testHarnessFlowEventListener)` Setup the flow expectations and start the given flow.
`void`	`startPauseFlow()` Setup the flow expectations and start and pause the given flow.
`void`	`stopFlow()`
`IkasanFlowTestRule`	`translator(String name)` Expect a translator
`IkasanFlowTestRule`	`withErrorEndState()` Indicate the flow end state will be 'stoppedInError', used in negative testing
`IkasanFlowTestRule`	`withFlow(Flow flow)` Set the flow which this Rule will check

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

- Constructor Detail
  - IkasanFlowTestRule
```
public IkasanFlowTestRule()
```
- Method Detail
  - apply
```
public org.junit.runners.model.Statement apply(org.junit.runners.model.Statement base,
                                               org.junit.runner.Description description)
```
    Applies the basic flow test rules: 1. Stop the flow and assert it is stopped; or stoppedInError if withErrorEndState() was called when building 2. Assert the flowTestHarness for component invocation completeness
    
    Specified by:
    
    apply in interface org.junit.rules.TestRule
    
    Parameters:
    
    base - a base Statement
    
    description - a Description (not used)
    
    Returns:
    
    a Statement, wrapping the provided instance, that can be evaluated by JUnit
  - withFlow
```
public IkasanFlowTestRule withFlow(Flow flow)
```
    Set the flow which this Rule will check
    
    Parameters:
    
    flow - the Flow
    
    Returns:
    
    this rule
  - withErrorEndState
```
public IkasanFlowTestRule withErrorEndState()
```
    Indicate the flow end state will be 'stoppedInError', used in negative testing
    
    Returns:
    
    this rule
  - consumer
```
public IkasanFlowTestRule consumer(String name)
```
    Expect a consumer
    
    Parameters:
    
    name - the consumer name
    
    Returns:
    
    this rule
  - scheduledConsumer
```
public IkasanFlowTestRule scheduledConsumer(String name)
```
    Expect a consumer
    
    Parameters:
    
    name - the consumer name
    
    Returns:
    
    this rule
  - splitter
```
public IkasanFlowTestRule splitter(String name)
```
    Expect a splitter
    
    Parameters:
    
    name - the splitter name
    
    Returns:
    
    this rule
  - converter
```
public IkasanFlowTestRule converter(String name)
```
    Expect a converter
    
    Parameters:
    
    name - the converter name
    
    Returns:
    
    this rule
  - producer
```
public IkasanFlowTestRule producer(String name)
```
    Expect a producer
    
    Parameters:
    
    name - the producer name
    
    Returns:
    
    this rule
  - router
```
public IkasanFlowTestRule router(String name)
```
    Expect a SingleRecipientRouter
    
    Parameters:
    
    name - the router name
    
    Returns:
    
    this rule
  - multiRecipientRouter
```
public IkasanFlowTestRule multiRecipientRouter(String name)
```
    Expect a MultiRecipientRouter
    
    Parameters:
    
    name - the MRR name
    
    Returns:
    
    this rule
  - translator
```
public IkasanFlowTestRule translator(String name)
```
    Expect a translator
    
    Parameters:
    
    name - the translator name
    
    Returns:
    
    this rule
  - broker
```
public IkasanFlowTestRule broker(String name)
```
    Expect a broker
    
    Parameters:
    
    name - the broker name
    
    Returns:
    
    this rule
  - filter
```
public IkasanFlowTestRule filter(String name)
```
    Expect a filter
    
    Parameters:
    
    name - the filter name
    
    Returns:
    
    this rule
  - sequencer
```
public IkasanFlowTestRule sequencer(String name)
```
    Expect a sequencer
    
    Parameters:
    
    name - the sequencer name
    
    Returns:
    
    this rule
  - blockStart
```
public IkasanFlowTestRule blockStart()
```
    Start a block of repeated components
    
    Returns:
    
    this rule
  - blockEnd
```
public IkasanFlowTestRule blockEnd()
```
    Close the current block of repeated components
    
    Returns:
    
    this rule
  - repeat
```
public IkasanFlowTestRule repeat(int n)
```
    Repeat the current block n times;
    
    Parameters:
    
    n - number of times to repeat the block
    
    Returns:
    
    this rule
  - fireScheduledConsumer
```
public void fireScheduledConsumer()
```
    Invoke the scheduled consumer via its triggerSchedulerNow method
    This method executes the underlying Job asynchronously
  - fireScheduledConsumerSynchronously
```
public void fireScheduledConsumerSynchronously(org.quartz.JobExecutionContext jobExecutionContext)
```
    Invoke the scheduled consumer with a given JobExecutionContext (can be mocked). This method executes synchronously - when the flow finished executing the given task this method will then return.
    
    Parameters:
    
    jobExecutionContext - a JobExecutionContext
  - startFlow
```
public void startFlow(FlowSubject testHarnessFlowEventListener)
```
    Setup the flow expectations and start the given flow.
    
    Parameters:
    
    testHarnessFlowEventListener - the test harness flow listener
  - startFlow
```
public void startFlow()
```
    Setup the flow expectations and start the given flow.
  - startPauseFlow
```
public void startPauseFlow()
```
    Setup the flow expectations and start and pause the given flow.
  - resumeFlow
```
public void resumeFlow()
```
    Resume a paused flow.
  - pauseFlow
```
public void pauseFlow()
```
    Pause a running flow.
  - stopFlow
```
public void stopFlow()
```
  - assertIsSatisfied
```
public void assertIsSatisfied()
```
  - getFlowState
```
public String getFlowState()
```
  - getComponent
```
public Object getComponent(String componentName)
```
    Gets component of given name from this flow.
    
    Parameters:
    
    componentName - component name to be looked up in flow
    
    Returns:
    
    component as Object
  - getComponentConfig
```
public <T> T getComponentConfig(String componentName,
                                Class<T> classType)
```
    Gets configuration of component with given name from this flow.
    
    Parameters:
    
    componentName - component name to be looked up in flow
    
    classType - class Type to configuration object
    
    Returns:
    
    configuration object casted to T
  - sleep
```
public void sleep(long time)
```
    Sleep for a bit to let a flow execution complete
    
    Parameters:
    
    time - the number of milliseconds to sleep for

Class IkasanFlowTestRule

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IkasanFlowTestRule

Method Detail

apply

withFlow

withErrorEndState

consumer

scheduledConsumer

splitter

converter

producer

router

multiRecipientRouter

translator

broker

filter

sequencer

blockStart

blockEnd

repeat

fireScheduledConsumer

fireScheduledConsumerSynchronously

startFlow

startFlow

startPauseFlow

resumeFlow

pauseFlow

stopFlow

assertIsSatisfied

getFlowState

getComponent

getComponentConfig

sleep