Polishing

Author: jhoeller

spring-test-mvc/src/main/java/org/springframework/test/web/client/MockMvcClientHttpRequestFactory.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2012 the original author or authors.
+ * Copyright 2002-2016 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.
@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 package org.springframework.test.web.client;
 
 import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.request;
@@ -33,6 +34,7 @@
 import org.springframework.test.web.servlet.MockMvc;
 import org.springframework.test.web.servlet.MvcResult;
 import org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder;
+import org.springframework.util.Assert;
 
 /**
  * A {@link ClientHttpRequestFactory} for requests executed via {@link MockMvc}.
@@ -46,29 +48,26 @@ public class MockMvcClientHttpRequestFactory implements ClientHttpRequestFactory
 
 
 	public MockMvcClientHttpRequestFactory(MockMvc mockMvc) {
+		Assert.notNull(mockMvc, "MockMvc must not be null");
 		this.mockMvc = mockMvc;
 	}
 
+
 	public ClientHttpRequest createRequest(final URI uri, final HttpMethod httpMethod) throws IOException {
 		return new MockClientHttpRequest(httpMethod, uri) {
-
 			@Override
 			public ClientHttpResponse executeInternal() throws IOException {
 				try {
 					MockHttpServletRequestBuilder requestBuilder = request(httpMethod, uri.toString());
 					requestBuilder.content(getBodyAsBytes());
 					requestBuilder.headers(getHeaders());
-
 					MvcResult mvcResult = MockMvcClientHttpRequestFactory.this.mockMvc.perform(requestBuilder).andReturn();
-
 					MockHttpServletResponse servletResponse = mvcResult.getResponse();
 					HttpStatus status = HttpStatus.valueOf(servletResponse.getStatus());
 					byte[] body = servletResponse.getContentAsByteArray();
 					HttpHeaders headers = getResponseHeaders(servletResponse);
-
 					MockClientHttpResponse clientResponse = new MockClientHttpResponse(body, status);
 					clientResponse.getHeaders().putAll(headers);
-
 					return clientResponse;
 				}
 				catch (Exception ex) {

spring-test-mvc/src/main/java/org/springframework/test/web/client/RequestMatcher.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2012 the original author or authors.
+ * Copyright 2002-2016 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.
@@ -28,8 +28,7 @@
 public interface RequestMatcher {
 
 	/**
-	 * Match the given request against some expectations.
-	 *
+	 * Match the given request against specific expectations.
 	 * @param request the request to make assertions on
 	 * @throws IOException in case of I/O errors
 	 * @throws AssertionError if expectations are not met

spring-test-mvc/src/main/java/org/springframework/test/web/client/RequestMatcherClientHttpRequest.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2012 the original author or authors.
+ * Copyright 2002-2016 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.
@@ -45,6 +45,7 @@ public RequestMatcherClientHttpRequest(RequestMatcher requestMatcher) {
 		this.requestMatchers.add(requestMatcher);
 	}
 
+
 	public ResponseActions andExpect(RequestMatcher requestMatcher) {
 		Assert.notNull(requestMatcher, "RequestMatcher is required");
 		this.requestMatchers.add(requestMatcher);
@@ -57,22 +58,17 @@ public void andRespond(ResponseCreator responseCreator) {
 	}
 
 	public ClientHttpResponse executeInternal() throws IOException {
-
 		if (this.requestMatchers.isEmpty()) {
 			throw new AssertionError("No request expectations to execute");
 		}
-
 		if (this.responseCreator == null) {
-			throw new AssertionError("No ResponseCreator was set up. Add it after request expectations, "
-					+ "e.g. MockRestServiceServer.expect(requestTo(\"/foo\")).andRespond(withSuccess())");
+			throw new AssertionError("No ResponseCreator was set up. Add it after request expectations, " +
+					"e.g. MockRestServiceServer.expect(requestTo(\"/foo\")).andRespond(withSuccess())");
 		}
-
 		for (RequestMatcher requestMatcher : this.requestMatchers) {
 			requestMatcher.match(this);
 		}
-
 		setResponse(this.responseCreator.createResponse(this));
-
 		return super.executeInternal();
 	}
 

spring-test-mvc/src/main/java/org/springframework/test/web/client/match/ContentRequestMatchers.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2013 the original author or authors.
+ * Copyright 2002-2016 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.
@@ -52,6 +52,7 @@ protected ContentRequestMatchers() {
 		this.xmlHelper = new XmlExpectationsHelper();
 	}
 
+
 	/**
 	 * Assert the request content type as a String.
 	 */
