org.mule.munit.runner.flow

Class TestFlow

java.lang.Object

org.mule.runtime.api.component.AbstractComponent

org.mule.runtime.core.privileged.component.AbstractExecutableComponent

org.mule.runtime.core.privileged.processor.CompositeProcessorChainRouter

org.mule.munit.runner.flow.TestFlow

All Implemented Interfaces:

TestComponent, org.mule.runtime.api.component.Component, org.mule.runtime.api.component.execution.ExecutableComponent, org.mule.runtime.api.lifecycle.Disposable, org.mule.runtime.api.lifecycle.Initialisable, org.mule.runtime.api.lifecycle.Lifecycle, org.mule.runtime.api.lifecycle.Startable, org.mule.runtime.api.lifecycle.Stoppable

public class TestFlow
extends org.mule.runtime.core.privileged.processor.CompositeProcessorChainRouter
implements TestComponent

The Test Flow

Since:

1.0.0

Author:

Mulesoft Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	TestFlow.ExceptionAwareCallable

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	logger
static String	MUNIT_TEST_TIMEOUT_PROPERTY
protected Optional<MunitModule>	munitModule

Fields inherited from class org.mule.runtime.core.privileged.component.AbstractExecutableComponent

muleContext

Fields inherited from class org.mule.runtime.api.component.AbstractComponent

LOCATION_KEY, ROOT_CONTAINER_NAME_KEY

Fields inherited from interface org.mule.runtime.api.component.Component

ANNOTATIONS_PROPERTY_NAME

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

PHASE_NAME

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

PHASE_NAME

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

PHASE_NAME

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

PHASE_NAME

Constructor Summary

Constructors

Constructor and Description
TestFlow()

Method Summary

Modifier and Type	Method and Description
void	addProcessingStrategy(String childName, org.mule.runtime.core.api.processor.strategy.ProcessingStrategy processingStrategy)
void	dispose()
protected org.mule.runtime.api.event.Event	doExecute(org.mule.runtime.api.event.Event event)
protected Boolean	evaluateExpectException(org.mule.runtime.api.event.Event event)
protected Boolean	exceptionMatches(Throwable exception)
String	getDescription()
EnableFlowSources	getEnableFlowSources()
String	getExpectedErrorDescription()
String	getExpectedErrorType()
String	getExpectedException()
String	getName()
Set<String>	getTags()
Integer	getTimeOut()
void	initialise()
protected boolean	isErrorDescriptionExpected(org.mule.runtime.api.message.Error error)
protected boolean	isErrorIdExpected(org.mule.runtime.api.event.Event exceptionEvent)
protected boolean	isExceptionExpected(Throwable exception, org.mule.runtime.api.event.Event exceptionEvent)
protected boolean	isExpectingFailure() Validates if this Test is expecting to fail
boolean	isIgnored()
protected List<org.mule.runtime.core.api.processor.ReactiveProcessor>	processorChainsToExecute(List<org.mule.runtime.core.privileged.processor.chain.MessageProcessorChain> chains) We override this method that is present since Mule Version 4.2.0.
org.mule.runtime.api.event.Event	run(org.mule.runtime.api.event.Event event)
void	setDescription(String description)
void	setEnableFlowSources(EnableFlowSources enableFlowSources)
protected void	setErrorTypeRepository(org.mule.runtime.api.exception.ErrorTypeRepository errorTypeRepository)
void	setExpectedErrorDescription(String expectedErrorDescription)
void	setExpectedErrorType(String expectedErrorType)
void	setExpectedException(String expectedException)
protected void	setExtendedExpressionManager(org.mule.runtime.core.api.el.ExtendedExpressionManager extendedExpressionManager)
void	setIgnore(String ignore)
protected void	setSchedulerService(org.mule.runtime.api.scheduler.SchedulerService schedulerService)
void	setTags(String tags)
void	setTimeOut(Integer timeout)
void	setUp()
void	start()
void	startFlowSources()
void	stop()
void	stopFlowSources()
void	tearDown()
protected Optional<org.junit.ComparisonFailure>	validateExpected(org.mule.runtime.api.message.Error error, org.mule.runtime.api.event.Event exceptionEvent) Validates if the MUnit Test Flow is expecting this specific exception

Methods inherited from class org.mule.runtime.core.privileged.processor.CompositeProcessorChainRouter

getExecutableFunction, setMuleContext, setProcessorChains

Methods inherited from class org.mule.runtime.core.privileged.component.AbstractExecutableComponent

createChildEventContext, createEventContext, execute, execute

Methods inherited from class org.mule.runtime.api.component.AbstractComponent

getAnnotation, getAnnotations, getLocation, getRootContainerLocation, setAnnotations

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mule.runtime.api.component.Component

getAnnotation, getAnnotations, getLocation, getRootContainerLocation, setAnnotations

Field Detail

MUNIT_TEST_TIMEOUT_PROPERTY

public static final String MUNIT_TEST_TIMEOUT_PROPERTY

See Also:

Constant Field Values

logger

protected static final transient org.slf4j.Logger logger

munitModule

@Inject
protected Optional<MunitModule> munitModule

Constructor Detail

TestFlow

public TestFlow()

Method Detail

isIgnored

public boolean isIgnored()

Specified by:

isIgnored in interface TestComponent

setIgnore

public void setIgnore(String ignore)

getExpectedErrorType

public String getExpectedErrorType()

setExpectedErrorType

public void setExpectedErrorType(String expectedErrorType)

getExpectedException

