root
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Actions 10 Packages Projects Releases Wiki Activity

Update contentType property via MockHttpServletResponse::setCharacterEncoding() 

Prior to this commit, MockHttpServletResponse's setCharacterEncoding()
method did not update the contentType property, which violates the
Servlet 2.4 Javadoc for getContentType() and setCharacterEncoding().

This commit addresses this issue; however, some existing tests may have
to be updated as a result of this change.

For example, note how some of the tests in this commit have been
refactored to use MediaType##isCompatibleWith() instead of asserting
exact matches for the value returned by MockHttpServletResponse's
getContentType() method.

Closes gh-25536
This commit is contained in:
Sam Brannen 2020-08-10 16:05:18 +02:00
parent c5bb5d6c03
commit 5de549d7d4
6 changed files with 44 additions and 60 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
spring-test/src/main/java/org/springframework/mock/web/MockHttpServletResponse.java
View File

@ -169,14 +169,15 @@ public class MockHttpServletResponse implements HttpServletResponse {
public void setCharacterEncoding(String characterEncoding) {
this.characterEncoding = characterEncoding;
this.charset = true;
updateContentTypeHeader();
updateContentTypePropertyAndHeader();
}
private void updateContentTypeHeader() {
private void updateContentTypePropertyAndHeader() {
if (this.contentType != null) {
String value = this.contentType;
if (this.charset && !this.contentType.toLowerCase().contains(CHARSET_PREFIX)) {
value = value + ';' + CHARSET_PREFIX + this.characterEncoding;
this.contentType = value;
}
doAddHeaderValue(HttpHeaders.CONTENT_TYPE, value, true);
}
@ -280,7 +281,7 @@ public class MockHttpServletResponse implements HttpServletResponse {
this.charset = true;
}
}
updateContentTypeHeader();
updateContentTypePropertyAndHeader();
}
}

6
spring-test/src/test/java/org/springframework/mock/web/MockHttpServletResponseTests.java
View File

