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

16
spring-test/src/main/java/org/springframework/test/context/web/ServletTestExecutionListener.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2014 the original author or authors.
* 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.
@@ -35,6 +35,7 @@ import org.springframework.test.context.support.AbstractTestExecutionListener;
import org.springframework.test.context.support.DependencyInjectionTestExecutionListener;
import org.springframework.util.Assert;
import org.springframework.web.context.WebApplicationContext;
import org.springframework.web.context.request.RequestAttributes;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletWebRequest;
@@ -85,6 +86,18 @@ public class ServletTestExecutionListener extends AbstractTestExecutionListener
public static final String POPULATED_REQUEST_CONTEXT_HOLDER_ATTRIBUTE = Conventions.getQualifiedAttributeName(
ServletTestExecutionListener.class, "populatedRequestContextHolder");
/**
* Attribute name for a request attribute which indicates that the
* {@link MockHttpServletRequest} stored in the {@link RequestAttributes}
* in Spring Web's {@link RequestContextHolder} was created by the TestContext
* framework.
*
* <p>Permissible values include {@link Boolean#TRUE} and {@link Boolean#FALSE}.
* @since 4.2
*/
public static final String CREATED_BY_THE_TESTCONTEXT_FRAMEWORK = Conventions.getQualifiedAttributeName(
ServletTestExecutionListener.class, "createdByTheTestContextFramework");
private static final Log logger = LogFactory.getLog(ServletTestExecutionListener.class);
@@ -184,6 +197,7 @@ public class ServletTestExecutionListener extends AbstractTestExecutionListener
MockServletContext mockServletContext = (MockServletContext) servletContext;
MockHttpServletRequest request = new MockHttpServletRequest(mockServletContext);
request.setAttribute(CREATED_BY_THE_TESTCONTEXT_FRAMEWORK, Boolean.TRUE);
MockHttpServletResponse response = new MockHttpServletResponse();
ServletWebRequest servletWebRequest = new ServletWebRequest(request, response);

4
spring-test/src/main/java/org/springframework/test/web/servlet/MockMvc.java
View File

