From 8f1b8622ba403c6e2f14f7f89c469f40c6f16a8d Mon Sep 17 00:00:00 2001 From: Andy Wilkinson Date: Thu, 14 Apr 2022 14:44:30 +0100 Subject: [PATCH] Ensure that webEnvironment=NONE creates non-web context Previously, if spring.main.web-application-type was configured in application.properties to servlet or reactive, setting webEnvironment=NONE on @SpringBootTest would not work correctly and a servlet or reactive web application context would be created based on the value of spring.main.web-application-type. This commit updates the test context bootstapper to set spring.main.web-application-type to none when webEnvironment has been set to none. This is done in the merged context configuration's property source properties which are applied to the environment in a high-precedence test property source that will override configuration in application.properties. Closes gh-29695 --- .../SpringBootTestContextBootstrapper.java | 8 +++- .../profile/ActiveProfilesTests.java | 3 +- .../build.gradle | 13 +++++ .../SampleWebApplicationTypeApplication.java | 29 +++++++++++ .../src/main/resources/application.properties | 1 + ...denWebApplicationTypeApplicationTests.java | 44 +++++++++++++++++ ...pleWebApplicationTypeApplicationTests.java | 44 +++++++++++++++++ ...tNoneOverridesWebApplicationTypeTests.java | 48 +++++++++++++++++++ 8 files changed, 186 insertions(+), 4 deletions(-) create mode 100644 spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-web-application-type/build.gradle create mode 100644 spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-web-application-type/src/main/java/smoketest/webapplicationtype/SampleWebApplicationTypeApplication.java create mode 100644 spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-web-application-type/src/main/resources/application.properties create mode 100644 spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-web-application-type/src/test/java/smoketest/webapplicationtype/OverriddenWebApplicationTypeApplicationTests.java create mode 100644 spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-web-application-type/src/test/java/smoketest/webapplicationtype/SampleWebApplicationTypeApplicationTests.java create mode 100644 spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-web-application-type/src/test/java/smoketest/webapplicationtype/WebEnvironmentNoneOverridesWebApplicationTypeTests.java diff --git a/spring-boot-project/spring-boot-test/src/main/java/org/springframework/boot/test/context/SpringBootTestContextBootstrapper.java b/spring-boot-project/spring-boot-test/src/main/java/org/springframework/boot/test/context/SpringBootTestContextBootstrapper.java index f521e0b815c..24c2ae68dab 100644 --- a/spring-boot-project/spring-boot-test/src/main/java/org/springframework/boot/test/context/SpringBootTestContextBootstrapper.java +++ b/spring-boot-project/spring-boot-test/src/main/java/org/springframework/boot/test/context/SpringBootTestContextBootstrapper.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2020 the original author or authors. + * 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. @@ -293,9 +293,13 @@ public class SpringBootTestContextBootstrapper extends DefaultTestContextBootstr // precedence propertySourceProperties.addAll(0, Arrays.asList(properties)); } - if (getWebEnvironment(testClass) == WebEnvironment.RANDOM_PORT) { + WebEnvironment webEnvironment = getWebEnvironment(testClass); + if (webEnvironment == WebEnvironment.RANDOM_PORT) { propertySourceProperties.add("server.port=0"); } + else if (webEnvironment == WebEnvironment.NONE) { + propertySourceProperties.add("spring.main.web-application-type=none"); + } } /** diff --git a/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-profile/src/test/java/smoketest/profile/ActiveProfilesTests.java b/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-profile/src/test/java/smoketest/profile/ActiveProfilesTests.java index 51a66ee2bd0..e116c52bbed 100644 --- a/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-profile/src/test/java/smoketest/profile/ActiveProfilesTests.java +++ b/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-profile/src/test/java/smoketest/profile/ActiveProfilesTests.java @@ -33,8 +33,7 @@ import static org.assertj.core.api.Assertions.assertThat; * * @author Madhura Bhave */ -@SpringBootTest(webEnvironment = WebEnvironment.NONE, - properties = { "enableEnvironmentPostProcessor=true", "server.port=0" }) // gh-28530 +@SpringBootTest(webEnvironment = WebEnvironment.NONE, properties = { "enableEnvironmentPostProcessor=true" }) // gh-28530 @ActiveProfiles("hello") class ActiveProfilesTests { diff --git a/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-web-application-type/build.gradle b/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-web-application-type/build.gradle new file mode 100644 index 00000000000..077f6cd415e --- /dev/null +++ b/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-web-application-type/build.gradle @@ -0,0 +1,13 @@ +plugins { + id "java" + id "org.springframework.boot.conventions" +} + +description = "Spring Boot web application type smoke test" + +dependencies { + implementation(project(":spring-boot-project:spring-boot-starters:spring-boot-starter-web")) + implementation(project(":spring-boot-project:spring-boot-starters:spring-boot-starter-webflux")) + + testImplementation(project(":spring-boot-project:spring-boot-starters:spring-boot-starter-test")) +} diff --git a/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-web-application-type/src/main/java/smoketest/webapplicationtype/SampleWebApplicationTypeApplication.java b/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-web-application-type/src/main/java/smoketest/webapplicationtype/SampleWebApplicationTypeApplication.java new file mode 100644 index 00000000000..6d836ae1bd9 --- /dev/null +++ b/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-web-application-type/src/main/java/smoketest/webapplicationtype/SampleWebApplicationTypeApplication.java @@ -0,0 +1,29 @@ +/* + * 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 smoketest.webapplicationtype; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; + +@SpringBootApplication +public class SampleWebApplicationTypeApplication { + + public static void main(String[] args) { + SpringApplication.run(SampleWebApplicationTypeApplication.class, args); + } + +} diff --git a/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-web-application-type/src/main/resources/application.properties b/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-web-application-type/src/main/resources/application.properties new file mode 100644 index 00000000000..a8cc36cc0a5 --- /dev/null +++ b/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-web-application-type/src/main/resources/application.properties @@ -0,0 +1 @@ +spring.main.web-application-type=reactive diff --git a/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-web-application-type/src/test/java/smoketest/webapplicationtype/OverriddenWebApplicationTypeApplicationTests.java b/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-web-application-type/src/test/java/smoketest/webapplicationtype/OverriddenWebApplicationTypeApplicationTests.java new file mode 100644 index 00000000000..217f7faeb9e --- /dev/null +++ b/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-web-application-type/src/test/java/smoketest/webapplicationtype/OverriddenWebApplicationTypeApplicationTests.java @@ -0,0 +1,44 @@ +/* + * 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 smoketest.webapplicationtype; + +import org.junit.jupiter.api.Test; + +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.context.ApplicationContext; +import org.springframework.web.context.WebApplicationContext; + +import static org.assertj.core.api.Assertions.assertThat; + +/** + * Integration tests for an application using an overridden web application type + * + * @author Andy Wilkinson + */ +@SpringBootTest(properties = "spring.main.web-application-type=servlet") +class OverriddenWebApplicationTypeApplicationTests { + + @Autowired + private ApplicationContext context; + + @Test + void contextIsServlet() { + assertThat(this.context).isInstanceOf(WebApplicationContext.class); + } + +} diff --git a/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-web-application-type/src/test/java/smoketest/webapplicationtype/SampleWebApplicationTypeApplicationTests.java b/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-web-application-type/src/test/java/smoketest/webapplicationtype/SampleWebApplicationTypeApplicationTests.java new file mode 100644 index 00000000000..a3fabb10ef1 --- /dev/null +++ b/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-web-application-type/src/test/java/smoketest/webapplicationtype/SampleWebApplicationTypeApplicationTests.java @@ -0,0 +1,44 @@ +/* + * 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 smoketest.webapplicationtype; + +import org.junit.jupiter.api.Test; + +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.boot.web.reactive.context.ReactiveWebApplicationContext; +import org.springframework.context.ApplicationContext; + +import static org.assertj.core.api.Assertions.assertThat; + +/** + * Integration tests for an application using a configured web application type + * + * @author Andy Wilkinson + */ +@SpringBootTest +class SampleWebApplicationTypeApplicationTests { + + @Autowired + private ApplicationContext context; + + @Test + void contextIsReactive() { + assertThat(this.context).isInstanceOf(ReactiveWebApplicationContext.class); + } + +} diff --git a/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-web-application-type/src/test/java/smoketest/webapplicationtype/WebEnvironmentNoneOverridesWebApplicationTypeTests.java b/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-web-application-type/src/test/java/smoketest/webapplicationtype/WebEnvironmentNoneOverridesWebApplicationTypeTests.java new file mode 100644 index 00000000000..c3275a9944a --- /dev/null +++ b/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-web-application-type/src/test/java/smoketest/webapplicationtype/WebEnvironmentNoneOverridesWebApplicationTypeTests.java @@ -0,0 +1,48 @@ +/* + * 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 smoketest.webapplicationtype; + +import org.junit.jupiter.api.Test; + +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.boot.test.context.SpringBootTest.WebEnvironment; +import org.springframework.boot.web.reactive.context.ReactiveWebApplicationContext; +import org.springframework.context.ApplicationContext; +import org.springframework.web.context.WebApplicationContext; + +import static org.assertj.core.api.Assertions.assertThat; + +/** + * Integration tests for a web environment of none overriding the configured web + * application type. + * + * @author Andy Wilkinson + */ +@SpringBootTest(webEnvironment = WebEnvironment.NONE) +class WebEnvironmentNoneOverridesWebApplicationTypeTests { + + @Autowired + private ApplicationContext context; + + @Test + void contextIsPlain() { + assertThat(this.context).isNotInstanceOf(ReactiveWebApplicationContext.class); + assertThat(this.context).isNotInstanceOf(WebApplicationContext.class); + } + +}