MockHttpServletRequestBuilder.java 25.2 KB
Newer Older
R
Rob Winch 已提交
1
/*
2
 * Copyright 2002-2016 the original author or authors.
R
Rob Winch 已提交
3 4 5 6 7 8 9 10 11 12 13 14 15 16
 *
 * 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.
 */

17
package org.springframework.test.web.servlet.request;
R
Rob Winch 已提交
18

19 20 21
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
R
Rossen Stoyanchev 已提交
22
import java.io.UnsupportedEncodingException;
23
import java.net.URI;
R
Rob Winch 已提交
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38
import java.security.Principal;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Map.Entry;
import javax.servlet.ServletContext;
import javax.servlet.ServletRequest;
import javax.servlet.http.Cookie;

import org.springframework.beans.Mergeable;
import org.springframework.beans.factory.NoSuchBeanDefinitionException;
import org.springframework.http.HttpHeaders;
39
import org.springframework.http.HttpInputMessage;
R
Rob Winch 已提交
40 41
import org.springframework.http.HttpMethod;
import org.springframework.http.MediaType;
42
import org.springframework.http.converter.FormHttpMessageConverter;
R
Rob Winch 已提交
43 44 45
import org.springframework.mock.web.MockHttpServletRequest;
import org.springframework.mock.web.MockHttpServletResponse;
import org.springframework.mock.web.MockHttpSession;
46
import org.springframework.test.web.servlet.MockMvc;
R
Rob Winch 已提交
47 48 49 50 51 52 53 54 55 56 57 58 59
import org.springframework.util.Assert;
import org.springframework.util.LinkedMultiValueMap;
import org.springframework.util.MultiValueMap;
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.support.WebApplicationContextUtils;
import org.springframework.web.servlet.DispatcherServlet;
import org.springframework.web.servlet.FlashMap;
import org.springframework.web.servlet.FlashMapManager;
import org.springframework.web.servlet.support.SessionFlashMapManager;
import org.springframework.web.util.UriComponentsBuilder;
R
Rossen Stoyanchev 已提交
60
import org.springframework.web.util.UriUtils;
R
Rob Winch 已提交
61 62

/**
J
Juergen Hoeller 已提交
63 64
 * Default builder for {@link MockHttpServletRequest} required as input to perform
 * requests in {@link MockMvc}.
R
Rob Winch 已提交
65
 *
J
Juergen Hoeller 已提交
66
 * <p>Application tests will typically access this builder through the static factory
67
 * methods in {@link MockMvcRequestBuilders}.
68 69 70
 * <p>Although this class cannot be extended, additional ways to initialize
 * the {@code MockHttpServletRequest} can be plugged in via
 * {@link #with(RequestPostProcessor)}.
R
Rob Winch 已提交
71 72 73
 *
 * @author Rossen Stoyanchev
 * @author Arjen Poutsma
74
 * @author Sam Brannen
75
 * @author Kamill Sokol
76 77
 * @since 3.2
 */
