org.springframework.test.context.transaction.BeforeTransaction Maven / Gradle / Ivy
Show all versions of spring-test Show documentation
/*
* Copyright 2002-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
*
* https://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.springframework.test.context.transaction;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Test annotation which indicates that the annotated {@code void} method
* should be executed before a transaction is started for a test method
* configured to run within a transaction via Spring's {@code @Transactional}
* annotation.
*
* Generally speaking, {@code @BeforeTransaction} methods must not accept any
* arguments. However, as of Spring Framework 6.1, for tests using the
* {@link org.springframework.test.context.junit.jupiter.SpringExtension SpringExtension}
* with JUnit Jupiter, {@code @BeforeTransaction} methods may optionally accept
* arguments which will be resolved by any registered JUnit
* {@link org.junit.jupiter.api.extension.ParameterResolver ParameterResolver}
* extension such as the {@code SpringExtension}. This means that JUnit-specific
* arguments like {@link org.junit.jupiter.api.TestInfo TestInfo} or beans from
* the test's {@code ApplicationContext} may be provided to {@code @BeforeTransaction}
* methods analogous to {@code @BeforeEach} methods.
*
*
{@code @BeforeTransaction} methods declared in superclasses or as interface
* default methods will be executed before those of the current test class.
*
*
This annotation may be used as a meta-annotation to create custom
* composed annotations.
*
* @author Sam Brannen
* @since 2.5
* @see org.springframework.transaction.annotation.Transactional
* @see AfterTransaction
*/
@Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface BeforeTransaction {
}