Provide a condition for detecting war deployments

Closes gh-19421

Author: mbhave

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnWarDeployment.java

@@ -0,0 +1,40 @@
+/*
+ * Copyright 2012-2020 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.autoconfigure.condition;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+import org.springframework.context.annotation.Conditional;
+
+/**
+ * {@link Conditional @Conditional} that matches when the application is a traditional WAR
+ * deployment. For applications with embedded servers, this condition will return false.
+ *
+ * @author Madhura Bhave
+ * @since 2.3.0
+ */
+@Target({ ElementType.TYPE, ElementType.METHOD })
+@Retention(RetentionPolicy.RUNTIME)
+@Documented
+@Conditional(OnWarDeploymentCondition.class)
+public @interface ConditionalOnWarDeployment {
+
+}

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/OnWarDeploymentCondition.java

@@ -0,0 +1,49 @@
+/*
+ * Copyright 2012-2020 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.autoconfigure.condition;
+
+import javax.servlet.ServletContext;
+
+import org.springframework.context.annotation.Condition;
+import org.springframework.context.annotation.ConditionContext;
+import org.springframework.core.io.ResourceLoader;
+import org.springframework.core.type.AnnotatedTypeMetadata;
+import org.springframework.web.context.WebApplicationContext;
+
+/**
+ * {@link Condition} that checks if the application is running as a traditional war
+ * deployment.
+ *
+ * @author Madhura Bhave
+ */
+class OnWarDeploymentCondition extends SpringBootCondition {
+
+	@Override
+	public ConditionOutcome getMatchOutcome(ConditionContext context, AnnotatedTypeMetadata metadata) {
+		ResourceLoader resourceLoader = context.getResourceLoader();
+		if (resourceLoader instanceof WebApplicationContext) {
+			WebApplicationContext applicationContext = (WebApplicationContext) resourceLoader;
+			ServletContext servletContext = applicationContext.getServletContext();
+			if (servletContext != null) {
+				return ConditionOutcome.match("Application is deployed as a WAR file.");
+			}
+		}
+		return ConditionOutcome.noMatch(ConditionMessage.forCondition(ConditionalOnWarDeployment.class)
+				.because("the application is not deployed as a WAR file."));
+	}
+
+}

spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/condition/ConditionalOnWarDeploymentTests.java

@@ -0,0 +1,79 @@
+/*
+ * Copyright 2012-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.
+ * 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.autoconfigure.condition;
+
+import org.junit.jupiter.api.Test;
+
+import org.springframework.boot.test.context.runner.ApplicationContextRunner;
+import org.springframework.boot.test.context.runner.ReactiveWebApplicationContextRunner;
+import org.springframework.boot.test.context.runner.WebApplicationContextRunner;
+import org.springframework.boot.web.servlet.context.AnnotationConfigServletWebApplicationContext;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * Tests for {@link ConditionalOnWarDeployment @ConditionalOnWarDeployment}.
+ *
+ * @author Madhura Bhave
+ */
+class ConditionalOnWarDeploymentTests {
+
+	@Test
+	void nonWebApplicationShouldNotMatch() {
+		ApplicationContextRunner contextRunner = new ApplicationContextRunner();
+		contextRunner.withUserConfiguration(TestConfiguration.class)
+				.run((context) -> assertThat(context).doesNotHaveBean("forWar"));
+	}
+
+	@Test
+	void reactiveWebApplicationShouldNotMatch() {
+		ReactiveWebApplicationContextRunner contextRunner = new ReactiveWebApplicationContextRunner();
+		contextRunner.withUserConfiguration(TestConfiguration.class)
+				.run((context) -> assertThat(context).doesNotHaveBean("forWar"));
+	}
+
+	@Test
+	void embeddedServletWebApplicationShouldNotMatch() {
+		WebApplicationContextRunner contextRunner = new WebApplicationContextRunner(
+				AnnotationConfigServletWebApplicationContext::new);
+		contextRunner.withUserConfiguration(TestConfiguration.class)
+				.run((context) -> assertThat(context).doesNotHaveBean("forWar"));
+	}
+
+	@Test
+	void warDeployedServletWebApplicationShouldMatch() {
+		// sets a mock servletContext before context refresh which is what the
+		// SpringBootServletInitializer does for WAR deployments.
+		WebApplicationContextRunner contextRunner = new WebApplicationContextRunner();
+		contextRunner.withUserConfiguration(TestConfiguration.class)
+				.run((context) -> assertThat(context).hasBean("forWar"));
+	}
+
+	@Configuration(proxyBeanMethods = false)
+	@ConditionalOnWarDeployment
+	static class TestConfiguration {
+
+		@Bean
+		String forWar() {
+			return "forWar";
+		}
+
+	}
+
+}

