org.mule.functional.junit4

Class FlowRunner

java.lang.Object

org.mule.functional.junit4.FlowConstructRunner<FlowRunner>

org.mule.functional.junit4.FlowRunner

All Implemented Interfaces:

org.mule.runtime.api.lifecycle.Disposable

public class FlowRunner
extends FlowConstructRunner<FlowRunner>
implements org.mule.runtime.api.lifecycle.Disposable

Provides a fluent API for running events through flows.

This runner is not thread-safe.

Field Summary

Fields inherited from class org.mule.functional.junit4.FlowConstructRunner

eventBuilder, muleContext

Fields inherited from interface org.mule.runtime.api.lifecycle.Disposable

PHASE_NAME

Constructor Summary

Constructors

Constructor and Description
FlowRunner(MuleContext muleContext, String flowName) Initializes this flow runner.

Method Summary

Modifier and Type	Method and Description
void	dispatch() Dispatches to the specified flow with the provided event and configuration, and performs a FlowAssert#verify(String)) afterwards.
void	dispatchAsync() Dispatches to the specified flow with the provided event and configuration in a new IO thread, and performs a FlowAssert#verify(String)) afterwards.
void	dispose()
String	getFlowConstructName()
FlowRunner	keepStreamsOpen() Makes all open cursors to not be closed when the executed flow is finished but when the test is disposed
Event	run() Runs the specified flow with the provided event and configuration, and performs a FlowAssert#verify(String)) afterwards.
Event	runAndVerify(String... flowNamesToVerify) Runs the specified flow with the provided event and configuration, and performs a FlowAssert#verify(String)) for each flowNamesToVerify afterwards.
MessagingException	runExpectingException() Runs the specified flow with the provided event and configuration expecting a failure.
Event	runNoVerify() Runs the specified flow with the provided event and configuration.
FlowRunner	transactionally(TransactionConfigEnum action, TransactionFactory factory) Configures the flow to run inside a transaction.
FlowRunner	withScheduler(org.mule.runtime.api.scheduler.Scheduler scheduler) Run Flow as a task of a given Scheduler.

Methods inherited from class org.mule.functional.junit4.FlowConstructRunner

buildEvent, getFlowConstruct, getOrBuildEvent, reset, spyObjects, withAttributes, withCorrelation, withInboundAttachment, withInboundProperties, withInboundProperty, withMediaType, withOutboundProperty, withPayload, withSessionProperty, withSourceCorrelationId, withVariable, withVariable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FlowRunner

public FlowRunner(MuleContext muleContext,
                  String flowName)

Initializes this flow runner.

Parameters:

muleContext - the context of the mule application

flowName - the name of the flow to run events through

Method Detail

transactionally

public FlowRunner transactionally(TransactionConfigEnum action,
                                  TransactionFactory factory)

Configures the flow to run inside a transaction.

Parameters:

action - The action to do at the start of the transactional block. See TransactionConfig constants.

factory - See MuleTransactionConfig.setFactory(TransactionFactory).

Returns:

this FlowRunner

keepStreamsOpen

public FlowRunner keepStreamsOpen()

Makes all open cursors to not be closed when the executed flow is finished but when the test is disposed

Returns:

this FlowRunner

withScheduler

public FlowRunner withScheduler(org.mule.runtime.api.scheduler.Scheduler scheduler)

Run Flow as a task of a given Scheduler.

Parameters:

scheduler - the scheduler to use to run the Flow.

Returns:

this FlowRunner

See Also:

org.mule.runtime.core.api.scheduler.SchedulerService}

run

public Event run()
          throws Exception

Runs the specified flow with the provided event and configuration, and performs a FlowAssert#verify(String)) afterwards.

If this is called multiple times, the same event will be sent. To force the creation of a new event, use FlowConstructRunner.reset().

Returns:

the resulting MuleEvent

Throws:

Exception

runNoVerify

public Event runNoVerify()
                  throws Exception

Runs the specified flow with the provided event and configuration.

If this is called multiple times, the same event will be sent. To force the creation of a new event, use FlowConstructRunner.reset().

Returns:

the resulting MuleEvent

Throws:

Exception

runAndVerify

public Event runAndVerify(String... flowNamesToVerify)
                   throws Exception

Runs the specified flow with the provided event and configuration, and performs a FlowAssert#verify(String)) for each flowNamesToVerify afterwards.

If this is called multiple times, the same event will be sent. To force the creation of a new event, use FlowConstructRunner.reset().

Parameters:

flowNamesToVerify - the names of the flows to FlowAssert#verify(String)) afterwards.

Returns:

the resulting MuleEvent

Throws:

Exception

dispatch

public void dispatch()
              throws Exception

Dispatches to the specified flow with the provided event and configuration, and performs a FlowAssert#verify(String)) afterwards.

If this is called multiple times, the same event will be sent. To force the creation of a new event, use FlowConstructRunner.reset().

Dispatch behaves differently to run() in that it does not propagate any exceptions to the test case or return a result.

Throws:

Exception

dispatchAsync

public void dispatchAsync()
                   throws Exception

Dispatches to the specified flow with the provided event and configuration in a new IO thread, and performs a FlowAssert#verify(String)) afterwards.

If this is called multiple times, the same event will be sent. To force the creation of a new event, use FlowConstructRunner.reset().

Dispatch behaves differently to run() in that it does not propagate any exceptions to the test case or return a result.

Throws:

Exception

runExpectingException

public MessagingException runExpectingException()
                                         throws Exception

Runs the specified flow with the provided event and configuration expecting a failure. Will fail if there's no failure running the flow.

Returns:

the message exception return by the flow

Throws:

Exception

getFlowConstructName

public String getFlowConstructName()

Specified by:

getFlowConstructName in class FlowConstructRunner<FlowRunner>

Returns:

the name of the FlowConstruct to use.

dispose

public void dispose()

Specified by:

dispose in interface org.mule.runtime.api.lifecycle.Disposable