78 79 80
public class MockHttpServletRequestBuilder
		implements ConfigurableSmartRequestBuilder<MockHttpServletRequestBuilder>, Mergeable {

81
	private final String method;
R
Rob Winch 已提交
82

83
	private final URI url;
J
Juergen Hoeller 已提交
84

R
Rob Winch 已提交
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
	private final MultiValueMap<String, Object> headers = new LinkedMultiValueMap<String, Object>();

	private String contentType;

	private byte[] content;

	private final MultiValueMap<String, String> parameters = new LinkedMultiValueMap<String, String>();

	private final List<Cookie> cookies = new ArrayList<Cookie>();

	private Locale locale;

	private String characterEncoding;

	private Boolean secure;

J
Juergen Hoeller 已提交
101 102
	private Principal principal;

R
Rob Winch 已提交
103 104 105 106 107 108 109 110 111 112 113 114 115 116
	private final Map<String, Object> attributes = new LinkedHashMap<String, Object>();

	private MockHttpSession session;

	private final Map<String, Object> sessionAttributes = new LinkedHashMap<String, Object>();

	private final Map<String, Object> flashAttributes = new LinkedHashMap<String, Object>();

	private String contextPath = "";

	private String servletPath = "";

	private String pathInfo = ValueConstants.DEFAULT_NONE;

J
Juergen Hoeller 已提交
117
	private final List<RequestPostProcessor> postProcessors = new ArrayList<RequestPostProcessor>();
R
Rob Winch 已提交
118 119 120


	/**
121 122 123 124 125
	 * Package private constructor. To get an instance, use static factory
	 * methods in {@link MockMvcRequestBuilders}.
	 * <p>Although this class cannot be extended, additional ways to initialize
	 * the {@code MockHttpServletRequest} can be plugged in via
	 * {@link #with(RequestPostProcessor)}.
126
	 * @param httpMethod the HTTP method (GET, POST, etc)
127 128
	 * @param url a URL template; the resulting URL will be encoded
	 * @param vars zero or more URL variables
R
Rob Winch 已提交
129
	 */
130
	MockHttpServletRequestBuilder(HttpMethod httpMethod, String url, Object... vars) {
131 132 133 134
		this(httpMethod.name(), UriComponentsBuilder.fromUriString(url).buildAndExpand(vars).encode().toUri());
	}

	/**
135 136
	 * Alternative to {@link #MockHttpServletRequestBuilder(HttpMethod, String, Object...)}
	 * with a pre-built URI.
137
	 * @param httpMethod the HTTP method (GET, POST, etc)
138
	 * @param url the URL
139 140
	 * @since 4.0.3
	 */
141
	MockHttpServletRequestBuilder(HttpMethod httpMethod, URI url) {
142
		this(httpMethod.name(), url);
143 144 145
	}

	/**
146
	 * Alternative constructor for custom HTTP methods.
147 148 149 150 151
	 * @param httpMethod the HTTP method (GET, POST, etc)
	 * @param url the URL
	 * @since 4.3
	 */
	MockHttpServletRequestBuilder(String httpMethod, URI url) {
152
		Assert.notNull(httpMethod, "httpMethod is required");
153
		Assert.notNull(url, "url is required");
154
		this.method = httpMethod;
155
		this.url = url;
156 157
	}

R
Rob Winch 已提交
158 159
	/**
	 * Add a request parameter to the {@link MockHttpServletRequest}.
J
Juergen Hoeller 已提交
160
	 * <p>If called more than once, new values get added to existing ones.
R
Rob Winch 已提交
161 162 163 164 165 166 167 168
	 * @param name the parameter name
	 * @param values one or more values
	 */
	public MockHttpServletRequestBuilder param(String name, String... values) {
		addToMultiValueMap(this.parameters, name, values);
		return this;
	}

169
	/**
J
Juergen Hoeller 已提交
170 171 172
	 * Add a map of request parameters to the {@link MockHttpServletRequest},
	 * for example when testing a form submission.
	 * <p>If called more than once, new values get added to existing ones.
173
	 * @param params the parameters to add
J
Juergen Hoeller 已提交
174
	 * @since 4.2.4
175 176 177 178 179 180 181 182 183 184
	 */
	public MockHttpServletRequestBuilder params(MultiValueMap<String, String> params) {
		for (String name : params.keySet()) {
			for (String value : params.get(name)) {
				this.parameters.add(name, value);
			}
		}
		return this;
	}

R
Rob Winch 已提交
185 186 187 188 189 190
	/**
	 * Add a header to the request. Values are always added.
	 * @param name the header name
	 * @param values one or more header values
	 */
	public MockHttpServletRequestBuilder header(String name, Object... values) {
191 192 193 194
		if ("Content-Type".equalsIgnoreCase(name)) {
			List<MediaType> mediaTypes = MediaType.parseMediaTypes(StringUtils.arrayToCommaDelimitedString(values));
			this.contentType = MediaType.toString(mediaTypes);
		}
R
Rob Winch 已提交
195 196 197 198 199 200 201 202 203
		addToMultiValueMap(this.headers, name, values);
		return this;
	}

	/**
	 * Add all headers to the request. Values are always added.
	 * @param httpHeaders the headers and values to add
	 */
	public MockHttpServletRequestBuilder headers(HttpHeaders httpHeaders) {
204 205 206 207
		MediaType mediaType = httpHeaders.getContentType();
		if (mediaType != null) {
			this.contentType = mediaType.toString();
		}
R
Rob Winch 已提交
208 209 210 211 212 213 214 215 216
		for (String name : httpHeaders.keySet()) {
			Object[] values = ObjectUtils.toObjectArray(httpHeaders.get(name).toArray());
			addToMultiValueMap(this.headers, name, values);
		}
		return this;
	}

	/**
	 * Set the 'Content-Type' header of the request.
217
	 * @param contentType the content type
R
Rob Winch 已提交
218
	 */
219 220 221 222 223 224 225 226 227 228 229 230 231 232
	public MockHttpServletRequestBuilder contentType(MediaType contentType) {
		Assert.notNull(contentType, "'contentType' must not be null");
		this.contentType = contentType.toString();
		this.headers.set("Content-Type", this.contentType);
		return this;
	}

	/**
	 * Set the 'Content-Type' header of the request.
	 * @param contentType the content type
	 * @since 4.1.2
	 */
	public MockHttpServletRequestBuilder contentType(String contentType) {
		this.contentType = MediaType.parseMediaType(contentType).toString();
R
Rob Winch 已提交
233 234 235 236 237 238 239 240 241 242 243 244 245 246
		this.headers.set("Content-Type", this.contentType);
		return this;
	}

	/**
	 * Set the 'Accept' header to the given media type(s).
	 * @param mediaTypes one or more media types
	 */
	public MockHttpServletRequestBuilder accept(MediaType... mediaTypes) {
		Assert.notEmpty(mediaTypes, "No 'Accept' media types");
		this.headers.set("Accept", MediaType.toString(Arrays.asList(mediaTypes)));
		return this;
	}

247 248 249 250 251 252 253 254 255 256 257 258 259 260
	/**
	 * Set the 'Accept' header to the given media type(s).
	 * @param mediaTypes one or more media types
	 */
	public MockHttpServletRequestBuilder accept(String... mediaTypes) {
		Assert.notEmpty(mediaTypes, "No 'Accept' media types");
		List<MediaType> result = new ArrayList<MediaType>(mediaTypes.length);
		for (String mediaType : mediaTypes) {
			result.add(MediaType.parseMediaType(mediaType));
		}
		this.headers.set("Accept", MediaType.toString(result));
		return this;
	}

R
Rob Winch 已提交
261 262 263 264
	/**
	 * Set the request body.
	 * @param content the body content
	 */
R
Rossen Stoyanchev 已提交
265
	public MockHttpServletRequestBuilder content(byte[] content) {
R
Rob Winch 已提交
266 267 268 269
		this.content = content;
		return this;
	}

270 271 272 273 274 275 276 277 278 279 280 281 282 283
	/**
	 * Set the request body as a UTF-8 String.
	 * @param content the body content
	 */
	public MockHttpServletRequestBuilder content(String content) {
		try {
			this.content = content.getBytes("UTF-8");
		}
		catch (UnsupportedEncodingException e) {
			// should never happen
		}
		return this;
	}

R
Rob Winch 已提交
284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318
	/**
	 * Add the given cookies to the request. Cookies are always added.
	 * @param cookies the cookies to add
	 */
	public MockHttpServletRequestBuilder cookie(Cookie... cookies) {
		Assert.notNull(cookies, "'cookies' must not be null");
		Assert.notEmpty(cookies, "'cookies' must not be empty");
		this.cookies.addAll(Arrays.asList(cookies));
		return this;
	}

	/**
	 * Set the locale of the request.
	 * @param locale the locale
	 */
	public MockHttpServletRequestBuilder locale(Locale locale) {
		this.locale = locale;
		return this;
	}

	/**
	 * Set the character encoding of the request.
	 * @param encoding the character encoding
	 */
	public MockHttpServletRequestBuilder characterEncoding(String encoding) {
		this.characterEncoding = encoding;
		return this;
	}

	/**
	 * Set a request attribute.
	 * @param name the attribute name
	 * @param value the attribute value
	 */
	public MockHttpServletRequestBuilder requestAttr(String name, Object value) {
J
Juergen Hoeller 已提交
319
		addToMap(this.attributes, name, value);
R
Rob Winch 已提交
320 321 322 323 324 325 326 327 328
		return this;
	}

	/**
	 * Set a session attribute.
	 * @param name the session attribute name
	 * @param value the session attribute value
	 */
	public MockHttpServletRequestBuilder sessionAttr(String name, Object value) {
J
Juergen Hoeller 已提交
329
		addToMap(this.sessionAttributes, name, value);
R
Rob Winch 已提交
330 331 332 333 334 335 336 337
		return this;
	}

	/**
	 * Set session attributes.
	 * @param sessionAttributes the session attributes
	 */
	public MockHttpServletRequestBuilder sessionAttrs(Map<String, Object> sessionAttributes) {
S
Sam Brannen 已提交
338
		Assert.notEmpty(sessionAttributes, "'sessionAttributes' must not be empty");
R
Rob Winch 已提交
339 340 341 342 343 344 345 346 347 348 349 350
		for (String name : sessionAttributes.keySet()) {
			sessionAttr(name, sessionAttributes.get(name));
		}
		return this;
	}

	/**
	 * Set an "input" flash attribute.
	 * @param name the flash attribute name
	 * @param value the flash attribute value
	 */
	public MockHttpServletRequestBuilder flashAttr(String name, Object value) {
J
Juergen Hoeller 已提交
351
		addToMap(this.flashAttributes, name, value);
R
Rob Winch 已提交
352 353 354 355 356 357 358 359
		return this;
	}

	/**
	 * Set flash attributes.
	 * @param flashAttributes the flash attributes
	 */
	public MockHttpServletRequestBuilder flashAttrs(Map<String, Object> flashAttributes) {
S
Sam Brannen 已提交
360
		Assert.notEmpty(flashAttributes, "'flashAttributes' must not be empty");
R
Rob Winch 已提交
361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390
		for (String name : flashAttributes.keySet()) {
			flashAttr(name, flashAttributes.get(name));
		}
		return this;
	}

	/**
	 * Set the HTTP session to use, possibly re-used across requests.
	 * <p>Individual attributes provided via {@link #sessionAttr(String, Object)}
	 * override the content of the session provided here.
	 * @param session the HTTP session
	 */
	public MockHttpServletRequestBuilder session(MockHttpSession session) {
		Assert.notNull(session, "'session' must not be null");
		this.session = session;
		return this;
	}

	/**
	 * Set the principal of the request.
	 * @param principal the principal
	 */
	public MockHttpServletRequestBuilder principal(Principal principal) {
		Assert.notNull(principal, "'principal' must not be null");
		this.principal = principal;
		return this;
	}

	/**
	 * Specify the portion of the requestURI that represents the context path.
J
Juergen Hoeller 已提交
391
	 * The context path, if specified, must match to the start of the request URI.
R
Rob Winch 已提交
392 393 394 395
	 * <p>In most cases, tests can be written by omitting the context path from
	 * the requestURI. This is because most applications don't actually depend
	 * on the name under which they're deployed. If specified here, the context
	 * path must start with a "/" and must not end with a "/".
J
Juergen Hoeller 已提交
396
	 * @see <a href="http://docs.oracle.com/javaee/6/api/javax/servlet/http/HttpServletRequest.html#getContextPath%28%29">HttpServletRequest.getContextPath()</a>
R
Rob Winch 已提交
397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417
	 */
	public MockHttpServletRequestBuilder contextPath(String contextPath) {
		if (StringUtils.hasText(contextPath)) {
			Assert.isTrue(contextPath.startsWith("/"), "Context path must start with a '/'");
			Assert.isTrue(!contextPath.endsWith("/"), "Context path must not end with a '/'");
		}
		this.contextPath = (contextPath != null) ? contextPath : "";
		return this;
	}

	/**
	 * Specify the portion of the requestURI that represents the path to which
	 * the Servlet is mapped. This is typically a portion of the requestURI
	 * after the context path.
	 * <p>In most cases, tests can be written by omitting the servlet path from
	 * the requestURI. This is because most applications don't actually depend
	 * on the prefix to which a servlet is mapped. For example if a Servlet is
	 * mapped to {@code "/main/*"}, tests can be written with the requestURI
	 * {@code "/accounts/1"} as opposed to {@code "/main/accounts/1"}.
	 * If specified here, the servletPath must start with a "/" and must not
	 * end with a "/".
J
Juergen Hoeller 已提交
418
	 * @see <a href="http://docs.oracle.com/javaee/6/api/javax/servlet/http/HttpServletRequest.html#getServletPath%28%29">HttpServletRequest.getServletPath()</a>
R
Rob Winch 已提交
419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435
	 */
	public MockHttpServletRequestBuilder servletPath(String servletPath) {
		if (StringUtils.hasText(servletPath)) {
			Assert.isTrue(servletPath.startsWith("/"), "Servlet path must start with a '/'");
			Assert.isTrue(!servletPath.endsWith("/"), "Servlet path must not end with a '/'");
		}
		this.servletPath = (servletPath != null) ? servletPath : "";
		return this;
	}

	/**
	 * Specify the portion of the requestURI that represents the pathInfo.
	 * <p>If left unspecified (recommended), the pathInfo will be automatically
	 * derived by removing the contextPath and the servletPath from the
	 * requestURI and using any remaining part. If specified here, the pathInfo
	 * must start with a "/".
	 * <p>If specified, the pathInfo will be used as is.
J
Juergen Hoeller 已提交
436
	 * @see <a href="http://docs.oracle.com/javaee/6/api/javax/servlet/http/HttpServletRequest.html#getPathInfo%28%29">HttpServletRequest.getServletPath()</a>
R
Rob Winch 已提交
437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462
	 */
	public MockHttpServletRequestBuilder pathInfo(String pathInfo) {
		if (StringUtils.hasText(pathInfo)) {
			Assert.isTrue(pathInfo.startsWith("/"), "pathInfo must start with a '/'");
		}
		this.pathInfo = pathInfo;
		return this;
	}

	/**
	 * Set the secure property of the {@link ServletRequest} indicating use of a
	 * secure channel, such as HTTPS.
	 * @param secure whether the request is using a secure channel
	 */
	public MockHttpServletRequestBuilder secure(boolean secure){
		this.secure = secure;
		return this;
	}

	/**
	 * An extension point for further initialization of {@link MockHttpServletRequest}
	 * in ways not built directly into the {@code MockHttpServletRequestBuilder}.
	 * Implementation of this interface can have builder-style methods themselves
	 * and be made accessible through static factory methods.
	 * @param postProcessor a post-processor to add
	 */
463
	@Override
R
Rob Winch 已提交
464 465 466 467 468 469
	public MockHttpServletRequestBuilder with(RequestPostProcessor postProcessor) {
		Assert.notNull(postProcessor, "postProcessor is required");
		this.postProcessors.add(postProcessor);
		return this;
	}

J
Juergen Hoeller 已提交
470

R
Rob Winch 已提交
471 472 473 474
	/**
	 * {@inheritDoc}
	 * @return always returns {@code true}.
	 */
475
	@Override
R
Rob Winch 已提交
476 477 478 479 480 481 482 483 484 485
	public boolean isMergeEnabled() {
		return true;
	}

	/**
	 * Merges the properties of the "parent" RequestBuilder accepting values
	 * only if not already set in "this" instance.
	 * @param parent the parent {@code RequestBuilder} to inherit properties from
	 * @return the result of the merge
	 */
486
	@Override
R
Rob Winch 已提交
487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526
	public Object merge(Object parent) {
		if (parent == null) {
			return this;
		}
		if (!(parent instanceof MockHttpServletRequestBuilder)) {
			throw new IllegalArgumentException("Cannot merge with [" + parent.getClass().getName() + "]");
		}
		MockHttpServletRequestBuilder parentBuilder = (MockHttpServletRequestBuilder) parent;

		for (String headerName : parentBuilder.headers.keySet()) {
			if (!this.headers.containsKey(headerName)) {
				this.headers.put(headerName, parentBuilder.headers.get(headerName));
			}
		}

		if (this.contentType == null) {
			this.contentType = parentBuilder.contentType;
		}
		if (this.content == null) {
			this.content = parentBuilder.content;
		}

		for (String paramName : parentBuilder.parameters.keySet()) {
			if (!this.parameters.containsKey(paramName)) {
				this.parameters.put(paramName, parentBuilder.parameters.get(paramName));
			}
		}
		for (Cookie cookie : parentBuilder.cookies) {
			if (!containsCookie(cookie)) {
				this.cookies.add(cookie);
			}
		}

		if (this.locale == null) {
			this.locale = parentBuilder.locale;
		}
		if (this.characterEncoding == null) {
			this.characterEncoding = parentBuilder.characterEncoding;
		}

J
Juergen Hoeller 已提交
527 528 529
		if (this.secure == null) {
			this.secure = parentBuilder.secure;
		}
R
Rob Winch 已提交
530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567
		if (this.principal == null) {
			this.principal = parentBuilder.principal;
		}

		for (String attributeName : parentBuilder.attributes.keySet()) {
			if (!this.attributes.containsKey(attributeName)) {
				this.attributes.put(attributeName, parentBuilder.attributes.get(attributeName));
			}
		}

		if (this.session == null) {
			this.session = parentBuilder.session;
		}

		for (String sessionAttributeName : parentBuilder.sessionAttributes.keySet()) {
			if (!this.sessionAttributes.containsKey(sessionAttributeName)) {
				this.sessionAttributes.put(sessionAttributeName, parentBuilder.sessionAttributes.get(sessionAttributeName));
			}
		}

		for (String flashAttributeName : parentBuilder.flashAttributes.keySet()) {
			if (!this.flashAttributes.containsKey(flashAttributeName)) {
				this.flashAttributes.put(flashAttributeName, parentBuilder.flashAttributes.get(flashAttributeName));
			}
		}

		if (!StringUtils.hasText(this.contextPath)) {
			this.contextPath = parentBuilder.contextPath;
		}

		if (!StringUtils.hasText(this.servletPath)) {
			this.servletPath = parentBuilder.servletPath;
		}

		if (ValueConstants.DEFAULT_NONE.equals(this.pathInfo)) {
			this.pathInfo = parentBuilder.pathInfo;
		}

568
		this.postProcessors.addAll(0, parentBuilder.postProcessors);
R
Rob Winch 已提交
569 570 571 572 573

		return this;
	}

	private boolean containsCookie(Cookie cookie) {
J
Juergen Hoeller 已提交
574 575
		for (Cookie cookieToCheck : this.cookies) {
			if (ObjectUtils.nullSafeEquals(cookieToCheck.getName(), cookie.getName())) {
R
Rob Winch 已提交
576 577 578 579 580 581 582 583 584
				return true;
			}
		}
		return false;
	}

	/**
	 * Build a {@link MockHttpServletRequest}.
	 */
585
	@Override
R
Rob Winch 已提交
586 587 588
	public final MockHttpServletRequest buildRequest(ServletContext servletContext) {
		MockHttpServletRequest request = createServletRequest(servletContext);

589
		String requestUri = this.url.getRawPath();
R
Rob Winch 已提交
590 591 592
		request.setRequestURI(requestUri);
		updatePathRequestProperties(request, requestUri);

593 594
		if (this.url.getScheme() != null) {
			request.setScheme(this.url.getScheme());
R
Rob Winch 已提交
595
		}
596 597
		if (this.url.getHost() != null) {
			request.setServerName(this.url.getHost());
R
Rob Winch 已提交
598
		}
599 600
		if (this.url.getPort() != -1) {
			request.setServerPort(this.url.getPort());
R
Rob Winch 已提交
601 602
		}

603
		request.setMethod(this.method);
604

R
Rob Winch 已提交
605 606 607 608 609 610
		for (String name : this.headers.keySet()) {
			for (Object value : this.headers.get(name)) {
				request.addHeader(name, value);
			}
		}

611 612
		if (this.url.getRawQuery() != null) {
			request.setQueryString(this.url.getRawQuery());
R
Rossen Stoyanchev 已提交
613
		}
614
		addRequestParams(request, UriComponentsBuilder.fromUri(this.url).build().getQueryParams());
R
Rob Winch 已提交
615 616 617 618 619 620 621 622 623

		for (String name : this.parameters.keySet()) {
			for (String value : this.parameters.get(name)) {
				request.addParameter(name, value);
			}
		}

		request.setContentType(this.contentType);
		request.setContent(this.content);
624 625
		request.setCharacterEncoding(this.characterEncoding);

626 627 628 629 630 631 632
		if (this.content != null && this.contentType != null) {
			MediaType mediaType = MediaType.parseMediaType(this.contentType);
			if (MediaType.APPLICATION_FORM_URLENCODED.includes(mediaType)) {
				addRequestParams(request, parseFormData(mediaType));
			}
		}

633 634 635
		if (!ObjectUtils.isEmpty(this.cookies)) {
			request.setCookies(this.cookies.toArray(new Cookie[this.cookies.size()]));
		}
R
Rob Winch 已提交
636 637 638 639 640 641 642 643

		if (this.locale != null) {
			request.addPreferredLocale(this.locale);
		}

		if (this.secure != null) {
			request.setSecure(this.secure);
		}
644

J
Juergen Hoeller 已提交
645
		request.setUserPrincipal(this.principal);
R
Rob Winch 已提交
646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664

		for (String name : this.attributes.keySet()) {
			request.setAttribute(name, this.attributes.get(name));
		}

		// Set session before session and flash attributes
		if (this.session != null) {
			request.setSession(this.session);
		}
		for (String name : this.sessionAttributes.keySet()) {
			request.getSession().setAttribute(name, this.sessionAttributes.get(name));
		}

		FlashMap flashMap = new FlashMap();
		flashMap.putAll(this.flashAttributes);

		FlashMapManager flashMapManager = getFlashMapManager(request);
		flashMapManager.saveOutputFlashMap(flashMap, request, new MockHttpServletResponse());

665 666
		request.setAsyncSupported(true);

R
Rob Winch 已提交
667 668 669 670
		return request;
	}

	/**
671 672
	 * Create a new {@link MockHttpServletRequest} based on the supplied
	 * {@code ServletContext}.
673
	 * <p>Can be overridden in subclasses.
R
Rob Winch 已提交
674 675
	 */
	protected MockHttpServletRequest createServletRequest(ServletContext servletContext) {
676
		return new MockHttpServletRequest(servletContext);
R
Rob Winch 已提交
677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695
	}

	/**
	 * Update the contextPath, servletPath, and pathInfo of the request.
	 */
	private void updatePathRequestProperties(MockHttpServletRequest request, String requestUri) {
		Assert.isTrue(requestUri.startsWith(this.contextPath),
				"requestURI [" + requestUri + "] does not start with contextPath [" + this.contextPath + "]");
		request.setContextPath(this.contextPath);
		request.setServletPath(this.servletPath);
		if (ValueConstants.DEFAULT_NONE.equals(this.pathInfo)) {
			Assert.isTrue(requestUri.startsWith(this.contextPath + this.servletPath),
					"Invalid servletPath [" + this.servletPath + "] for requestURI [" + requestUri + "]");
			String extraPath = requestUri.substring(this.contextPath.length() + this.servletPath.length());
			this.pathInfo = (StringUtils.hasText(extraPath)) ? extraPath : null;
		}
		request.setPathInfo(this.pathInfo);
	}

696 697 698 699 700 701 702 703 704 705 706 707 708 709 710
	private void addRequestParams(MockHttpServletRequest request, MultiValueMap<String, String> map) {
		try {
			for (Entry<String, List<String>> entry : map.entrySet()) {
				for (String value : entry.getValue()) {
					value = (value != null) ? UriUtils.decode(value, "UTF-8") : null;
					request.addParameter(UriUtils.decode(entry.getKey(), "UTF-8"), value);
				}
			}
		}
		catch (UnsupportedEncodingException ex) {
			// shouldn't happen
		}
	}

	private MultiValueMap<String, String> parseFormData(final MediaType mediaType) {
S
Sam Brannen 已提交
711 712
		MultiValueMap<String, String> map;
		HttpInputMessage message = new HttpInputMessage() {
713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728
			@Override
			public InputStream getBody() throws IOException {
				return new ByteArrayInputStream(content);
			}

			@Override
			public HttpHeaders getHeaders() {
				HttpHeaders headers = new HttpHeaders();
				headers.setContentType(mediaType);
				return headers;
			}
		};
		try {
			map = new FormHttpMessageConverter().read(null, message);
		}
		catch (IOException ex) {
S
Sam Brannen 已提交
729
			throw new IllegalStateException("Failed to parse form data in request body", ex);
730 731 732 733
		}
		return map;
	}

R
Rob Winch 已提交
734 735 736 737 738 739 740 741
	private FlashMapManager getFlashMapManager(MockHttpServletRequest request) {
		FlashMapManager flashMapManager = null;
		try {
			ServletContext servletContext = request.getServletContext();
			WebApplicationContext wac = WebApplicationContextUtils.getRequiredWebApplicationContext(servletContext);
			flashMapManager = wac.getBean(DispatcherServlet.FLASH_MAP_MANAGER_BEAN_NAME, FlashMapManager.class);
		}
		catch (IllegalStateException ex) {
J
Juergen Hoeller 已提交
742
			// ignore
R
Rob Winch 已提交
743 744
		}
		catch (NoSuchBeanDefinitionException ex) {
J
Juergen Hoeller 已提交
745
			// ignore
R
Rob Winch 已提交
746
		}
J
Juergen Hoeller 已提交
747
		return (flashMapManager != null ? flashMapManager : new SessionFlashMapManager());
R
Rob Winch 已提交
748 749
	}

750 751 752 753 754 755 756 757 758 759 760 761
	@Override
	public MockHttpServletRequest postProcessRequest(MockHttpServletRequest request) {
		for (RequestPostProcessor postProcessor : this.postProcessors) {
			request = postProcessor.postProcessRequest(request);
			if (request == null) {
				throw new IllegalStateException(
						"Post-processor [" + postProcessor.getClass().getName() + "] returned null");
			}
		}
		return request;
	}

J
Juergen Hoeller 已提交
762 763 764 765 766 767 768

	private static void addToMap(Map<String, Object> map, String name, Object value) {
		Assert.hasLength(name, "'name' must not be empty");
		Assert.notNull(value, "'value' must not be null");
		map.put(name, value);
	}

R
Rob Winch 已提交
769 770 771 772 773 774 775 776 777
	private static <T> void addToMultiValueMap(MultiValueMap<String, T> map, String name, T[] values) {
		Assert.hasLength(name, "'name' must not be empty");
		Assert.notEmpty(values, "'values' must not be empty");
		for (T value : values) {
			map.add(name, value);
		}
	}

}