spring-boot-project/spring-boot-docs/src/docs/asciidoc/spring-boot-features.adoc

@@ -7606,6 +7606,9 @@ The `@ConditionalOnWebApplication` and `@ConditionalOnNotWebApplication` annotat
 A servlet-based web application is any application that uses a Spring `WebApplicationContext`, defines a `session` scope, or has a `ConfigurableWebEnvironment`.
 A reactive web application is any application that uses a `ReactiveWebApplicationContext`, or has a `ConfigurableReactiveWebEnvironment`.
 
+The `@ConditionalOnWarDeployment` annotation lets configuration be included depending on whether the application is a traditional WAR application that is deployed to a container.
+This condition will not match for applications that are run with an embedded server.
+
 
 
 [[boot-features-spel-conditions]]

spring-boot-tests/spring-boot-deployment-tests/build.gradle

@@ -10,6 +10,7 @@ dependencies {
 	implementation(project(":spring-boot-project:spring-boot-starters:spring-boot-starter-web")) {
 		exclude group: "org.hibernate.validator"
 	}
+	implementation(project(":spring-boot-project:spring-boot-starters:spring-boot-starter-actuator"))
 
 	intTestImplementation(enforcedPlatform(project(path: ":spring-boot-project:spring-boot-parent")))
 	intTestImplementation(project(":spring-boot-project:spring-boot-starters:spring-boot-starter-test"))
@@ -20,8 +21,6 @@ dependencies {
 	intTestImplementation("org.springframework:spring-web")
 
 	providedRuntime(project(":spring-boot-project:spring-boot-starters:spring-boot-starter-tomcat"))
-
-	runtimeOnly(project(":spring-boot-project:spring-boot-starters:spring-boot-starter-actuator"))
 }
 
 intTest {

spring-boot-tests/spring-boot-deployment-tests/src/intTest/java/sample/DeploymentIntegrationTests.java

@@ -66,6 +66,16 @@ void health(DeployedApplication application) {
 		});
 	}
 
