/
ResponseStatusExceptionResolverTests.java
183 lines (150 loc) · 6.49 KB
/
ResponseStatusExceptionResolverTests.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
/*
* Copyright 2002-2020 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.web.servlet.mvc.annotation;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.util.Arrays;
import java.util.Locale;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.springframework.beans.TypeMismatchException;
import org.springframework.beans.testfixture.beans.ITestBean;
import org.springframework.context.i18n.LocaleContextHolder;
import org.springframework.context.support.StaticMessageSource;
import org.springframework.core.annotation.AliasFor;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpMethod;
import org.springframework.http.HttpStatus;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.server.MethodNotAllowedException;
import org.springframework.web.server.ResponseStatusException;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.testfixture.servlet.MockHttpServletRequest;
import org.springframework.web.testfixture.servlet.MockHttpServletResponse;
import static org.assertj.core.api.Assertions.assertThat;
/**
* Integration tests for {@link ResponseStatusExceptionResolver}.
*
* @author Arjen Poutsma
* @author Sam Brannen
* @author Rossen Stoyanchev
*/
public class ResponseStatusExceptionResolverTests {
private final ResponseStatusExceptionResolver exceptionResolver = new ResponseStatusExceptionResolver();
private final MockHttpServletRequest request = new MockHttpServletRequest("GET", "");
private final MockHttpServletResponse response = new MockHttpServletResponse();
@BeforeEach
public void setup() {
exceptionResolver.setWarnLogCategory(exceptionResolver.getClass().getName());
}
@Test
public void statusCode() {
StatusCodeException ex = new StatusCodeException();
ModelAndView mav = exceptionResolver.resolveException(request, response, null, ex);
assertResolved(mav, 400, null);
}
@Test
public void statusCodeFromComposedResponseStatus() {
StatusCodeFromComposedResponseStatusException ex = new StatusCodeFromComposedResponseStatusException();
ModelAndView mav = exceptionResolver.resolveException(request, response, null, ex);
assertResolved(mav, 400, null);
}
@Test
public void statusCodeAndReason() {
StatusCodeAndReasonException ex = new StatusCodeAndReasonException();
ModelAndView mav = exceptionResolver.resolveException(request, response, null, ex);
assertResolved(mav, 410, "You suck!");
}
@Test
public void statusCodeAndReasonMessage() {
Locale locale = Locale.CHINESE;
LocaleContextHolder.setLocale(locale);
try {
StaticMessageSource messageSource = new StaticMessageSource();
messageSource.addMessage("gone.reason", locale, "Gone reason message");
exceptionResolver.setMessageSource(messageSource);
StatusCodeAndReasonMessageException ex = new StatusCodeAndReasonMessageException();
exceptionResolver.resolveException(request, response, null, ex);
assertThat(response.getErrorMessage()).as("Invalid status reason").isEqualTo("Gone reason message");
}
finally {
LocaleContextHolder.resetLocaleContext();
}
}
@Test
public void notAnnotated() {
Exception ex = new Exception();
exceptionResolver.resolveException(request, response, null, ex);
ModelAndView mav = exceptionResolver.resolveException(request, response, null, ex);
assertThat(mav).as("ModelAndView returned").isNull();
}
@Test // SPR-12903
public void nestedException() {
Exception cause = new StatusCodeAndReasonMessageException();
TypeMismatchException ex = new TypeMismatchException("value", ITestBean.class, cause);
ModelAndView mav = exceptionResolver.resolveException(request, response, null, ex);
assertResolved(mav, 410, "gone.reason");
}
@Test
public void responseStatusException() {
ResponseStatusException ex = new ResponseStatusException(HttpStatus.BAD_REQUEST);
ModelAndView mav = exceptionResolver.resolveException(request, response, null, ex);
assertResolved(mav, 400, null);
}
@Test // SPR-15524
public void responseStatusExceptionWithReason() {
ResponseStatusException ex = new ResponseStatusException(HttpStatus.BAD_REQUEST, "The reason");
ModelAndView mav = exceptionResolver.resolveException(request, response, null, ex);
assertResolved(mav, 400, "The reason");
}
@Test
void responseStatusExceptionWithHeaders() {
Exception ex = new MethodNotAllowedException(
HttpMethod.GET, Arrays.asList(HttpMethod.POST, HttpMethod.PUT));
ModelAndView mav = exceptionResolver.resolveException(request, response, null, ex);
assertResolved(mav, 405, "Request method 'GET' is not supported.");
assertThat(response.getHeader(HttpHeaders.ALLOW)).isEqualTo("POST,PUT");
}
private void assertResolved(ModelAndView mav, int status, String reason) {
assertThat(mav != null && mav.isEmpty()).as("No Empty ModelAndView returned").isTrue();
assertThat(response.getStatus()).isEqualTo(status);
assertThat(response.getErrorMessage()).isEqualTo(reason);
assertThat(response.isCommitted()).isTrue();
}
@ResponseStatus(HttpStatus.BAD_REQUEST)
@SuppressWarnings("serial")
private static class StatusCodeException extends Exception {
}
@ResponseStatus(code = HttpStatus.GONE, reason = "You suck!")
@SuppressWarnings("serial")
private static class StatusCodeAndReasonException extends Exception {
}
@ResponseStatus(code = HttpStatus.GONE, reason = "gone.reason")
@SuppressWarnings("serial")
private static class StatusCodeAndReasonMessageException extends Exception {
}
@ResponseStatus
@Retention(RetentionPolicy.RUNTIME)
@SuppressWarnings("unused")
@interface ComposedResponseStatus {
@AliasFor(annotation = ResponseStatus.class, attribute = "code")
HttpStatus responseStatus() default HttpStatus.INTERNAL_SERVER_ERROR;
}
@ComposedResponseStatus(responseStatus = HttpStatus.BAD_REQUEST)
@SuppressWarnings("serial")
private static class StatusCodeFromComposedResponseStatusException extends Exception {
}
}