From 9505673d6f45271b2bac13ca0b308960527676e4 Mon Sep 17 00:00:00 2001 From: Phillip Webb Date: Tue, 25 Oct 2022 15:36:54 -0700 Subject: [PATCH] Ensure application event listeners are always refreshed Update `EventPublishingRunListener` to ensure that application event listeners are always refreshed before multicasting initial events. Prior to this commit, refreshing occurred after multicasting which meant that listeners added by a different `SpringApplicationRunListener` would not be picked up. This caused properties from tests that have `UseMainMethod` set to `ALWAYS` or `WHEN_AVAILABLE` to be missing. Fixes gh-32860 --- ...tTestUseMainMethodWithPropertiesTests.java | 57 +++++++++++++++++++ .../event/EventPublishingRunListener.java | 3 +- 2 files changed, 58 insertions(+), 2 deletions(-) create mode 100644 spring-boot-project/spring-boot-test/src/test/java/org/springframework/boot/test/context/SpringBootTestUseMainMethodWithPropertiesTests.java diff --git a/spring-boot-project/spring-boot-test/src/test/java/org/springframework/boot/test/context/SpringBootTestUseMainMethodWithPropertiesTests.java b/spring-boot-project/spring-boot-test/src/test/java/org/springframework/boot/test/context/SpringBootTestUseMainMethodWithPropertiesTests.java new file mode 100644 index 0000000000..c0b8f6943b --- /dev/null +++ b/spring-boot-project/spring-boot-test/src/test/java/org/springframework/boot/test/context/SpringBootTestUseMainMethodWithPropertiesTests.java @@ -0,0 +1,57 @@ +/* + * Copyright 2012-2022 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.boot.test.context; + +import org.junit.jupiter.api.Test; + +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.SpringApplication; +import org.springframework.boot.SpringBootConfiguration; +import org.springframework.boot.test.context.SpringBootTest.UseMainMethod; +import org.springframework.context.ApplicationContext; +import org.springframework.context.annotation.Configuration; + +import static org.assertj.core.api.Assertions.assertThat; + +/** + * Tests for {@link SpringBootTest} when using {@link UseMainMethod#ALWAYS} and setting + * properties. + * + * @author Phillip Webb + */ +@SpringBootTest(properties = "test=123", useMainMethod = UseMainMethod.ALWAYS) +class SpringBootTestUseMainMethodWithPropertiesTests { + + @Autowired + private ApplicationContext applicationContext; + + @Test + void propertyIsSet() { + assertThat(this.applicationContext.getEnvironment().getProperty("test")).isEqualTo("123"); + } + + @Configuration(proxyBeanMethods = false) + @SpringBootConfiguration + public static class ConfigWithMain { + + public static void main(String[] args) { + new SpringApplication(ConfigWithMain.class).run(); + } + + } + +} diff --git a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/event/EventPublishingRunListener.java b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/event/EventPublishingRunListener.java index 19dda7eb5b..e5d53881da 100644 --- a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/event/EventPublishingRunListener.java +++ b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/event/EventPublishingRunListener.java @@ -63,7 +63,6 @@ class EventPublishingRunListener implements SpringApplicationRunListener, Ordere this.application = application; this.args = args; this.initialMulticaster = new SimpleApplicationEventMulticaster(); - refreshApplicationListeners(); } @Override @@ -133,8 +132,8 @@ class EventPublishingRunListener implements SpringApplicationRunListener, Ordere } private void multicastInitialEvent(ApplicationEvent event) { - this.initialMulticaster.multicastEvent(event); refreshApplicationListeners(); + this.initialMulticaster.multicastEvent(event); } private void refreshApplicationListeners() {