@@ -135,10 +136,8 @@ public void match(ClientHttpRequest request) throws IOException, AssertionError
 	 * Parse the request body and the given String as XML and assert that the
 	 * two are "similar" - i.e. they contain the same elements and attributes
 	 * regardless of order.
-	 *
 	 * <p>Use of this matcher assumes the
 	 * <a href="http://xmlunit.sourceforge.net/">XMLUnit<a/> library is available.
-	 *
 	 * @param expectedXmlContent the expected XML content
 	 */
 	public RequestMatcher xml(final String expectedXmlContent) {
@@ -175,6 +174,7 @@ protected void matchInternal(MockClientHttpRequest request) throws Exception {
 		};
 	}
 
+
 	/**
 	 * Abstract base class for XML {@link RequestMatcher}'s.
 	 */
@@ -191,6 +191,6 @@ public final void match(ClientHttpRequest request) throws IOException, Assertion
 		}
 
 		protected abstract void matchInternal(MockClientHttpRequest request) throws Exception;
-
 	}
+
 }

spring-test-mvc/src/main/java/org/springframework/test/web/client/match/JsonPathRequestMatchers.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2012 the original author or authors.
+ * Copyright 2002-2016 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.
@@ -25,8 +25,8 @@
 import org.springframework.test.web.client.RequestMatcher;
 
 /**
- * Factory methods for request content {@code RequestMatcher}'s using a <a
- * href="http://goessner.net/articles/JsonPath/">JSONPath</a> expression.
+ * Factory methods for request content {@code RequestMatcher}'s using a
+ * <a href="http://goessner.net/articles/JsonPath/">JSONPath</a> expression.
  * An instance of this class is typically accessed via
  * {@code RequestMatchers.jsonPath(..)}.
  *
@@ -42,7 +42,6 @@ public class JsonPathRequestMatchers {
 	 * Class constructor, not for direct instantiation. Use
 	 * {@link MockRestRequestMatchers#jsonPath(String, Matcher)} or
 	 * {@link MockRestRequestMatchers#jsonPath(String, Object...)}.
-	 *
 	 * @param expression the JSONPath expression
 	 * @param args arguments to parameterize the JSONPath expression with using
 	 * the formatting specifiers defined in
@@ -123,12 +122,12 @@ public final void match(ClientHttpRequest request) throws IOException, Assertion
 				MockClientHttpRequest mockRequest = (MockClientHttpRequest) request;
 				matchInternal(mockRequest);
 			}
-			catch (ParseException e) {
-				throw new AssertionError("Failed to parse JSON request content: " + e.getMessage());
+			catch (ParseException ex) {
+				throw new AssertionError("Failed to parse JSON request content: " + ex.getMessage());
 			}
 		}
 
 		protected abstract void matchInternal(MockClientHttpRequest request) throws IOException, ParseException;
-
 	}
+
 }

spring-test-mvc/src/main/java/org/springframework/test/web/client/match/MockRestRequestMatchers.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2012 the original author or authors.
+ * Copyright 2002-2016 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.
@@ -47,13 +47,6 @@
  */
 public abstract class MockRestRequestMatchers {
 
-
-	/**
-	 * Private class constructor.
-	 */
-	private MockRestRequestMatchers() {
-	}
-
 	/**
 	 * Match to any request.
 	 */
@@ -66,7 +59,6 @@ public void match(ClientHttpRequest request) throws AssertionError {
 
 	/**
 	 * Assert the request URI string with the given matcher.
-	 *
 	 * @param matcher String matcher for the expected URI
 	 * @return the request matcher
 	 */
@@ -81,7 +73,6 @@ public void match(ClientHttpRequest request) throws IOException, AssertionError
 
 	/**
 	 * Assert the request URI string.
-	 *
 	 * @param expectedUri the expected URI
 	 * @return the request matcher
 	 */
@@ -96,7 +87,6 @@ public void match(ClientHttpRequest request) throws IOException, AssertionError
 
 	/**
 	 * Assert the {@link HttpMethod} of the request.
-	 *
 	 * @param method the HTTP method
 	 * @return the request matcher
 	 */
@@ -111,7 +101,6 @@ public void match(ClientHttpRequest request) throws AssertionError {
 
 	/**
 	 * Expect a request to the given URI.
-	 *
 	 * @param uri the expected URI
 	 * @return the request matcher
 	 */
@@ -156,8 +145,8 @@ public void match(ClientHttpRequest request) {
 	private static void assertHeaderValueCount(final String name, HttpHeaders headers, int expectedCount) {
 		List<String> actualValues = headers.get(name);
 		AssertionErrors.assertTrue("Expected header <" + name + ">", actualValues != null);
-		AssertionErrors.assertTrue("Expected header <" + name + "> to have at least <" + expectedCount
-				+ "> values but found " + actualValues, expectedCount <= actualValues.size());
+		AssertionErrors.assertTrue("Expected header <" + name + "> to have at least <" + expectedCount +
+				"> values but found " + actualValues, expectedCount <= actualValues.size());
 	}
 
 	/**
@@ -168,12 +157,11 @@ public static ContentRequestMatchers content() {
 	}
 
 	/**
-	 * Access to request body matchers using a <a
-	 * href="http://goessner.net/articles/JsonPath/">JSONPath</a> expression to
+	 * Access to request body matchers using a
+	 * <a href="http://goessner.net/articles/JsonPath/">JSONPath</a> expression to
 	 * inspect a specific subset of the body. The JSON path expression can be a
 	 * parameterized string using formatting specifiers as defined in
 	 * {@link String#format(String, Object...)}.
-	 *
 	 * @param expression the JSON path optionally parameterized with arguments
 	 * @param args arguments to parameterize the JSON path expression with
 	 */
@@ -182,11 +170,10 @@ public static JsonPathRequestMatchers jsonPath(String expression, Object ... arg
 	}
 
 	/**
-	 * Access to request body matchers using a <a
-	 * href="http://goessner.net/articles/JsonPath/">JSONPath</a> expression to
+	 * Access to request body matchers using a
+	 * <a href="http://goessner.net/articles/JsonPath/">JSONPath</a> expression to
 	 * inspect a specific subset of the body and a Hamcrest match for asserting
 	 * the value found at the JSON path.
-	 *
 	 * @param expression the JSON path expression
 	 * @param matcher a matcher for the value expected at the JSON path
 	 */
@@ -199,7 +186,6 @@ public static <T> RequestMatcher jsonPath(String expression, Matcher<T> matcher)
 	 * subset of the body. The XPath expression can be a parameterized string
 	 * using formatting specifiers as defined in
 	 * {@link String#format(String, Object...)}.
-	 *
 	 * @param expression the XPath optionally parameterized with arguments
 	 * @param args arguments to parameterize the XPath expression with
 	 */
@@ -212,7 +198,6 @@ public static XpathRequestMatchers xpath(String expression, Object... args) thro
 	 * subset of the body. The XPath expression can be a parameterized string
 	 * using formatting specifiers as defined in
 	 * {@link String#format(String, Object...)}.
-	 *
 	 * @param expression the XPath optionally parameterized with arguments
 	 * @param namespaces namespaces referenced in the XPath expression
 	 * @param args arguments to parameterize the XPath expression with

spring-test-mvc/src/main/java/org/springframework/test/web/client/match/XpathRequestMatchers.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2012 the original author or authors.
+ * Copyright 2002-2016 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.
@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 package org.springframework.test.web.client.match;
 
 import java.io.IOException;
@@ -44,12 +45,10 @@ public class XpathRequestMatchers {
 	 * Class constructor, not for direct instantiation. Use
 	 * {@link MockRestRequestMatchers#xpath(String, Object...)} or
 	 * {@link MockRestRequestMatchers#xpath(String, Map, Object...)}.
-	 *
 	 * @param expression the XPath expression
 	 * @param namespaces XML namespaces referenced in the XPath expression, or {@code null}
 	 * @param args arguments to parameterize the XPath expression with using the
 	 * formatting specifiers defined in {@link String#format(String, Object...)}
-	 *
 	 * @throws XPathExpressionException
 	 */
 	protected XpathRequestMatchers(String expression, Map<String, String> namespaces, Object ... args)
@@ -58,6 +57,7 @@ protected XpathRequestMatchers(String expression, Map<String, String> namespaces
 		this.xpathHelper = new XpathExpectationsHelper(expression, namespaces, args);
 	}
 
+
 	/**
 	 * Apply the XPath and assert it with the given {@code Matcher<Node>}.
 	 */