WebTestClient polish and minor refactoring

Author: rstoyanchev

spring-test/src/main/java/org/springframework/test/web/reactive/server/DefaultWebTestClient.java

@@ -24,6 +24,7 @@
 import org.springframework.http.HttpHeaders;
 import org.springframework.http.HttpMethod;
 import org.springframework.http.HttpStatus;
+import org.springframework.http.client.reactive.ClientHttpRequest;
 import org.springframework.web.reactive.function.client.ClientResponse;
 
 import static org.springframework.web.reactive.function.BodyExtractors.toDataBuffers;
@@ -111,19 +112,16 @@ public T getResponseBody() {
 
 
 	/**
-	 * Create an instance from a ClientResponse (body not yet consumed).
+	 * Create from ClientHttpRequest and ClientResponse (body not yet consumed).
 	 */
-	static ExchangeResult<Flux<DataBuffer>> fromResponse(HttpMethod method, URI url,
-			HttpHeaders requestHeaders, ClientResponse response) {
-
-		HttpStatus status = response.statusCode();
-		HttpHeaders responseHeaders = response.headers().asHttpHeaders();
-		Flux<DataBuffer> body = response.body(toDataBuffers());
-		return new ExchangeResult<>(method, url, requestHeaders, status, responseHeaders, body);
+	static ExchangeResult<Flux<DataBuffer>> create(ClientHttpRequest request, ClientResponse response) {
+		return new ExchangeResult<>(request.getMethod(), request.getURI(), request.getHeaders(),
+				response.statusCode(), response.headers().asHttpHeaders(),
+				response.body(toDataBuffers()));
 	}
 
 	/**
-	 * Re-create the result with a generic type matching the decoded body.
+	 * Re-create with decoded body (possibly still not consumed).
 	 */
 	static <T> ExchangeResult<T> withDecodedBody(ExchangeResult<?> result, T body) {
 		return new ExchangeResult<>(result.getMethod(), result.getUrl(), result.getRequestHeaders(),

spring-test/src/main/java/org/springframework/test/web/reactive/server/ExchangeResult.java

@@ -29,74 +29,108 @@
 import static org.springframework.test.util.AssertionErrors.assertTrue;
 
 /**
- * Provides methods for HTTP header assertions.
+ * Assertions on headers of the response.
  *
  * @author Rossen Stoyanchev
  * @since 5.0
- * @see ResponseAssertions#header()
+ * @see WebTestClient.ResponseSpec#expectHeader()
  */
 public class HeaderAssertions {
 
-	private final HttpHeaders headers;
+	private final ExchangeResult<?> exchangeResult;
 
 	private final WebTestClient.ResponseSpec responseSpec;
 
 
-	public HeaderAssertions(HttpHeaders headers, WebTestClient.ResponseSpec responseSpec) {
-		this.headers = headers;
+	HeaderAssertions(ExchangeResult<?> exchangeResult, WebTestClient.ResponseSpec responseSpec) {
+		this.exchangeResult = exchangeResult;
 		this.responseSpec = responseSpec;
 	}
 
 
+	/**
+	 * Expect a header with the given name to match the specified values.
+	 */
 	public WebTestClient.ResponseSpec valueEquals(String headerName, String... values) {
-		List<String> actual = this.headers.get(headerName);
+		List<String> actual = getHeaders().get(headerName);
 		assertEquals("Response header [" + headerName + "]", Arrays.asList(values), actual);
 		return this.responseSpec;
 	}
 
+	/**
+	 * Expect a header with the given name whose first value matches the
+	 * provided regex pattern.
+	 * @param headerName the header name
+	 * @param pattern String pattern to pass to {@link Pattern#compile(String)}
+	 */
 	public WebTestClient.ResponseSpec valueMatches(String headerName, String pattern) {
-		List<String> values = this.headers.get(headerName);
+		List<String> values = getHeaders().get(headerName);
 		String value = CollectionUtils.isEmpty(values) ? "" : values.get(0);
 		boolean match = Pattern.compile(pattern).matcher(value).matches();
 		String message = "Response header " + headerName + "=\'" + value + "\' does not match " + pattern;
 		assertTrue(message, match);
 		return this.responseSpec;
 	}
 
-	public WebTestClient.ResponseSpec cacheControlEquals(CacheControl cacheControl) {
-		String actual = this.headers.getCacheControl();
+	/**
+	 * Expect a "Cache-Control" header with the given value.
+	 */
+	public WebTestClient.ResponseSpec cacheControl(CacheControl cacheControl) {
+		String actual = getHeaders().getCacheControl();
 		assertEquals("Response header Cache-Control", cacheControl.getHeaderValue(), actual);
 		return this.responseSpec;
 	}
 
-	public WebTestClient.ResponseSpec contentDispositionEquals(ContentDisposition contentDisposition) {
-		ContentDisposition actual = this.headers.getContentDisposition();
+	/**
+	 * Expect a "Content-Disposition" header with the given value.
+	 */
+	public WebTestClient.ResponseSpec contentDisposition(ContentDisposition contentDisposition) {
+		ContentDisposition actual = getHeaders().getContentDisposition();
 		assertEquals("Response header Content-Disposition", contentDisposition, actual);
 		return this.responseSpec;
 	}
 
-	public WebTestClient.ResponseSpec contentLengthEquals(long contentLength) {
-		long actual = this.headers.getContentLength();
+	/**
+	 * Expect a "Content-Length" header with the given value.
+	 */
+	public WebTestClient.ResponseSpec contentLength(long contentLength) {
+		long actual = getHeaders().getContentLength();
 		assertEquals("Response header Content-Length", contentLength, actual);
 		return this.responseSpec;
 	}
 
-	public WebTestClient.ResponseSpec contentTypeEquals(MediaType mediaType) {
-		MediaType actual = this.headers.getContentType();
+	/**
+	 * Expect a "Content-Type" header with the given value.
+	 */
+	public WebTestClient.ResponseSpec contentType(MediaType mediaType) {
+		MediaType actual = getHeaders().getContentType();
 		assertEquals("Response header Content-Type", mediaType, actual);
 		return this.responseSpec;
 	}
 
-	public WebTestClient.ResponseSpec expiresEquals(int expires) {
-		long actual = this.headers.getExpires();
+	/**
+	 * Expect an "Expires" header with the given value.
+	 */
+	public WebTestClient.ResponseSpec expires(int expires) {
+		long actual = getHeaders().getExpires();
 		assertEquals("Response header Expires", expires, actual);
 		return this.responseSpec;
 	}
 
-	public WebTestClient.ResponseSpec lastModifiedEquals(int lastModified) {
-		long actual = this.headers.getLastModified();
+	/**
+	 * Expect a "Last-Modified" header with the given value.
+	 */
+	public WebTestClient.ResponseSpec lastModified(int lastModified) {
+		long actual = getHeaders().getLastModified();
 		assertEquals("Response header Last-Modified", lastModified, actual);
 		return this.responseSpec;
 	}
 
+
+	// Private methods
+
+	private HttpHeaders getHeaders() {
+		return this.exchangeResult.getResponseHeaders();
+	}
+
 }

spring-test/src/main/java/org/springframework/test/web/reactive/server/HeaderAssertions.java

@@ -20,22 +20,22 @@
 import static org.springframework.test.util.AssertionErrors.assertEquals;
 
 /**
- * Assertions on the status of a response.
+ * Assertions on the response status.
  *
  * @author Rossen Stoyanchev
  * @since 5.0
- * @see ResponseAssertions#status()
+ * @see WebTestClient.ResponseSpec#expectStatus()
  */
 @SuppressWarnings("unused")
 public class StatusAssertions {
 
-	private final HttpStatus httpStatus;
+	private final ExchangeResult<?> exchangeResult;
 
 	private final WebTestClient.ResponseSpec responseSpec;
 
 
-	StatusAssertions(HttpStatus status, WebTestClient.ResponseSpec responseSpec) {
-		this.httpStatus = status;
+	StatusAssertions(ExchangeResult<?> exchangeResult, WebTestClient.ResponseSpec responseSpec) {
+		this.exchangeResult = exchangeResult;
 		this.responseSpec = responseSpec;
 	}
 
@@ -44,157 +44,172 @@ public class StatusAssertions {
 	 * Assert the response status as an {@link HttpStatus}.
 	 */
 	public WebTestClient.ResponseSpec isEqualTo(HttpStatus status) {
-		assertEquals("Response status", status, this.httpStatus);
+		assertEquals("Response status", status, getStatus());
 		return this.responseSpec;
 	}
 
 	/**
 	 * Assert the response status as an integer.
 	 */
 	public WebTestClient.ResponseSpec isEqualTo(int status) {
-		assertEquals("Response status", status, this.httpStatus.value());
+		assertEquals("Response status", status, getStatus().value());
 		return this.responseSpec;
 	}
 
 	/**
 	 * Assert the response status code is {@code HttpStatus.OK} (200).
 	 */
 	public WebTestClient.ResponseSpec isOk() {
-		assertEquals("Status", HttpStatus.OK, this.httpStatus);
+		assertEquals("Status", HttpStatus.OK, getStatus());
 		return this.responseSpec;
 	}
 
 	/**
 	 * Assert the response status code is {@code HttpStatus.CREATED} (201).
 	 */
 	public WebTestClient.ResponseSpec isCreated() {
-		assertEquals("Status", HttpStatus.CREATED, this.httpStatus);
+		assertEquals("Status", HttpStatus.CREATED, getStatus());
 		return this.responseSpec;
 	}
 
 	/**
 	 * Assert the response status code is {@code HttpStatus.ACCEPTED} (202).
 	 */
 	public WebTestClient.ResponseSpec isAccepted() {
-		assertEquals("Status", HttpStatus.ACCEPTED, this.httpStatus);
+		assertEquals("Status", HttpStatus.ACCEPTED, getStatus());
 		return this.responseSpec;
 	}
 
 	/**
 	 * Assert the response status code is {@code HttpStatus.NO_CONTENT} (204).
 	 */
 	public WebTestClient.ResponseSpec isNoContent() {
-		assertEquals("Status", HttpStatus.NO_CONTENT, this.httpStatus);
+		assertEquals("Status", HttpStatus.NO_CONTENT, getStatus());
 		return this.responseSpec;
 	}
 
 	/**
 	 * Assert the response status code is {@code HttpStatus.FOUND} (302).
 	 */
 	public WebTestClient.ResponseSpec isFound() {
-		assertEquals("Status", HttpStatus.FOUND, this.httpStatus);
+		assertEquals("Status", HttpStatus.FOUND, getStatus());
 		return this.responseSpec;
 	}
 
 	/**
 	 * Assert the response status code is {@code HttpStatus.SEE_OTHER} (303).
 	 */
 	public WebTestClient.ResponseSpec isSeeOther() {
-		assertEquals("Status", HttpStatus.SEE_OTHER, this.httpStatus);
+		assertEquals("Status", HttpStatus.SEE_OTHER, getStatus());
 		return this.responseSpec;
 	}
 
 	/**
 	 * Assert the response status code is {@code HttpStatus.NOT_MODIFIED} (304).
 	 */
 	public WebTestClient.ResponseSpec isNotModified() {
-		assertEquals("Status", HttpStatus.NOT_MODIFIED, this.httpStatus);
+		assertEquals("Status", HttpStatus.NOT_MODIFIED, getStatus());
 		return this.responseSpec;
 	}
 
 	/**
 	 * Assert the response status code is {@code HttpStatus.TEMPORARY_REDIRECT} (307).
 	 */
 	public WebTestClient.ResponseSpec isTemporaryRedirect() {
-		assertEquals("Status", HttpStatus.TEMPORARY_REDIRECT, this.httpStatus);
+		assertEquals("Status", HttpStatus.TEMPORARY_REDIRECT, getStatus());
 		return this.responseSpec;
 	}
 
 	/**
 	 * Assert the response status code is {@code HttpStatus.PERMANENT_REDIRECT} (308).
 	 */
 	public WebTestClient.ResponseSpec isPermanentRedirect() {
-		assertEquals("Status", HttpStatus.PERMANENT_REDIRECT, this.httpStatus);
+		assertEquals("Status", HttpStatus.PERMANENT_REDIRECT, getStatus());
 		return this.responseSpec;
 	}
 
 	/**
 	 * Assert the response status code is {@code HttpStatus.BAD_REQUEST} (400).
 	 */
 	public WebTestClient.ResponseSpec isBadRequest() {
-		assertEquals("Status", HttpStatus.BAD_REQUEST, this.httpStatus);
+		assertEquals("Status", HttpStatus.BAD_REQUEST, getStatus());
+		return this.responseSpec;
+	}
+
+	/**
+	 * Assert the response status code is {@code HttpStatus.UNAUTHORIZED} (401).
+	 */
+	public WebTestClient.ResponseSpec isUnauthorized() {
+		assertEquals("Status", HttpStatus.UNAUTHORIZED, getStatus());
 		return this.responseSpec;
 	}
 
 	/**
 	 * Assert the response status code is {@code HttpStatus.NOT_FOUND} (404).
 	 */
 	public WebTestClient.ResponseSpec isNotFound() {
-		assertEquals("Status", HttpStatus.NOT_FOUND, this.httpStatus);
+		assertEquals("Status", HttpStatus.NOT_FOUND, getStatus());
 		return this.responseSpec;
 	}
 
 	/**
 	 * Assert the response error message.
 	 */
 	public WebTestClient.ResponseSpec reasonEquals(String reason) {
-		assertEquals("Response status reason", reason, this.httpStatus.getReasonPhrase());
+		assertEquals("Response status reason", reason, getStatus().getReasonPhrase());
 		return this.responseSpec;
 	}
 
 	/**
 	 * Assert the response status code is in the 1xx range.
 	 */
 	public WebTestClient.ResponseSpec is1xxInformational() {
-		String message = "Range for response status value " + this.httpStatus;
-		assertEquals(message, HttpStatus.Series.INFORMATIONAL, this.httpStatus.series());
+		String message = "Range for response status value " + getStatus();
+		assertEquals(message, HttpStatus.Series.INFORMATIONAL, getStatus().series());
 		return this.responseSpec;
 	}
 
 	/**
 	 * Assert the response status code is in the 2xx range.
 	 */
 	public WebTestClient.ResponseSpec is2xxSuccessful() {
-		String message = "Range for response status value " + this.httpStatus;
-		assertEquals(message, HttpStatus.Series.SUCCESSFUL, this.httpStatus.series());
+		String message = "Range for response status value " + getStatus();
+		assertEquals(message, HttpStatus.Series.SUCCESSFUL, getStatus().series());
 		return this.responseSpec;
 	}
 
 	/**
 	 * Assert the response status code is in the 3xx range.
 	 */
 	public WebTestClient.ResponseSpec is3xxRedirection() {
-		String message = "Range for response status value " + this.httpStatus;
-		assertEquals(message, HttpStatus.Series.REDIRECTION, this.httpStatus.series());
+		String message = "Range for response status value " + getStatus();
+		assertEquals(message, HttpStatus.Series.REDIRECTION, getStatus().series());
 		return this.responseSpec;
 	}
 
 	/**
 	 * Assert the response status code is in the 4xx range.
 	 */
 	public WebTestClient.ResponseSpec is4xxClientError() {
-		String message = "Range for response status value " + this.httpStatus;
-		assertEquals(message, HttpStatus.Series.CLIENT_ERROR, this.httpStatus.series());
+		String message = "Range for response status value " + getStatus();
+		assertEquals(message, HttpStatus.Series.CLIENT_ERROR, getStatus().series());
 		return this.responseSpec;
 	}
 
 	/**
 	 * Assert the response status code is in the 5xx range.
 	 */
 	public WebTestClient.ResponseSpec is5xxServerError() {
-		String message = "Range for response status value " + this.httpStatus;
-		assertEquals(message, HttpStatus.Series.SERVER_ERROR, this.httpStatus.series());
+		String message = "Range for response status value " + getStatus();
+		assertEquals(message, HttpStatus.Series.SERVER_ERROR, getStatus().series());
 		return this.responseSpec;
 	}
 
+
+	// Private methods
+
+	private HttpStatus getStatus() {
+		return this.exchangeResult.getStatus();
+	}
+
 }