/*
* Copyright 2002-2017 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.reactive.server;
import java.net.URI;
import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
import java.time.Duration;
import java.util.Arrays;
import java.util.List;
import java.util.stream.Collectors;
import reactor.core.publisher.MonoProcessor;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpMethod;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseCookie;
import org.springframework.util.Assert;
import org.springframework.util.MultiValueMap;
/**
* Container for request and response details for exchanges performed through
* {@link WebTestClient}.
*
* <p>Note that a decoded response body is not exposed at this level since the
* body may not have been decoded and consumed yet. Sub-types
* {@link EntityExchangeResult} and {@link FluxExchangeResult} provide access
* to a decoded response entity and a decoded (but not consumed) response body
* respectively.
*
* @author Rossen Stoyanchev
* @since 5.0
* @see EntityExchangeResult
* @see FluxExchangeResult
*/
public class ExchangeResult {
private static final List<MediaType> PRINTABLE_MEDIA_TYPES = Arrays.asList(
MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML,
MediaType.parseMediaType("text/*"), MediaType.APPLICATION_FORM_URLENCODED);
private final WiretapClientHttpRequest request;
private final WiretapClientHttpResponse response;
/**
* Constructor used when the {@code ClientHttpResponse} becomes available.
*/
protected ExchangeResult(WiretapClientHttpRequest request, WiretapClientHttpResponse response) {
this.request = request;
this.response = response;
}
/**
* Copy constructor used when the body is decoded or consumed.
*/
protected ExchangeResult(ExchangeResult other) {
this.request = other.request;
this.response = other.response;
}
/**
* Return the method of the request.
*/
public HttpMethod getMethod() {
return this.request.getMethod();
}
/**
* Return the request headers that were sent to the server.
*/
public URI getUrl() {
return this.request.getURI();
}
/**
* Return the request headers sent to the server.
*/
public HttpHeaders getRequestHeaders() {
return this.request.getHeaders();
}
/**
* Return the raw request body content written as a {@code byte[]}.
* @throws IllegalStateException if the request body is not fully written yet.
*/
public byte[] getRequestBodyContent() {
MonoProcessor<byte[]> body = this.request.getRecordedContent();
Assert.isTrue(body.isTerminated(), "Request body incomplete.");
return body.block(Duration.ZERO);
}
/**
* Return the status of the executed request.
*/
public HttpStatus getStatus() {
return this.response.getStatusCode();
}
/**
* Return the response headers received from the server.
*/
public HttpHeaders getResponseHeaders() {
return this.response.getHeaders();
}
/**
* Return response cookies received from the server.
*/
public MultiValueMap<String, ResponseCookie> getResponseCookies() {
return this.response.getCookies();
}
/**
* Return the raw request body content written as a {@code byte[]}.
* @throws IllegalStateException if the response is not fully read yet.
*/
public byte[] getResponseBodyContent() {
MonoProcessor<byte[]> body = this.response.getRecordedContent();
Assert.state(body.isTerminated(), "Response body incomplete.");
return body.block(Duration.ZERO);
}
/**
* Execute the given Runnable, catch any {@link AssertionError}, decorate
* with {@code AssertionError} containing diagnostic information about the
* request and response, and then re-throw.
*/
public void assertWithDiagnostics(Runnable assertion) {
try {
assertion.run();
}
catch (AssertionError ex) {
throw new AssertionError(ex.getMessage() + "\n" + this, ex);
}
}
@Override
public String toString() {
return "\n" +
"> " + getMethod() + " " + getUrl() + "\n" +
"> " + formatHeaders(getRequestHeaders(), "\n> ") + "\n" +
"\n" +
formatBody(getRequestHeaders().getContentType(), this.request.getRecordedContent()) + "\n" +
"\n" +
"< " + getStatus() + " " + getStatusReason() + "\n" +
"< " + formatHeaders(getResponseHeaders(), "\n< ") + "\n" +
"\n" +
formatBody(getResponseHeaders().getContentType(), this.response.getRecordedContent()) +"\n";
}
private String getStatusReason() {
String reason = "";
if (getStatus() != null && getStatus().getReasonPhrase() != null) {
reason = getStatus().getReasonPhrase();
}
return reason;
}
private String formatHeaders(HttpHeaders headers, String delimiter) {
return headers.entrySet().stream()
.map(entry -> entry.getKey() + ": " + entry.getValue())
.collect(Collectors.joining(delimiter));
}
private String formatBody(MediaType contentType, MonoProcessor<byte[]> body) {
if (body.isSuccess()) {
byte[] bytes = body.block(Duration.ZERO);
if (bytes.length == 0) {
return "No content";
}
if (contentType == null) {
return "Unknown content type (" + bytes.length + " bytes)";
}
Charset charset = contentType.getCharset();
if (charset != null) {
return new String(bytes, charset);
}
if (PRINTABLE_MEDIA_TYPES.stream().anyMatch(contentType::isCompatibleWith)) {
return new String(bytes, StandardCharsets.UTF_8);
}
return "Unknown charset (" + bytes.length + " bytes)";
}
else if (body.isError()) {
return "I/O failure: " + body.getError().getMessage();
}
else {
return "Content not available yet";
}
}
}