Register EventPublishingTestExecutionListener by default (round 2)

This commit registers the EventPublishingTestExecutionListener as a
default TestExecutionListener with an order of 10,000. This registers
the EventPublishingTestExecutionListener as the last listener provided
by the Spring Framework.

With EventPublishingTestExecutionListener registered with an order of
10,000, it is effectively wrapped by all other Spring listeners,
including support for @DirtiesContext and test-managed transactions.

Furthermore, this commit revises the implementation of
EventPublishingTestExecutionListener to take advantage of the new
TestContext#hasApplicationContext() support which allows the
EventPublishingTestExecutionListener to publish events only if the
test's ApplicationContext is currently available. This avoids
undesirable side-effects such as eager loading of the
ApplicationContext before it is needed or re-loading of the
ApplicationContext after it has been intentionally closed.

Closes gh-18490

Author: sbrannen

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

@@ -44,8 +44,6 @@
  * <p>Spring provides the following out-of-the-box implementations (all of
  * which implement {@code Ordered}):
  * <ul>
- * <li>{@link org.springframework.test.context.event.EventPublishingTestExecutionListener
- * EventPublishingTestExecutionListener} (not registered by default)</li>
  * <li>{@link org.springframework.test.context.web.ServletTestExecutionListener
  * ServletTestExecutionListener}</li>
  * <li>{@link org.springframework.test.context.support.DirtiesContextBeforeModesTestExecutionListener
@@ -58,6 +56,8 @@
  * TransactionalTestExecutionListener}</li>
  * <li>{@link org.springframework.test.context.jdbc.SqlScriptsTestExecutionListener
  * SqlScriptsTestExecutionListener}</li>
+ * <li>{@link org.springframework.test.context.event.EventPublishingTestExecutionListener
+ * EventPublishingTestExecutionListener}</li>
  * </ul>
  *
  * @author Sam Brannen

spring-test/src/main/java/org/springframework/test/context/event/EventPublishingTestExecutionListener.java

@@ -16,15 +16,19 @@
 
 package org.springframework.test.context.event;
 
-import org.springframework.core.Ordered;
+import java.util.function.Function;
+
 import org.springframework.test.context.TestContext;
 import org.springframework.test.context.TestExecutionListener;
 import org.springframework.test.context.support.AbstractTestExecutionListener;
 
 /**
  * {@link org.springframework.test.context.TestExecutionListener TestExecutionListener}
- * that publishes test execution events to a Spring test
- * {@link org.springframework.context.ApplicationContext ApplicationContext}.
+ * that publishes test execution events to the
+ * {@link org.springframework.context.ApplicationContext ApplicationContext}
+ * for the currently executing test. Events are only published if the
+ * {@code ApplicationContext} {@linkplain TestContext#hasApplicationContext()
+ * has already been loaded}.
  *
  * <h3>Supported Events</h3>
  * <ul>
@@ -61,16 +65,8 @@
  * support. For further details, consult the class-level Javadoc for
  * {@link org.springframework.context.event.EventListener @EventListener}.
  *
- * <h3>Listener Registration</h3>
- * <p>Note that this {@code TestExecutionListener} is not registered by default,
- * but it may be registered for a given test class via
- * {@link org.springframework.test.context.TestExecutionListeners @TestExecutionListeners}
- * or globally via the {@link org.springframework.core.io.support.SpringFactoriesLoader
- * SpringFactoriesLoader} mechanism (consult the Javadoc and Spring reference manual for
- * details).
- *
- * @author Frank Scheffler
  * @author Sam Brannen
+ * @author Frank Scheffler
  * @since 5.2
  * @see org.springframework.test.context.event.annotation.BeforeTestClass @BeforeTestClass
  * @see org.springframework.test.context.event.annotation.PrepareTestInstance @PrepareTestInstance
@@ -83,74 +79,80 @@
 public class EventPublishingTestExecutionListener extends AbstractTestExecutionListener {
 
 	/**
-	 * Returns {@link Ordered#HIGHEST_PRECEDENCE}.
+	 * Returns {@code 10000}.
 	 */
 	@Override
