root
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Actions 8 Packages Projects Releases Wiki Activity

Improve documentation for @⁠Sql execution phases regarding lifecycle 

Closes gh-32343
This commit is contained in:
Sam Brannen 2024-03-01 14:37:31 +01:00
parent 85a781d517
commit de828e9764
1 changed files with 44 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
spring-test/src/main/java/org/springframework/test/context/jdbc/Sql.java
View File

@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2023 the original author or authors. * Copyright 2002-2024 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -171,28 +171,67 @@ public @interface Sql {
enum ExecutionPhase { enum ExecutionPhase {
/** /**
* The configured SQL scripts and statements will be executed * The configured SQL scripts and statements will be executed once per
* once per test class <em>before</em> any test method is run. * test class <em>before</em> any test method is run.
* <p>Specifically, the configured SQL scripts and statements will be
* executed prior to any <em>before class lifecycle methods</em> of a
* particular testing framework &mdash; for example, methods annotated
* with JUnit Jupiter's {@link org.junit.jupiter.api.BeforeAll @BeforeAll}
* annotation.
* <p>NOTE: Configuring {@code BEFORE_TEST_CLASS} as the execution phase
* causes the test's {@code ApplicationContext} to be eagerly loaded
* during test class initialization which can potentially result in
* undesired side effects. For example,
* {@link org.springframework.test.context.DynamicPropertySource @DynamicPropertySource}
* methods will be invoked before {@code @BeforeAll} methods when using
* {@code BEFORE_TEST_CLASS}.
* @since 6.1 * @since 6.1
* @see #AFTER_TEST_CLASS
* @see #BEFORE_TEST_METHOD
* @see #AFTER_TEST_METHOD
*/ */
BEFORE_TEST_CLASS, BEFORE_TEST_CLASS,
/** /**
* The configured SQL scripts and statements will be executed * The configured SQL scripts and statements will be executed once per
* once per test class <em>after</em> all test methods have run. * test class <em>after</em> all test methods have run.
* <p>Specifically, the configured SQL scripts and statements will be
* executed after any <em>after class lifecycle methods</em> of a
* particular testing framework &mdash; for example, methods annotated
* with JUnit Jupiter's {@link org.junit.jupiter.api.AfterAll @AfterAll}
* annotation.
* @since 6.1 * @since 6.1
* @see #BEFORE_TEST_CLASS
* @see #BEFORE_TEST_METHOD
* @see #AFTER_TEST_METHOD
*/ */
AFTER_TEST_CLASS, AFTER_TEST_CLASS,
/** /**
* The configured SQL scripts and statements will be executed * The configured SQL scripts and statements will be executed
* <em>before</em> the corresponding test method. * <em>before</em> the corresponding test method.
* <p>Specifically, the configured SQL scripts and statements will be
* executed prior to any <em>before test lifecycle methods</em> of a
* particular testing framework &mdash; for example, methods annotated
* with JUnit Jupiter's {@link org.junit.jupiter.api.BeforeEach @BeforeEach}
* annotation.
* @see #BEFORE_TEST_CLASS
* @see #AFTER_TEST_CLASS
* @see #AFTER_TEST_METHOD
*/ */
BEFORE_TEST_METHOD, BEFORE_TEST_METHOD,
/** /**
* The configured SQL scripts and statements will be executed * The configured SQL scripts and statements will be executed
* <em>after</em> the corresponding test method. * <em>after</em> the corresponding test method.
* <p>Specifically, the configured SQL scripts and statements will be
* executed after any <em>after test lifecycle methods</em> of a
* particular testing framework &mdash; for example, methods annotated
* with JUnit Jupiter's {@link org.junit.jupiter.api.AfterEach @AfterEach}
* annotation.
* @see #BEFORE_TEST_CLASS
* @see #AFTER_TEST_CLASS
* @see #BEFORE_TEST_METHOD
*/ */
AFTER_TEST_METHOD AFTER_TEST_METHOD
} }