org.camunda.bpm.engine.test

Class ProcessEngineRule

java.lang.Object

org.junit.rules.TestWatcher

org.camunda.bpm.engine.test.ProcessEngineRule

All Implemented Interfaces:

org.junit.rules.TestRule

public class ProcessEngineRule
extends org.junit.rules.TestWatcher

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

Usage:

public class YourTest {

   @Rule
   public ProcessEngineRule processEngineRule = new ProcessEngineRule();

   ...
 }
 

The ProcessEngine and the services will be made available to the test class through the getters of the processEngineRule. The processEngine will be initialized by default with the camunda.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 Deployment annotation. This base class will make sure that this deployment gets deployed before the setUp and cascade deleted after the tearDown.

The processEngineRule 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. In other words, you don't have to clean up your own time messing mess ;-)

Author:

Tom Baeyens

Field Summary

Fields

Modifier and Type	Field and Description
protected List<String>	additionalDeployments
protected AuthorizationService	authorizationService
protected CaseService	caseService
protected String	configurationResource
protected String	configurationResourceCompat
protected String	deploymentId
protected boolean	ensureCleanAfterTest
protected FilterService	filterService
protected FormService	formService
protected HistoryService	historyService
protected IdentityService	identityService
protected ManagementService	managementService
protected ProcessEngine	processEngine
protected RepositoryService	repositoryService
protected RuntimeService	runtimeService
protected TaskService	taskService

Constructor Summary

Constructors

Constructor and Description
ProcessEngineRule()
ProcessEngineRule(boolean ensureCleanAfterTest)
ProcessEngineRule(ProcessEngine processEngine)
ProcessEngineRule(ProcessEngine processEngine, boolean ensureCleanAfterTest)
ProcessEngineRule(String configurationResource)
ProcessEngineRule(String configurationResource, boolean ensureCleanAfterTest)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	clearServiceReferences()
void	finished(org.junit.runner.Description description)
String	getConfigurationResource()
FilterService	getFilterService()
FormService	getFormService()
HistoryService	getHistoryService()
IdentityService	getIdentityService()
ManagementService	getManagementService()
ProcessEngine	getProcessEngine()
RepositoryService	getRepositoryService()
RuntimeService	getRuntimeService()
TaskService	getTaskService()
protected void	initializeProcessEngine()
protected void	initializeServices()
void	manageDeployment(Deployment deployment)
void	setConfigurationResource(String configurationResource)
void	setCurrentTime(Date currentTime)
void	setFilterService(FilterService filterService)
void	setHistoricDataService(HistoryService historicDataService)
void	setIdentityService(IdentityService identityService)
void	setManagementService(ManagementService managementService)
void	setProcessEngine(ProcessEngine processEngine)
void	setRepositoryService(RepositoryService repositoryService)
void	setRuntimeService(RuntimeService runtimeService)
void	setTaskService(TaskService taskService)
void	starting(org.junit.runner.Description description)

Methods inherited from class org.junit.rules.TestWatcher

apply, failed, skipped, succeeded

Methods inherited from class java.lang.Object

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

Field Detail

configurationResource

protected String configurationResource

configurationResourceCompat

protected String configurationResourceCompat

deploymentId

protected String deploymentId

additionalDeployments

protected List<String> additionalDeployments

ensureCleanAfterTest

protected boolean ensureCleanAfterTest

processEngine

protected ProcessEngine processEngine

repositoryService

protected RepositoryService repositoryService

runtimeService

protected RuntimeService runtimeService

taskService

protected TaskService taskService

historyService

protected HistoryService historyService

identityService

protected IdentityService identityService

managementService

protected ManagementService managementService

formService

protected FormService formService

filterService

protected FilterService filterService

authorizationService

protected AuthorizationService authorizationService

caseService

protected CaseService caseService

Constructor Detail

ProcessEngineRule

public ProcessEngineRule()

ProcessEngineRule

public ProcessEngineRule(boolean ensureCleanAfterTest)

ProcessEngineRule

public ProcessEngineRule(String configurationResource)

ProcessEngineRule

public ProcessEngineRule(String configurationResource,
                 boolean ensureCleanAfterTest)

ProcessEngineRule

public ProcessEngineRule(ProcessEngine processEngine)

ProcessEngineRule

public ProcessEngineRule(ProcessEngine processEngine,
                 boolean ensureCleanAfterTest)

Method Detail

starting

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

Overrides:

starting in class org.junit.rules.TestWatcher

initializeProcessEngine

protected void initializeProcessEngine()

initializeServices

protected void initializeServices()

clearServiceReferences

protected void clearServiceReferences()

finished

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

Overrides:

finished in class org.junit.rules.TestWatcher

setCurrentTime

public void setCurrentTime(Date currentTime)

getConfigurationResource

public String getConfigurationResource()

setConfigurationResource

public void setConfigurationResource(String configurationResource)

getProcessEngine

public ProcessEngine getProcessEngine()

setProcessEngine

public void setProcessEngine(ProcessEngine processEngine)

getRepositoryService

public RepositoryService getRepositoryService()

setRepositoryService

public void setRepositoryService(RepositoryService repositoryService)

getRuntimeService

public RuntimeService getRuntimeService()

setRuntimeService

public void setRuntimeService(RuntimeService runtimeService)

getTaskService

public TaskService getTaskService()

setTaskService

public void setTaskService(TaskService taskService)

getHistoryService

public HistoryService getHistoryService()

setHistoricDataService

public void setHistoricDataService(HistoryService historicDataService)

getIdentityService

public IdentityService getIdentityService()

setIdentityService

public void setIdentityService(IdentityService identityService)

getManagementService

public ManagementService getManagementService()

getFormService

public FormService getFormService()

setManagementService

public void setManagementService(ManagementService managementService)

getFilterService

public FilterService getFilterService()

setFilterService

public void setFilterService(FilterService filterService)

manageDeployment

public void manageDeployment(Deployment deployment)