org.flowable.engine.test

Class FlowableExtension

java.lang.Object

org.flowable.engine.test.FlowableExtension

All Implemented Interfaces:

org.junit.jupiter.api.extension.AfterEachCallback, org.junit.jupiter.api.extension.BeforeEachCallback, org.junit.jupiter.api.extension.Extension, org.junit.jupiter.api.extension.ParameterResolver

public class FlowableExtension
extends Object
implements org.junit.jupiter.api.extension.ParameterResolver, org.junit.jupiter.api.extension.BeforeEachCallback, org.junit.jupiter.api.extension.AfterEachCallback

JUnit Jupiter extension for the Flowable ProcessEngine and services initialization.

Usage:

 @FlowableTest
 class YourTest {

   @BeforeEach
   void setUp(ProcessEngine processEngine) {
       ...
   }

   @Test
   void myTest(RuntimeService runtimeService) {
       ...
   }

   ...
 }
 

The ProcessEngine and the services will be made available to the test class through the parameter resolution (BeforeEach, AfterEach, test methods). The ProcessEngine will be initialized by default with the flowable.cfg.xml resource on the classpath. To specify a different configuration file, annotate your class witn ConfigurationResource. Process engines will be cached as part of the JUnit Jupiter Extension context. Right before the first time the setUp is called for a given configuration resource, the process engine will be constructed.

You can declare a deployment with the Deployment annotation. This extension will make sure that this deployment gets deployed before the setUp and cascade deleted after the tearDown. The id of the deployment can be accessed by using DeploymentId in a test method.

can be used to set the current time used by the process engine This can be handy to control the exact time that is used by the engine in order to verify e.g. e.g. due dates of timers. Or start, end and duration times in the history service. In the tearDown, the internal clock will automatically be reset to use the current system time rather then the time that was set during a test method.

Author:

Filip Hrisafov

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CONFIGURATION_RESOURCE
protected org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor and Description
FlowableExtension()

Method Summary

Modifier and Type	Method and Description
void	afterEach(org.junit.jupiter.api.extension.ExtensionContext context)
void	beforeEach(org.junit.jupiter.api.extension.ExtensionContext context)
protected ProcessEngine	createProcessEngine(org.junit.jupiter.api.extension.ExtensionContext context)
protected String	getConfigurationResource(org.junit.jupiter.api.extension.ExtensionContext context)
protected org.junit.jupiter.api.extension.ExtensionContext.Store	getStore(org.junit.jupiter.api.extension.ExtensionContext context)
protected FlowableTestHelper	getTestHelper(org.junit.jupiter.api.extension.ExtensionContext context)
Object	resolveParameter(org.junit.jupiter.api.extension.ParameterContext parameterContext, org.junit.jupiter.api.extension.ExtensionContext context)
boolean	supportsParameter(org.junit.jupiter.api.extension.ParameterContext parameterContext, org.junit.jupiter.api.extension.ExtensionContext context)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CONFIGURATION_RESOURCE

public static final String DEFAULT_CONFIGURATION_RESOURCE

See Also:

Constant Field Values

logger

protected final org.slf4j.Logger logger

Constructor Detail

FlowableExtension

public FlowableExtension()

Method Detail

beforeEach

public void beforeEach(org.junit.jupiter.api.extension.ExtensionContext context)
                throws Exception

Specified by:

beforeEach in interface org.junit.jupiter.api.extension.BeforeEachCallback

Throws:

Exception

afterEach

public void afterEach(org.junit.jupiter.api.extension.ExtensionContext context)
               throws Exception

Specified by:

afterEach in interface org.junit.jupiter.api.extension.AfterEachCallback

Throws:

Exception

supportsParameter

public boolean supportsParameter(org.junit.jupiter.api.extension.ParameterContext parameterContext,
                                 org.junit.jupiter.api.extension.ExtensionContext context)

Specified by:

supportsParameter in interface org.junit.jupiter.api.extension.ParameterResolver

resolveParameter

public Object resolveParameter(org.junit.jupiter.api.extension.ParameterContext parameterContext,
                               org.junit.jupiter.api.extension.ExtensionContext context)

Specified by:

resolveParameter in interface org.junit.jupiter.api.extension.ParameterResolver

getConfigurationResource

protected String getConfigurationResource(org.junit.jupiter.api.extension.ExtensionContext context)

getTestHelper

protected FlowableTestHelper getTestHelper(org.junit.jupiter.api.extension.ExtensionContext context)

createProcessEngine

protected ProcessEngine createProcessEngine(org.junit.jupiter.api.extension.ExtensionContext context)

getStore

protected org.junit.jupiter.api.extension.ExtensionContext.Store getStore(org.junit.jupiter.api.extension.ExtensionContext context)