Package com.flowable.form.engine.test

Class FlowableFormExtension

  • All Implemented Interfaces:
    org.junit.jupiter.api.extension.AfterEachCallback, org.junit.jupiter.api.extension.BeforeEachCallback, org.junit.jupiter.api.extension.Extension, org.junit.jupiter.api.extension.ParameterResolver
    Direct Known Subclasses:
    FlowableFormSpringExtension
    public class FlowableFormExtension
extends java.lang.Object
implements org.junit.jupiter.api.extension.ParameterResolver, org.junit.jupiter.api.extension.BeforeEachCallback, org.junit.jupiter.api.extension.AfterEachCallback
    JUnit Jupiter extension for the Flowable FormEngine and services initialization.

    Usage: 

     @ExtendWith(FlowableFormExtension.class)
 class YourTest {

   @BeforeEach
   void setUp(FormEngine FormEngine) {
       ...
   }

   @Test
   void myTest(FormRepositoryService formRepositoryService) {
       ...
   }

   ...
 }

    The FormEngine and the services will be made available to the test class through the parameter resolution (BeforeEach, AfterEach, test methods). The FormEngine will be initialized by default with the flowable.form.cfg.xml resource on the classpath. To specify a different configuration file, annotate your class with FormConfigurationResource. Form engines will be cached as part of the JUnit Jupiter Extension context. Right before the first time the setUp is called for a given configuration resource, the form engine will be constructed.

    You can declare a deployment with the FormDeploymentAnnotation annotation. This extension will make sure that this deployment gets deployed before the setUp and deleted after the tearDown. The id of the deployment can be accessed by using FormDeploymentId in a test method.

    FlowableFormTestHelper.setCurrentTime(Date) can be used to set the current time used by the form engine} This can be handy to control the exact time that is used by the engine in order to verify for example 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:
    Filip Hrisafov

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void afterEach​(org.junit.jupiter.api.extension.ExtensionContext context)  
      void beforeEach​(org.junit.jupiter.api.extension.ExtensionContext context)  
      protected FormEngine createFormEngine​(org.junit.jupiter.api.extension.ExtensionContext context)  
      protected java.lang.String getConfigurationResource​(org.junit.jupiter.api.extension.ExtensionContext context)  
      protected org.junit.jupiter.api.extension.ExtensionContext.Store getStore​(org.junit.jupiter.api.extension.ExtensionContext context)  
      protected FlowableFormTestHelper getTestHelper​(org.junit.jupiter.api.extension.ExtensionContext context)  
      java.lang.Object resolveParameter​(org.junit.jupiter.api.extension.ParameterContext parameterContext, org.junit.jupiter.api.extension.ExtensionContext context)  
      boolean supportsParameter​(org.junit.jupiter.api.extension.ParameterContext parameterContext, org.junit.jupiter.api.extension.ExtensionContext context)  

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • DEFAULT_CONFIGURATION_RESOURCE

        public static final java.lang.String DEFAULT_CONFIGURATION_RESOURCE
        See Also:
        Constant Field Values

      • logger

        protected final org.slf4j.Logger logger

      • configurationResource

        protected final java.lang.String configurationResource

    • Constructor Detail

      • FlowableFormExtension

        public FlowableFormExtension()

      • FlowableFormExtension

        public FlowableFormExtension​(java.lang.String configurationResource)

    • Method Detail

      • beforeEach

        public void beforeEach​(org.junit.jupiter.api.extension.ExtensionContext context)
        Specified by:
        beforeEach in interface org.junit.jupiter.api.extension.BeforeEachCallback

      • afterEach

        public void afterEach​(org.junit.jupiter.api.extension.ExtensionContext context)
        Specified by:
        afterEach in interface org.junit.jupiter.api.extension.AfterEachCallback

      • supportsParameter

        public boolean supportsParameter​(org.junit.jupiter.api.extension.ParameterContext parameterContext,
                                 org.junit.jupiter.api.extension.ExtensionContext context)
        Specified by:
        supportsParameter in interface org.junit.jupiter.api.extension.ParameterResolver

      • resolveParameter

        public java.lang.Object resolveParameter​(org.junit.jupiter.api.extension.ParameterContext parameterContext,
                                         org.junit.jupiter.api.extension.ExtensionContext context)
        Specified by:
        resolveParameter in interface org.junit.jupiter.api.extension.ParameterResolver

      • getConfigurationResource

        protected java.lang.String getConfigurationResource​(org.junit.jupiter.api.extension.ExtensionContext context)

      • getTestHelper

        protected FlowableFormTestHelper getTestHelper​(org.junit.jupiter.api.extension.ExtensionContext context)

      • createFormEngine

        protected FormEngine createFormEngine​(org.junit.jupiter.api.extension.ExtensionContext context)

      • getStore

        protected org.junit.jupiter.api.extension.ExtensionContext.Store getStore​(org.junit.jupiter.api.extension.ExtensionContext context)