-	public int getOrder() {
-		return Ordered.HIGHEST_PRECEDENCE;
+	public final int getOrder() {
+		return 10_000;
 	}
 
 	/**
-	 * Publishes a {@link BeforeTestClassEvent} to the {@code ApplicationContext}
+	 * Publish a {@link BeforeTestClassEvent} to the {@code ApplicationContext}
 	 * for the supplied {@link TestContext}.
 	 */
 	@Override
 	public void beforeTestClass(TestContext testContext) {
-		testContext.getApplicationContext().publishEvent(new BeforeTestClassEvent(testContext));
+		publishEvent(testContext, BeforeTestClassEvent::new);
 	}
 
 	/**
-	 * Publishes a {@link PrepareTestInstanceEvent} to the {@code ApplicationContext}
+	 * Publish a {@link PrepareTestInstanceEvent} to the {@code ApplicationContext}
 	 * for the supplied {@link TestContext}.
 	 */
 	@Override
 	public void prepareTestInstance(TestContext testContext) {
-		testContext.getApplicationContext().publishEvent(new PrepareTestInstanceEvent(testContext));
+		publishEvent(testContext, PrepareTestInstanceEvent::new);
 	}
 
 	/**
-	 * Publishes a {@link BeforeTestMethodEvent} to the {@code ApplicationContext}
+	 * Publish a {@link BeforeTestMethodEvent} to the {@code ApplicationContext}
 	 * for the supplied {@link TestContext}.
 	 */
 	@Override
 	public void beforeTestMethod(TestContext testContext) {
-		testContext.getApplicationContext().publishEvent(new BeforeTestMethodEvent(testContext));
+		publishEvent(testContext, BeforeTestMethodEvent::new);
 	}
 
 	/**
-	 * Publishes a {@link BeforeTestExecutionEvent} to the {@code ApplicationContext}
+	 * Publish a {@link BeforeTestExecutionEvent} to the {@code ApplicationContext}
 	 * for the supplied {@link TestContext}.
 	 */
 	@Override
 	public void beforeTestExecution(TestContext testContext) {
-		testContext.getApplicationContext().publishEvent(new BeforeTestExecutionEvent(testContext));
+		publishEvent(testContext, BeforeTestExecutionEvent::new);
 	}
 
 	/**
-	 * Publishes an {@link AfterTestExecutionEvent} to the {@code ApplicationContext}
+	 * Publish an {@link AfterTestExecutionEvent} to the {@code ApplicationContext}
 	 * for the supplied {@link TestContext}.
 	 */
 	@Override
 	public void afterTestExecution(TestContext testContext) {
-		testContext.getApplicationContext().publishEvent(new AfterTestExecutionEvent(testContext));
+		publishEvent(testContext, AfterTestExecutionEvent::new);
 	}
 
 	/**
-	 * Publishes an {@link AfterTestMethodEvent} to the {@code ApplicationContext}
+	 * Publish an {@link AfterTestMethodEvent} to the {@code ApplicationContext}
 	 * for the supplied {@link TestContext}.
 	 */
 	@Override
 	public void afterTestMethod(TestContext testContext) {
-		testContext.getApplicationContext().publishEvent(new AfterTestMethodEvent(testContext));
+		publishEvent(testContext, AfterTestMethodEvent::new);
 	}
 
 	/**
-	 * Publishes an {@link AfterTestClassEvent} to the {@code ApplicationContext}
+	 * Publish an {@link AfterTestClassEvent} to the {@code ApplicationContext}
 	 * for the supplied {@link TestContext}.
 	 */
 	@Override
 	public void afterTestClass(TestContext testContext) {
-		testContext.getApplicationContext().publishEvent(new AfterTestClassEvent(testContext));
+		publishEvent(testContext, AfterTestClassEvent::new);
+	}
+
+	private void publishEvent(TestContext testContext, Function<TestContext, TestContextEvent> eventFactory) {
+		if (testContext.hasApplicationContext()) {
+			testContext.getApplicationContext().publishEvent(eventFactory.apply(testContext));
+		}
 	}
 
 }

spring-test/src/main/resources/META-INF/spring.factories

@@ -6,7 +6,8 @@ org.springframework.test.context.TestExecutionListener = \
 	org.springframework.test.context.support.DependencyInjectionTestExecutionListener,\
 	org.springframework.test.context.support.DirtiesContextTestExecutionListener,\
 	org.springframework.test.context.transaction.TransactionalTestExecutionListener,\
