Merge branch '2.7.x' into 3.0.x

Closes gh-35553

spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/web/servlet/WebMvcAutoConfigurationTests.java

@@ -165,7 +165,7 @@ class WebMvcAutoConfigurationTests {
 
 	@Test
 	void handlerMappingsCreated() {
-		this.contextRunner.run((context) -> assertThat(context).getBeans(HandlerMapping.class).hasSize(5));
+		this.contextRunner.run((context) -> assertThat(context).getBeans(HandlerMapping.class).hasSize(6));
 	}
 
 	@Test
@@ -687,8 +687,8 @@ class WebMvcAutoConfigurationTests {
 		this.contextRunner.withPropertyValues("spring.web.resources.static-locations:classpath:/welcome-page/")
 			.run((context) -> {
 				assertThat(context).hasSingleBean(WelcomePageHandlerMapping.class);
-				WelcomePageHandlerMapping bean = context.getBean(WelcomePageHandlerMapping.class);
-				assertThat(bean.getRootHandler()).isNotNull();
+				assertThat(context.getBean(WelcomePageHandlerMapping.class).getRootHandler()).isNotNull();
+				assertThat(context.getBean(WelcomePageNotAcceptableHandlerMapping.class).getRootHandler()).isNotNull();
 			});
 	}
 

spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/web/servlet/WelcomePageHandlerMappingTests.java

@@ -115,7 +115,6 @@ class WelcomePageHandlerMappingTests {
 				.perform(get("/").header(HttpHeaders.ACCEPT, ""))
 				.andExpect(status().isOk())
 				.andExpect(forwardedUrl("index.html")));
-
 	}
 
 	@Test

spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/web/servlet/WelcomePageIntegrationTests.java

@@ -29,6 +29,7 @@ import org.springframework.boot.test.web.client.TestRestTemplate;
 import org.springframework.boot.test.web.server.LocalServerPort;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Import;
+import org.springframework.http.HttpStatus;
 import org.springframework.http.MediaType;
 import org.springframework.http.RequestEntity;
 import org.springframework.http.ResponseEntity;
@@ -57,6 +58,16 @@ class WelcomePageIntegrationTests {
 			.build();
 		ResponseEntity<String> content = this.template.exchange(entity, String.class);
 		assertThat(content.getBody()).contains("/custom-");
+		assertThat(content.getStatusCode()).isEqualTo(HttpStatus.OK);
+	}
+
+	@Test
+	void notAcceptableWelcomePage() throws Exception {
+		RequestEntity<?> entity = RequestEntity.get(new URI("http://localhost:" + this.port + "/"))
+			.header("Accept", "spring/boot")
+			.build();
+		ResponseEntity<String> content = this.template.exchange(entity, String.class);
+		assertThat(content.getStatusCode()).isEqualTo(HttpStatus.NOT_ACCEPTABLE);
 	}
 
 	@Configuration

spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/web/servlet/WelcomePageNotAcceptableHandlerMappingTests.java

