org.flowable.engine.test.FlowableTest Maven / Gradle / Ivy
/* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.flowable.engine.test;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.util.Date;
import org.flowable.engine.RepositoryService;
import org.junit.jupiter.api.extension.ExtendWith;
/**
* Convenience for annotation that activates the {@link FlowableExtension} JUnit Jupiter annotation.
*
*
* Usage:
*
*
*
* @FlowableTest
* class YourTest {
*
* @BeforeEach
* void setUp(ProcessEngine processEngine) {
* ...
* }
*
* @Test
* void myTest(RuntimeService runtimeService) {
* ...
* }
*
* ...
* }
*
*
*
* The ProcessEngine and the services will be made available to the test class through the parameter resolution (BeforeEach, AfterEach, test methods).
* The processEngine will be initialized by default with the flowable.cfg.xml resource on the classpath.
* To specify a different configuration file, annotate your class with {@link ConfigurationResource}.
* Process 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 process engine will be constructed.
*
*
*
* You can declare a deployment with the {@link Deployment} annotation. The extension will make sure that this deployment gets deployed before the setUp and
* {@link RepositoryService#deleteDeployment(String, boolean) cascade deleted} after the tearDown.
* The id of the deployment can be accessed by using {@link DeploymentId} in a test method.
*
*
*
* {@link FlowableTestHelper#setCurrentTime(Date) can be used to 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 Filip Hrisafov
*/
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@ExtendWith(FlowableExtension.class)
public @interface FlowableTest {
}