-	org.springframework.test.context.jdbc.SqlScriptsTestExecutionListener
+	org.springframework.test.context.jdbc.SqlScriptsTestExecutionListener,\
+	org.springframework.test.context.event.EventPublishingTestExecutionListener
 
 # Default ContextCustomizerFactory implementations for the Spring TestContext Framework
 #

spring-test/src/test/java/org/springframework/test/context/TestExecutionListenersTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2016 the original author or authors.
+ * Copyright 2002-2019 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.
@@ -24,6 +24,7 @@
 
 import org.springframework.core.Ordered;
 import org.springframework.core.annotation.AnnotationConfigurationException;
+import org.springframework.test.context.event.EventPublishingTestExecutionListener;
 import org.springframework.test.context.jdbc.SqlScriptsTestExecutionListener;
 import org.springframework.test.context.support.AbstractTestExecutionListener;
 import org.springframework.test.context.support.DependencyInjectionTestExecutionListener;
@@ -57,7 +58,7 @@ public void defaultListeners() {
 		List<Class<?>> expected = asList(ServletTestExecutionListener.class,
 				DirtiesContextBeforeModesTestExecutionListener.class, DependencyInjectionTestExecutionListener.class,
 				DirtiesContextTestExecutionListener.class, TransactionalTestExecutionListener.class,
-				SqlScriptsTestExecutionListener.class);
+				SqlScriptsTestExecutionListener.class, EventPublishingTestExecutionListener.class);
 		assertRegisteredListeners(DefaultListenersTestCase.class, expected);
 	}
 
@@ -69,7 +70,7 @@ public void defaultListenersMergedWithCustomListenerPrepended() {
 		List<Class<?>> expected = asList(QuuxTestExecutionListener.class, ServletTestExecutionListener.class,
 				DirtiesContextBeforeModesTestExecutionListener.class, DependencyInjectionTestExecutionListener.class,
 				DirtiesContextTestExecutionListener.class, TransactionalTestExecutionListener.class,
-				SqlScriptsTestExecutionListener.class);
+				SqlScriptsTestExecutionListener.class, EventPublishingTestExecutionListener.class);
 		assertRegisteredListeners(MergedDefaultListenersWithCustomListenerPrependedTestCase.class, expected);
 	}
 
@@ -81,7 +82,8 @@ public void defaultListenersMergedWithCustomListenerAppended() {
 		List<Class<?>> expected = asList(ServletTestExecutionListener.class,
 				DirtiesContextBeforeModesTestExecutionListener.class, DependencyInjectionTestExecutionListener.class,
 				DirtiesContextTestExecutionListener.class, TransactionalTestExecutionListener.class,
-				SqlScriptsTestExecutionListener.class, BazTestExecutionListener.class);
+				SqlScriptsTestExecutionListener.class, EventPublishingTestExecutionListener.class,
+				BazTestExecutionListener.class);
 		assertRegisteredListeners(MergedDefaultListenersWithCustomListenerAppendedTestCase.class, expected);
 	}
 
@@ -93,7 +95,8 @@ public void defaultListenersMergedWithCustomListenerInserted() {
 		List<Class<?>> expected = asList(ServletTestExecutionListener.class,
 				DirtiesContextBeforeModesTestExecutionListener.class, DependencyInjectionTestExecutionListener.class,
 				BarTestExecutionListener.class, DirtiesContextTestExecutionListener.class,
-				TransactionalTestExecutionListener.class, SqlScriptsTestExecutionListener.class);
+				TransactionalTestExecutionListener.class, SqlScriptsTestExecutionListener.class,
+				EventPublishingTestExecutionListener.class);
 		assertRegisteredListeners(MergedDefaultListenersWithCustomListenerInsertedTestCase.class, expected);
 	}
 

spring-test/src/test/java/org/springframework/test/context/cache/ClassLevelDirtiesContextTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2016 the original author or authors.
+ * Copyright 2002-2019 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.
@@ -22,15 +22,18 @@
 import org.junit.BeforeClass;
 import org.junit.Test;
 import org.junit.runner.RunWith;
-import org.junit.runners.JUnit4;
 
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.context.ApplicationContext;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.test.annotation.DirtiesContext;
 import org.springframework.test.annotation.DirtiesContext.ClassMode;
 import org.springframework.test.context.ContextConfiguration;
