org.flowable.idm.engine.test

Class FlowableIdmRule

java.lang.Object

org.flowable.idm.engine.test.FlowableIdmRule

All Implemented Interfaces:

org.junit.rules.TestRule

public class FlowableIdmRule
extends Object
implements org.junit.rules.TestRule

Convenience for IdmEngine and services initialization in the form of a JUnit rule.

Usage:

 public class YourTest {
 
   @Rule
   public FlowableIdmRule flowableIdmRule = new FlowableIdmRule();
   
   ...
 }
 

The IdmEngine and the services will be made available to the test class through the getters of the FlowableRule. The idmEngine will be initialized by default with the flowable.idm.cfg.xml resource on the classpath. To specify a different configuration file, pass the resource location in the appropriate constructor. Process engines will be cached statically. 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 FormDeploymentAnnotation annotation. This base class will make sure that this deployment gets deployed before the setUp and cascade deleted after the tearDown.

The Flowable also lets you 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:

Tijs Rademakers

Field Summary

Fields

Modifier and Type	Field and Description
protected String	configurationResource
protected String	deploymentId
protected IdmIdentityService	identityService
protected IdmEngine	idmEngine
protected IdmEngineConfiguration	idmEngineConfiguration

Constructor Summary

Constructors

Constructor and Description
FlowableIdmRule()
FlowableIdmRule(IdmEngine idmEngine)
FlowableIdmRule(String configurationResource)

Method Summary

Modifier and Type	Method and Description
org.junit.runners.model.Statement	apply(org.junit.runners.model.Statement base, org.junit.runner.Description description) Implementation based on TestWatcher.
protected void	configureIdmEngine()
protected void	failed(Throwable e, org.junit.runner.Description description) Invoked when a test fails
String	getConfigurationResource()
IdmIdentityService	getIdentityService()
IdmEngine	getIdmEngine()
protected void	initializeIdmEngine()
protected void	initializeServices()
void	setConfigurationResource(String configurationResource)
void	setIdentityService(IdmIdentityService identityService)
void	setIdmEngine(IdmEngine idmEngine)
void	setIdmEngineConfiguration(IdmEngineConfiguration idmEngineConfiguration)
protected void	skipped(org.junit.internal.AssumptionViolatedException e, org.junit.runner.Description description) Invoked when a test is skipped due to a failed assumption.
protected void	starting(org.junit.runner.Description description)
protected void	succeeded(org.junit.runner.Description description) Invoked when a test succeeds

Methods inherited from class java.lang.Object

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

Field Detail

configurationResource

protected String configurationResource

deploymentId

protected String deploymentId

idmEngineConfiguration

protected IdmEngineConfiguration idmEngineConfiguration

idmEngine

protected IdmEngine idmEngine

identityService

protected IdmIdentityService identityService

Constructor Detail

FlowableIdmRule

public FlowableIdmRule()

FlowableIdmRule

public FlowableIdmRule(String configurationResource)

FlowableIdmRule

public FlowableIdmRule(IdmEngine idmEngine)

Method Detail

apply

public org.junit.runners.model.Statement apply(org.junit.runners.model.Statement base,
                                               org.junit.runner.Description description)

Implementation based on TestWatcher.

Specified by:

apply in interface org.junit.rules.TestRule

succeeded

protected void succeeded(org.junit.runner.Description description)

Invoked when a test succeeds

failed

protected void failed(Throwable e,
                      org.junit.runner.Description description)

Invoked when a test fails

skipped

protected void skipped(org.junit.internal.AssumptionViolatedException e,
                       org.junit.runner.Description description)

Invoked when a test is skipped due to a failed assumption.

starting

protected void starting(org.junit.runner.Description description)

initializeIdmEngine

protected void initializeIdmEngine()

initializeServices

protected void initializeServices()

configureIdmEngine

protected void configureIdmEngine()

getConfigurationResource

public String getConfigurationResource()

setConfigurationResource

public void setConfigurationResource(String configurationResource)

getIdmEngine

public IdmEngine getIdmEngine()

setIdmEngine

public void setIdmEngine(IdmEngine idmEngine)

getIdentityService

public IdmIdentityService getIdentityService()

setIdentityService

public void setIdentityService(IdmIdentityService identityService)

setIdmEngineConfiguration

public void setIdmEngineConfiguration(IdmEngineConfiguration idmEngineConfiguration)