IkasanStandaloneFlowTestRule (Ikasan Test Harness 3.0.0 API)

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

All Implemented Interfaces:

org.junit.rules.TestRule
```
public class IkasanStandaloneFlowTestRule
extends Object
implements org.junit.rules.TestRule
```
JUnit Rule implementation allowing flow tests to be created and executed using a builder pattern.
The rule will take care of starting up spring context bases on IkasanApplicationFactory and Application class provided in constructor.
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
`IkasanStandaloneFlowTestRule(String flowUnderTest, Class<?> applicationClass)`
`IkasanStandaloneFlowTestRule(String flowUnderTest, Class<?> applicationClass, String[] args)`
`IkasanStandaloneFlowTestRule(String flowUnderTest, IkasanApplication ikasanApplication)`

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`	`assertFlowComponentExecution()`
`IkasanStandaloneFlowTestRule`	`blockEnd()` Close the current block of repeated components
`IkasanStandaloneFlowTestRule`	`blockStart()` Start a block of repeated components
`IkasanStandaloneFlowTestRule`	`broker(String name)` Expect a broker
`IkasanStandaloneFlowTestRule`	`consumer(String name)` Expect a consumer
`IkasanStandaloneFlowTestRule`	`converter(String name)` Expect a converter
`IkasanStandaloneFlowTestRule`	`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.
`IkasanApplication`	`getIkasanApplication()`
`IkasanStandaloneFlowTestRule`	`multiRecipientRouter(String name)` Expect a MultiRecipientRouter
`IkasanStandaloneFlowTestRule`	`producer(String name)` Expect a producer
`IkasanStandaloneFlowTestRule`	`repeat(int n)` Repeat the current block n times;
`IkasanStandaloneFlowTestRule`	`router(String name)` Expect a SingleRecipientRouter
`IkasanStandaloneFlowTestRule`	`scheduledConsumer(String name)` Expect a consumer
`IkasanStandaloneFlowTestRule`	`sequencer(String name)` Expect a sequencer
`void`	`sleep(long time)` Sleep for a bit to let a flow execution complete
`IkasanStandaloneFlowTestRule`	`splitter(String name)` Expect a splitter
`void`	`startFlow()` Setup the flow expectations, make sure that testHarness listener is attached to flow and start the given flow.
`IkasanStandaloneFlowTestRule`	`translator(String name)` Expect a translator
`IkasanStandaloneFlowTestRule`	`withErrorEndState()` Indicate the flow end state will be 'stoppedInError', used in negative testing
`IkasanStandaloneFlowTestRule`	`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
  - IkasanStandaloneFlowTestRule
```
public IkasanStandaloneFlowTestRule(String flowUnderTest,
                                    Class<?> applicationClass)
```
  - IkasanStandaloneFlowTestRule
```
public IkasanStandaloneFlowTestRule(String flowUnderTest,
                                    Class<?> applicationClass,
                                    String[] args)
```
  - IkasanStandaloneFlowTestRule
```
public IkasanStandaloneFlowTestRule(String flowUnderTest,
                                    IkasanApplication ikasanApplication)
```
- 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
  - assertFlowComponentExecution
```
public void assertFlowComponentExecution()
```
  - withFlow
```
public IkasanStandaloneFlowTestRule withFlow(Flow flow)
```
    Set the flow which this Rule will check
    
    Parameters:
    
    flow - the Flow
    
    Returns:
    
    this rule
  - withErrorEndState
```
public IkasanStandaloneFlowTestRule withErrorEndState()
```
    Indicate the flow end state will be 'stoppedInError', used in negative testing
    
    Returns:
    
    this rule
  - consumer
```
public IkasanStandaloneFlowTestRule consumer(String name)
```
    Expect a consumer
    
    Parameters:
    
    name - the consumer name
    
    Returns:
    
    this rule
  - scheduledConsumer
```
public IkasanStandaloneFlowTestRule scheduledConsumer(String name)
```
    Expect a consumer
    
    Parameters:
    
    name - the consumer name
    
    Returns:
    
    this rule
  - splitter
```
public IkasanStandaloneFlowTestRule splitter(String name)
```
    Expect a splitter
    
    Parameters:
    
    name - the splitter name
    
    Returns:
    
    this rule
  - converter
```
public IkasanStandaloneFlowTestRule converter(String name)
```
    Expect a converter
    
    Parameters:
    
    name - the converter name
    
    Returns:
    
    this rule
  - producer
```
public IkasanStandaloneFlowTestRule producer(String name)
```
    Expect a producer
    
    Parameters:
    
    name - the producer name
    
    Returns:
    
    this rule
  - router
```
public IkasanStandaloneFlowTestRule router(String name)
```
    Expect a SingleRecipientRouter
    
    Parameters:
    
    name - the router name
    
    Returns:
    
    this rule
  - multiRecipientRouter
```
public IkasanStandaloneFlowTestRule multiRecipientRouter(String name)
```
    Expect a MultiRecipientRouter
    
    Parameters:
    
    name - the MRR name
    
    Returns:
    
    this rule
  - translator
```
public IkasanStandaloneFlowTestRule translator(String name)
```
    Expect a translator
    
    Parameters:
    
    name - the translator name
    
    Returns:
    
    this rule
  - broker
```
public IkasanStandaloneFlowTestRule broker(String name)
```
    Expect a broker
    
    Parameters:
    
    name - the broker name
    
    Returns:
    
    this rule
  - filter
```
public IkasanStandaloneFlowTestRule filter(String name)
```
    Expect a filter
    
    Parameters:
    
    name - the filter name
    
    Returns:
    
    this rule
  - sequencer
```
public IkasanStandaloneFlowTestRule sequencer(String name)
```
    Expect a sequencer
    
    Parameters:
    
    name - the sequencer name
    
    Returns:
    
    this rule
  - blockStart
```
public IkasanStandaloneFlowTestRule blockStart()
```
    Start a block of repeated components
    
    Returns:
    
    this rule
  - blockEnd
```
public IkasanStandaloneFlowTestRule blockEnd()
```
    Close the current block of repeated components
    
    Returns:
    
    this rule
  - repeat
```
public IkasanStandaloneFlowTestRule 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()
```
    Setup the flow expectations, make sure that testHarness listener is attached to flow and start the given flow.
  - 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
  - getIkasanApplication
```
public IkasanApplication getIkasanApplication()
```

Class IkasanStandaloneFlowTestRule

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IkasanStandaloneFlowTestRule

IkasanStandaloneFlowTestRule

IkasanStandaloneFlowTestRule

Method Detail

apply

assertFlowComponentExecution

withFlow

withErrorEndState

consumer

scheduledConsumer

splitter

converter

producer

router

multiRecipientRouter

translator

broker

filter

sequencer

blockStart

blockEnd

repeat

fireScheduledConsumer

fireScheduledConsumerSynchronously

startFlow

getComponent

getComponentConfig

sleep

getIkasanApplication