org.mule.functional.api.flow

Class FlowRunner

java.lang.Object

org.mule.functional.api.flow.FlowConstructRunner<FlowRunner>

org.mule.functional.api.flow.FlowRunner

All Implemented Interfaces:

org.mule.runtime.api.lifecycle.Disposable

public class FlowRunner
extends FlowConstructRunner<FlowRunner>

Provides a fluent API for running events through flows.

This runner is not thread-safe.

Field Summary

Fields inherited from class org.mule.functional.api.flow.FlowConstructRunner

eventBuilder, registry

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

PHASE_NAME

Constructor Summary

Constructors

Constructor and Description
FlowRunner(org.mule.runtime.api.artifact.Registry registry, 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(org.mule.runtime.api.scheduler.Scheduler scheduler) 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
CoreEvent	run() Runs the specified flow with the provided event and configuration, and performs a FlowAssert#verify(String)) afterwards.
CoreEvent	runAndVerify(String... flowNamesToVerify) Runs the specified flow with the provided event and configuration, and performs a FlowAssert#verify(String)) for each flowNamesToVerify afterwards.
Exception	runExpectingException() Runs the specified flow with the provided event and configuration expecting a failure.
void	runExpectingException(ErrorTypeMatcher matcher) Runs the specified flow with the provided event and configuration expecting a failure with an error type that matches the given matcher.
void	runExpectingException(ErrorTypeMatcher matcher, org.hamcrest.Matcher<CoreEvent> errorEventMatcher) Runs the specified flow with the provided event and configuration expecting a failure with an CoreEvent that matches the given errorEventMatcher.
void	runExpectingException(EventMatcher errorEventMatcher) Runs the specified flow with the provided event and configuration expecting a failure with an CoreEvent that matches the given errorEventMatcher.
void	runExpectingException(org.hamcrest.Matcher<Throwable> causeMatcher) Runs the specified flow with the provided event and configuration expecting a failure with a cause that matches the given matcher.
void	runExpectingException(org.hamcrest.Matcher<Throwable> causeMatcher, org.hamcrest.Matcher<CoreEvent> errorEventMatcher) Runs the specified flow with the provided event and configuration expecting a failure with an CoreEvent that matches the given errorEventMatcher.
CoreEvent	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.api.flow.FlowConstructRunner

buildEvent, getFlowConstruct, getOrBuildEvent, reset, spyObjects, withAttributes, withCorrelation, withInboundAttachment, withInboundProperties, withInboundProperty, withItemSequenceInfo, 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(org.mule.runtime.api.artifact.Registry registry,
                  String flowName)

Initializes this flow runner.

Parameters:

registry - the registry for the currently running test

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:

SchedulerService}

run

public CoreEvent 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 CoreEvent 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 CoreEvent 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(org.mule.runtime.api.scheduler.Scheduler scheduler)
                   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 Exception 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 processing exception return by the flow

Throws:

Exception

runExpectingException

public void runExpectingException(ErrorTypeMatcher matcher)
                           throws Exception

Runs the specified flow with the provided event and configuration expecting a failure with an error type that matches the given matcher.

Will fail if there's no failure running the flow.

Throws:

Exception

runExpectingException

public void runExpectingException(org.hamcrest.Matcher<Throwable> causeMatcher)
                           throws Exception

Runs the specified flow with the provided event and configuration expecting a failure with a cause that matches the given matcher.

Will fail if there's no failure running the flow.

Throws:

Exception

runExpectingException

public void runExpectingException(EventMatcher errorEventMatcher)
                           throws Exception

Runs the specified flow with the provided event and configuration expecting a failure with an CoreEvent that matches the given errorEventMatcher.

Will fail if there's no failure running the flow.

Throws:

Exception

runExpectingException

public void runExpectingException(ErrorTypeMatcher matcher,
                                  org.hamcrest.Matcher<CoreEvent> errorEventMatcher)
                           throws Exception

Runs the specified flow with the provided event and configuration expecting a failure with an CoreEvent that matches the given errorEventMatcher.

Will fail if there's no failure running the flow.

Throws:

Exception

runExpectingException

public void runExpectingException(org.hamcrest.Matcher<Throwable> causeMatcher,
                                  org.hamcrest.Matcher<CoreEvent> errorEventMatcher)
                           throws Exception

Runs the specified flow with the provided event and configuration expecting a failure with an CoreEvent that matches the given errorEventMatcher.

Will fail if there's no failure running 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

Overrides:

dispose in class FlowConstructRunner<FlowRunner>