Use HttpStatusCode interface

This commit contains changes made because of the introduction of
HttpStatusCode. In general, methods that used to return a HttpStatus
now return HttpStatusCode instead, and methods that returned raw status
codes are now deprecated.

See gh-28214

Author: poutsma

spring-test/src/main/java/org/springframework/mock/http/client/MockClientHttpResponse.java

@@ -20,6 +20,7 @@
 import java.io.InputStream;
 
 import org.springframework.http.HttpStatus;
+import org.springframework.http.HttpStatusCode;
 import org.springframework.http.client.ClientHttpResponse;
 import org.springframework.mock.http.MockHttpInputMessage;
 import org.springframework.util.Assert;
@@ -32,62 +33,65 @@
  */
 public class MockClientHttpResponse extends MockHttpInputMessage implements ClientHttpResponse {
 
-	private final int statusCode;
+	private final HttpStatusCode statusCode;
 
 
 	/**
 	 * Constructor with response body as a byte array.
 	 */
-	public MockClientHttpResponse(byte[] body, HttpStatus statusCode) {
+	public MockClientHttpResponse(byte[] body, HttpStatusCode statusCode) {
 		super(body);
-		Assert.notNull(statusCode, "HttpStatus is required");
-		this.statusCode = statusCode.value();
+		Assert.notNull(statusCode, "HttpStatusCode is required");
+		this.statusCode = statusCode;
 	}
 
 	/**
-	 * Variant of {@link #MockClientHttpResponse(byte[], HttpStatus)} with a
+	 * Variant of {@link #MockClientHttpResponse(byte[], HttpStatusCode)} with a
 	 * custom HTTP status code.
 	 * @since 5.3.17
 	 */
 	public MockClientHttpResponse(byte[] body, int statusCode) {
-		super(body);
-		this.statusCode = statusCode;
+		this(body, HttpStatusCode.valueOf(statusCode));
 	}
 
 	/**
 	 * Constructor with response body as InputStream.
 	 */
-	public MockClientHttpResponse(InputStream body, HttpStatus statusCode) {
+	public MockClientHttpResponse(InputStream body, HttpStatusCode statusCode) {
 		super(body);
 		Assert.notNull(statusCode, "HttpStatus is required");
-		this.statusCode = statusCode.value();
+		this.statusCode = statusCode;
 	}
 
 	/**
-	 * Variant of {@link #MockClientHttpResponse(InputStream, HttpStatus)} with a
+	 * Variant of {@link #MockClientHttpResponse(InputStream, HttpStatusCode)} with a
 	 * custom HTTP status code.
 	 * @since 5.3.17
 	 */
 	public MockClientHttpResponse(InputStream body, int statusCode) {
-		super(body);
-		this.statusCode = statusCode;
+		this(body, HttpStatusCode.valueOf(statusCode));
 	}
 
 
 	@Override
-	public HttpStatus getStatusCode() {
-		return HttpStatus.valueOf(this.statusCode);
+	public HttpStatusCode getStatusCode() {
+		return this.statusCode;
 	}
 
 	@Override
+	@Deprecated
 	public int getRawStatusCode() {
-		return this.statusCode;
+		return this.statusCode.value();
 	}
 
 	@Override
 	public String getStatusText() {
-		HttpStatus status = HttpStatus.resolve(this.statusCode);
-		return (status != null ? status.getReasonPhrase() : "");
+		if (this.statusCode instanceof HttpStatus status) {
+			return status.getReasonPhrase();
+		}
+		else {
+			return "";
+		}
 	}
 
 	@Override

spring-test/src/main/java/org/springframework/mock/http/client/reactive/MockClientHttpResponse.java

@@ -30,6 +30,7 @@
 import org.springframework.core.io.buffer.DefaultDataBufferFactory;
 import org.springframework.http.HttpHeaders;
 import org.springframework.http.HttpStatus;
+import org.springframework.http.HttpStatusCode;
 import org.springframework.http.MediaType;
 import org.springframework.http.ResponseCookie;
 import org.springframework.http.client.reactive.ClientHttpResponse;
@@ -46,7 +47,7 @@
  */
 public class MockClientHttpResponse implements ClientHttpResponse {
 
-	private final int status;
+	private final HttpStatusCode statusCode;
 
 	private final HttpHeaders headers = new HttpHeaders();
 
@@ -55,25 +56,25 @@ public class MockClientHttpResponse implements ClientHttpResponse {
 	private Flux<DataBuffer> body = Flux.empty();
 
 
-	public MockClientHttpResponse(HttpStatus status) {
-		Assert.notNull(status, "HttpStatus is required");
-		this.status = status.value();
+	public MockClientHttpResponse(int status) {
+		this(HttpStatusCode.valueOf(status));
 	}
 
-	public MockClientHttpResponse(int status) {
-		Assert.isTrue(status > 99 && status < 1000, "Status must be between 100 and 999");
-		this.status = status;
+	public MockClientHttpResponse(HttpStatusCode status) {
+		Assert.notNull(status, "HttpStatusCode is required");
+		this.statusCode = status;
 	}
 
 
 	@Override
-	public HttpStatus getStatusCode() {
-		return HttpStatus.valueOf(this.status);
+	public HttpStatusCode getStatusCode() {
+		return this.statusCode;
 	}
 
 	@Override
+	@Deprecated
 	public int getRawStatusCode() {
-		return this.status;
+		return this.statusCode.value();
 	}
 
 	@Override
@@ -140,7 +141,11 @@ private Charset getCharset() {
 
 	@Override
 	public String toString() {
-		HttpStatus code = HttpStatus.resolve(this.status);
-		return (code != null ? code.name() + "(" + this.status + ")" : "Status (" + this.status + ")") + this.headers;
+		if (this.statusCode instanceof HttpStatus status) {
+			return status.name() + "(" + this.statusCode + ")" + this.headers;
+		}
+		else {
+			return "Status (" + this.statusCode + ")" + this.headers;
+		}
 	}
 }

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

@@ -23,6 +23,7 @@
 import org.springframework.http.HttpHeaders;
 import org.springframework.http.HttpMethod;
 import org.springframework.http.HttpStatus;
+import org.springframework.http.HttpStatusCode;
 import org.springframework.http.client.ClientHttpRequest;
 import org.springframework.http.client.ClientHttpRequestFactory;
 import org.springframework.http.client.ClientHttpResponse;
@@ -71,7 +72,7 @@ private ClientHttpResponse getClientHttpResponse(
 					.andReturn()
 					.getResponse();
 
-			HttpStatus status = HttpStatus.valueOf(servletResponse.getStatus());
+			HttpStatusCode status = HttpStatusCode.valueOf(servletResponse.getStatus());
 			byte[] body = servletResponse.getContentAsByteArray();
 			MockClientHttpResponse clientResponse = new MockClientHttpResponse(body, status);
 			clientResponse.getHeaders().putAll(getResponseHeaders(servletResponse));

spring-test/src/main/java/org/springframework/test/web/client/response/DefaultResponseCreator.java

@@ -22,7 +22,7 @@
 
 import org.springframework.core.io.Resource;
 import org.springframework.http.HttpHeaders;
-import org.springframework.http.HttpStatus;
+import org.springframework.http.HttpStatusCode;
 import org.springframework.http.MediaType;
 import org.springframework.http.client.ClientHttpRequest;
 import org.springframework.http.client.ClientHttpResponse;
@@ -39,7 +39,7 @@
  */
 public class DefaultResponseCreator implements ResponseCreator {
 
-	private final int statusCode;
+	private final HttpStatusCode statusCode;
 
 	private byte[] content = new byte[0];
 
@@ -52,18 +52,18 @@ public class DefaultResponseCreator implements ResponseCreator {
 	/**
 	 * Protected constructor.
 	 * Use static factory methods in {@link MockRestResponseCreators}.
+	 * @since 5.3.17
 	 */
-	protected DefaultResponseCreator(HttpStatus statusCode) {
-		Assert.notNull(statusCode, "HttpStatus must not be null");
-		this.statusCode = statusCode.value();
+	protected DefaultResponseCreator(int statusCode) {
+		this(HttpStatusCode.valueOf(statusCode));
 	}
 
 	/**
 	 * Protected constructor.
 	 * Use static factory methods in {@link MockRestResponseCreators}.
-	 * @since 5.3.17
 	 */
-	protected DefaultResponseCreator(int statusCode) {
+	protected DefaultResponseCreator(HttpStatusCode statusCode) {
+		Assert.notNull(statusCode, "HttpStatusCode must not be null");
 		this.statusCode = statusCode;
 	}
 

spring-test/src/main/java/org/springframework/test/web/client/response/MockRestResponseCreators.java

@@ -21,6 +21,7 @@
 
 import org.springframework.core.io.Resource;
 import org.springframework.http.HttpStatus;
+import org.springframework.http.HttpStatusCode;
 import org.springframework.http.MediaType;
 import org.springframework.lang.Nullable;
 import org.springframework.test.web.client.ResponseCreator;
@@ -113,12 +114,12 @@ public static DefaultResponseCreator withServerError() {
 	 * {@code ResponseCreator} with a specific HTTP status.
 	 * @param status the response status
 	 */
-	public static DefaultResponseCreator withStatus(HttpStatus status) {
+	public static DefaultResponseCreator withStatus(HttpStatusCode status) {
 		return new DefaultResponseCreator(status);
 	}
 
 	/**
-	 * Variant of {@link #withStatus(HttpStatus)} for a custom HTTP status code.
+	 * Variant of {@link #withStatus(HttpStatusCode)} with an integer.
 	 * @param status the response status
 	 * @since 5.3.17
 	 */

spring-test/src/main/java/org/springframework/test/web/reactive/server/ExchangeResult.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.http.MediaType;
 import org.springframework.http.ResponseCookie;
 import org.springframework.http.client.reactive.ClientHttpRequest;
@@ -170,17 +171,18 @@ public byte[] getRequestBodyContent() {
 
 
 	/**
-	 * Return the HTTP status code as an {@link HttpStatus} enum value.
+	 * Return the HTTP status code as an {@link HttpStatusCode} value.
 	 */
-	public HttpStatus getStatus() {
+	public HttpStatusCode getStatus() {
 		return this.response.getStatusCode();
 	}
 
 	/**
-	 * Return the HTTP status code (potentially non-standard and not resolvable
-	 * through the {@link HttpStatus} enum) as an integer.
+	 * Return the HTTP status code as an integer.
 	 * @since 5.1.10
+	 * @deprecated as of 6.0, in favor of {@link #getStatus()}
 	 */
+	@Deprecated
 	public int getRawStatusCode() {
 		return this.response.getRawStatusCode();
 	}
@@ -248,13 +250,22 @@ public String toString() {
 				"\n" +
 				formatBody(getRequestHeaders().getContentType(), this.requestBody) + "\n" +
 				"\n" +
-				"< " + getStatus() + " " + getStatus().getReasonPhrase() + "\n" +
+				"< " + getStatus() + " " + getReasonPhrase(getStatus()) + "\n" +
 				"< " + formatHeaders(getResponseHeaders(), "\n< ") + "\n" +
 				"\n" +
 				formatBody(getResponseHeaders().getContentType(), this.responseBody) +"\n" +
 				formatMockServerResult();
 	}
 
+	private static String getReasonPhrase(HttpStatusCode statusCode) {
+		if (statusCode instanceof HttpStatus status) {
+			return status.getReasonPhrase();
+		}
+		else {
+			return "";
+		}
+	}
+
 	private String formatHeaders(HttpHeaders headers, String delimiter) {
 		return headers.entrySet().stream()
 				.map(entry -> entry.getKey() + ": " + entry.getValue())

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

@@ -31,6 +31,8 @@
 import org.springframework.http.HttpCookie;
 import org.springframework.http.HttpHeaders;
 import org.springframework.http.HttpMethod;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.HttpStatusCode;
 import org.springframework.http.client.reactive.ClientHttpConnector;
 import org.springframework.http.client.reactive.ClientHttpRequest;
 import org.springframework.http.client.reactive.ClientHttpResponse;
@@ -142,8 +144,8 @@ private ServerHttpResponse prepareResponse(ServerHttpResponse response, ServerHt
 	}
 
 	private ClientHttpResponse adaptResponse(MockServerHttpResponse response, Flux<DataBuffer> body) {
-		Integer status = response.getRawStatusCode();
-		MockClientHttpResponse clientResponse = new MockClientHttpResponse((status != null) ? status : 200);
+		HttpStatusCode status = response.getStatusCode();
+		MockClientHttpResponse clientResponse = new MockClientHttpResponse((status != null) ? status : HttpStatus.OK);
 		clientResponse.getHeaders().putAll(response.getHeaders());
 		clientResponse.getCookies().putAll(response.getCookies());
 		clientResponse.setBody(body);