Introduce class-level execution phases for @Sql

Resolves gh-18929.

Author: aahlenst

spring-test/src/main/java/org/springframework/test/context/TestContext.java

@@ -110,6 +110,25 @@ default void publishEvent(Function<TestContext, ? extends ApplicationEvent> even
 	 */
 	Object getTestInstance();
 
+	/**
+	 * Tests whether a test method is part of this test context. Returns
+	 * {@code true} if this context has a current test method, {@code false}
+	 * otherwise.
+	 *
+	 * <p>The default implementation of this method always returns {@code false}.
+	 * Custom {@code TestContext} implementations are therefore highly encouraged
+	 * to override this method with a more meaningful implementation. Note that
+	 * the standard {@code TestContext} implementation in Spring overrides this
+	 * method appropriately.
+	 * @return {@code true} if the test execution has already entered a test
+	 * method
+	 * @since 6.1
+	 * @see #getTestMethod()
+	 */
+	default boolean hasTestMethod() {
+		return false;
+	}
+
 	/**
 	 * Get the current {@linkplain Method test method} for this test context.
 	 * <p>Note: this is a mutable property.

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

@@ -33,6 +33,11 @@
  *
  * <p>Method-level declarations override class-level declarations by default,
  * but this behavior can be configured via {@link SqlMergeMode @SqlMergeMode}.
+ * However, this does not apply to class-level declarations that use
+ * {@link ExecutionPhase#BEFORE_TEST_CLASS} or
+ * {@link ExecutionPhase#AFTER_TEST_CLASS}. Such declarations are retained and
+ * scripts and statements are executed once per class in addition to any
+ * method-level annotations.
  *
  * <p>Script execution is performed by the {@link SqlScriptsTestExecutionListener},
  * which is enabled by default.
@@ -161,6 +166,18 @@
 	 */
 	enum ExecutionPhase {
 
+		/**
+		 * The configured SQL scripts and statements will be executed
+		 * once <em>before</em> any test method is run.
+		 */
+		BEFORE_TEST_CLASS,
+
+		/**
+		 * The configured SQL scripts and statements will be executed
+		 * once <em>after</em> any test method is run.
+		 */
+		AFTER_TEST_CLASS,
+
 		/**
 		 * The configured SQL scripts and statements will be executed
 		 * <em>before</em> the corresponding test method.

spring-test/src/main/java/org/springframework/test/context/jdbc/SqlScriptsTestExecutionListener.java

@@ -67,10 +67,17 @@
  * {@link Sql#scripts scripts} and inlined {@link Sql#statements statements}
  * configured via the {@link Sql @Sql} annotation.
  *
- * <p>Scripts and inlined statements will be executed {@linkplain #beforeTestMethod(TestContext) before}
- * or {@linkplain #afterTestMethod(TestContext) after} execution of the corresponding
- * {@linkplain java.lang.reflect.Method test method}, depending on the configured
- * value of the {@link Sql#executionPhase executionPhase} flag.
+ * <p>Class-level annotations that are constrained to a class-level execution
+ * phase ({@link ExecutionPhase#BEFORE_TEST_CLASS} or
+ * {@link ExecutionPhase#AFTER_TEST_CLASS}) will be run
+ * {@linkplain #beforeTestClass(TestContext) once before all test methods} or
+ * {@linkplain #afterTestMethod(TestContext) once after all test methods},
+ * respectively. All other scripts and inlined statements will be executed
+ * {@linkplain #beforeTestMethod(TestContext) before} or
+ * {@linkplain #afterTestMethod(TestContext) after} execution of the
+ * corresponding {@linkplain java.lang.reflect.Method test method}, depending
+ * on the configured value of the {@link Sql#executionPhase executionPhase}
+ * flag.
  *
  * <p>Scripts and inlined statements will be executed without a transaction,
  * within an existing Spring-managed transaction, or within an isolated transaction,
@@ -126,6 +133,26 @@ public final int getOrder() {
 		return 5000;
 	}
 
+	/**
+	 * Execute SQL scripts configured via {@link Sql @Sql} for the supplied
+	 * {@link TestContext} once per test class <em>before</em> any test method
+	 * is run.
+	 */
+	@Override
+	public void beforeTestClass(TestContext testContext) throws Exception {
+		executeBeforeOrAfterClassSqlScripts(testContext, ExecutionPhase.BEFORE_TEST_CLASS);
+	}
+
+	/**
+	 * Execute SQL scripts configured via {@link Sql @Sql} for the supplied
+	 * {@link TestContext} once per test class <em>after</em> all test methods
+	 * have been run.
+	 */
+	@Override
+	public void afterTestClass(TestContext testContext) throws Exception {
+		executeBeforeOrAfterClassSqlScripts(testContext, ExecutionPhase.AFTER_TEST_CLASS);
+	}
+
 	/**
 	 * Execute SQL scripts configured via {@link Sql @Sql} for the supplied
 	 * {@link TestContext} <em>before</em> the current test method.
@@ -159,6 +186,17 @@ public void processAheadOfTime(RuntimeHints runtimeHints, Class<?> testClass, Cl
 				registerClasspathResources(getScripts(sql, testClass, testMethod, false), runtimeHints, classLoader)));
 	}
 
+	/**
+	 * Execute class-level SQL scripts configured via {@link Sql @Sql} for the
+	 * supplied {@link TestContext} and the execution phases
+	 * {@link ExecutionPhase#BEFORE_TEST_CLASS} and
+	 * {@link ExecutionPhase#AFTER_TEST_CLASS}.
+	 */
+	private void executeBeforeOrAfterClassSqlScripts(TestContext testContext, ExecutionPhase executionPhase) {
+		Class<?> testClass = testContext.getTestClass();
+		executeSqlScripts(getSqlAnnotationsFor(testClass), testContext, executionPhase, true);
+	}
+
 	/**
 	 * Execute SQL scripts configured via {@link Sql @Sql} for the supplied
 	 * {@link TestContext} and {@link ExecutionPhase}.
@@ -260,7 +298,12 @@ else if (logger.isDebugEnabled()) {
 					.formatted(executionPhase, testContext.getTestClass().getName()));
 		}
 
-		String[] scripts = getScripts(sql, testContext.getTestClass(), testContext.getTestMethod(), classLevel);
+		Method testMethod = null;
+		if (testContext.hasTestMethod()) {
+			testMethod = testContext.getTestMethod();
+		}
+
+		String[] scripts = getScripts(sql, testContext.getTestClass(), testMethod, classLevel);
 		List<Resource> scriptResources = TestContextResourceUtils.convertToResourceList(
 				testContext.getApplicationContext(), scripts);
 		for (String stmt : sql.statements()) {
@@ -354,7 +397,7 @@ private DataSource getDataSourceFromTransactionManager(PlatformTransactionManage
 		return null;
 	}
 
-	private String[] getScripts(Sql sql, Class<?> testClass, Method testMethod, boolean classLevel) {
+	private String[] getScripts(Sql sql, Class<?> testClass, @Nullable Method testMethod, boolean classLevel) {
 		String[] scripts = sql.scripts();
 		if (ObjectUtils.isEmpty(scripts) && ObjectUtils.isEmpty(sql.statements())) {
 			scripts = new String[] {detectDefaultScript(testClass, testMethod, classLevel)};
@@ -366,7 +409,11 @@ private String[] getScripts(Sql sql, Class<?> testClass, Method testMethod, bool
 	 * Detect a default SQL script by implementing the algorithm defined in
 	 * {@link Sql#scripts}.
 	 */
-	private String detectDefaultScript(Class<?> testClass, Method testMethod, boolean classLevel) {
+	private String detectDefaultScript(Class<?> testClass, @Nullable Method testMethod, boolean classLevel) {
+		if (!classLevel && testMethod == null) {
+			throw new AssertionError("Method-level @Sql requires a testMethod");
+		}
+
 		String elementType = (classLevel ? "class" : "method");
 		String elementName = (classLevel ? testClass.getName() : testMethod.toString());
 

spring-test/src/main/java/org/springframework/test/context/support/DefaultTestContext.java

@@ -166,6 +166,11 @@ public final Object getTestInstance() {
 		return testInstance;
 	}
 
+	@Override
+	public boolean hasTestMethod() {
+		return this.testMethod != null;
+	}
+
 	@Override
 	public final Method getTestMethod() {
 		Method testMethod = this.testMethod;

spring-test/src/main/java/org/springframework/test/context/transaction/TestContextTransactionUtils.java

@@ -227,7 +227,8 @@ private static void logBeansException(TestContext testContext, BeansException ex
 	/**
 	 * Create a delegating {@link TransactionAttribute} for the supplied target
 	 * {@link TransactionAttribute} and {@link TestContext}, using the names of
-	 * the test class and test method to build the name of the transaction.
+	 * the test class and test method (if available) to build the name of the
+	 * transaction.
 	 * @param testContext the {@code TestContext} upon which to base the name
 	 * @param targetAttribute the {@code TransactionAttribute} to delegate to
 	 * @return the delegating {@code TransactionAttribute}
@@ -248,7 +249,13 @@ private static class TestContextTransactionAttribute extends DelegatingTransacti
 
 		public TestContextTransactionAttribute(TransactionAttribute targetAttribute, TestContext testContext) {
 			super(targetAttribute);
-			this.name = ClassUtils.getQualifiedMethodName(testContext.getTestMethod(), testContext.getTestClass());
+
+			if (testContext.hasTestMethod()) {
+				this.name = ClassUtils.getQualifiedMethodName(testContext.getTestMethod(), testContext.getTestClass());
+			}
+			else {
+				this.name = testContext.getTestClass().getName();
+			}
 		}
 
 		@Override

spring-test/src/test/java/org/springframework/test/context/jdbc/AfterTestClassSqlScriptsTests.java

@@ -0,0 +1,69 @@
+/*
+ * Copyright 2002-2021 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.jdbc;
+
+import javax.sql.DataSource;
+
+import org.junit.jupiter.api.Test;
+
+import org.springframework.core.Ordered;
+import org.springframework.jdbc.BadSqlGrammarException;
+import org.springframework.jdbc.core.JdbcTemplate;
+import org.springframework.test.annotation.DirtiesContext;
+import org.springframework.test.context.TestContext;
+import org.springframework.test.context.TestExecutionListener;
+import org.springframework.test.context.TestExecutionListeners;
+import org.springframework.test.context.junit.jupiter.SpringJUnitConfig;
+import org.springframework.test.context.transaction.TestContextTransactionUtils;
+
+@SpringJUnitConfig(PopulatedSchemaDatabaseConfig.class)
+@DirtiesContext
+@Sql(value = {"drop-schema.sql"}, executionPhase = Sql.ExecutionPhase.AFTER_TEST_CLASS)
+@TestExecutionListeners(
+		value = AfterTestClassSqlScriptsTests.VerifyTestExecutionListener.class,
+		mergeMode = TestExecutionListeners.MergeMode.MERGE_WITH_DEFAULTS
+)
+class AfterTestClassSqlScriptsTests extends AbstractTransactionalTests {
+
+	@Test
+	@Sql(scripts = "data-add-catbert.sql")
+	void databaseHasBeenInitialized() {
+		// Ensure that the database has been initialized and can be accessed.
+		assertUsers("Catbert");
+	}
+
+	static class VerifyTestExecutionListener implements TestExecutionListener, Ordered {
+
+		@Override
+		public void afterTestClass(TestContext testContext) throws Exception {
+			DataSource dataSource = TestContextTransactionUtils.retrieveDataSource(testContext, null);
+			try {
+				new JdbcTemplate(dataSource).queryForList("SELECT name FROM user", String.class);
+				throw new AssertionError("BadSqlGrammarException should have been thrown.");
+			}
+			catch (BadSqlGrammarException expected) {
+			}
+		}
+
+		@Override
+		public int getOrder() {
+			// Must run before DirtiesContextTestExecutionListener. Otherwise, the old data source will be removed and
+			// replaced with a new one.
+			return 3001;
+		}
+	}
+}

spring-test/src/test/java/org/springframework/test/context/jdbc/BeforeTestClassSqlScriptsTests.java

@@ -0,0 +1,59 @@
+/*
+ * Copyright 2002-2021 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.jdbc;
+
+import org.junit.jupiter.api.Test;
+
+import org.springframework.test.annotation.DirtiesContext;
+import org.springframework.test.context.junit.jupiter.SpringJUnitConfig;
+
+import static org.springframework.test.context.jdbc.SqlMergeMode.MergeMode.MERGE;
+import static org.springframework.test.context.jdbc.SqlMergeMode.MergeMode.OVERRIDE;
+
+@SpringJUnitConfig(classes = EmptyDatabaseConfig.class)
+@DirtiesContext
+@Sql(value = {"schema.sql", "data-add-catbert.sql"}, executionPhase = Sql.ExecutionPhase.BEFORE_TEST_CLASS)
+class BeforeTestClassSqlScriptsTests extends AbstractTransactionalTests {
+
+	@Test
+	void classLevelScriptsHaveBeenRun() {
+		assertUsers("Catbert");
+	}
+
+	@Test
+	@Sql("data-add-dogbert.sql")
+	@SqlMergeMode(MERGE)
+	void mergeDoesNotAffectClassLevelPhase() {
+		assertUsers("Catbert", "Dogbert");
+	}
+
+	@Test
+	@Sql({"data-add-dogbert.sql"})
+	@SqlMergeMode(OVERRIDE)
+	void overrideDoesNotAffectClassLevelPhase() {
+		assertUsers("Dogbert", "Catbert");
+	}
+
+	@Test
+	@Sql(scripts = {"data-add-catbert.sql"}, executionPhase = Sql.ExecutionPhase.BEFORE_TEST_CLASS)
+	void classLevelPhaseIsIgnoredOnMethod() {
+		// There's a unique constraint on the name. If the script succeeded, there would be a
+		// constraint violation.
+		assertUsers("Catbert");
+	}
+}
+

spring-test/src/test/java/org/springframework/test/context/jdbc/SqlScriptsTestExecutionListenerTests.java

@@ -56,6 +56,7 @@ void missingValueAndScriptsAndStatementsAtClassLevel() throws Exception {
 	void missingValueAndScriptsAndStatementsAtMethodLevel() throws Exception {
 		Class<?> clazz = MissingValueAndScriptsAndStatementsAtMethodLevel.class;
 		BDDMockito.<Class<?>> given(testContext.getTestClass()).willReturn(clazz);
+		given(testContext.hasTestMethod()).willReturn(true);
 		given(testContext.getTestMethod()).willReturn(clazz.getDeclaredMethod("foo"));
 
 		assertExceptionContains(clazz.getSimpleName() + ".foo" + ".sql");