Use Framework's HttpStatusCode to model response's status

Closes gh-848

Author: wilkinsona

spring-restdocs-core/src/main/java/org/springframework/restdocs/http/HttpResponseSnippet.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2014-2019 the original author or authors.
+ * Copyright 2014-2022 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.
@@ -23,6 +23,7 @@
 import java.util.Map.Entry;
 
 import org.springframework.http.HttpStatus;
+import org.springframework.http.HttpStatusCode;
 import org.springframework.restdocs.operation.Operation;
 import org.springframework.restdocs.operation.OperationResponse;
 import org.springframework.restdocs.snippet.Snippet;
@@ -59,15 +60,9 @@ protected Map<String, Object> createModel(Operation operation) {
 		Map<String, Object> model = new HashMap<>();
 		model.put("responseBody", responseBody(response));
 		model.put("headers", headers(response));
-		HttpStatus status = response.getStatus();
-		if (status != null) {
-			model.put("statusCode", status.value());
-			model.put("statusReason", status.getReasonPhrase());
-		}
-		else {
-			model.put("statusCode", response.getStatusCode());
-			model.put("statusReason", "");
-		}
+		HttpStatusCode status = response.getStatus();
+		model.put("statusCode", status.value());
+		model.put("statusReason", (status instanceof HttpStatus) ? ((HttpStatus) status).getReasonPhrase() : "");
 		return model;
 	}
 

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

@@ -19,7 +19,7 @@
 import java.util.Collection;
 
 import org.springframework.http.HttpHeaders;
-import org.springframework.http.HttpStatus;
+import org.springframework.http.HttpStatusCode;
 
 /**
  * The response that was received as part of performing an operation on a RESTful service.
@@ -33,17 +33,9 @@ public interface OperationResponse {
 
 	/**
 	 * Returns the status of the response.
-	 * @return the status or {@code null} if the status is unknown to {@link HttpStatus}
+	 * @return the status, never {@code null}
 	 */
-	HttpStatus getStatus();
-
-	/**
-	 * Returns the status code of the response.
-	 * @return the status code
-	 */
-	default int getStatusCode() {
-		throw new UnsupportedOperationException();
-	}
+	HttpStatusCode getStatus();
 
 	/**
 	 * Returns the headers in the response.

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

@@ -20,6 +20,7 @@
 import java.util.Collections;
 
 import org.springframework.http.HttpHeaders;
+import org.springframework.http.HttpStatusCode;
 
 /**
  * A factory for creating {@link OperationResponse OperationResponses}.
@@ -37,8 +38,9 @@ public class OperationResponseFactory {
 	 * @param headers the request's headers
 	 * @param content the content of the request
 	 * @return the {@code OperationResponse}
+	 * @since 3.0.0
 	 */
