Package org.flowable.engine.test

Class FlowableRule

java.lang.Object
org.flowable.engine.test.FlowableRule
All Implemented Interfaces:
org.junit.rules.TestRule
@Deprecated(forRemoval=true, since="7.2.0") public class FlowableRule extends Object implements org.junit.rules.TestRule
Deprecated, for removal: This API element is subject to removal in a future version.
Use JUnit Jupiter with FlowableTest instead
Convenience for ProcessEngine and services initialization in the form of a JUnit rule.

Usage: 

 public class YourTest {
 
   @Rule
   public FlowableRule flowableRule = new FlowableRule();
   
   ...
 }

The ProcessEngine and the services will be made available to the test class through the getters of the FlowableRule. The processEngine will be initialized by default with the flowable.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 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:
Tom Baeyens

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected String
    configurationResource
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected String
    deploymentId
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected FormService
    formService
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected HistoryService
    historyService
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected IdentityService
    identityService
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected ManagementService
    managementService
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected FlowableMockSupport
    mockSupport
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected ProcessEngine
    processEngine
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected ProcessEngineConfiguration
    processEngineConfiguration
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected RepositoryService
    repositoryService
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected RuntimeService
    runtimeService
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected TaskService
    taskService
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    FlowableRule()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    FlowableRule(String configurationResource)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    FlowableRule(ProcessEngine processEngine)
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Method Summary

    Modifier and Type
    Method
    Description
    org.junit.runners.model.Statement
    apply(org.junit.runners.model.Statement base, org.junit.runner.Description description)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Implementation based on TestWatcher.
    protected void
    configureProcessEngine()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected void
    failed(Throwable e, org.junit.runner.Description description)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Invoked when a test fails
    protected void
    finished(org.junit.runner.Description description)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    String
    getConfigurationResource()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    FormService
    getFormService()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    HistoryService
    getHistoryService()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    IdentityService
    getIdentityService()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    ManagementService
    getManagementService()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    FlowableMockSupport
    getMockSupport()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    ProcessEngine
    getProcessEngine()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    RepositoryService
    getRepositoryService()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    RuntimeService
    getRuntimeService()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    TaskService
    getTaskService()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected void
    initializeMockSupport()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected void
    initializeProcessEngine()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected void
    initializeServices()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    FlowableMockSupport
    mockSupport()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setConfigurationResource(String configurationResource)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setCurrentTime(Date currentTime)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setHistoricDataService(HistoryService historicDataService)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setIdentityService(IdentityService identityService)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setManagementService(ManagementService managementService)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setProcessEngine(ProcessEngine processEngine)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setProcessEngineConfiguration(ProcessEngineConfigurationImpl processEngineConfiguration)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setRepositoryService(RepositoryService repositoryService)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setRuntimeService(RuntimeService runtimeService)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setTaskService(TaskService taskService)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected void
    skipped(org.junit.internal.AssumptionViolatedException e, org.junit.runner.Description description)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Invoked when a test is skipped due to a failed assumption.
    protected void
    starting(org.junit.runner.Description description)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected void
    succeeded(org.junit.runner.Description description)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Invoked when a test succeeds

    Methods inherited from class java.lang.Object

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

  • Field Details

    • configurationResource

      protected String configurationResource
      Deprecated, for removal: This API element is subject to removal in a future version.

    • deploymentId

      protected String deploymentId
      Deprecated, for removal: This API element is subject to removal in a future version.

    • processEngineConfiguration

      protected ProcessEngineConfiguration processEngineConfiguration
      Deprecated, for removal: This API element is subject to removal in a future version.

    • processEngine

      protected ProcessEngine processEngine
      Deprecated, for removal: This API element is subject to removal in a future version.

    • repositoryService

      protected RepositoryService repositoryService
      Deprecated, for removal: This API element is subject to removal in a future version.

    • runtimeService

      protected RuntimeService runtimeService
      Deprecated, for removal: This API element is subject to removal in a future version.

    • taskService

      protected TaskService taskService
      Deprecated, for removal: This API element is subject to removal in a future version.

    • historyService

      protected HistoryService historyService
      Deprecated, for removal: This API element is subject to removal in a future version.

    • identityService

      protected IdentityService identityService
      Deprecated, for removal: This API element is subject to removal in a future version.

    • managementService

      protected ManagementService managementService
      Deprecated, for removal: This API element is subject to removal in a future version.

    • formService

      protected FormService formService
      Deprecated, for removal: This API element is subject to removal in a future version.

    • mockSupport

      protected FlowableMockSupport mockSupport
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Constructor Details

    • FlowableRule

      public FlowableRule()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • FlowableRule

      public FlowableRule(String configurationResource)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • FlowableRule

      public FlowableRule(ProcessEngine processEngine)
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Method Details

    • apply

      public org.junit.runners.model.Statement apply(org.junit.runners.model.Statement base, org.junit.runner.Description description)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Implementation based on TestWatcher.
      Specified by:
      apply in interface org.junit.rules.TestRule

    • succeeded

      protected void succeeded(org.junit.runner.Description description)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Invoked when a test succeeds

    • failed

      protected void failed(Throwable e, org.junit.runner.Description description)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Invoked when a test fails

    • skipped

      protected void skipped(org.junit.internal.AssumptionViolatedException e, org.junit.runner.Description description)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Invoked when a test is skipped due to a failed assumption.

    • starting

      protected void starting(org.junit.runner.Description description)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • initializeProcessEngine

      protected void initializeProcessEngine()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • initializeServices

      protected void initializeServices()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • initializeMockSupport

      protected void initializeMockSupport()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • configureProcessEngine

      protected void configureProcessEngine()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • finished

      protected void finished(org.junit.runner.Description description)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setCurrentTime

      public void setCurrentTime(Date currentTime)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getConfigurationResource

      public String getConfigurationResource()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setConfigurationResource

      public void setConfigurationResource(String configurationResource)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getProcessEngine

      public ProcessEngine getProcessEngine()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setProcessEngine

      public void setProcessEngine(ProcessEngine processEngine)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getRepositoryService

      public RepositoryService getRepositoryService()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setRepositoryService

      public void setRepositoryService(RepositoryService repositoryService)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getRuntimeService

      public RuntimeService getRuntimeService()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setRuntimeService

      public void setRuntimeService(RuntimeService runtimeService)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getTaskService

      public TaskService getTaskService()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setTaskService

      public void setTaskService(TaskService taskService)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getHistoryService

      public HistoryService getHistoryService()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setHistoricDataService

      public void setHistoricDataService(HistoryService historicDataService)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getIdentityService

      public IdentityService getIdentityService()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setIdentityService

      public void setIdentityService(IdentityService identityService)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getManagementService

      public ManagementService getManagementService()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getFormService

      public FormService getFormService()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setManagementService

      public void setManagementService(ManagementService managementService)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setProcessEngineConfiguration

      public void setProcessEngineConfiguration(ProcessEngineConfigurationImpl processEngineConfiguration)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getMockSupport

      public FlowableMockSupport getMockSupport()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • mockSupport

      public FlowableMockSupport mockSupport()
      Deprecated, for removal: This API element is subject to removal in a future version.