Spring/spring-framework
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Reuse mock request from the TCF in Spring MVC Test

Browse Source 
Prior to this commit, the Spring MVC Test Framework always created a
new MockHttpServletRequest, disregarding any mock request already
present in Spring Web's RequestContextHolder -- for example, one
created by the ServletTestExecutionListener in the Spring TestContext
Framework (TCF).

This commit modifies MockHttpServletRequestBuilder so that it reuses a
mock request created by the TCF. However,
MockMultipartHttpServletRequestBuilder continues to always create a new
MockMultipartHttpServletRequest since a MockHttpServletRequest created
by the TCF is not directly compatible with a
MockMultipartHttpServletRequest. Furthermore, in order to avoid
unforeseen side effects, MockHttpServletRequestBuilder will always
create a new MockHttpServletRequest if a mock request is present in the
RequestContextHolder but not created by the TCF.

Issue: SPR-13211
This commit is contained in:
Sam Brannen
2015-07-20 21:56:04 +02:00
parent 24ff4f56e1
commit bf06bf33ab
7 changed files with 239 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

141
spring-test/src/test/java/org/springframework/test/web/servlet/samples/spr/CustomRequestAttributesRequestContextHolderTests.java Normal file
View File

@@ -0,0 +1,141 @@
/*
* Copyright 2002-2015 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
*
* http://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.test.web.servlet.samples.spr;
import javax.servlet.ServletContext;
import javax.servlet.ServletRequest;
import javax.servlet.http.HttpServletRequest;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.springframework.context.annotation.AnnotatedBeanDefinitionReader;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.mock.web.MockHttpServletRequest;
import org.springframework.mock.web.MockHttpServletResponse;
import org.springframework.mock.web.MockServletContext;
import org.springframework.test.context.web.ServletTestExecutionListener;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.context.request.RequestAttributes;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
import org.springframework.web.context.request.ServletWebRequest;
import org.springframework.web.context.support.GenericWebApplicationContext;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
import static org.hamcrest.CoreMatchers.*;
import static org.junit.Assert.*;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.*;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.*;
import static org.springframework.test.web.servlet.setup.MockMvcBuilders.*;
/**
* Integration tests for SPR-13211 which verify that a custom mock request
* (i.e., one not created by {@link ServletTestExecutionListener}) is not
* reused by MockMvc.
*
* @author Sam Brannen
* @since 4.2
* @see RequestContextHolderTests
*/
public class CustomRequestAttributesRequestContextHolderTests {
private static final String FROM_CUSTOM_MOCK = "fromCustomMock";
private static final String FROM_MVC_TEST_DEFAULT = "fromSpringMvcTestDefault";
private static final String FROM_MVC_TEST_MOCK = "fromSpringMvcTestMock";
private final GenericWebApplicationContext wac = new GenericWebApplicationContext();
private MockMvc mockMvc;
@Before
public void setUp() {
ServletContext servletContext = new MockServletContext();
MockHttpServletRequest mockRequest = new MockHttpServletRequest(servletContext);
mockRequest.setAttribute(FROM_CUSTOM_MOCK, FROM_CUSTOM_MOCK);
RequestContextHolder.setRequestAttributes(new ServletWebRequest(mockRequest, new MockHttpServletResponse()));
this.wac.setServletContext(servletContext);
new AnnotatedBeanDefinitionReader(this.wac).register(WebConfig.class);
this.wac.refresh();
this.mockMvc = webAppContextSetup(this.wac)
.defaultRequest(get("/").requestAttr(FROM_MVC_TEST_DEFAULT, FROM_MVC_TEST_DEFAULT))
.alwaysExpect(status().isOk())
.build();
}
@Test
public void singletonController() throws Exception {
this.mockMvc.perform(get("/singletonController").requestAttr(FROM_MVC_TEST_MOCK, FROM_MVC_TEST_MOCK));
}
@After
public void verifyCustomRequestAttributesAreRestored() {
RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes();
assertThat(requestAttributes, instanceOf(ServletRequestAttributes.class));
HttpServletRequest request = ((ServletRequestAttributes) requestAttributes).getRequest();
assertThat(request.getAttribute(FROM_CUSTOM_MOCK), is(FROM_CUSTOM_MOCK));
assertThat(request.getAttribute(FROM_MVC_TEST_DEFAULT), is(nullValue()));
assertThat(request.getAttribute(FROM_MVC_TEST_MOCK), is(nullValue()));
RequestContextHolder.resetRequestAttributes();
this.wac.close();
}
// -------------------------------------------------------------------
@Configuration
@EnableWebMvc
static class WebConfig extends WebMvcConfigurerAdapter {
@Bean
public SingletonController singletonController() {
return new SingletonController();
}
}
@RestController
private static class SingletonController {
@RequestMapping("/singletonController")
public void handle() {
assertRequestAttributes();
}
}
private static void assertRequestAttributes() {
RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes();
assertThat(requestAttributes, instanceOf(ServletRequestAttributes.class));
assertRequestAttributes(((ServletRequestAttributes) requestAttributes).getRequest());
}
private static void assertRequestAttributes(ServletRequest request) {
assertThat(request.getAttribute(FROM_CUSTOM_MOCK), is(nullValue()));
assertThat(request.getAttribute(FROM_MVC_TEST_DEFAULT), is(FROM_MVC_TEST_DEFAULT));
assertThat(request.getAttribute(FROM_MVC_TEST_MOCK), is(FROM_MVC_TEST_MOCK));
}
}