public String getExpectedException()

setExpectedException

public void setExpectedException(String expectedException)

getExpectedErrorDescription

public String getExpectedErrorDescription()

setExpectedErrorDescription

public void setExpectedErrorDescription(String expectedErrorDescription)

setTimeOut

public void setTimeOut(Integer timeout)

getTimeOut

public Integer getTimeOut()

getTags

public Set<String> getTags()

Specified by:

getTags in interface TestComponent

setTags

public void setTags(String tags)

getDescription

public String getDescription()

Specified by:

getDescription in interface TestComponent

setDescription

public void setDescription(String description)

getEnableFlowSources

public EnableFlowSources getEnableFlowSources()

setEnableFlowSources

public void setEnableFlowSources(EnableFlowSources enableFlowSources)

getName

public String getName()

Specified by:

getName in interface TestComponent

run

public org.mule.runtime.api.event.Event run(org.mule.runtime.api.event.Event event)
                                     throws Throwable

Specified by:

run in interface TestComponent

Throws:

Throwable

setUp

public void setUp()

Specified by:

setUp in interface TestComponent

tearDown

public void tearDown()

Specified by:

tearDown in interface TestComponent

startFlowSources

public void startFlowSources()

stopFlowSources

public void stopFlowSources()

doExecute

protected org.mule.runtime.api.event.Event doExecute(org.mule.runtime.api.event.Event event)
                                              throws InterruptedException,
                                                     ExecutionException

Throws:

InterruptedException

ExecutionException

isExpectingFailure

protected boolean isExpectingFailure()

Validates if this Test is expecting to fail

Returns:

false, if no errorId nor exception are being expected

validateExpected

protected Optional<org.junit.ComparisonFailure> validateExpected(org.mule.runtime.api.message.Error error,
                                                                 org.mule.runtime.api.event.Event exceptionEvent)
                                                          throws org.mule.munit.common.exception.MunitError

Validates if the MUnit Test Flow is expecting this specific exception

Parameters:

error - the error inside the Event

exceptionEvent - the event coming with the exception

Returns:

false, is no failure was expected of if the exception does not matches the failure cause expected

Throws:

org.mule.munit.common.exception.MunitError - in case of major internal error

isErrorIdExpected

protected boolean isErrorIdExpected(org.mule.runtime.api.event.Event exceptionEvent)
                             throws org.mule.munit.common.exception.MunitError

Throws:

org.mule.munit.common.exception.MunitError

isExceptionExpected

protected boolean isExceptionExpected(Throwable exception,
                                      org.mule.runtime.api.event.Event exceptionEvent)
                               throws org.mule.munit.common.exception.MunitError

Throws:

org.mule.munit.common.exception.MunitError

isErrorDescriptionExpected

protected boolean isErrorDescriptionExpected(org.mule.runtime.api.message.Error error)
                                      throws org.mule.munit.common.exception.MunitError

Throws:

org.mule.munit.common.exception.MunitError

evaluateExpectException

protected Boolean evaluateExpectException(org.mule.runtime.api.event.Event event)
                                   throws org.mule.munit.common.exception.MunitError

Throws:

org.mule.munit.common.exception.MunitError

exceptionMatches

protected Boolean exceptionMatches(Throwable exception)
                            throws org.mule.munit.common.exception.MunitError

Throws:

org.mule.munit.common.exception.MunitError

setErrorTypeRepository

protected void setErrorTypeRepository(org.mule.runtime.api.exception.ErrorTypeRepository errorTypeRepository)

setExtendedExpressionManager

protected void setExtendedExpressionManager(org.mule.runtime.core.api.el.ExtendedExpressionManager extendedExpressionManager)

setSchedulerService

protected void setSchedulerService(org.mule.runtime.api.scheduler.SchedulerService schedulerService)

addProcessingStrategy

public void addProcessingStrategy(String childName,
                                  org.mule.runtime.core.api.processor.strategy.ProcessingStrategy processingStrategy)

initialise

public void initialise()
                throws org.mule.runtime.api.lifecycle.InitialisationException

Specified by:

initialise in interface org.mule.runtime.api.lifecycle.Initialisable

Overrides:

initialise in class org.mule.runtime.core.privileged.processor.CompositeProcessorChainRouter

Throws:

org.mule.runtime.api.lifecycle.InitialisationException

start

public void start()
           throws org.mule.runtime.api.exception.MuleException

Specified by:

start in interface org.mule.runtime.api.lifecycle.Startable

Overrides:

start in class org.mule.runtime.core.privileged.processor.CompositeProcessorChainRouter

Throws:

org.mule.runtime.api.exception.MuleException

stop

public void stop()
          throws org.mule.runtime.api.exception.MuleException

Specified by:

stop in interface org.mule.runtime.api.lifecycle.Stoppable

Overrides:

stop in class org.mule.runtime.core.privileged.processor.CompositeProcessorChainRouter

Throws:

org.mule.runtime.api.exception.MuleException

dispose

public void dispose()

Specified by:

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

Overrides:

dispose in class org.mule.runtime.core.privileged.processor.CompositeProcessorChainRouter

processorChainsToExecute

protected List<org.mule.runtime.core.api.processor.ReactiveProcessor> processorChainsToExecute(List<org.mule.runtime.core.privileged.processor.chain.MessageProcessorChain> chains)

We override this method that is present since Mule Version 4.2.0. When MUnit has a minMuleVersion 4.2.0, we can remove the reflection from this method and use the proper override annotation.