Make servlet context property source available before refresh

Previously, when deploying a Spring Boot application to a container,
the servlet context property source was not fully initialised until
the context was refreshed. This led to a problem where a value from a
property source with lower precedence would be seen during the early
stages of the application starting. Once the servlet context property
source had been initialized, its value for the property would then
become visible effectively making it appear as if the property's
value had changed during startup. This led to a specific problem
with determining active profiles.

If spring.profiles.active was set both in JNDI and via the servlet
context both profiles would end up being active, rather than the
more intuitive behaviour of the profiles made active via the servlet
context overriding those made active via JNDI.

This commit updates SpringBootServletInitializer so that it explicitly
creates the StandardServletEnvironment and initializes its property
sources using the servlet context. This is done before the application
is created and run, thereby ensuring that the servlet context
property source is available throughout the application's startup.

Closes gh-9972

Author: wilkinsona

spring-boot/src/main/java/org/springframework/boot/web/support/ServletContextApplicationListener.java

@@ -37,6 +37,7 @@
 import org.springframework.web.WebApplicationInitializer;
 import org.springframework.web.context.ContextLoaderListener;
 import org.springframework.web.context.WebApplicationContext;
+import org.springframework.web.context.support.StandardServletEnvironment;
 
 /**
  * An opinionated {@link WebApplicationInitializer} to run a {@link SpringApplication}
@@ -103,6 +104,9 @@ public void contextInitialized(ServletContextEvent event) {
 	protected WebApplicationContext createRootApplicationContext(
 			ServletContext servletContext) {
 		SpringApplicationBuilder builder = createSpringApplicationBuilder();
+		StandardServletEnvironment environment = new StandardServletEnvironment();
+		environment.initPropertySources(servletContext, null);
+		builder.environment(environment);
 		builder.main(getClass());
 		ApplicationContext parent = getExistingRootWebApplicationContext(servletContext);
 		if (parent != null) {
@@ -113,7 +117,6 @@ protected WebApplicationContext createRootApplicationContext(
 		}
 		builder.initializers(
 				new ServletContextApplicationContextInitializer(servletContext));
-		builder.listeners(new ServletContextApplicationListener(servletContext));
 		builder.contextClass(AnnotationConfigEmbeddedWebApplicationContext.class);
 		builder = configure(builder);
 		SpringApplication application = builder.build();

spring-boot/src/main/java/org/springframework/boot/web/support/SpringBootServletInitializer.java

@@ -16,6 +16,9 @@
 
 package org.springframework.boot.web.support;
 
+import java.util.Arrays;
+import java.util.Collections;
+
 import javax.servlet.ServletContext;
 import javax.servlet.ServletException;
 
@@ -29,15 +32,21 @@
 import org.springframework.boot.context.embedded.EmbeddedServletContainer;
 import org.springframework.boot.context.embedded.EmbeddedServletContainerFactory;
 import org.springframework.boot.context.embedded.undertow.UndertowEmbeddedServletContainerFactory;
+import org.springframework.boot.context.event.ApplicationEnvironmentPreparedEvent;
 import org.springframework.boot.web.servlet.ServletContextInitializer;
+import org.springframework.context.ApplicationListener;
 import org.springframework.context.ConfigurableApplicationContext;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.support.AbstractApplicationContext;
+import org.springframework.core.env.PropertySource;
 import org.springframework.mock.web.MockServletContext;
 import org.springframework.web.context.WebApplicationContext;
+import org.springframework.web.context.support.StandardServletEnvironment;
 
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.mockito.BDDMockito.given;
+import static org.mockito.Mockito.mock;
 
 /**
  * Tests for {@link SpringBootServletInitializer}.
@@ -135,10 +144,43 @@ public void executableWarThatUsesServletInitializerDoesNotHaveErrorPageFilterCon
 	}
 
 	@Test
-	public void servletContextApplicationListenerIsAdded() {
-		new WithConfiguredSource().createRootApplicationContext(this.servletContext);
-		assertThat(this.application.getListeners())
-				.hasAtLeastOneElementOfType(ServletContextApplicationListener.class);
+	public void servletContextPropertySourceIsAvailablePriorToRefresh()
+			throws ServletException {
+		ServletContext servletContext = mock(ServletContext.class);
+		given(servletContext.getInitParameterNames()).willReturn(
+				Collections.enumeration(Arrays.asList("spring.profiles.active")));
+		given(servletContext.getInitParameter("spring.profiles.active"))
+				.willReturn("from-servlet-context");
+		given(servletContext.getAttributeNames())
+				.willReturn(Collections.enumeration(Collections.<String>emptyList()));
+		WebApplicationContext context = null;
+		try {
+			context = new PropertySourceVerifyingSpringBootServletInitializer()
+					.createRootApplicationContext(servletContext);
+			assertThat(context.getEnvironment().getActiveProfiles())
+					.containsExactly("from-servlet-context");
+		}
+		finally {
+			if (context instanceof ConfigurableApplicationContext) {
+				((ConfigurableApplicationContext) context).close();
+			}
+		}
+	}
+
+	private static class PropertySourceVerifyingSpringBootServletInitializer
+			extends SpringBootServletInitializer {
+
+		@Override
+		protected SpringApplicationBuilder configure(SpringApplicationBuilder builder) {
+			return builder.sources(TestApp.class)
+					.listeners(new PropertySourceVerifyingApplicationListener());
+		}
+
+	}
+
+	@Configuration
+	static class TestApp {
+
 	}
 
 	private class MockSpringBootServletInitializer extends SpringBootServletInitializer {
@@ -221,4 +263,17 @@ public SpringApplication build() {
 
 	}
 
+	private static final class PropertySourceVerifyingApplicationListener
+			implements ApplicationListener<ApplicationEnvironmentPreparedEvent> {
+
+		@Override
+		public void onApplicationEvent(ApplicationEnvironmentPreparedEvent event) {
+			PropertySource<?> propertySource = event.getEnvironment().getPropertySources()
+					.get(StandardServletEnvironment.SERVLET_CONTEXT_PROPERTY_SOURCE_NAME);
+			assertThat(propertySource.getProperty("spring.profiles.active"))
+					.isEqualTo("from-servlet-context");
+		}
+
+	}
+
 }