org.flowable.engine.test.ConfigurationResource 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;
/**
* An annotation that can be used on test classes or as a meta annotation to use a custom configuration resource for the {@link FlowableExtension}.
*
* This annotation can be used to create a custom annotation that would provide the configuration resource to the {@link FlowableExtension}.
*
* Usage
*
* @Target({ElementType.TYPE})
* @Retention(RetentionPolicy.RUNTIME)
* @Documented
* @ConfigurationResource("flowable.custom.cfg.xm")
* public @interface MyCustomResource {
*
* }
*
* @FlowableTest
* @MyCustomResource
* class YourTest {
*
* @BeforeEach
* void setUp(ProcessEngine processEngine) {
* ...
* }
*
* @Test
* void myTest(RuntimeService runtimeService) {
* ...
* }
* ...
* }
*
* In this example the configuration flowable.custom.cfg.xml will be used to create the ProcessEngine
*
* NB: This only works for the tests with JUnit Jupiter.
*
* @author Filip Hrisafov
*/
@Target({ ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
public @interface ConfigurationResource {
/**
* The location of the resource that should be used to create the ProcessEngine.
*/
String value() default "flowable.cfg.xml";
}