19
spring-test/src/test/java/org/springframework/test/web/servlet/samples/spr/RequestContextHolderTests.java
View File

@@ -23,6 +23,7 @@ import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
@@ -56,12 +57,16 @@ import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.
import static org.springframework.test.web.servlet.setup.MockMvcBuilders.*;
/**
* Tests for SPR-10025 (access to request attributes via RequestContextHolder),
* SPR-13217 (Populate RequestAttributes before invoking Filters in MockMvc),
* and SPR-13211 (re-use of mock request from the TestContext framework).
* Integration tests for the following use cases.
* <ul>
* <li>SPR-10025: Access to request attributes via RequestContextHolder</li>
* <li>SPR-13217: Populate RequestAttributes before invoking Filters in MockMvc</li>
* <li>SPR-13211: Reuse of mock request from the TestContext framework</li>
* </ul>
*
* @author Rossen Stoyanchev
* @author Sam Brannen
* @see CustomRequestAttributesRequestContextHolderTests
*/
@RunWith(SpringJUnit4ClassRunner.class)
@WebAppConfiguration
@@ -130,6 +135,11 @@ public class RequestContextHolderTests {
this.mockMvc.perform(get("/sessionScopedService").requestAttr(FROM_MVC_TEST_MOCK, FROM_MVC_TEST_MOCK));
}
@After
public void verifyRestoredRequestAttributes() {
assertRequestAttributes();
}
// -------------------------------------------------------------------
@@ -290,8 +300,7 @@ public class RequestContextHolderTests {
}
private static void assertRequestAttributes(ServletRequest request) {
// TODO [SPR-13211] Assert that FROM_TCF_MOCK is FROM_TCF_MOCK, instead of NULL.
assertThat(request.getAttribute(FROM_TCF_MOCK), is(nullValue()));
assertThat(request.getAttribute(FROM_TCF_MOCK), is(FROM_TCF_MOCK));
assertThat(request.getAttribute(FROM_MVC_TEST_DEFAULT), is(FROM_MVC_TEST_DEFAULT));
assertThat(request.getAttribute(FROM_MVC_TEST_MOCK), is(FROM_MVC_TEST_MOCK));
assertThat(request.getAttribute(FROM_REQUEST_FILTER), is(FROM_REQUEST_FILTER));