-	public OperationResponse create(int status, HttpHeaders headers, byte[] content) {
+	public OperationResponse create(HttpStatusCode status, HttpHeaders headers, byte[] content) {
 		return new StandardOperationResponse(status, augmentHeaders(headers, content), content,
 				Collections.emptyList());
 	}
@@ -52,9 +54,9 @@ public OperationResponse create(int status, HttpHeaders headers, byte[] content)
 	 * @param content the content of the request
 	 * @param cookies the cookies
 	 * @return the {@code OperationResponse}
-	 * @since 3.0
+	 * @since 3.0.0
 	 */
-	public OperationResponse create(int status, HttpHeaders headers, byte[] content,
+	public OperationResponse create(HttpStatusCode status, HttpHeaders headers, byte[] content,
 			Collection<ResponseCookie> cookies) {
 		return new StandardOperationResponse(status, augmentHeaders(headers, content), content, cookies);
 	}
@@ -69,8 +71,8 @@ public OperationResponse create(int status, HttpHeaders headers, byte[] content,
 	 * @return the new response with the new content
 	 */
 	public OperationResponse createFrom(OperationResponse original, byte[] newContent) {
-		return new StandardOperationResponse(original.getStatusCode(),
-				getUpdatedHeaders(original.getHeaders(), newContent), newContent, original.getCookies());
+		return new StandardOperationResponse(original.getStatus(), getUpdatedHeaders(original.getHeaders(), newContent),
+				newContent, original.getCookies());
 	}
 
 	/**
@@ -81,7 +83,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.getStatusCode(), newHeaders, original.getContent(),
+		return new StandardOperationResponse(original.getStatus(), newHeaders, original.getContent(),
 				original.getCookies());
 	}
 

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

@@ -19,7 +19,7 @@
 import java.util.Collection;
 
 import org.springframework.http.HttpHeaders;
-import org.springframework.http.HttpStatus;
+import org.springframework.http.HttpStatusCode;
 
 /**
  * Standard implementation of {@link OperationResponse}.
@@ -29,7 +29,7 @@
  */
 class StandardOperationResponse extends AbstractOperationMessage implements OperationResponse {
 
-	private final int status;
+	private final HttpStatusCode status;
 
 	private Collection<ResponseCookie> cookies;
 
@@ -41,19 +41,15 @@ class StandardOperationResponse extends AbstractOperationMessage implements Oper
 	 * @param content the content of the response
 	 * @param cookies any cookies included in the response
 	 */
-	StandardOperationResponse(int status, HttpHeaders headers, byte[] content, Collection<ResponseCookie> cookies) {
+	StandardOperationResponse(HttpStatusCode status, HttpHeaders headers, byte[] content,
+			Collection<ResponseCookie> cookies) {
 		super(content, headers);
 		this.status = status;
 		this.cookies = cookies;
 	}
 
 	@Override
-	public HttpStatus getStatus() {
-		return HttpStatus.resolve(this.status);
-	}
-
-	@Override
-	public int getStatusCode() {
+	public HttpStatusCode getStatus() {
 		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.getStatusCode(),
+		return this.contentModifyingDelegate.preprocess(new OperationResponseFactory().create(response.getStatus(),
 				modify(response.getHeaders()), response.getContent(), response.getCookies()));
 	}
 

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2014-2019 the original author or authors.
+ * Copyright 2014-2022 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,6 +28,7 @@
 import org.mockito.Mockito;
 
 import org.springframework.http.HttpHeaders;
+import org.springframework.http.HttpStatus;
 import org.springframework.restdocs.generate.RestDocumentationGenerator;
 import org.springframework.restdocs.operation.Operation;
 import org.springframework.restdocs.operation.OperationRequest;
@@ -69,7 +70,8 @@ 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(0, null, null);
+	private final OperationResponse operationResponse = new OperationResponseFactory().create(HttpStatus.OK, null,
+			null);
 
 	private final Snippet snippet = mock(Snippet.class);
 
@@ -197,7 +199,7 @@ private static OperationRequest createRequest() {
 	}
 
 	private static OperationResponse createResponse() {
-		return new OperationResponseFactory().create(0, null, null);
+		return new OperationResponseFactory().create(HttpStatus.OK, null, null);
 	}
 
 }

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

@@ -223,7 +223,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.value(), headers, null);
+		OperationResponse response = new OperationResponseFactory().create(HttpStatus.OK, headers, null);
 		assertThat(preprocessor.preprocess(response).getHeaders()).doesNotContainKey("Foo");
 	}
 

spring-restdocs-core/src/test/java/org/springframework/restdocs/http/HttpResponseSnippetTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2014-2019 the original author or authors.
+ * Copyright 2014-2022 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.
@@ -22,6 +22,7 @@
 
 import org.springframework.http.HttpHeaders;
 import org.springframework.http.HttpStatus;
+import org.springframework.http.HttpStatusCode;
 import org.springframework.http.MediaType;
 import org.springframework.restdocs.AbstractSnippetTests;
 import org.springframework.restdocs.templates.TemplateEngine;
@@ -55,8 +56,7 @@ public void basicResponse() throws IOException {
 
 	@Test
 	public void nonOkResponse() throws IOException {
-		new HttpResponseSnippet()
-				.document(this.operationBuilder.response().status(HttpStatus.BAD_REQUEST.value()).build());
+		new HttpResponseSnippet().document(this.operationBuilder.response().status(HttpStatus.BAD_REQUEST).build());
 		assertThat(this.generatedSnippets.httpResponse()).is(httpResponse(HttpStatus.BAD_REQUEST));
 	}
 
@@ -99,7 +99,8 @@ public void responseWithCustomSnippetAttributes() throws IOException {
 
 	@Test
 	public void responseWithCustomStatus() throws IOException {
-		new HttpResponseSnippet().document(this.operationBuilder.response().status(215).build());
+		new HttpResponseSnippet()
+				.document(this.operationBuilder.response().status(HttpStatusCode.valueOf(215)).build());
 		assertThat(this.generatedSnippets.httpResponse()).is(httpResponse(215));
 	}
 

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2014-2019 the original author or authors.
+ * Copyright 2014-2022 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.
@@ -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.value(), new HttpHeaders(), null));
+				.extractLinks(this.responseFactory.create(HttpStatus.OK, 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.value(), httpHeaders, null);
+		OperationResponse response = this.responseFactory.create(HttpStatus.OK, 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.value(), httpHeaders, null);
+		OperationResponse response = this.responseFactory.create(HttpStatus.OK, httpHeaders, null);
 		new ContentTypeLinkExtractor(extractors).extractLinks(response);
 		verify(extractor).extractLinks(response);
 	}

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2014-2019 the original author or authors.
+ * Copyright 2014-2022 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.
@@ -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.value(), null,
+		return this.responseFactory.create(HttpStatus.OK, null,
 				FileCopyUtils.copyToByteArray(getPayloadFile(contentName)));
 	}
 

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

@@ -65,7 +65,7 @@ public void modifyRequestContent() {
 
 	@Test
 	public void modifyResponseContent() {
-		OperationResponse response = this.responseFactory.create(HttpStatus.OK.value(), new HttpHeaders(),
+		OperationResponse response = this.responseFactory.create(HttpStatus.OK, 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/HeadersModifyingOperationPreprocessorTests.java

@@ -160,7 +160,7 @@ private OperationResponse createResponse(Consumer<HttpHeaders> headersCustomizer
 		if (headersCustomizer != null) {
 			headersCustomizer.accept(headers);
 		}
-		return new OperationResponseFactory().create(HttpStatus.OK.value(), headers, new byte[0]);
+		return new OperationResponseFactory().create(HttpStatus.OK, headers, new byte[0]);
 	}
 
 }

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

@@ -340,13 +340,13 @@ private OperationRequest createRequestWithPartWithContent(String content) {
 	}
 
 	private OperationResponse createResponseWithContent(String content) {
-		return this.responseFactory.create(HttpStatus.OK.value(), new HttpHeaders(), content.getBytes());
+		return this.responseFactory.create(HttpStatus.OK, 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.value(), headers, new byte[0]);
+		return this.responseFactory.create(HttpStatus.OK, headers, new byte[0]);
 	}
 
 }

spring-restdocs-core/src/testFixtures/java/org/springframework/restdocs/testfixtures/OperationBuilder.java

@@ -31,6 +31,7 @@
 import org.springframework.http.HttpHeaders;
 import org.springframework.http.HttpMethod;
 import org.springframework.http.HttpStatus;
+import org.springframework.http.HttpStatusCode;
 import org.springframework.restdocs.ManualRestDocumentation;
 import org.springframework.restdocs.RestDocumentationContext;
 import org.springframework.restdocs.mustache.Mustache;
@@ -247,7 +248,7 @@ public OperationRequestPartBuilder header(String name, String value) {
 	 */
 	public final class OperationResponseBuilder {
 
-		private int status = HttpStatus.OK.value();
+		private HttpStatusCode status = HttpStatus.OK;
 
 		private HttpHeaders headers = new HttpHeaders();
 
@@ -259,7 +260,7 @@ private OperationResponse buildResponse() {
 			return new OperationResponseFactory().create(this.status, this.headers, this.content, this.cookies);
 		}
 
-		public OperationResponseBuilder status(int status) {
+		public OperationResponseBuilder status(HttpStatusCode status) {
 			this.status = status;
 			return this;
 		}

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

@@ -24,6 +24,7 @@
 import jakarta.servlet.http.Cookie;
 
 import org.springframework.http.HttpHeaders;
+import org.springframework.http.HttpStatusCode;
 import org.springframework.mock.web.MockHttpServletResponse;
 import org.springframework.restdocs.operation.OperationResponse;
 import org.springframework.restdocs.operation.OperationResponseFactory;
@@ -44,7 +45,7 @@ class MockMvcResponseConverter implements ResponseConverter<MockHttpServletRespo
 	public OperationResponse convert(MockHttpServletResponse mockResponse) {
 		HttpHeaders headers = extractHeaders(mockResponse);
 		Collection<ResponseCookie> cookies = extractCookies(mockResponse);
-		return new OperationResponseFactory().create(mockResponse.getStatus(), headers,
+		return new OperationResponseFactory().create(HttpStatusCode.valueOf(mockResponse.getStatus()), headers,
 				mockResponse.getContentAsByteArray(), cookies);
 	}
 

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

@@ -24,6 +24,7 @@
 
 import org.springframework.http.HttpHeaders;
 import org.springframework.http.HttpStatus;
+import org.springframework.http.HttpStatusCode;
 import org.springframework.mock.web.MockHttpServletResponse;
 import org.springframework.restdocs.operation.OperationResponse;
 import org.springframework.restdocs.operation.ResponseCookie;
@@ -69,8 +70,7 @@ 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);
+		assertThat(operationResponse.getStatus()).isEqualTo(HttpStatusCode.valueOf(600));
 	}
 
 }