org.flywaydb.test.junit5.annotation.FlywayTestExtension Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of flyway-spring-test Show documentation

Implementation test support for Flyway based on springframework. Work together with Junit4, Junit5 or TestNG.

The newest version!

/**
 * Copyright (C) 2011-2023 the original author or authors.
 *
 * 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.flywaydb.test.junit5.annotation;

import org.junit.jupiter.api.extension.ExtendWith;
import org.springframework.test.context.junit.jupiter.SpringExtension;

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;

/**
 * The annotation FlywayTestExtension is a shortcut for JUnit5 usage.
 *
 * The annotation only work together with Spring Framework and need a
 * implementation of {@link SpringExtension}.
 *
 * It support all features that are described with {@link org.flywaydb.test.annotation.FlywayTest} and
 * {@link org.flywaydb.test.annotation.FlywayTests}.
 *
 * Usage:
 *  * {@code
 * @FlywayTestExtension.class
 * class TestClass {
 *
 * }
 * }
 * 
 * and will replace
 *  * {@code
 * @ExtendWith(org.springframework.test.context.junit.jupiter.SpringExtension.class)
 * @ExtendWith(org.flywaydb.test.junit5.FlywayTestExtension.class)
 * class TestClass {
 *
 * }
 * }
 * 
 *
 *
 * @author florian
 * @since 5.2.2
 */
@Target({ ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@ExtendWith(SpringExtension.class)
@ExtendWith(org.flywaydb.test.junit5.FlywayTestExtension.class)
public @interface FlywayTestExtension {
}