@ -144,7 +144,7 @@ class MockHttpServletResponseTests {
void setContentTypeThenCharacterEncoding() {
response.setContentType("test/plain");
response.setCharacterEncoding("UTF-8");
assertThat(response.getContentType()).isEqualTo("test/plain");
assertThat(response.getContentType()).isEqualTo("test/plain;charset=UTF-8");
assertThat(response.getHeader(CONTENT_TYPE)).isEqualTo("test/plain;charset=UTF-8");
assertThat(response.getCharacterEncoding()).isEqualTo("UTF-8");
}
@ -153,7 +153,7 @@ class MockHttpServletResponseTests {
void setCharacterEncodingThenContentType() {
response.setCharacterEncoding("UTF-8");
response.setContentType("test/plain");
assertThat(response.getContentType()).isEqualTo("test/plain");
assertThat(response.getContentType()).isEqualTo("test/plain;charset=UTF-8");
assertThat(response.getHeader(CONTENT_TYPE)).isEqualTo("test/plain;charset=UTF-8");
assertThat(response.getCharacterEncoding()).isEqualTo("UTF-8");
}
@ -488,7 +488,7 @@ class MockHttpServletResponseTests {
assertThat(response.isCharset()).isTrue();
assertThat(response.getCharacterEncoding()).isEqualTo("UTF-8");
response.setContentType("text/plain");
assertThat(response.getContentType()).isEqualTo("text/plain");
assertThat(response.getContentType()).isEqualTo("text/plain;charset=UTF-8");
String contentTypeHeader = response.getHeader(CONTENT_TYPE);
assertThat(contentTypeHeader).isEqualTo("text/plain;charset=UTF-8");

5
spring-test/src/test/java/org/springframework/test/web/servlet/samples/standalone/ViewResolutionTests.java
View File

@ -73,7 +73,7 @@ class ViewResolutionTests {
standaloneSetup(new PersonController()).setSingleView(new MappingJackson2JsonView()).build()
.perform(get("/person/Corea"))
.andExpect(status().isOk())
.andExpect(content().contentType(MediaType.APPLICATION_JSON))
.andExpect(content().contentTypeCompatibleWith(MediaType.APPLICATION_JSON))
.andExpect(jsonPath("$.person.name").value("Corea"));
}
@ -119,7 +119,7 @@ class ViewResolutionTests {
mockMvc.perform(get("/person/Corea").accept(MediaType.APPLICATION_JSON))
.andExpect(status().isOk())
.andExpect(content().contentType(MediaType.APPLICATION_JSON))
.andExpect(content().contentTypeCompatibleWith(MediaType.APPLICATION_JSON))
.andExpect(jsonPath("$.person.name").value("Corea"));
mockMvc.perform(get("/person/Corea").accept(MediaType.APPLICATION_XML))
@ -150,4 +150,3 @@ class ViewResolutionTests {
}
}

7
spring-web/src/testFixtures/java/org/springframework/web/testfixture/servlet/MockHttpServletResponse.java
View File

@ -169,14 +169,15 @@ public class MockHttpServletResponse implements HttpServletResponse {
public void setCharacterEncoding(String characterEncoding) {
this.characterEncoding = characterEncoding;
this.charset = true;
updateContentTypeHeader();
updateContentTypePropertyAndHeader();
}
private void updateContentTypeHeader() {
private void updateContentTypePropertyAndHeader() {
if (this.contentType != null) {
String value = this.contentType;
if (this.charset && !this.contentType.toLowerCase().contains(CHARSET_PREFIX)) {
value = value + ';' + CHARSET_PREFIX + this.characterEncoding;
this.contentType = value;
}
doAddHeaderValue(HttpHeaders.CONTENT_TYPE, value, true);
}
@ -280,7 +281,7 @@ public class MockHttpServletResponse implements HttpServletResponse {
this.charset = true;
}
}
updateContentTypeHeader();
updateContentTypePropertyAndHeader();
}
}

41
spring-webmvc/src/test/java/org/springframework/web/servlet/view/json/MappingJackson2JsonViewTests.java
View File

@ -1,5 +1,5 @@
/*
* Copyright 2002-2019 the original author or authors.
* Copyright 2002-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.
@ -38,7 +38,6 @@ import com.fasterxml.jackson.databind.ser.FilterProvider;
import com.fasterxml.jackson.databind.ser.SerializerFactory;
import com.fasterxml.jackson.databind.ser.impl.SimpleBeanPropertyFilter;
import com.fasterxml.jackson.databind.ser.impl.SimpleFilterProvider;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.mozilla.javascript.Context;
import org.mozilla.javascript.ContextFactory;
@ -60,30 +59,19 @@ import static org.mockito.Mockito.mock;
* @author Arjen Poutsma
* @author Rossen Stoyanchev
* @author Sebastien Deleuze
* @author Sam Brannen
*/
public class MappingJackson2JsonViewTests {
private MappingJackson2JsonView view;
private MappingJackson2JsonView view = new MappingJackson2JsonView();
private MockHttpServletRequest request;
private MockHttpServletRequest request = new MockHttpServletRequest();
private MockHttpServletResponse response;
private MockHttpServletResponse response = new MockHttpServletResponse();
private Context jsContext;
private Context jsContext = ContextFactory.getGlobal().enterContext();
private ScriptableObject jsScope;
@BeforeEach
public void setUp() {
request = new MockHttpServletRequest();
response = new MockHttpServletResponse();
jsContext = ContextFactory.getGlobal().enterContext();
jsScope = jsContext.initStandardObjects();
view = new MappingJackson2JsonView();
}
private ScriptableObject jsScope = jsContext.initStandardObjects();
@Test
@ -102,7 +90,8 @@ public class MappingJackson2JsonViewTests {
assertThat(response.getHeader("Cache-Control")).isEqualTo("no-store");
assertThat(response.getContentType()).isEqualTo(MappingJackson2JsonView.DEFAULT_CONTENT_TYPE);
MediaType mediaType = MediaType.parseMediaType(response.getContentType());
assertThat(mediaType.isCompatibleWith(MediaType.parseMediaType(MappingJackson2JsonView.DEFAULT_CONTENT_TYPE))).isTrue();
String jsonResult = response.getContentAsString();
assertThat(jsonResult.length() > 0).isTrue();
@ -117,12 +106,14 @@ public class MappingJackson2JsonViewTests {
model.put("foo", "bar");
view.render(model, request, response);
assertThat(response.getContentType()).isEqualTo("application/json");
MediaType mediaType = MediaType.parseMediaType(response.getContentType());
assertThat(mediaType.isCompatibleWith(MediaType.APPLICATION_JSON)).isTrue();
request.setAttribute(View.SELECTED_CONTENT_TYPE, new MediaType("application", "vnd.example-v2+xml"));
view.render(model, request, response);
assertThat(response.getContentType()).isEqualTo("application/vnd.example-v2+xml");
mediaType = MediaType.parseMediaType(response.getContentType());
assertThat(mediaType.isCompatibleWith(MediaType.parseMediaType("application/vnd.example-v2+xml"))).isTrue();
}
@Test
@ -326,10 +317,10 @@ public class MappingJackson2JsonViewTests {
if (jsonPrefix != null) {
json = json.substring(5);
}
Object jsResult =
jsContext.evaluateString(jsScope, "(" + json + ")", "JSON Stream", 1, null);
Object jsResult = jsContext.evaluateString(jsScope, "(" + json + ")", "JSON Stream", 1, null);
assertThat(jsResult).as("Json Result did not eval as valid JavaScript").isNotNull();
assertThat(response.getContentType()).isEqualTo("application/json");
MediaType mediaType = MediaType.parseMediaType(response.getContentType());
assertThat(mediaType.isCompatibleWith(MediaType.APPLICATION_JSON)).isTrue();
}

38
spring-webmvc/src/test/java/org/springframework/web/servlet/view/xml/MappingJackson2XmlViewTests.java
View File

@ -1,5 +1,5 @@
/*
* Copyright 2002-2019 the original author or authors.
* Copyright 2002-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.
@ -33,7 +33,6 @@ import com.fasterxml.jackson.databind.cfg.SerializerFactoryConfig;
import com.fasterxml.jackson.databind.ser.BeanSerializerFactory;
import com.fasterxml.jackson.databind.ser.SerializerFactory;
import com.fasterxml.jackson.dataformat.xml.XmlMapper;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.mozilla.javascript.Context;
import org.mozilla.javascript.ContextFactory;
@ -51,30 +50,19 @@ import static org.mockito.Mockito.mock;
/**
* @author Sebastien Deleuze
* @author Sam Brannen
*/
public class MappingJackson2XmlViewTests {
private MappingJackson2XmlView view;
private MappingJackson2XmlView view = new MappingJackson2XmlView();
private MockHttpServletRequest request;
private MockHttpServletRequest request = new MockHttpServletRequest();
private MockHttpServletResponse response;
private MockHttpServletResponse response = new MockHttpServletResponse();
private Context jsContext;
private Context jsContext = ContextFactory.getGlobal().enterContext();
private ScriptableObject jsScope;
@BeforeEach
public void setUp() {
request = new MockHttpServletRequest();
response = new MockHttpServletResponse();
jsContext = ContextFactory.getGlobal().enterContext();
jsScope = jsContext.initStandardObjects();
view = new MappingJackson2XmlView();
}
private ScriptableObject jsScope = jsContext.initStandardObjects();
@Test
@ -93,7 +81,8 @@ public class MappingJackson2XmlViewTests {
assertThat(response.getHeader("Cache-Control")).isEqualTo("no-store");
assertThat(response.getContentType()).isEqualTo(MappingJackson2XmlView.DEFAULT_CONTENT_TYPE);
MediaType mediaType = MediaType.parseMediaType(response.getContentType());
assertThat(mediaType.isCompatibleWith(MediaType.parseMediaType(MappingJackson2XmlView.DEFAULT_CONTENT_TYPE))).isTrue();
String jsonResult = response.getContentAsString();
assertThat(jsonResult.length() > 0).isTrue();
@ -108,12 +97,14 @@ public class MappingJackson2XmlViewTests {
model.put("foo", "bar");
view.render(model, request, response);
assertThat(response.getContentType()).isEqualTo("application/xml");
MediaType mediaType = MediaType.parseMediaType(response.getContentType());
assertThat(mediaType.isCompatibleWith(MediaType.APPLICATION_XML)).isTrue();
request.setAttribute(View.SELECTED_CONTENT_TYPE, new MediaType("application", "vnd.example-v2+xml"));
view.render(model, request, response);
assertThat(response.getContentType()).isEqualTo("application/vnd.example-v2+xml");
mediaType = MediaType.parseMediaType(response.getContentType());
assertThat(mediaType.isCompatibleWith(MediaType.parseMediaType("application/vnd.example-v2+xml"))).isTrue();
}
@Test
@ -232,7 +223,8 @@ public class MappingJackson2XmlViewTests {
Object xmlResult =
jsContext.evaluateString(jsScope, "(" + response.getContentAsString() + ")", "XML Stream", 1, null);
assertThat(xmlResult).as("XML Result did not eval as valid JavaScript").isNotNull();
assertThat(response.getContentType()).isEqualTo("application/xml");
MediaType mediaType = MediaType.parseMediaType(response.getContentType());
assertThat(mediaType.isCompatibleWith(MediaType.APPLICATION_XML)).isTrue();
}