@@ -0,0 +1,144 @@
+/*
+ * Copyright 2012-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.boot.autoconfigure.web.servlet;
+
+import org.junit.jupiter.api.Test;
+
+import org.springframework.beans.factory.ObjectProvider;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.boot.autoconfigure.AutoConfigurations;
+import org.springframework.boot.autoconfigure.context.PropertyPlaceholderAutoConfiguration;
+import org.springframework.boot.autoconfigure.template.TemplateAvailabilityProviders;
+import org.springframework.boot.test.context.runner.WebApplicationContextRunner;
+import org.springframework.context.ApplicationContext;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.core.Ordered;
+import org.springframework.core.io.FileSystemResource;
+import org.springframework.core.io.Resource;
+import org.springframework.http.HttpHeaders;
+import org.springframework.http.MediaType;
+import org.springframework.test.util.ReflectionTestUtils;
+import org.springframework.test.web.servlet.setup.MockMvcBuilders;
+import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
+
+/**
+ * Tests for {@link WelcomePageNotAcceptableHandlerMapping}.
+ *
+ * @author Phillip Webb
+ */
+class WelcomePageNotAcceptableHandlerMappingTests {
+
+	private final WebApplicationContextRunner contextRunner = new WebApplicationContextRunner()
+		.withUserConfiguration(HandlerMappingConfiguration.class)
+		.withConfiguration(AutoConfigurations.of(PropertyPlaceholderAutoConfiguration.class));
+
+	@Test
+	void isOrderedAtLowPriorityButAboveResourceHandlerRegistry() {
+		this.contextRunner.withUserConfiguration(StaticResourceConfiguration.class).run((context) -> {
+			WelcomePageNotAcceptableHandlerMapping handler = context
+				.getBean(WelcomePageNotAcceptableHandlerMapping.class);
+			ResourceHandlerRegistry registry = new ResourceHandlerRegistry(context, null);
+			Integer resourceOrder = (Integer) ReflectionTestUtils.getField(registry, "order");
+			assertThat(handler.getOrder()).isEqualTo(Ordered.LOWEST_PRECEDENCE - 10);
+			assertThat(handler.getOrder()).isLessThan(resourceOrder);
+		});
+	}
+
+	@Test
+	void handlesRequestForStaticPageThatAcceptsTextHtml() {
+		this.contextRunner.withUserConfiguration(StaticResourceConfiguration.class)
+			.run((context) -> MockMvcBuilders.webAppContextSetup(context)
+				.build()
+				.perform(get("/").accept(MediaType.TEXT_HTML))
+				.andExpect(status().isNotAcceptable()));
+	}
+
+	@Test
+	void handlesRequestForStaticPagetThatDoesNotAcceptTextHtml() {
+		this.contextRunner.withUserConfiguration(StaticResourceConfiguration.class)
+			.run((context) -> MockMvcBuilders.webAppContextSetup(context)
+				.build()
+				.perform(get("/").accept(MediaType.APPLICATION_JSON))
+				.andExpect(status().isNotAcceptable()));
+	}
+
+	@Test
+	void handlesRequestWithNoAcceptHeader() {
+		this.contextRunner.withUserConfiguration(StaticResourceConfiguration.class)
+			.run((context) -> MockMvcBuilders.webAppContextSetup(context)
+				.build()
+				.perform(get("/"))
+				.andExpect(status().isNotAcceptable()));
+	}
+
+	@Test
+	void handlesRequestWithEmptyAcceptHeader() {
+		this.contextRunner.withUserConfiguration(StaticResourceConfiguration.class)
+			.run((context) -> MockMvcBuilders.webAppContextSetup(context)
+				.build()
+				.perform(get("/").header(HttpHeaders.ACCEPT, ""))
+				.andExpect(status().isNotAcceptable()));
+	}
+
+	@Test
+	void rootHandlerIsNotRegisteredWhenStaticPathPatternIsNotSlashStarStar() {
+		this.contextRunner.withUserConfiguration(StaticResourceConfiguration.class)
+			.withPropertyValues("static-path-pattern=/foo/**")
+			.run((context) -> assertThat(context.getBean(WelcomePageNotAcceptableHandlerMapping.class).getRootHandler())
+				.isNull());
+	}
+
+	@Test
+	void producesNotFoundResponseWhenThereIsNoWelcomePage() {
+		this.contextRunner.run((context) -> MockMvcBuilders.webAppContextSetup(context)
+			.build()
+			.perform(get("/").accept(MediaType.TEXT_HTML))
+			.andExpect(status().isNotFound()));
+	}
+
+	@Configuration(proxyBeanMethods = false)
+	static class HandlerMappingConfiguration {
+
+		@Bean
+		WelcomePageNotAcceptableHandlerMapping handlerMapping(ApplicationContext applicationContext,
+				ObjectProvider<TemplateAvailabilityProviders> templateAvailabilityProviders,
+				ObjectProvider<Resource> staticIndexPage,
+				@Value("${static-path-pattern:/**}") String staticPathPattern) {
+			return new WelcomePageNotAcceptableHandlerMapping(
+					templateAvailabilityProviders
+						.getIfAvailable(() -> new TemplateAvailabilityProviders(applicationContext)),
+					applicationContext, staticIndexPage.getIfAvailable(), staticPathPattern);
+		}
+
+	}
+
+	@Configuration(proxyBeanMethods = false)
+	static class StaticResourceConfiguration {
+
+		@Bean
+		Resource staticIndexPage() {
+			return new FileSystemResource("src/test/resources/welcome-page/index.html");
+		}
+
+	}
+
+}