Introduce before/after test execution callbacks in the TCF

This commit introduces 'before' and 'after' test execution callbacks in
the Spring TestContext Framework. Specifically, this set of commits
introduces the following.

- beforeTestExecution() and afterTestExecution() callbacks in the
  TestExecutionListener API

- beforeTestExecution() and afterTestExecution() callbacks in
  TestContextManager

- RunBeforeTestExecutionCallbacks and RunAfterTestExecutionCallbacks
  JUnit 4 statements that are used by the SpringJUnit4ClassRunner

- Documentation in the class-level Javadoc for SpringMethodRule stating
  that before/after test execution callbacks cannot be supported with
  JUnit 4 Rules

- Support for JUnit Jupiter's BeforeTestExecutionCallback and
  AfterTestExecutionCallback extension APIs in the SpringExtension for
  JUnit 5

- Support for before/after test execution callbacks in
  AbstractTestNGSpringContextTests for TestNG

Issue: SPR-4365

Author: sbrannen

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

@@ -55,6 +55,7 @@
  * @author Sam Brannen
  * @author Juergen Hoeller
  * @since 2.5
+ * @see TestContextManager
  * @see org.springframework.test.context.support.AbstractTestExecutionListener
  */
 public interface TestExecutionListener {
@@ -70,6 +71,7 @@ public interface TestExecutionListener {
 	 * concrete classes as necessary.
 	 * @param testContext the test context for the test; never {@code null}
 	 * @throws Exception allows any exception to propagate
+	 * @since 3.0
 	 */
 	default void beforeTestClass(TestContext testContext) throws Exception {
 		/* no-op */
@@ -90,34 +92,90 @@ default void prepareTestInstance(TestContext testContext) throws Exception {
 	}
 
 	/**
-	 * Pre-processes a test <em>before</em> execution of the
+	 * Pre-processes a test <em>before</em> execution of <em>before</em>
+	 * lifecycle callbacks of the underlying test framework &mdash; for example,
+	 * by setting up test fixtures.
+	 * <p>This method <strong>must</strong> be called immediately prior to
+	 * framework-specific <em>before</em> lifecycle callbacks. For historical
+	 * reasons, this method is named {@code beforeTestMethod}. Since the
+	 * introduction of {@link #beforeTestExecution}, a more suitable name for
+	 * this method might be something like {@code beforeTestSetUp} or
+	 * {@code beforeEach}; however, it is unfortunately impossible to rename
+	 * this method due to backward compatibility concerns.
+	 * <p>The default implementation is <em>empty</em>. Can be overridden by
+	 * concrete classes as necessary.
+	 * @param testContext the test context in which the test method will be
+	 * executed; never {@code null}
+	 * @throws Exception allows any exception to propagate
+	 * @see #afterTestMethod
+	 * @see #beforeTestExecution
+	 * @see #afterTestExecution
+	 */
+	default void beforeTestMethod(TestContext testContext) throws Exception {
+		/* no-op */
+	}
+
+	/**
+	 * Pre-processes a test <em>immediately before</em> execution of the
 	 * {@link java.lang.reflect.Method test method} in the supplied
-	 * {@link TestContext test context}, for example by setting up test
-	 * fixtures.
-	 * <p>This method should be called immediately prior to framework-specific
+	 * {@link TestContext test context} &mdash; for example, for timing
+	 * or logging purposes.
+	 * <p>This method <strong>must</strong> be called after framework-specific
 	 * <em>before</em> lifecycle callbacks.
 	 * <p>The default implementation is <em>empty</em>. Can be overridden by
 	 * concrete classes as necessary.
 	 * @param testContext the test context in which the test method will be
 	 * executed; never {@code null}
 	 * @throws Exception allows any exception to propagate
+	 * @since 5.0
+	 * @see #beforeTestMethod
+	 * @see #afterTestMethod
+	 * @see #afterTestExecution
 	 */
-	default void beforeTestMethod(TestContext testContext) throws Exception {
+	default void beforeTestExecution(TestContext testContext) throws Exception {
 		/* no-op */
 	}
 
 	/**
-	 * Post-processes a test <em>after</em> execution of the
+	 * Post-processes a test <em>immediately after</em> execution of the
 	 * {@link java.lang.reflect.Method test method} in the supplied
-	 * {@link TestContext test context}, for example by tearing down test
-	 * fixtures.
-	 * <p>This method should be called immediately after framework-specific
+	 * {@link TestContext test context} &mdash; for example, for timing
+	 * or logging purposes.
+	 * <p>This method <strong>must</strong> be called before framework-specific
 	 * <em>after</em> lifecycle callbacks.
 	 * <p>The default implementation is <em>empty</em>. Can be overridden by
 	 * concrete classes as necessary.
+	 * @param testContext the test context in which the test method will be
+	 * executed; never {@code null}
+	 * @throws Exception allows any exception to propagate
+	 * @since 5.0
+	 * @see #beforeTestMethod
+	 * @see #afterTestMethod
+	 * @see #beforeTestExecution
+	 */
+	default void afterTestExecution(TestContext testContext) throws Exception {
+		/* no-op */
+	}
+
+	/**
+	 * Post-processes a test <em>after</em> execution of <em>after</em>
+	 * lifecycle callbacks of the underlying test framework &mdash; for example,
+	 * by tearing down test fixtures.
+	 * <p>This method <strong>must</strong> be called immediately after
+	 * framework-specific <em>after</em> lifecycle callbacks. For historical
+	 * reasons, this method is named {@code afterTestMethod}. Since the
+	 * introduction of {@link #afterTestExecution}, a more suitable name for
+	 * this method might be something like {@code afterTestTearDown} or
+	 * {@code afterEach}; however, it is unfortunately impossible to rename
+	 * this method due to backward compatibility concerns.
+	 * <p>The default implementation is <em>empty</em>. Can be overridden by
+	 * concrete classes as necessary.
 	 * @param testContext the test context in which the test method was
 	 * executed; never {@code null}
 	 * @throws Exception allows any exception to propagate
+	 * @see #beforeTestMethod
+	 * @see #beforeTestExecution
+	 * @see #afterTestExecution
 	 */
 	default void afterTestMethod(TestContext testContext) throws Exception {
 		/* no-op */
@@ -134,6 +192,7 @@ default void afterTestMethod(TestContext testContext) throws Exception {
 	 * concrete classes as necessary.
 	 * @param testContext the test context for the test; never {@code null}
 	 * @throws Exception allows any exception to propagate
+	 * @since 3.0
 	 */
 	default void afterTestClass(TestContext testContext) throws Exception {
 		/* no-op */

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

@@ -23,8 +23,10 @@
 
 import org.junit.jupiter.api.extension.AfterAllCallback;
 import org.junit.jupiter.api.extension.AfterEachCallback;
+import org.junit.jupiter.api.extension.AfterTestExecutionCallback;
 import org.junit.jupiter.api.extension.BeforeAllCallback;
 import org.junit.jupiter.api.extension.BeforeEachCallback;
+import org.junit.jupiter.api.extension.BeforeTestExecutionCallback;
 import org.junit.jupiter.api.extension.ContainerExtensionContext;
 import org.junit.jupiter.api.extension.ExtensionContext;
 import org.junit.jupiter.api.extension.ExtensionContext.Namespace;
@@ -54,7 +56,8 @@
  * @see org.springframework.test.context.TestContextManager
  */
 public class SpringExtension implements BeforeAllCallback, AfterAllCallback, TestInstancePostProcessor,
-		BeforeEachCallback, AfterEachCallback, ParameterResolver {
+		BeforeEachCallback, AfterEachCallback, BeforeTestExecutionCallback, AfterTestExecutionCallback,
+		ParameterResolver {
 
 	/**
 	 * {@link Namespace} in which {@code TestContextManagers} are stored, keyed
@@ -101,6 +104,27 @@ public void beforeEach(TestExtensionContext context) throws Exception {
 		getTestContextManager(context).beforeTestMethod(testInstance, testMethod);
 	}
 
+	/**
+	 * Delegates to {@link TestContextManager#beforeTestExecution}.
+	 */
+	@Override
+	public void beforeTestExecution(TestExtensionContext context) throws Exception {
+		Object testInstance = context.getTestInstance();
+		Method testMethod = context.getTestMethod().get();
+		getTestContextManager(context).beforeTestExecution(testInstance, testMethod);
+	}
+
+	/**
+	 * Delegates to {@link TestContextManager#afterTestExecution}.
+	 */
+	@Override
+	public void afterTestExecution(TestExtensionContext context) throws Exception {
+		Object testInstance = context.getTestInstance();
+		Method testMethod = context.getTestMethod().get();
+		Throwable testException = context.getTestException().orElse(null);
+		getTestContextManager(context).afterTestExecution(testInstance, testMethod, testException);
+	}
+
 	/**
 	 * Delegates to {@link TestContextManager#afterTestMethod}.
 	 */

spring-test/src/main/java/org/springframework/test/context/junit/jupiter/SpringExtension.java

@@ -42,8 +42,10 @@
 import org.springframework.test.context.junit4.rules.SpringClassRule;
 import org.springframework.test.context.junit4.rules.SpringMethodRule;
 import org.springframework.test.context.junit4.statements.RunAfterTestClassCallbacks;
+import org.springframework.test.context.junit4.statements.RunAfterTestExecutionCallbacks;
 import org.springframework.test.context.junit4.statements.RunAfterTestMethodCallbacks;
 import org.springframework.test.context.junit4.statements.RunBeforeTestClassCallbacks;
+import org.springframework.test.context.junit4.statements.RunBeforeTestExecutionCallbacks;
 import org.springframework.test.context.junit4.statements.RunBeforeTestMethodCallbacks;
 import org.springframework.test.context.junit4.statements.SpringFailOnTimeout;
 import org.springframework.test.context.junit4.statements.SpringRepeat;
@@ -270,6 +272,9 @@ protected void runChild(FrameworkMethod frameworkMethod, RunNotifier notifier) {
 	 * Spring-specific timeouts in that the former execute in a separate
 	 * thread while the latter simply execute in the main thread (like regular
 	 * tests).
+	 * @see #methodInvoker(FrameworkMethod, Object)
+	 * @see #withBeforeTestExecutionCallbacks(FrameworkMethod, Object, Statement)
+	 * @see #withAfterTestExecutionCallbacks(FrameworkMethod, Object, Statement)
 	 * @see #possiblyExpectingExceptions(FrameworkMethod, Object, Statement)
 	 * @see #withBefores(FrameworkMethod, Object, Statement)
 	 * @see #withAfters(FrameworkMethod, Object, Statement)
@@ -293,6 +298,8 @@ protected Object runReflectiveCall() throws Throwable {
 		}
 
 		Statement statement = methodInvoker(frameworkMethod, testInstance);
+		statement = withBeforeTestExecutionCallbacks(frameworkMethod, testInstance, statement);
+		statement = withAfterTestExecutionCallbacks(frameworkMethod, testInstance, statement);
 		statement = possiblyExpectingExceptions(frameworkMethod, testInstance, statement);
 		statement = withBefores(frameworkMethod, testInstance, statement);
 		statement = withAfters(frameworkMethod, testInstance, statement);
@@ -404,6 +411,26 @@ protected long getSpringTimeout(FrameworkMethod frameworkMethod) {
 		return TestAnnotationUtils.getTimeout(frameworkMethod.getMethod());
 	}
 
+	/**
+	 * Wrap the supplied {@link Statement} with a {@code RunBeforeTestExecutionCallbacks}
+	 * statement, thus preserving the default functionality while adding support for the
+	 * Spring TestContext Framework.
+	 * @see RunBeforeTestExecutionCallbacks
+	 */
+	protected Statement withBeforeTestExecutionCallbacks(FrameworkMethod frameworkMethod, Object testInstance, Statement statement) {
+		return new RunBeforeTestExecutionCallbacks(statement, testInstance, frameworkMethod.getMethod(), getTestContextManager());
+	}
+
+	/**
+	 * Wrap the supplied {@link Statement} with a {@code RunAfterTestExecutionCallbacks}
+	 * statement, thus preserving the default functionality while adding support for the
+	 * Spring TestContext Framework.
+	 * @see RunAfterTestExecutionCallbacks
+	 */
+	protected Statement withAfterTestExecutionCallbacks(FrameworkMethod frameworkMethod, Object testInstance, Statement statement) {
+		return new RunAfterTestExecutionCallbacks(statement, testInstance, frameworkMethod.getMethod(), getTestContextManager());
+	}
+
 	/**
 	 * Wrap the {@link Statement} returned by the parent implementation with a
 	 * {@code RunBeforeTestMethodCallbacks} statement, thus preserving the
@@ -414,8 +441,7 @@ protected long getSpringTimeout(FrameworkMethod frameworkMethod) {
 	@Override
 	protected Statement withBefores(FrameworkMethod frameworkMethod, Object testInstance, Statement statement) {
 		Statement junitBefores = super.withBefores(frameworkMethod, testInstance, statement);
-		return new RunBeforeTestMethodCallbacks(junitBefores, testInstance, frameworkMethod.getMethod(),
-				getTestContextManager());
+		return new RunBeforeTestMethodCallbacks(junitBefores, testInstance, frameworkMethod.getMethod(), getTestContextManager());
 	}
 
 	/**
@@ -428,8 +454,7 @@ protected Statement withBefores(FrameworkMethod frameworkMethod, Object testInst
 	@Override
 	protected Statement withAfters(FrameworkMethod frameworkMethod, Object testInstance, Statement statement) {
 		Statement junitAfters = super.withAfters(frameworkMethod, testInstance, statement);
-		return new RunAfterTestMethodCallbacks(junitAfters, testInstance, frameworkMethod.getMethod(),
-				getTestContextManager());
+		return new RunAfterTestMethodCallbacks(junitAfters, testInstance, frameworkMethod.getMethod(), getTestContextManager());
 	}
 
 	/**

spring-test/src/main/java/org/springframework/test/context/junit4/SpringJUnit4ClassRunner.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2015 the original author or authors.
+ * Copyright 2002-2016 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.
@@ -37,7 +37,7 @@
 import org.springframework.util.ReflectionUtils;
 
 /**
- * {@code SpringMethodRule} is a custom JUnit {@link MethodRule} that
+ * {@code SpringMethodRule} is a custom JUnit 4 {@link MethodRule} that
  * supports instance-level and method-level features of the
  * <em>Spring TestContext Framework</em> in standard JUnit tests by means
  * of the {@link TestContextManager} and associated support classes and
@@ -82,6 +82,12 @@
  *
  * <p><strong>NOTE:</strong> As of Spring Framework 4.3, this class requires JUnit 4.12 or higher.
  *
+ * <p><strong>WARNING:</strong> Due to the shortcomings of JUnit rules, the
+ * {@code SpringMethodRule} does <strong>not</strong> support the
+ * {@code beforeTestExecution()} and {@code afterTestExecution()} callbacks of the
+ * {@link org.springframework.test.context.TestExecutionListener TestExecutionListener}
+ * API.
+ *
  * @author Sam Brannen
  * @author Philippe Marschall
  * @since 4.2

spring-test/src/main/java/org/springframework/test/context/junit4/rules/SpringMethodRule.java

@@ -0,0 +1,100 @@
+/*
+ * Copyright 2002-2016 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.springframework.test.context.junit4.statements;
+
+import java.lang.reflect.Method;
+import java.util.ArrayList;
+import java.util.List;
+
+import org.junit.runners.model.MultipleFailureException;
+import org.junit.runners.model.Statement;
+import org.springframework.test.context.TestContextManager;
+
+/**
+ * {@code RunAfterTestExecutionCallbacks} is a custom JUnit {@link Statement}
+ * which allows the <em>Spring TestContext Framework</em> to be plugged into the
+ * JUnit 4 execution chain by calling {@link TestContextManager#afterTestExecution
+ * afterTestExecution()} on the supplied {@link TestContextManager}.
+ *
+ * <p><strong>NOTE:</strong> This class requires JUnit 4.9 or higher.
+ *
+ * @author Sam Brannen
+ * @since 5.0
+ * @see #evaluate()
+ * @see RunBeforeTestExecutionCallbacks
+ */
+public class RunAfterTestExecutionCallbacks extends Statement {
+
+	private final Statement next;
+
+	private final Object testInstance;
+
+	private final Method testMethod;
+
+	private final TestContextManager testContextManager;
+
+
+	/**
+	 * Construct a new {@code RunAfterTestExecutionCallbacks} statement.
+	 * @param next the next {@code Statement} in the execution chain
+	 * @param testInstance the current test instance (never {@code null})
+	 * @param testMethod the test method which has just been executed on the
+	 * test instance
+	 * @param testContextManager the TestContextManager upon which to call
+	 * {@code afterTestExecution()}
+	 */
+	public RunAfterTestExecutionCallbacks(Statement next, Object testInstance, Method testMethod,
+			TestContextManager testContextManager) {
+
+		this.next = next;
+		this.testInstance = testInstance;
+		this.testMethod = testMethod;
+		this.testContextManager = testContextManager;
+	}
+
+	/**
+	 * Evaluate the next {@link Statement} in the execution chain (typically an
+	 * instance of {@link RunBeforeTestExecutionCallbacks}), catching any exceptions
+	 * thrown, and then invoke {@link TestContextManager#afterTestExecution} supplying
+	 * the first caught exception (if any).
+	 * <p>If the invocation of {@code afterTestExecution()} throws an exception, that
+	 * exception will also be tracked. Multiple exceptions will be combined into a
+	 * {@link MultipleFailureException}.
+	 */
+	@Override
+	public void evaluate() throws Throwable {
+		Throwable testException = null;
+		List<Throwable> errors = new ArrayList<>();
+		try {
+			this.next.evaluate();
+		}
+		catch (Throwable ex) {
+			testException = ex;
+			errors.add(ex);
+		}
+
+		try {
+			this.testContextManager.afterTestExecution(this.testInstance, this.testMethod, testException);
+		}
+		catch (Throwable ex) {
+			errors.add(ex);
+		}
+
+		MultipleFailureException.assertEmpty(errors);
+	}
+
+}