org.flowable.content.engine.test

Class FlowableContentRule

java.lang.Object

org.flowable.content.engine.test.FlowableContentRule

All Implemented Interfaces:

org.junit.rules.TestRule

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

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

Usage:

 public class YourTest {
 
   @Rule
   public FlowableContentRule flowableContentRule = new FlowableContentRule();
   
   ...
 }
 

The DmnEngine and the services will be made available to the test class through the getters of the FlowableContentRule. The dmnEngine will be initialized by default with the flowable.dmn.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 FlowableRule 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 ContentEngine	contentEngine
protected ContentEngineConfiguration	contentEngineConfiguration
protected ContentService	contentService
protected String	deploymentId

Constructor Summary

Constructors

Constructor and Description
FlowableContentRule()
FlowableContentRule(ContentEngine contentEngine)
FlowableContentRule(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	configureContentEngine()
protected void	failed(Throwable e, org.junit.runner.Description description) Invoked when a test fails
protected void	finished(org.junit.runner.Description description)
String	getConfigurationResource()
ContentEngine	getContentEngine()
ContentService	getContentService()
protected void	initializeContentEngine()
protected void	initializeServices()
void	setConfigurationResource(String configurationResource)
void	setContentEngine(ContentEngine contentEngine)
void	setContentEngineConfiguration(ContentEngineConfiguration contentEngineConfiguration)
void	setContentService(ContentService contentService)
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

contentEngineConfiguration

protected ContentEngineConfiguration contentEngineConfiguration

contentEngine

protected ContentEngine contentEngine

contentService

protected ContentService contentService

Constructor Detail

FlowableContentRule

public FlowableContentRule()

FlowableContentRule

public FlowableContentRule(String configurationResource)

FlowableContentRule

public FlowableContentRule(ContentEngine contentEngine)

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)

initializeContentEngine

protected void initializeContentEngine()

initializeServices

protected void initializeServices()

configureContentEngine

protected void configureContentEngine()

finished

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

getConfigurationResource

public String getConfigurationResource()

setConfigurationResource

public void setConfigurationResource(String configurationResource)

getContentEngine

public ContentEngine getContentEngine()

setContentEngine

public void setContentEngine(ContentEngine contentEngine)

getContentService

public ContentService getContentService()

setContentService

public void setContentService(ContentService contentService)

setContentEngineConfiguration

public void setContentEngineConfiguration(ContentEngineConfiguration contentEngineConfiguration)