+	@ParameterizedTest
+	@MethodSource("deployedApplications")
+	void conditionalOnWarShouldBeTrue(DeployedApplication application) throws Exception {
+		application.test((rest) -> {
+			ResponseEntity<String> response = rest.getForEntity("/actuator/war", String.class);
+			assertThat(response.getStatusCode()).isEqualTo(HttpStatus.OK);
+			assertThat(response.getBody()).isEqualTo("{\"hello\":\"world\"}");
+		});
+	}
+
 	static List<DeployedApplication> deployedApplications() {
 		return Arrays.asList(new DeployedApplication("open-liberty:19.0.0.9-webProfile8", "/config/dropins", 9080),
 				new DeployedApplication("tomcat:9.0.29-jdk8-openjdk", "/usr/local/tomcat/webapps", 8080),

spring-boot-tests/spring-boot-deployment-tests/src/main/java/sample/DeploymentTestApplication.java renamed to spring-boot-tests/spring-boot-deployment-tests/src/main/java/sample/app/DeploymentTestApplication.java

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package sample;
+package sample.app;
 
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 import org.springframework.boot.web.servlet.support.SpringBootServletInitializer;

spring-boot-tests/spring-boot-deployment-tests/src/main/java/sample/SampleController.java renamed to spring-boot-tests/spring-boot-deployment-tests/src/main/java/sample/app/SampleController.java

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package sample;
+package sample.app;
 
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.RestController;

spring-boot-tests/spring-boot-deployment-tests/src/main/java/sample/autoconfig/ExampleAutoConfiguration.java

@@ -0,0 +1,44 @@
+/*
+ * Copyright 2012-2020 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 sample.autoconfig;
+
+import org.springframework.boot.actuate.endpoint.annotation.Endpoint;
+import org.springframework.boot.actuate.endpoint.annotation.ReadOperation;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnWarDeployment;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+@ConditionalOnWarDeployment
+@Configuration
+public class ExampleAutoConfiguration {
+
+	@Bean
+	public TestEndpoint testEndpoint() {
+		return new TestEndpoint();
+	}
+
+	@Endpoint(id = "war")
+	static class TestEndpoint {
+
+		@ReadOperation
+		String hello() {
+			return "{\"hello\":\"world\"}";
+		}
+
+	}
+
+}

spring-boot-tests/spring-boot-deployment-tests/src/main/resources/META-INF/spring.factories

@@ -0,0 +1,2 @@
+org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
+sample.autoconfig.ExampleAutoConfiguration

spring-boot-tests/spring-boot-deployment-tests/src/main/resources/application.yml

@@ -0,0 +1 @@
+management.endpoints.web.exposure.include: '*'

spring-boot-tests/spring-boot-integration-tests/spring-boot-server-tests/build.gradle

@@ -11,6 +11,7 @@ configurations {
 
 dependencies {
 	testImplementation(project(":spring-boot-project:spring-boot-starters:spring-boot-starter-test"))
+	testImplementation(project(":spring-boot-project:spring-boot-actuator-autoconfigure"))
 	testImplementation(project(":spring-boot-project:spring-boot-tools:spring-boot-test-support"))
 	testImplementation("com.samskivert:jmustache")
 	testImplementation("jakarta.servlet:jakarta.servlet-api")
@@ -25,6 +26,7 @@ dependencies {
 	testRepository(project(path: ":spring-boot-project:spring-boot-dependencies", configuration: "mavenRepository"))
 	testRepository(project(path: ":spring-boot-project:spring-boot-tools:spring-boot-maven-plugin", configuration: "mavenRepository"))
 	testRepository(project(path: ":spring-boot-project:spring-boot-starters:spring-boot-starter", configuration: "mavenRepository"))
+	testRepository(project(path: ":spring-boot-project:spring-boot-starters:spring-boot-starter-actuator", configuration: "mavenRepository"))
 	testRepository(project(path: ":spring-boot-project:spring-boot-starters:spring-boot-starter-jetty", configuration: "mavenRepository"))
 	testRepository(project(path: ":spring-boot-project:spring-boot-starters:spring-boot-starter-parent", configuration: "mavenRepository"))
 	testRepository(project(path: ":spring-boot-project:spring-boot-starters:spring-boot-starter-tomcat", configuration: "mavenRepository"))

spring-boot-tests/spring-boot-integration-tests/spring-boot-server-tests/src/test/java/com/autoconfig/ExampleAutoConfiguration.java

@@ -0,0 +1,44 @@
+/*
+ * Copyright 2012-2020 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 com.autoconfig;
+
+import org.springframework.boot.actuate.endpoint.annotation.Endpoint;
+import org.springframework.boot.actuate.endpoint.annotation.ReadOperation;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnWarDeployment;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+@ConditionalOnWarDeployment
+@Configuration
+public class ExampleAutoConfiguration {
+
+	@Bean
+	public TestEndpoint testEndpoint() {
+		return new TestEndpoint();
+	}
+
+	@Endpoint(id = "war")
+	static class TestEndpoint {
+
+		@ReadOperation
+		String hello() {
+			return "{\"hello\":\"world\"}";
+		}
+
+	}
+
+}

spring-boot-tests/spring-boot-integration-tests/spring-boot-server-tests/src/test/java/org/springframework/boot/context/embedded/ApplicationBuilder.java

@@ -146,6 +146,23 @@ private void copyApplicationSource(File appFolder) throws IOException {
 			srcMainWebapp.mkdirs();
 			FileCopyUtils.copy("webapp resource", new FileWriter(new File(srcMainWebapp, "webapp-resource.txt")));
 		}
+		copyAutoConfigurationFiles(appFolder);
+		return;
+	}
+
+	private void copyAutoConfigurationFiles(File appFolder) throws IOException {
+		File autoConfigPackage = new File(appFolder, "src/main/java/com/autoconfig");
+		autoConfigPackage.mkdirs();
+		FileCopyUtils.copy(new File("src/test/java/com/autoconfig/ExampleAutoConfiguration.java"),
+				new File(autoConfigPackage, "ExampleAutoConfiguration.java"));
+		File srcMainResources = new File(appFolder, "src/main/resources");
+		srcMainResources.mkdirs();
+		File metaInf = new File(srcMainResources, "META-INF");
+		metaInf.mkdirs();
+		FileCopyUtils.copy(new File("src/test/resources/META-INF/spring.factories"),
+				new File(metaInf, "spring.factories"));
+		FileCopyUtils.copy(new File("src/test/resources/application.yml"),
+				new File(srcMainResources, "application.yml"));
 	}
 
 	private void packageApplication(File appFolder, File settingsXml) throws MavenInvocationException {

spring-boot-tests/spring-boot-integration-tests/spring-boot-server-tests/src/test/java/org/springframework/boot/context/embedded/EmbeddedServletContainerJarPackagingIntegrationTests.java

@@ -79,4 +79,10 @@ void launcherIsNotAvailableViaHttp(RestTemplate rest) {
 		assertThat(entity.getStatusCode()).isEqualTo(HttpStatus.NOT_FOUND);
 	}
 
+	@TestTemplate
+	void conditionalOnWarDeploymentBeanIsNotAvailableForEmbeddedServer(RestTemplate rest) {
+		ResponseEntity<String> entity = rest.getForEntity("/actuator/war", String.class);
+		assertThat(entity.getStatusCode()).isEqualTo(HttpStatus.NOT_FOUND);
+	}
+
 }

spring-boot-tests/spring-boot-integration-tests/spring-boot-server-tests/src/test/java/org/springframework/boot/context/embedded/EmbeddedServletContainerWarPackagingIntegrationTests.java

@@ -102,6 +102,12 @@ void loaderClassesAreNotAvailableViaResourcePaths(RestTemplate rest) {
 				.noneMatch((resourcePath) -> resourcePath.startsWith("/org/springframework/boot/loader"));
 	}
 
+	@TestTemplate
+	void conditionalOnWarDeploymentBeanIsNotAvailableForEmbeddedServer(RestTemplate rest) {
+		ResponseEntity<String> entity = rest.getForEntity("/actuator/war", String.class);
+		assertThat(entity.getStatusCode()).isEqualTo(HttpStatus.NOT_FOUND);
+	}
+
 	private List<String> readLines(String input) {
 		if (input == null) {
 			return Collections.emptyList();

spring-boot-tests/spring-boot-integration-tests/spring-boot-server-tests/src/test/resources/META-INF/spring.factories

@@ -0,0 +1,2 @@
+org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
+com.autoconfig.ExampleAutoConfiguration

spring-boot-tests/spring-boot-integration-tests/spring-boot-server-tests/src/test/resources/application.yml

@@ -0,0 +1 @@
+management.endpoints.web.exposure.include: '*'