Class FlowableFormRule

java.lang.Object
com.flowable.form.engine.test.FlowableFormRule
All Implemented Interfaces:
org.junit.rules.TestRule

public class FlowableFormRule extends Object implements org.junit.rules.TestRule
Convenience for FormEngine and services initialization in the form of a JUnit rule.

Usage:

 public class YourTest {
 
   @Rule
   public FlowableFormRule flowableFormRule = new FlowableFormRule();
   
   ...
 }
 

The FormEngine and the services will be made available to the test class through the getters of the FlowableRule. The formEngine will be initialized by default with the flowable.form.cfg.xml resource on the classpath. To specify a different configuration file, pass the resource location in FlowableFormRule(String) the appropriate constructor. Form 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 RepositoryService#deleteDeployment(String, boolean) cascade deleted after the tearDown.

Author:
Tijs Rademakers
  • Field Details

  • Constructor Details

    • FlowableFormRule

      public FlowableFormRule()
    • FlowableFormRule

      public FlowableFormRule(String configurationResource)
    • FlowableFormRule

      public FlowableFormRule(FormEngine formEngine)
  • Method Details

    • 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)
    • initializeFormEngine

      protected void initializeFormEngine()
    • initializeServices

      protected void initializeServices()
    • configureFormEngine

      protected void configureFormEngine()
    • finished

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

      public String getConfigurationResource()
    • setConfigurationResource

      public void setConfigurationResource(String configurationResource)
    • getFormEngine

      public FormEngine getFormEngine()
    • setFormEngine

      public void setFormEngine(FormEngine formEngine)
    • getRepositoryService

      public FormRepositoryService getRepositoryService()
    • setRepositoryService

      public void setRepositoryService(FormRepositoryService repositoryService)
    • setFormEngineConfiguration

      public void setFormEngineConfiguration(FormEngineConfiguration formEngineConfiguration)