Tests for ErrorResponse hierarchy to verify the output

rstoyanchev · rstoyanchev · commit b045e5baef04 · 2022-02-28T13:40:05.000Z
See gh-27052
diff --git a/spring-web/src/main/java/org/springframework/web/ErrorResponseException.java b/spring-web/src/main/java/org/springframework/web/ErrorResponseException.java
@@ -61,7 +61,7 @@ public ErrorResponseException(HttpStatus status) {
 	 * Constructor with a well-known {@link HttpStatus} and an optional cause.
 	 */
 	public ErrorResponseException(HttpStatus status, @Nullable Throwable cause) {
-		this(status.value(), null);
+		this(status.value(), cause);
 	}
 
 	/**
diff --git a/spring-web/src/main/java/org/springframework/web/HttpMediaTypeNotAcceptableException.java b/spring-web/src/main/java/org/springframework/web/HttpMediaTypeNotAcceptableException.java
@@ -17,6 +17,7 @@
 package org.springframework.web;
 
 import java.util.List;
+import java.util.stream.Collectors;
 
 import org.springframework.http.HttpHeaders;
 import org.springframework.http.HttpStatus;
@@ -39,15 +40,17 @@ public class HttpMediaTypeNotAcceptableException extends HttpMediaTypeException
 	 */
 	public HttpMediaTypeNotAcceptableException(String message) {
 		super(message);
-		getBody().setDetail("Could not parse Accept header");
+		getBody().setDetail("Could not parse Accept header.");
 	}
 
 	/**
 	 * Create a new HttpMediaTypeNotSupportedException.
-	 * @param supportedMediaTypes the list of supported media types
+	 * @param mediaTypes the list of supported media types
 	 */
-	public HttpMediaTypeNotAcceptableException(List<MediaType> supportedMediaTypes) {
-		super("No acceptable representation", supportedMediaTypes);
+	public HttpMediaTypeNotAcceptableException(List<MediaType> mediaTypes) {
+		super("No acceptable representation", mediaTypes);
+		getBody().setDetail("Acceptable representations: " +
+				mediaTypes.stream().map(MediaType::toString).collect(Collectors.joining(", ", "'", "'")) + ".");
 	}
 
 
diff --git a/spring-web/src/main/java/org/springframework/web/HttpMediaTypeNotSupportedException.java b/spring-web/src/main/java/org/springframework/web/HttpMediaTypeNotSupportedException.java
@@ -51,29 +51,29 @@ public HttpMediaTypeNotSupportedException(String message) {
 		super(message);
 		this.contentType = null;
 		this.httpMethod = null;
-		getBody().setDetail("Could not parse Content-Type");
+		getBody().setDetail("Could not parse Content-Type.");
 	}
 
 	/**
 	 * Create a new HttpMediaTypeNotSupportedException.
 	 * @param contentType the unsupported content type
-	 * @param supportedMediaTypes the list of supported media types
+	 * @param mediaTypes the list of supported media types
 	 */
-	public HttpMediaTypeNotSupportedException(@Nullable MediaType contentType, List<MediaType> supportedMediaTypes) {
-		this(contentType, supportedMediaTypes, null);
+	public HttpMediaTypeNotSupportedException(@Nullable MediaType contentType, List<MediaType> mediaTypes) {
+		this(contentType, mediaTypes, null);
 	}
 
 	/**
 	 * Create a new HttpMediaTypeNotSupportedException.
 	 * @param contentType the unsupported content type
-	 * @param supportedMediaTypes the list of supported media types
+	 * @param mediaTypes the list of supported media types
 	 * @param httpMethod the HTTP method of the request
 	 * @since 6.0
 	 */
-	public HttpMediaTypeNotSupportedException(@Nullable MediaType contentType,
-			List<MediaType> supportedMediaTypes, @Nullable HttpMethod httpMethod) {
+	public HttpMediaTypeNotSupportedException(
+			@Nullable MediaType contentType, List<MediaType> mediaTypes, @Nullable HttpMethod httpMethod) {
 
-		this(contentType, supportedMediaTypes, httpMethod,
+		this(contentType, mediaTypes, httpMethod,
 				"Content-Type " + (contentType != null ? "'" + contentType + "' " : "") + "is not supported");
 	}
 
@@ -91,7 +91,7 @@ public HttpMediaTypeNotSupportedException(@Nullable MediaType contentType,
 		super(message, supportedMediaTypes);
 		this.contentType = contentType;
 		this.httpMethod = httpMethod;
-		getBody().setDetail("Content-Type " + this.contentType + " is not supported");
+		getBody().setDetail("Content-Type '" + this.contentType + "' is not supported.");
 	}
 
 
diff --git a/spring-web/src/main/java/org/springframework/web/HttpRequestMethodNotSupportedException.java b/spring-web/src/main/java/org/springframework/web/HttpRequestMethodNotSupportedException.java
@@ -93,8 +93,9 @@ public HttpRequestMethodNotSupportedException(String method, @Nullable String[]
 		super(msg);
 		this.method = method;
 		this.supportedMethods = supportedMethods;
-		this.body = ProblemDetail.forRawStatusCode(getRawStatusCode())
-				.withDetail("Method '" + method + "' is not supported");
+
+		String detail = "Method '" + method + "' is not supported.";
+		this.body = ProblemDetail.forRawStatusCode(getRawStatusCode()).withDetail(detail);
 	}
 
 
diff --git a/spring-web/src/main/java/org/springframework/web/bind/MethodArgumentNotValidException.java b/spring-web/src/main/java/org/springframework/web/bind/MethodArgumentNotValidException.java
@@ -48,7 +48,7 @@ public class MethodArgumentNotValidException extends BindException implements Er
 	public MethodArgumentNotValidException(MethodParameter parameter, BindingResult bindingResult) {
 		super(bindingResult);
 		this.parameter = parameter;
-		this.body = ProblemDetail.forRawStatusCode(getRawStatusCode()).withDetail(initMessage(parameter));
+		this.body = ProblemDetail.forRawStatusCode(getRawStatusCode()).withDetail("Invalid request content.");
 	}
 
 
@@ -71,13 +71,9 @@ public final MethodParameter getParameter() {
 
 	@Override
 	public String getMessage() {
-		return initMessage(this.parameter);
-	}
-
-	private String initMessage(MethodParameter parameter) {
 		StringBuilder sb = new StringBuilder("Validation failed for argument [")
-				.append(parameter.getParameterIndex()).append("] in ")
-				.append(parameter.getExecutable().toGenericString());
+				.append(this.parameter.getParameterIndex()).append("] in ")
+				.append(this.parameter.getExecutable().toGenericString());
 		BindingResult bindingResult = getBindingResult();
 		if (bindingResult.getErrorCount() > 1) {
 			sb.append(" with ").append(bindingResult.getErrorCount()).append(" errors");
diff --git a/spring-web/src/main/java/org/springframework/web/bind/MissingMatrixVariableException.java b/spring-web/src/main/java/org/springframework/web/bind/MissingMatrixVariableException.java
@@ -57,7 +57,7 @@ public MissingMatrixVariableException(
 		super("", missingAfterConversion);
 		this.variableName = variableName;
 		this.parameter = parameter;
-		getBody().setDetail("Required path parameter '" + this.variableName + "' is not present");
+		getBody().setDetail("Required path parameter '" + this.variableName + "' is not present.");
 	}
 
 
diff --git a/spring-web/src/main/java/org/springframework/web/bind/MissingPathVariableException.java b/spring-web/src/main/java/org/springframework/web/bind/MissingPathVariableException.java
@@ -60,7 +60,7 @@ public MissingPathVariableException(
 		super("", missingAfterConversion);
 		this.variableName = variableName;
 		this.parameter = parameter;
-		getBody().setDetail("Required URI variable '" + this.variableName + "' is not present");
+		getBody().setDetail("Required path variable '" + this.variableName + "' is not present.");
 	}
 
 
diff --git a/spring-web/src/main/java/org/springframework/web/bind/MissingRequestCookieException.java b/spring-web/src/main/java/org/springframework/web/bind/MissingRequestCookieException.java
@@ -57,7 +57,7 @@ public MissingRequestCookieException(
 		super("", missingAfterConversion);
 		this.cookieName = cookieName;
 		this.parameter = parameter;
-		getBody().setDetail("Required cookie '" + this.cookieName + "' is not present");
+		getBody().setDetail("Required cookie '" + this.cookieName + "' is not present.");
 	}
 
 
diff --git a/spring-web/src/main/java/org/springframework/web/bind/MissingRequestHeaderException.java b/spring-web/src/main/java/org/springframework/web/bind/MissingRequestHeaderException.java
@@ -57,7 +57,7 @@ public MissingRequestHeaderException(
 		super("", missingAfterConversion);
 		this.headerName = headerName;
 		this.parameter = parameter;
-		getBody().setDetail("Required header '" + this.headerName + "' is not present");
+		getBody().setDetail("Required header '" + this.headerName + "' is not present.");
 	}
 
 
diff --git a/spring-web/src/main/java/org/springframework/web/bind/MissingServletRequestParameterException.java b/spring-web/src/main/java/org/springframework/web/bind/MissingServletRequestParameterException.java
@@ -52,7 +52,7 @@ public MissingServletRequestParameterException(
 		super("", missingAfterConversion);
 		this.parameterName = parameterName;
 		this.parameterType = parameterType;
-		getBody().setDetail("Required parameter '" + this.parameterName + "' is not present");
+		getBody().setDetail("Required parameter '" + this.parameterName + "' is not present.");
 	}
 
 
diff --git a/spring-web/src/main/java/org/springframework/web/bind/UnsatisfiedServletRequestParameterException.java b/spring-web/src/main/java/org/springframework/web/bind/UnsatisfiedServletRequestParameterException.java
@@ -16,7 +16,6 @@
 
 package org.springframework.web.bind;
 
-import java.util.Arrays;
 import java.util.Iterator;
 import java.util.List;
 import java.util.Map;
@@ -48,9 +47,7 @@ public class UnsatisfiedServletRequestParameterException extends ServletRequestB
 	 * @param actualParams the actual parameter Map associated with the ServletRequest
 	 */
 	public UnsatisfiedServletRequestParameterException(String[] paramConditions, Map<String, String[]> actualParams) {
-		super("");
-		this.paramConditions = Arrays.<String[]>asList(paramConditions);
-		this.actualParams = actualParams;
+		this(List.<String[]>of(paramConditions), actualParams);
 	}
 
 	/**
@@ -66,6 +63,7 @@ public UnsatisfiedServletRequestParameterException(List<String[]> paramCondition
 		Assert.notEmpty(paramConditions, "Parameter conditions must not be empty");
 		this.paramConditions = paramConditions;
 		this.actualParams = actualParams;
+		getBody().setDetail("Invalid request parameters.");
 	}
 
 
diff --git a/spring-web/src/main/java/org/springframework/web/bind/support/WebExchangeBindException.java b/spring-web/src/main/java/org/springframework/web/bind/support/WebExchangeBindException.java
@@ -49,6 +49,7 @@ public class WebExchangeBindException extends ServerWebInputException implements
 	public WebExchangeBindException(MethodParameter parameter, BindingResult bindingResult) {
 		super("Validation failure", parameter);
 		this.bindingResult = bindingResult;
+		getBody().setDetail("Invalid request content.");
 	}
 
 
diff --git a/spring-web/src/main/java/org/springframework/web/multipart/support/MissingServletRequestPartException.java b/spring-web/src/main/java/org/springframework/web/multipart/support/MissingServletRequestPartException.java
@@ -40,7 +40,7 @@ public class MissingServletRequestPartException extends ServletRequestBindingExc
 	 * @param requestPartName the name of the missing part of the multipart request
 	 */
 	public MissingServletRequestPartException(String requestPartName) {
-		super("Required request part '" + requestPartName + "' is not present");
+		super("Required part '" + requestPartName + "' is not present.");
 		this.requestPartName = requestPartName;
 		getBody().setDetail(getMessage());
 	}
diff --git a/spring-web/src/main/java/org/springframework/web/server/MethodNotAllowedException.java b/spring-web/src/main/java/org/springframework/web/server/MethodNotAllowedException.java
@@ -20,6 +20,7 @@
 import java.util.Collections;
 import java.util.LinkedHashSet;
 import java.util.Set;
+import java.util.stream.Collectors;
 
 import org.springframework.http.HttpHeaders;
 import org.springframework.http.HttpMethod;
@@ -47,13 +48,17 @@ public MethodNotAllowedException(HttpMethod method, Collection<HttpMethod> suppo
 	}
 
 	public MethodNotAllowedException(String method, @Nullable Collection<HttpMethod> supportedMethods) {
-		super(HttpStatus.METHOD_NOT_ALLOWED, "Request method '" + method + "' not supported");
+		super(HttpStatus.METHOD_NOT_ALLOWED, "Request method '" + method + "' is not supported.");
 		Assert.notNull(method, "'method' is required");
 		if (supportedMethods == null) {
 			supportedMethods = Collections.emptySet();
 		}
 		this.method = method;
 		this.httpMethods = Collections.unmodifiableSet(new LinkedHashSet<>(supportedMethods));
+
+		getBody().setDetail(this.httpMethods.isEmpty() ? getReason() :
+				"Supported methods: " + this.httpMethods.stream()
+						.map(HttpMethod::toString).collect(Collectors.joining("', '", "'", "'")));
 	}
 
 
diff --git a/spring-web/src/main/java/org/springframework/web/server/NotAcceptableStatusException.java b/spring-web/src/main/java/org/springframework/web/server/NotAcceptableStatusException.java
@@ -18,6 +18,7 @@
 
 import java.util.Collections;
 import java.util.List;
+import java.util.stream.Collectors;
 
 import org.springframework.http.HttpHeaders;
 import org.springframework.http.HttpStatus;
@@ -42,14 +43,17 @@ public class NotAcceptableStatusException extends ResponseStatusException {
 	public NotAcceptableStatusException(String reason) {
 		super(HttpStatus.NOT_ACCEPTABLE, reason);
 		this.supportedMediaTypes = Collections.emptyList();
+		getBody().setDetail("Could not parse Accept header.");
 	}
 
 	/**
 	 * Constructor for when the requested Content-Type is not supported.
 	 */
-	public NotAcceptableStatusException(List<MediaType> supportedMediaTypes) {
+	public NotAcceptableStatusException(List<MediaType> mediaTypes) {
 		super(HttpStatus.NOT_ACCEPTABLE, "Could not find acceptable representation");
-		this.supportedMediaTypes = Collections.unmodifiableList(supportedMediaTypes);
+		this.supportedMediaTypes = Collections.unmodifiableList(mediaTypes);
+		getBody().setDetail("Acceptable representations: " +
+				mediaTypes.stream().map(MediaType::toString).collect(Collectors.joining(", ", "'", "'")) + ".");
 	}
 
 
diff --git a/spring-web/src/main/java/org/springframework/web/server/ResponseStatusException.java b/spring-web/src/main/java/org/springframework/web/server/ResponseStatusException.java
@@ -77,7 +77,6 @@ public ResponseStatusException(HttpStatus status, @Nullable String reason, @Null
 	public ResponseStatusException(int rawStatusCode, @Nullable String reason, @Nullable Throwable cause) {
 		super(rawStatusCode, cause);
 		this.reason = reason;
-		setDetail(reason);
 	}
 
 
diff --git a/spring-web/src/main/java/org/springframework/web/server/UnsupportedMediaTypeStatusException.java b/spring-web/src/main/java/org/springframework/web/server/UnsupportedMediaTypeStatusException.java
@@ -57,6 +57,7 @@ public UnsupportedMediaTypeStatusException(@Nullable String reason) {
 		this.supportedMediaTypes = Collections.emptyList();
 		this.bodyType = null;
 		this.method = null;
+		getBody().setDetail("Could not parse Content-Type.");
 	}
 
 	/**
@@ -100,8 +101,7 @@ public UnsupportedMediaTypeStatusException(@Nullable MediaType contentType, List
 		this.bodyType = bodyType;
 		this.method = method;
 
-		// Set explicitly to avoid implementation details
-		setDetail(contentType != null ? "Content-Type '" + contentType + "' is not supported" : null);
+		setDetail(contentType != null ? "Content-Type '" + contentType + "' is not supported." : null);
 	}
 
 
diff --git a/spring-web/src/test/java/org/springframework/web/ErrorResponseExceptionTests.java b/spring-web/src/test/java/org/springframework/web/ErrorResponseExceptionTests.java
diff --git a/spring-webmvc/src/main/java/org/springframework/web/servlet/NoHandlerFoundException.java b/spring-webmvc/src/main/java/org/springframework/web/servlet/NoHandlerFoundException.java
diff --git a/spring-webmvc/src/main/java/org/springframework/web/servlet/mvc/method/annotation/ResponseEntityExceptionHandler.java b/spring-webmvc/src/main/java/org/springframework/web/servlet/mvc/method/annotation/ResponseEntityExceptionHandler.java

Original file line number	Diff line number	Diff line change
`@@ -61,7 +61,7 @@ public ErrorResponseException(HttpStatus status) {`
`61`	`61`	`* Constructor with a well-known {@link HttpStatus} and an optional cause.`
`62`	`62`	`*/`
`63`	`63`	`public ErrorResponseException(HttpStatus status, @Nullable Throwable cause) {`
`64`		`- this(status.value(), null);`
	`64`	`+ this(status.value(), cause);`
`65`	`65`	`}`
`66`	`66`
`67`	`67`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,7 @@ public MissingMatrixVariableException(`
`57`	`57`	`super("", missingAfterConversion);`
`58`	`58`	`this.variableName = variableName;`
`59`	`59`	`this.parameter = parameter;`
`60`		`- getBody().setDetail("Required path parameter '" + this.variableName + "' is not present");`
	`60`	`+ getBody().setDetail("Required path parameter '" + this.variableName + "' is not present.");`
`61`	`61`	`}`
`62`	`62`
`63`	`63`
Original file line number	Diff line number	Diff line change
`@@ -60,7 +60,7 @@ public MissingPathVariableException(`
`60`	`60`	`super("", missingAfterConversion);`
`61`	`61`	`this.variableName = variableName;`
`62`	`62`	`this.parameter = parameter;`
`63`		`- getBody().setDetail("Required URI variable '" + this.variableName + "' is not present");`
	`63`	`+ getBody().setDetail("Required path variable '" + this.variableName + "' is not present.");`
`64`	`64`	`}`
`65`	`65`
`66`	`66`
Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,7 @@ public MissingRequestCookieException(`
`57`	`57`	`super("", missingAfterConversion);`
`58`	`58`	`this.cookieName = cookieName;`
`59`	`59`	`this.parameter = parameter;`
`60`		`- getBody().setDetail("Required cookie '" + this.cookieName + "' is not present");`
	`60`	`+ getBody().setDetail("Required cookie '" + this.cookieName + "' is not present.");`
`61`	`61`	`}`
`62`	`62`
`63`	`63`
Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,7 @@ public MissingServletRequestParameterException(`
`52`	`52`	`super("", missingAfterConversion);`
`53`	`53`	`this.parameterName = parameterName;`
`54`	`54`	`this.parameterType = parameterType;`
`55`		`- getBody().setDetail("Required parameter '" + this.parameterName + "' is not present");`
	`55`	`+ getBody().setDetail("Required parameter '" + this.parameterName + "' is not present.");`
`56`	`56`	`}`
`57`	`57`
`58`	`58`