Package org.flowable.app.engine.test

Class FlowableAppRule

java.lang.Object
org.flowable.app.engine.test.FlowableAppRule
All Implemented Interfaces:
org.junit.rules.TestRule
@Deprecated(forRemoval=true, since="7.2.0") public class FlowableAppRule 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 FlowableAppExtension instead
Convenience for AppEngine and services initialization in the form of a JUnit rule.

Usage: 

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

The AppEngine and the services will be made available to the test class through the getters of the FlowableAppRule. The cmmnEngine 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. App engines will be cached statically. Right before the first time the setUp is called for a given configuration resource, the app engine will be constructed.

You can declare a deployment with the AppDeployment annotation. This base class will make sure that this deployment gets deployed before the setUp and cascade deleted after the tearDown.

The FlowableAppRule 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 AppEngine
    appEngine
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected AppEngineConfiguration
    appEngineConfiguration
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected AppManagementService
    appManagementService
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected AppRepositoryService
    appRepositoryService
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    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.
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    FlowableAppRule()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    FlowableAppRule(String configurationResource)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    FlowableAppRule(AppEngine appEngine)
    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
    configureAppEngine()
    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.
     
    AppEngine
    getAppEngine()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    AppManagementService
    getAppManagementService()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    AppRepositoryService
    getAppRepositoryService()
    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.
     
    protected void
    initializeAppEngine()
    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.
     
    void
    setAppEngine(AppEngine appEngine)
    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.
     
    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.

    • appEngineConfiguration

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

    • appEngine

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

    • appRepositoryService

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

    • appManagementService

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

  • Constructor Details

    • FlowableAppRule

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

    • FlowableAppRule

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

    • FlowableAppRule

      public FlowableAppRule(AppEngine appEngine)
      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.

    • initializeAppEngine

      protected void initializeAppEngine()
      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.

    • configureAppEngine

      protected void configureAppEngine()
      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.

    • getAppEngine

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

    • setAppEngine

      public void setAppEngine(AppEngine appEngine)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getAppRepositoryService

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

    • getAppManagementService

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