+import org.springframework.test.context.TestExecutionListeners;
 import org.springframework.test.context.junit4.SpringRunner;
+import org.springframework.test.context.support.DependencyInjectionTestExecutionListener;
+import org.springframework.test.context.support.DirtiesContextBeforeModesTestExecutionListener;
+import org.springframework.test.context.support.DirtiesContextTestExecutionListener;
 
 import static org.junit.Assert.*;
 import static org.springframework.test.context.cache.ContextCacheTestUtils.*;
@@ -44,7 +47,6 @@
  * @author Sam Brannen
  * @since 3.0
  */
-@RunWith(JUnit4.class)
 public class ClassLevelDirtiesContextTests {
 
 	private static final AtomicInteger cacheHits = new AtomicInteger(0);
@@ -146,6 +148,14 @@ public static void verifyFinalCacheState() {
 
 	@RunWith(SpringRunner.class)
 	@ContextConfiguration
+	// Ensure that we do not include the EventPublishingTestExecutionListener
+	// since it will access the ApplicationContext for each method in the
+	// TestExecutionListener API, thus distorting our cache hit/miss results.
+	@TestExecutionListeners({
+		DirtiesContextBeforeModesTestExecutionListener.class,
+		DependencyInjectionTestExecutionListener.class,
+		DirtiesContextTestExecutionListener.class
+	})
 	static abstract class BaseTestCase {
 
 		@Configuration

spring-test/src/test/java/org/springframework/test/context/configuration/interfaces/DirtiesContextInterfaceTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2016 the original author or authors.
+ * Copyright 2002-2019 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.
@@ -22,12 +22,15 @@
 import org.junit.BeforeClass;
 import org.junit.Test;
 import org.junit.runner.RunWith;
-import org.junit.runners.JUnit4;
 
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.context.ApplicationContext;
 import org.springframework.context.annotation.Configuration;
+import org.springframework.test.context.TestExecutionListeners;
 import org.springframework.test.context.junit4.SpringRunner;
+import org.springframework.test.context.support.DependencyInjectionTestExecutionListener;
+import org.springframework.test.context.support.DirtiesContextBeforeModesTestExecutionListener;
+import org.springframework.test.context.support.DirtiesContextTestExecutionListener;
 
 import static org.junit.Assert.*;
 import static org.springframework.test.context.cache.ContextCacheTestUtils.*;
@@ -37,7 +40,6 @@
  * @author Sam Brannen
  * @since 4.3
  */
-@RunWith(JUnit4.class)
 public class DirtiesContextInterfaceTests {
 
 	private static final AtomicInteger cacheHits = new AtomicInteger(0);
@@ -72,6 +74,14 @@ private void runTestClassAndAssertStats(Class<?> testClass, int expectedTestCoun
 
 
 	@RunWith(SpringRunner.class)
+	// Ensure that we do not include the EventPublishingTestExecutionListener
+	// since it will access the ApplicationContext for each method in the
+	// TestExecutionListener API, thus distorting our cache hit/miss results.
+	@TestExecutionListeners({
+		DirtiesContextBeforeModesTestExecutionListener.class,
+		DependencyInjectionTestExecutionListener.class,
+		DirtiesContextTestExecutionListener.class
+	})
 	public static class ClassLevelDirtiesContextWithCleanMethodsAndDefaultModeTestCase
 			implements DirtiesContextTestInterface {
 

spring-test/src/test/java/org/springframework/test/context/event/EventPublishingTestExecutionListenerIntegrationTests.java

@@ -41,7 +41,6 @@
 import org.springframework.test.context.TestContext;
 import org.springframework.test.context.TestContextManager;
 import org.springframework.test.context.TestExecutionListener;
-import org.springframework.test.context.TestExecutionListeners;
 import org.springframework.test.context.event.annotation.AfterTestClass;
 import org.springframework.test.context.event.annotation.AfterTestExecution;
 import org.springframework.test.context.event.annotation.AfterTestMethod;
@@ -193,7 +192,6 @@ public void afterTestClassAnnotation() throws Exception {
 
 	@RunWith(SpringRunner.class)
 	@ContextConfiguration(classes = TestEventListenerConfiguration.class)
-	@TestExecutionListeners(EventPublishingTestExecutionListener.class)
 	public static class ExampleTestCase {
 
 		@Traceable