Merge branch '6.1.x'

sbrannen · Mar 1, 2024 · c76d681 · c76d681
2 parents 4149d5c + de828e9
commit c76d681
Showing 1 changed file with 44 additions and 5 deletions.
diff --git a/spring-test/src/main/java/org/springframework/test/context/jdbc/Sql.java b/spring-test/src/main/java/org/springframework/test/context/jdbc/Sql.java
@@ -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");
  * you may not use this file except in compliance with the License.
@@ -171,28 +171,67 @@
 	enum ExecutionPhase {
 
 		/**
-		 * The configured SQL scripts and statements will be executed
-		 * once per test class <em>before</em> any test method is run.
+		 * The configured SQL scripts and statements will be executed once per
+		 * 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
+		 * @see #AFTER_TEST_CLASS
+		 * @see #BEFORE_TEST_METHOD
+		 * @see #AFTER_TEST_METHOD
 		 */
 		BEFORE_TEST_CLASS,
 
 		/**
-		 * The configured SQL scripts and statements will be executed
-		 * once per test class <em>after</em> all test methods have run.
+		 * The configured SQL scripts and statements will be executed once per
+		 * 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
+		 * @see #BEFORE_TEST_CLASS
+		 * @see #BEFORE_TEST_METHOD
+		 * @see #AFTER_TEST_METHOD
 		 */
 		AFTER_TEST_CLASS,
 
 		/**
 		 * The configured SQL scripts and statements will be executed
 		 * <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,
 
 		/**
 		 * The configured SQL scripts and statements will be executed
 		 * <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
 	}