Only print request/response body if char enc is present in MVC Test

Commit e65a1a4372 introduced support in PrintingResultHandler for only
printing the request or response body in the Spring MVC Test framework
if the content type is known to be text-based (e.g., plain text, HTML,
XHTML, XML, JSON, etc.). For unknown content types the body is assumed
to be text-based and is therefore always printed. The latter behavior,
however, is undesirable since the content may in fact not be text-based.

This commit addresses this issue by making the printing of the request
or response body an opt-in feature. Specifically, if a character
encoding has been set, the request or response body will be printed by
the PrintingResultHandler. Note, however, that the character encoding
is set to ISO-8859-1 in MockHttpServletResponse by default.

In addition, MockHttpServletRequest's getContentAsString() method now
throws an IllegalStateException if the character encoding has not been
set.

Issue: SPR-14776

spring-test/src/test/java/org/springframework/mock/web/MockHttpServletRequestTests.java

@@ -30,7 +30,9 @@ import java.util.Map;
 
 import javax.servlet.http.Cookie;
 
+import org.junit.Rule;
 import org.junit.Test;
+import org.junit.rules.ExpectedException;
 
 import org.springframework.util.StreamUtils;
 
@@ -54,7 +56,10 @@ public class MockHttpServletRequestTests {
 
 	private static final String IF_MODIFIED_SINCE = "If-Modified-Since";
 
-	private MockHttpServletRequest request = new MockHttpServletRequest();
+	private final MockHttpServletRequest request = new MockHttpServletRequest();
+
+	@Rule
+	public final ExpectedException exception = ExpectedException.none();
 
 
 	@Test
@@ -76,13 +81,10 @@ public class MockHttpServletRequestTests {
 	}
 
 	@Test
-	public void setContentAndGetContentAsStringWithDefaultCharacterEncoding() throws IOException {
-		String palindrome = "ablE was I ere I saw Elba";
-		byte[] bytes = palindrome.getBytes();
-		request.setContent(bytes);
-		assertEquals(bytes.length, request.getContentLength());
-		assertNotNull(request.getContentAsString());
-		assertEquals(palindrome, request.getContentAsString());
+	public void getContentAsStringWithoutSettingCharacterEncoding() throws IOException {
+		exception.expect(IllegalStateException.class);
+		exception.expectMessage("Cannot get content as a String for a null character encoding");
+		request.getContentAsString();
 	}
 
 	@Test
@@ -102,7 +104,6 @@ public class MockHttpServletRequestTests {
 		assertNotNull(request.getInputStream());
 		assertEquals(-1, request.getInputStream().read());
 		assertNull(request.getContentAsByteArray());
-		assertNull(request.getContentAsString());
 	}
 
 	@Test

spring-test/src/test/java/org/springframework/test/web/servlet/result/PrintingResultHandlerTests.java

@@ -17,9 +17,7 @@
 package org.springframework.test.web.servlet.result;
 
 import java.net.URI;
-import java.util.Arrays;
 import java.util.HashMap;
-import java.util.List;
 import java.util.Map;
 
 import javax.servlet.http.Cookie;
@@ -33,7 +31,6 @@ import org.springframework.mock.web.MockHttpServletResponse;
 import org.springframework.test.web.servlet.StubMvcResult;
 import org.springframework.util.Assert;
 import org.springframework.util.LinkedMultiValueMap;
-import org.springframework.util.MimeTypeUtils;
 import org.springframework.util.MultiValueMap;
 import org.springframework.validation.BindException;
 import org.springframework.validation.BindingResult;
@@ -53,11 +50,6 @@ import static org.junit.Assert.*;
  */
 public class PrintingResultHandlerTests {
 
-	private static final List<String> textContentTypes = Arrays.asList(MimeTypeUtils.APPLICATION_JSON_VALUE,
-		MimeTypeUtils.APPLICATION_XML_VALUE, MimeTypeUtils.APPLICATION_XHTML_XML_VALUE,
-		MimeTypeUtils.TEXT_HTML_VALUE, MimeTypeUtils.TEXT_PLAIN_VALUE);
-
-
 	private final TestPrintingResultHandler handler = new TestPrintingResultHandler();
 
 	private final MockHttpServletRequest request = new MockHttpServletRequest("GET", "/") {
@@ -147,43 +139,48 @@ public class PrintingResultHandlerTests {
 	}
 
 	@Test
-	public void printRequestWithTextContentTypes() throws Exception {
-		this.request.setContent("text".getBytes());
+	public void printRequestWithCharacterEncoding() throws Exception {
+		this.request.setCharacterEncoding("UTF-8");
+		this.request.setContent("text".getBytes("UTF-8"));
 
-		for (String contentType: textContentTypes) {
-			this.request.setContentType(contentType);
-			this.handler.handle(this.mvcResult);
-			assertValue("MockHttpServletRequest", "Body", "text");
-		}
+		this.handler.handle(this.mvcResult);
+
+		assertValue("MockHttpServletRequest", "Body", "text");
 	}
 
 	@Test
-	public void printResponseWithTextContentTypes() throws Exception {
+	public void printRequestWithoutCharacterEncoding() throws Exception {
+		this.handler.handle(this.mvcResult);
+
+		assertValue("MockHttpServletRequest", "Body", "<no character encoding set>");
+	}
+
+	@Test
+	public void printResponseWithCharacterEncoding() throws Exception {
+		this.response.setCharacterEncoding("UTF-8");
 		this.response.getWriter().print("text");
 
-		for (String contentType: textContentTypes) {
-			this.response.setContentType(contentType);
-			this.handler.handle(this.mvcResult);
-			assertValue("MockHttpServletResponse", "Body", "text");
-		}
+		this.handler.handle(this.mvcResult);
+		assertValue("MockHttpServletResponse", "Body", "text");
 	}
 
 	@Test
-	public void printRequestWithBinaryContentType() throws Exception {
-		this.request.setContentType(MimeTypeUtils.IMAGE_JPEG_VALUE);
+	public void printResponseWithDefaultCharacterEncoding() throws Exception {
+		this.response.getWriter().print("text");
 
 		this.handler.handle(this.mvcResult);
 
-		assertValue("MockHttpServletRequest", "Body", "<content type is not printable text>");
+		assertValue("MockHttpServletResponse", "Body", "text");
 	}
 
 	@Test
-	public void printResponseWithBinaryContentType() throws Exception {
-		this.response.setContentType(MimeTypeUtils.IMAGE_JPEG_VALUE);
+	public void printResponseWithoutCharacterEncoding() throws Exception {
+		this.response.setCharacterEncoding(null);
+		this.response.getWriter().print("text");
 
 		this.handler.handle(this.mvcResult);
 
-		assertValue("MockHttpServletResponse", "Body", "<content type is not printable text>");
+		assertValue("MockHttpServletResponse", "Body", "<no character encoding set>");
 	}
 
 	@Test