GH-116 - PublishedEvents now sees events from asynchronous event listeners as well.

The ApplicationListener we deploy to capture events published  during a test method execution now uses an InheritableThreadLocal so that events published on threads spawned from the main test execution thread also end up in the PublishedEvents instance prepared for the test method.

Also, the registration of that particular event listener avoids duplicate registrations by inspecting the application context in use for the test method execution for an already registered listener, falling back to registering one.

Author: odrotbohm

spring-modulith-test/pom.xml

@@ -55,6 +55,12 @@
 			<artifactId>spring-boot-starter-test</artifactId>
 			<optional>true</optional>
 		</dependency>
+		
+		<dependency>
+			<groupId>org.awaitility</groupId>
+			<artifactId>awaitility</artifactId>
+			<scope>test</scope>
+		</dependency>
 
 	</dependencies>
 </project>

spring-modulith-test/src/main/java/org/springframework/modulith/test/PublishedEventsParameterResolver.java

@@ -25,7 +25,7 @@
 import org.springframework.context.ApplicationContext;
 import org.springframework.context.ApplicationEvent;
 import org.springframework.context.ApplicationListener;
-import org.springframework.context.ConfigurableApplicationContext;
+import org.springframework.context.support.AbstractApplicationContext;
 import org.springframework.test.context.junit.jupiter.SpringExtension;
 import org.springframework.util.Assert;
 import org.springframework.util.ClassUtils;
@@ -40,7 +40,7 @@ class PublishedEventsParameterResolver implements ParameterResolver, BeforeAllCa
 	private static final boolean ASSERT_J_PRESENT = ClassUtils.isPresent("org.assertj.core.api.Assert",
 			PublishedEventsParameterResolver.class.getClassLoader());
 
-	private ThreadBoundApplicationListenerAdapter listener = new ThreadBoundApplicationListenerAdapter();
+	private ThreadBoundApplicationListenerAdapter listener;
 	private final Function<ExtensionContext, ApplicationContext> lookup;
 
 	PublishedEventsParameterResolver() {
@@ -59,7 +59,22 @@ class PublishedEventsParameterResolver implements ParameterResolver, BeforeAllCa
 	public void beforeAll(ExtensionContext extensionContext) {
 
 		ApplicationContext context = lookup.apply(extensionContext);
-		((ConfigurableApplicationContext) context).addApplicationListener(listener);
+
+		if (!(context instanceof AbstractApplicationContext aac)) {
+			throw new IllegalStateException();
+		}
+
+		listener = aac.getApplicationListeners().stream()
+				.filter(ThreadBoundApplicationListenerAdapter.class::isInstance)
+				.map(ThreadBoundApplicationListenerAdapter.class::cast)
+				.findFirst()
+				.orElseGet(() -> {
+
+					var adapter = new ThreadBoundApplicationListenerAdapter();
+					aac.addApplicationListener(adapter);
+
+					return adapter;
+				});
 	}
 
 	/*
@@ -114,7 +129,7 @@ public void afterEach(ExtensionContext context) {
 	 */
 	private static class ThreadBoundApplicationListenerAdapter implements ApplicationListener<ApplicationEvent> {
 
-		private final ThreadLocal<ApplicationListener<ApplicationEvent>> delegate = new ThreadLocal<>();
+		private final ThreadLocal<ApplicationListener<ApplicationEvent>> delegate = new InheritableThreadLocal<>();
 
 		/**
 		 * Registers the given {@link ApplicationListener} to be used for the current thread.

spring-modulith-test/src/test/java/example/AsyncEventListener.java

@@ -0,0 +1,48 @@
+/*
+ * Copyright 2023 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 example;
+
+import lombok.RequiredArgsConstructor;
+
+import org.springframework.context.ApplicationEventPublisher;
+import org.springframework.context.event.EventListener;
+import org.springframework.scheduling.annotation.Async;
+import org.springframework.stereotype.Component;
+
+@Component
+@RequiredArgsConstructor
+public class AsyncEventListener {
+
+	private final ApplicationEventPublisher publisher;
+
+	@Async
+	@EventListener
+	void on(FirstEvent event) {
+		publisher.publishEvent(new SecondEvent());
+	}
+
+	@Async
+	@EventListener
+	void on(SecondEvent event) {
+		publisher.publishEvent(new ThirdEvent());
+	}
+
+	public static record FirstEvent() {}
+
+	static record SecondEvent() {}
+
+	public static record ThirdEvent() {}
+}

spring-modulith-test/src/test/java/example/TestConfiguration.java

@@ -0,0 +1,23 @@
+/*
+ * Copyright 2023 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 example;
+
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.scheduling.annotation.EnableAsync;
+
+@EnableAsync(proxyTargetClass = true)
+@SpringBootApplication
+public class TestConfiguration {}

spring-modulith-test/src/test/java/org/springframework/modulith/test/PublishedEventsIntegrationTests.java

@@ -0,0 +1,56 @@
+/*
+ * Copyright 2023 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.modulith.test;
+
+import static org.assertj.core.api.Assertions.*;
+
+import example.AsyncEventListener;
+import example.AsyncEventListener.FirstEvent;
+import example.AsyncEventListener.ThirdEvent;
+import example.TestConfiguration;
+import lombok.RequiredArgsConstructor;
+
+import org.awaitility.Awaitility;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.context.ApplicationEventPublisher;
+
+/**
+ * Integration tests for {@link PublishedEvents}.
+ *
+ * @author Oliver Drotbohm
+ */
+@RequiredArgsConstructor
+@ExtendWith(PublishedEventsExtension.class)
+@SpringBootTest(classes = TestConfiguration.class)
+class PublishedEventsIntegrationTests {
+
+	@Autowired ApplicationEventPublisher publisher;
+	@Autowired AsyncEventListener listener;
+
+	@Test // #116
+	void capturesEventsTriggeredByAsyncEventListeners(PublishedEvents events) {
+
+		assertThatNoException().isThrownBy(() -> {
+
+			publisher.publishEvent(new FirstEvent());
+
+			Awaitility.await().until(() -> events.eventOfTypeWasPublished(ThirdEvent.class));
+		});
+	}
+}