@@ -26,6 +26,7 @@ import org.springframework.mock.web.MockFilterChain;
import org.springframework.mock.web.MockHttpServletRequest;
import org.springframework.mock.web.MockHttpServletResponse;
import org.springframework.util.Assert;
import org.springframework.web.context.request.RequestAttributes;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
@@ -145,6 +146,7 @@ public final class MockMvc {
// [SPR-13217] Simulate RequestContextFilter to ensure that RequestAttributes are
// populated before filters are invoked.
RequestAttributes previousAttributes = RequestContextHolder.getRequestAttributes();
RequestContextHolder.setRequestAttributes(new ServletRequestAttributes(request, response));
MockFilterChain filterChain = new MockFilterChain(this.servlet, this.filters);
@@ -152,6 +154,8 @@ public final class MockMvc {
applyDefaultResultActions(mvcResult);
RequestContextHolder.setRequestAttributes(previousAttributes);
return new ResultActions() {
@Override

33
spring-test/src/main/java/org/springframework/test/web/servlet/request/MockHttpServletRequestBuilder.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2014 the original author or authors.
* 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.
@@ -29,6 +29,7 @@ import java.util.Map.Entry;
import javax.servlet.ServletContext;
import javax.servlet.ServletRequest;
import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServletRequest;
import org.springframework.beans.Mergeable;
import org.springframework.beans.factory.NoSuchBeanDefinitionException;
@@ -38,6 +39,7 @@ import org.springframework.http.MediaType;
import org.springframework.mock.web.MockHttpServletRequest;
import org.springframework.mock.web.MockHttpServletResponse;
import org.springframework.mock.web.MockHttpSession;
import org.springframework.test.context.web.ServletTestExecutionListener;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.util.Assert;
import org.springframework.util.LinkedMultiValueMap;
@@ -46,6 +48,9 @@ import org.springframework.util.ObjectUtils;
import org.springframework.util.StringUtils;
import org.springframework.web.bind.annotation.ValueConstants;
import org.springframework.web.context.WebApplicationContext;
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.support.WebApplicationContextUtils;
import org.springframework.web.servlet.DispatcherServlet;
import org.springframework.web.servlet.FlashMap;
@@ -64,6 +69,7 @@ import org.springframework.web.util.UriUtils;
*
* @author Rossen Stoyanchev
* @author Arjen Poutsma
* @author Sam Brannen
* @since 3.2
*/
public class MockHttpServletRequestBuilder
@@ -639,10 +645,31 @@ public class MockHttpServletRequestBuilder
}
/**
* Create a new {@link MockHttpServletRequest} based on the given
* {@link ServletContext}. Can be overridden in subclasses.
* Create a {@link MockHttpServletRequest}.
* <p>If an instance of {@code MockHttpServletRequest} that was created
* by the <em>Spring TestContext Framework</em> is available via the
* {@link RequestAttributes} bound to the current thread in
* {@link RequestContextHolder}, this method simply returns that instance.
* <p>Otherwise, this method creates a new {@code MockHttpServletRequest}
* based on the supplied {@link ServletContext}.
* <p>Can be overridden in subclasses.
* @see RequestContextHolder#getRequestAttributes()
* @see ServletRequestAttributes
* @see ServletTestExecutionListener#CREATED_BY_THE_TESTCONTEXT_FRAMEWORK
*/
protected MockHttpServletRequest createServletRequest(ServletContext servletContext) {
RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes();
if (requestAttributes instanceof ServletRequestAttributes) {
HttpServletRequest request = ((ServletRequestAttributes) requestAttributes).getRequest();
if (request instanceof MockHttpServletRequest) {
MockHttpServletRequest mockRequest = (MockHttpServletRequest) request;
Object createdByTcf = mockRequest.getAttribute(ServletTestExecutionListener.CREATED_BY_THE_TESTCONTEXT_FRAMEWORK);
if (Boolean.TRUE.equals(createdByTcf)) {
return mockRequest;
}
}
}
return new MockHttpServletRequest(servletContext);
}

8
spring-test/src/main/java/org/springframework/test/web/servlet/request/MockMultipartHttpServletRequestBuilder.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2014 the original author or authors.
* 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.
@@ -105,6 +105,12 @@ public class MockMultipartHttpServletRequestBuilder extends MockHttpServletReque
return this;
}
/**
* Create a new {@link MockMultipartHttpServletRequest} based on the
* supplied {@code ServletContext} and the {@code MockMultipartFiles}
* added to this builder.
* <p>Can be overridden in subclasses.
*/
@Override
protected final MockHttpServletRequest createServletRequest(ServletContext servletContext) {
MockMultipartHttpServletRequest request = new MockMultipartHttpServletRequest(servletContext);

33
spring-test/src/main/java/org/springframework/test/web/servlet/request/MockMvcRequestBuilders.java
View File

@@ -13,6 +13,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.test.web.servlet.request;
import java.net.URI;
@@ -20,19 +21,31 @@ import javax.servlet.ServletContext;
import org.springframework.http.HttpMethod;
import org.springframework.mock.web.MockHttpServletRequest;
import org.springframework.mock.web.MockMultipartHttpServletRequest;
import org.springframework.test.web.servlet.MvcResult;
import org.springframework.test.web.servlet.RequestBuilder;
/**
* Static factory methods for {@link RequestBuilder}s.
* Static factory methods for {@link RequestBuilder RequestBuilders}.
*
* <p><strong>Eclipse users:</strong> Consider adding this class as a Java
* editor favorite. To navigate, open the Preferences and type "favorites".
* <h3>Integration with the Spring TestContext Framework</h3>
* <p>Methods in this class will reuse a
* {@link org.springframework.mock.web.MockServletContext MockServletContext}
* that was created by the Spring TestContext Framework.
*
* <p>Methods in this class that return a {@link MockHttpServletRequestBuilder}
* will reuse a {@link MockHttpServletRequest} that was created by the Spring
* TestContext Framework.
*
* <h3>Eclipse Users</h3>
* <p>Consider adding this class as a Java editor favorite. To navigate to
* this setting, open the Preferences and type "favorites".
*
* @author Arjen Poutsma
* @author Rossen Stoyanchev
* @author Greg Turnquist
* @author Sebastien Deleuze
* @author Sam Brannen
* @since 3.2
*/
public abstract class MockMvcRequestBuilders {
@@ -185,7 +198,12 @@ public abstract class MockMvcRequestBuilders {
}
/**
* Create a {@link MockHttpServletRequestBuilder} for a multipart request.
* Create a {@link MockMultipartHttpServletRequestBuilder} for a multipart request.
* <p>In contrast to methods in this class that return a
* {@link MockHttpServletRequestBuilder}, the builder returned by this
* method will always create a new {@link MockMultipartHttpServletRequest}
* that is <em>not</em> associated with a mock request created by the
* Spring TestContext Framework.
* @param urlTemplate a URL template; the resulting URL will be encoded
* @param urlVariables zero or more URL variables
*/
@@ -194,7 +212,12 @@ public abstract class MockMvcRequestBuilders {
}
/**
* Create a {@link MockHttpServletRequestBuilder} for a multipart request.
* Create a {@link MockMultipartHttpServletRequestBuilder} for a multipart request.
* <p>In contrast to methods in this class that return a
* {@link MockHttpServletRequestBuilder}, the builder returned by this
* method will always create a new {@link MockMultipartHttpServletRequest}
* that is <em>not</em> associated with a mock request created by the
* Spring TestContext Framework.
* @param uri the URL
* @since 4.0.3
*/