Allow responses with non-standard status codes to be documented

Fixes gh-639

Author: wilkinsona

spring-restdocs-core/src/main/java/org/springframework/restdocs/operation/OperationResponse.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2014-2015 the original author or authors.
+ * Copyright 2014-2019 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.
@@ -30,10 +30,18 @@ public interface OperationResponse {
 
 	/**
 	 * Returns the status of the response.
-	 * @return the status
+	 * @return the status or {@code null} if the status is unknown to {@link HttpStatus}
 	 */
 	HttpStatus getStatus();
 
+	/**
+	 * Returns the status code of the response.
+	 * @return the status code
+	 */
+	default int getStatusCode() {
+		throw new UnsupportedOperationException();
+	}
+
 	/**
 	 * Returns the headers in the response.
 	 * @return the headers

spring-restdocs-core/src/main/java/org/springframework/restdocs/operation/OperationResponseFactory.java

@@ -34,8 +34,14 @@ public class OperationResponseFactory {
 	 * @param headers the request's headers
 	 * @param content the content of the request
 	 * @return the {@code OperationResponse}
+	 * @deprecated since 2.0.4 in favor of {@link #create(int, HttpHeaders, byte[])}
 	 */
+	@Deprecated
 	public OperationResponse create(HttpStatus status, HttpHeaders headers, byte[] content) {
+		return this.create(status.value(), headers, content);
+	}
+
+	public OperationResponse create(int status, HttpHeaders headers, byte[] content) {
 		return new StandardOperationResponse(status, augmentHeaders(headers, content), content);
 	}
 
@@ -49,8 +55,8 @@ public OperationResponse create(HttpStatus status, HttpHeaders headers, byte[] c
 	 * @return the new response with the new content
 	 */
 	public OperationResponse createFrom(OperationResponse original, byte[] newContent) {
-		return new StandardOperationResponse(original.getStatus(), getUpdatedHeaders(original.getHeaders(), newContent),
-				newContent);
+		return new StandardOperationResponse(original.getStatusCode(),
+				getUpdatedHeaders(original.getHeaders(), newContent), newContent);
 	}
 
 	/**
@@ -61,7 +67,7 @@ public OperationResponse createFrom(OperationResponse original, byte[] newConten
 	 * @return the new response with the new headers
 	 */
 	public OperationResponse createFrom(OperationResponse original, HttpHeaders newHeaders) {
-		return new StandardOperationResponse(original.getStatus(), newHeaders, original.getContent());
+		return new StandardOperationResponse(original.getStatusCode(), newHeaders, original.getContent());
 	}
 
 	private HttpHeaders augmentHeaders(HttpHeaders originalHeaders, byte[] content) {

spring-restdocs-core/src/main/java/org/springframework/restdocs/operation/StandardOperationResponse.java

@@ -26,7 +26,7 @@
  */
 class StandardOperationResponse extends AbstractOperationMessage implements OperationResponse {
 
-	private final HttpStatus status;
+	private final int status;
 
 	/**
 	 * Creates a new response with the given {@code status}, {@code headers}, and
@@ -35,13 +35,18 @@ class StandardOperationResponse extends AbstractOperationMessage implements Oper
 	 * @param headers the headers of the response
 	 * @param content the content of the response
 	 */
-	StandardOperationResponse(HttpStatus status, HttpHeaders headers, byte[] content) {
+	StandardOperationResponse(int status, HttpHeaders headers, byte[] content) {
 		super(content, headers);
 		this.status = status;
 	}
 
 	@Override
 	public HttpStatus getStatus() {
+		return HttpStatus.resolve(this.status);
+	}
+
+	@Override
+	public int getStatusCode() {
 		return this.status;
 	}
 

spring-restdocs-core/src/main/java/org/springframework/restdocs/operation/preprocess/UriModifyingOperationPreprocessor.java

@@ -141,7 +141,7 @@ public OperationRequest preprocess(OperationRequest request) {
 
 	@Override
 	public OperationResponse preprocess(OperationResponse response) {
-		return this.contentModifyingDelegate.preprocess(new OperationResponseFactory().create(response.getStatus(),
+		return this.contentModifyingDelegate.preprocess(new OperationResponseFactory().create(response.getStatusCode(),
 				modify(response.getHeaders()), response.getContent()));
 	}
 

spring-restdocs-core/src/test/java/org/springframework/restdocs/RestDocumentationGeneratorTests.java

@@ -69,7 +69,7 @@ public class RestDocumentationGeneratorTests {
 	private final OperationRequest operationRequest = new OperationRequestFactory()
 			.create(URI.create("http://localhost:8080"), null, null, new HttpHeaders(), null, null);
 
-	private final OperationResponse operationResponse = new OperationResponseFactory().create(null, null, null);
+	private final OperationResponse operationResponse = new OperationResponseFactory().create(0, null, null);
 
 	private final Snippet snippet = mock(Snippet.class);
 
@@ -197,7 +197,7 @@ private static OperationRequest createRequest() {
 	}
 
 	private static OperationResponse createResponse() {
-		return new OperationResponseFactory().create(null, null, null);
+		return new OperationResponseFactory().create(0, null, null);
 	}
 
 }

spring-restdocs-core/src/test/java/org/springframework/restdocs/config/RestDocumentationConfigurerTests.java

@@ -217,7 +217,7 @@ public void customDefaultOperationResponsePreprocessor() {
 				.get(RestDocumentationGenerator.ATTRIBUTE_NAME_DEFAULT_OPERATION_RESPONSE_PREPROCESSOR);
 		HttpHeaders headers = new HttpHeaders();
 		headers.add("Foo", "value");
-		OperationResponse response = new OperationResponseFactory().create(HttpStatus.OK, headers, null);
+		OperationResponse response = new OperationResponseFactory().create(HttpStatus.OK.value(), headers, null);
 		assertThat(preprocessor.preprocess(response).getHeaders()).doesNotContainKey("Foo");
 	}
 

spring-restdocs-core/src/test/java/org/springframework/restdocs/hypermedia/ContentTypeLinkExtractorTests.java

@@ -49,7 +49,7 @@ public class ContentTypeLinkExtractorTests {
 	public void extractionFailsWithNullContentType() throws IOException {
 		this.thrown.expect(IllegalStateException.class);
 		new ContentTypeLinkExtractor()
-				.extractLinks(this.responseFactory.create(HttpStatus.OK, new HttpHeaders(), null));
+				.extractLinks(this.responseFactory.create(HttpStatus.OK.value(), new HttpHeaders(), null));
 	}
 
 	@Test
@@ -59,7 +59,7 @@ public void extractorCalledWithMatchingContextType() throws IOException {
 		extractors.put(MediaType.APPLICATION_JSON, extractor);
 		HttpHeaders httpHeaders = new HttpHeaders();
 		httpHeaders.setContentType(MediaType.APPLICATION_JSON);
-		OperationResponse response = this.responseFactory.create(HttpStatus.OK, httpHeaders, null);
+		OperationResponse response = this.responseFactory.create(HttpStatus.OK.value(), httpHeaders, null);
 		new ContentTypeLinkExtractor(extractors).extractLinks(response);
 		verify(extractor).extractLinks(response);
 	}
@@ -71,7 +71,7 @@ public void extractorCalledWithCompatibleContextType() throws IOException {
 		extractors.put(MediaType.APPLICATION_JSON, extractor);
 		HttpHeaders httpHeaders = new HttpHeaders();
 		httpHeaders.setContentType(MediaType.parseMediaType("application/json;foo=bar"));
-		OperationResponse response = this.responseFactory.create(HttpStatus.OK, httpHeaders, null);
+		OperationResponse response = this.responseFactory.create(HttpStatus.OK.value(), httpHeaders, null);
 		new ContentTypeLinkExtractor(extractors).extractLinks(response);
 		verify(extractor).extractLinks(response);
 	}

spring-restdocs-core/src/test/java/org/springframework/restdocs/hypermedia/LinkExtractorsPayloadTests.java

@@ -106,7 +106,7 @@ private void assertLinks(List<Link> expectedLinks, Map<String, List<Link>> actua
 	}
 
 	private OperationResponse createResponse(String contentName) throws IOException {
-		return this.responseFactory.create(HttpStatus.OK, null,
+		return this.responseFactory.create(HttpStatus.OK.value(), null,
 				FileCopyUtils.copyToByteArray(getPayloadFile(contentName)));
 	}
 

spring-restdocs-core/src/test/java/org/springframework/restdocs/operation/preprocess/ContentModifyingOperationPreprocessorTests.java

@@ -67,7 +67,7 @@ public void modifyRequestContent() {
 
 	@Test
 	public void modifyResponseContent() {
-		OperationResponse response = this.responseFactory.create(HttpStatus.OK, new HttpHeaders(),
+		OperationResponse response = this.responseFactory.create(HttpStatus.OK.value(), new HttpHeaders(),
 				"content".getBytes());
 		OperationResponse preprocessed = this.preprocessor.preprocess(response);
 		assertThat(preprocessed.getContent()).isEqualTo("modified".getBytes());

spring-restdocs-core/src/test/java/org/springframework/restdocs/operation/preprocess/HeaderRemovingOperationPreprocessorTests.java

@@ -87,7 +87,7 @@ public void removeAllHeaders() {
 	}
 
 	private OperationResponse createResponse(String... extraHeaders) {
-		return this.responseFactory.create(HttpStatus.OK, getHttpHeaders(extraHeaders), new byte[0]);
+		return this.responseFactory.create(HttpStatus.OK.value(), getHttpHeaders(extraHeaders), new byte[0]);
 	}
 
 	private HttpHeaders getHttpHeaders(String... extraHeaders) {

spring-restdocs-core/src/test/java/org/springframework/restdocs/operation/preprocess/UriModifyingOperationPreprocessorTests.java

@@ -321,13 +321,13 @@ private OperationRequest createRequestWithPartWithContent(String content) {
 	}
 
 	private OperationResponse createResponseWithContent(String content) {
-		return this.responseFactory.create(HttpStatus.OK, new HttpHeaders(), content.getBytes());
+		return this.responseFactory.create(HttpStatus.OK.value(), new HttpHeaders(), content.getBytes());
 	}
 
 	private OperationResponse createResponseWithHeader(String name, String value) {
 		HttpHeaders headers = new HttpHeaders();
 		headers.add(name, value);
-		return this.responseFactory.create(HttpStatus.OK, headers, new byte[0]);
+		return this.responseFactory.create(HttpStatus.OK.value(), headers, new byte[0]);
 	}
 
 }

spring-restdocs-core/src/test/java/org/springframework/restdocs/test/OperationBuilder.java

@@ -261,7 +261,7 @@ public OperationRequestPartBuilder header(String name, String value) {
 	 */
 	public final class OperationResponseBuilder {
 
-		private HttpStatus status = HttpStatus.OK;
+		private int status = HttpStatus.OK.value();
 
 		private HttpHeaders headers = new HttpHeaders();
 
@@ -272,7 +272,7 @@ private OperationResponse buildResponse() {
 		}
 
 		public OperationResponseBuilder status(int status) {
-			this.status = HttpStatus.valueOf(status);
+			this.status = status;
 			return this;
 		}
 

spring-restdocs-mockmvc/src/main/java/org/springframework/restdocs/mockmvc/MockMvcResponseConverter.java

@@ -19,7 +19,6 @@
 import javax.servlet.http.Cookie;
 
 import org.springframework.http.HttpHeaders;
-import org.springframework.http.HttpStatus;
 import org.springframework.mock.web.MockHttpServletResponse;
 import org.springframework.restdocs.operation.OperationResponse;
 import org.springframework.restdocs.operation.OperationResponseFactory;
@@ -36,8 +35,8 @@ class MockMvcResponseConverter implements ResponseConverter<MockHttpServletRespo
 
 	@Override
 	public OperationResponse convert(MockHttpServletResponse mockResponse) {
-		return new OperationResponseFactory().create(HttpStatus.valueOf(mockResponse.getStatus()),
-				extractHeaders(mockResponse), mockResponse.getContentAsByteArray());
+		return new OperationResponseFactory().create(mockResponse.getStatus(), extractHeaders(mockResponse),
+				mockResponse.getContentAsByteArray());
 	}
 
 	private HttpHeaders extractHeaders(MockHttpServletResponse response) {

spring-restdocs-mockmvc/src/test/java/org/springframework/restdocs/mockmvc/MockMvcResponseConverterTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2014-2018 the original author or authors.
+ * Copyright 2014-2019 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.
@@ -61,4 +61,13 @@ public void responseWithCookie() {
 				Collections.singletonList("name=value; Domain=localhost; HttpOnly"));
 	}
 
+	@Test
+	public void responseWithCustomStatus() {
+		MockHttpServletResponse response = new MockHttpServletResponse();
+		response.setStatus(600);
+		OperationResponse operationResponse = this.factory.convert(response);
+		assertThat(operationResponse.getStatus()).isNull();
+		assertThat(operationResponse.getStatusCode()).isEqualTo(600);
+	}
+
 }

spring-restdocs-restassured/src/main/java/org/springframework/restdocs/restassured3/RestAssuredResponseConverter.java

@@ -20,7 +20,6 @@
 import io.restassured.response.Response;
 
 import org.springframework.http.HttpHeaders;
-import org.springframework.http.HttpStatus;
 import org.springframework.restdocs.operation.OperationResponse;
 import org.springframework.restdocs.operation.OperationResponseFactory;
 import org.springframework.restdocs.operation.ResponseConverter;
@@ -35,8 +34,8 @@ class RestAssuredResponseConverter implements ResponseConverter<Response> {
 
 	@Override
 	public OperationResponse convert(Response response) {
-		return new OperationResponseFactory().create(HttpStatus.valueOf(response.getStatusCode()),
-				extractHeaders(response), extractContent(response));
+		return new OperationResponseFactory().create(response.getStatusCode(), extractHeaders(response),
+				extractContent(response));
 	}
 
 	private HttpHeaders extractHeaders(Response response) {

spring-restdocs-restassured/src/test/java/org/springframework/restdocs/restassured3/RestAssuredResponseConverterTests.java

@@ -0,0 +1,52 @@
+/*
+ * Copyright 2014-2019 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
+ *
+ *      https://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.restdocs.restassured3;
+
+import io.restassured.http.Headers;
+import io.restassured.response.Response;
+import io.restassured.response.ResponseBody;
+import org.junit.Test;
+
+import org.springframework.restdocs.operation.OperationResponse;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.mockito.BDDMockito.given;
+import static org.mockito.Mockito.mock;
+
+/**
+ * Tests for {@link RestAssuredResponseConverter}.
+ *
+ * @author Andy Wilkinson
+ */
+public class RestAssuredResponseConverterTests {
+
+	private final RestAssuredResponseConverter converter = new RestAssuredResponseConverter();
+
+	@Test
+	public void responseWithCustomStatus() {
+		Response response = mock(Response.class);
+		given(response.getStatusCode()).willReturn(600);
+		given(response.getHeaders()).willReturn(new Headers());
+		ResponseBody<?> body = mock(ResponseBody.class);
+		given(response.getBody()).willReturn(body);
+		given(body.asByteArray()).willReturn(new byte[0]);
+		OperationResponse operationResponse = this.converter.convert(response);
+		assertThat(operationResponse.getStatus()).isNull();
+		assertThat(operationResponse.getStatusCode()).isEqualTo(600);
+	}
+
+}

spring-restdocs-webtestclient/src/main/java/org/springframework/restdocs/webtestclient/WebTestClientResponseConverter.java

@@ -36,7 +36,7 @@ class WebTestClientResponseConverter implements ResponseConverter<ExchangeResult
 
 	@Override
 	public OperationResponse convert(ExchangeResult result) {
-		return new OperationResponseFactory().create(result.getStatus(), extractHeaders(result),
+		return new OperationResponseFactory().create(result.getStatus().value(), extractHeaders(result),
 				result.getResponseBodyContent());
 	}