Merge branch '3.1.x' into 3.2.x

mhalbritter · mhalbritter · commit 26f1bbb634f8 · 2024-04-25T11:07:25.000+02:00
Closes gh-40516
diff --git a/spring-boot-project/spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure/web/servlet/SpringBootMockMvcBuilderCustomizer.java b/spring-boot-project/spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure/web/servlet/SpringBootMockMvcBuilderCustomizer.java
@@ -52,6 +52,7 @@
  *
  * @author Phillip Webb
  * @author Andy Wilkinson
+ * @author Moritz Halbritter
  * @since 1.4.0
  */
 public class SpringBootMockMvcBuilderCustomizer implements MockMvcBuilderCustomizer {
@@ -100,7 +101,7 @@ private LinesWriter getLinesWriter() {
 			return null;
 		}
 		if (this.print == MockMvcPrint.LOG_DEBUG) {
-			return new LoggingLinesWriter();
+			return (LoggingLinesWriter.isDebugEnabled()) ? new LoggingLinesWriter() : null;
 		}
 		return new SystemLinesWriter(this.print);
 	}
@@ -188,7 +189,12 @@ public void printValue(String label, Object value) {
 					if (value != null && value.getClass().isArray()) {
 						value = CollectionUtils.arrayToList(value);
 					}
-					this.lines.add(String.format("%17s = %s", label, value));
+					try {
+						this.lines.add("%17s = %s".formatted(label, value));
+					}
+					catch (RuntimeException ex) {
+						this.lines.add("%17s = << Exception '%s' occurred while formatting >>".formatted(label, ex));
+					}
 				}
 
 				List<String> getLines() {
@@ -273,6 +279,10 @@ public void write(List<String> lines) {
 			}
 		}
 
+		static boolean isDebugEnabled() {
+			return logger.isDebugEnabled();
+		}
+
 	}
 
 	/**
diff --git a/spring-boot-project/spring-boot-test-autoconfigure/src/test/java/org/springframework/boot/test/autoconfigure/web/servlet/mockmvc/ExampleController1.java b/spring-boot-project/spring-boot-test-autoconfigure/src/test/java/org/springframework/boot/test/autoconfigure/web/servlet/mockmvc/ExampleController1.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2019 the original author or authors.
+ * Copyright 2012-2024 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.
@@ -20,11 +20,14 @@
 import org.springframework.stereotype.Controller;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.RestController;
+import org.springframework.web.context.request.RequestAttributes;
+import org.springframework.web.context.request.WebRequest;
 
 /**
  * Example {@link Controller @Controller} used with {@link WebMvcTest @WebMvcTest} tests.
  *
  * @author Phillip Webb
+ * @author Moritz Halbritter
  */
 @RestController
 public class ExampleController1 {
@@ -44,4 +47,16 @@ public String html() {
 		return "<html><body>Hello</body></html>";
 	}
 
+	@GetMapping("/formatting")
+	public String formatting(WebRequest request) {
+		Object formattingFails = new Object() {
+			@Override
+			public String toString() {
+				throw new IllegalStateException("Formatting failed");
+			}
+		};
+		request.setAttribute("attribute-1", formattingFails, RequestAttributes.SCOPE_SESSION);
+		return "formatting";
+	}
+
 }
diff --git a/spring-boot-project/spring-boot-test-autoconfigure/src/test/java/org/springframework/boot/test/autoconfigure/web/servlet/mockmvc/MockMvcSpringBootTestIntegrationTests.java b/spring-boot-project/spring-boot-test-autoconfigure/src/test/java/org/springframework/boot/test/autoconfigure/web/servlet/mockmvc/MockMvcSpringBootTestIntegrationTests.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2021 the original author or authors.
+ * Copyright 2012-2024 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.
@@ -41,6 +41,7 @@
  * {@link AutoConfigureMockMvc @AutoConfigureMockMvc} (i.e. full integration test).
  *
  * @author Phillip Webb
+ * @author Moritz Halbritter
  */
 @SpringBootTest
 @AutoConfigureMockMvc(print = MockMvcPrint.SYSTEM_ERR, printOnlyOnFailure = false)
@@ -83,4 +84,11 @@ void shouldTestWithWebTestClient(@Autowired WebTestClient webTestClient) {
 		webTestClient.get().uri("/one").exchange().expectStatus().isOk().expectBody(String.class).isEqualTo("one");
 	}
 
+	@Test
+	void shouldNotFailIfFormattingValueThrowsException(CapturedOutput output) throws Exception {
+		this.mvc.perform(get("/formatting")).andExpect(content().string("formatting")).andExpect(status().isOk());
+		assertThat(output).contains(
+				"Session Attrs = << Exception 'java.lang.IllegalStateException: Formatting failed' occurred while formatting >>");
+	}
+
 }

Original file line number	Diff line number	Diff line change
`@@ -52,6 +52,7 @@`
`52`	`52`	`*`
`53`	`53`	`* @author Phillip Webb`
`54`	`54`	`* @author Andy Wilkinson`
	`55`	`+ * @author Moritz Halbritter`
`55`	`56`	`* @since 1.4.0`
`56`	`57`	`*/`
`57`	`58`	`public class SpringBootMockMvcBuilderCustomizer implements MockMvcBuilderCustomizer {`
`@@ -100,7 +101,7 @@ private LinesWriter getLinesWriter() {`
`100`	`101`	`return null;`
`101`	`102`	`}`
`102`	`103`	`if (this.print == MockMvcPrint.LOG_DEBUG) {`
`103`		`- return new LoggingLinesWriter();`
	`104`	`+ return (LoggingLinesWriter.isDebugEnabled()) ? new LoggingLinesWriter() : null;`
`104`	`105`	`}`
`105`	`106`	`return new SystemLinesWriter(this.print);`
`106`	`107`	`}`
`@@ -188,7 +189,12 @@ public void printValue(String label, Object value) {`
`188`	`189`	`if (value != null && value.getClass().isArray()) {`
`189`	`190`	`value = CollectionUtils.arrayToList(value);`
`190`	`191`	`}`
`191`		`- this.lines.add(String.format("%17s = %s", label, value));`
	`192`	`+ try {`
	`193`	`+ this.lines.add("%17s = %s".formatted(label, value));`
	`194`	`+ }`
	`195`	`+ catch (RuntimeException ex) {`
	`196`	`+ this.lines.add("%17s = << Exception '%s' occurred while formatting >>".formatted(label, ex));`
	`197`	`+ }`
`192`	`198`	`}`
`193`	`199`
`194`	`200`	`List<String> getLines() {`
`@@ -273,6 +279,10 @@ public void write(List<String> lines) {`
`273`	`279`	`}`
`274`	`280`	`}`
`275`	`281`
	`282`	`+ static boolean isDebugEnabled() {`
	`283`	`+ return logger.isDebugEnabled();`
	`284`	`+ }`
	`285`	`+`
`276`	`286`	`}`
`277`	`287`
`278`	`288`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/*`
`2`		`- * Copyright 2012-2021 the original author or authors.`
	`2`	`+ * Copyright 2012-2024 the original author or authors.`
`3`	`3`	`*`
`4`	`4`	`* Licensed under the Apache License, Version 2.0 (the "License");`
`5`	`5`	`* you may not use this file except in compliance with the License.`
`@@ -41,6 +41,7 @@`
`41`	`41`	`* {@link AutoConfigureMockMvc @AutoConfigureMockMvc} (i.e. full integration test).`
`42`	`42`	`*`
`43`	`43`	`* @author Phillip Webb`
	`44`	`+ * @author Moritz Halbritter`
`44`	`45`	`*/`
`45`	`46`	`@SpringBootTest`
`46`	`47`	`@AutoConfigureMockMvc(print = MockMvcPrint.SYSTEM_ERR, printOnlyOnFailure = false)`
`@@ -83,4 +84,11 @@ void shouldTestWithWebTestClient(@Autowired WebTestClient webTestClient) {`
`83`	`84`	`webTestClient.get().uri("/one").exchange().expectStatus().isOk().expectBody(String.class).isEqualTo("one");`
`84`	`85`	`}`
`85`	`86`
	`87`	`+ @Test`
	`88`	`+ void shouldNotFailIfFormattingValueThrowsException(CapturedOutput output) throws Exception {`
	`89`	`+ this.mvc.perform(get("/formatting")).andExpect(content().string("formatting")).andExpect(status().isOk());`
	`90`	`+ assertThat(output).contains(`
	`91`	`+ "Session Attrs = << Exception 'java.lang.IllegalStateException: Formatting failed' occurred while formatting >>");`
	`92`	`+ }`
	`93`	`+`
`86`	`94`	`}`