-
Notifications
You must be signed in to change notification settings - Fork 37.7k
/
ResultMatcher.java
104 lines (96 loc) · 2.99 KB
/
ResultMatcher.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
/*
* Copyright 2002-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.test.web.servlet;
import java.util.ArrayList;
import java.util.List;
/**
* A {@code ResultMatcher} matches the result of an executed request against
* some expectation.
*
* <p>See static factory methods in
* {@link org.springframework.test.web.servlet.result.MockMvcResultMatchers
* MockMvcResultMatchers}.
*
* <h3>Example Using Status and Content Result Matchers</h3>
*
* <pre class="code">
* import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.*;
* import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.*;
* import static org.springframework.test.web.servlet.setup.MockMvcBuilders.*;
*
* // ...
*
* WebApplicationContext wac = ...;
*
* MockMvc mockMvc = webAppContextSetup(wac).build();
*
* mockMvc.perform(get("/form"))
* .andExpect(status().isOk())
* .andExpect(content().mimeType(MediaType.APPLICATION_JSON));
* </pre>
*
* @author Rossen Stoyanchev
* @author Sam Brannen
* @since 3.2
*/
@FunctionalInterface
public interface ResultMatcher {
/**
* Assert the result of an executed request.
* @param result the result of the executed request
* @throws Exception if a failure occurs
*/
void match(MvcResult result) throws Exception;
/**
* Static method for matching with an array of result matchers.
* @param matchers the matchers
* @since 5.1
*/
static ResultMatcher matchAll(ResultMatcher... matchers) {
return result -> {
for (ResultMatcher matcher : matchers) {
matcher.match(result);
}
};
}
/**
* Static method for matching with an array of result matchers whose assertion failures are caught and stored.
* Only when all of them would be called a {@link AssertionError} be thrown containing the error messages of those
* previously caught assertion failures.
* @param matchers the matchers
* @author Michał Rowicki
* @since 5.2
*/
static ResultMatcher matchAllSoftly(ResultMatcher... matchers) {
return result -> {
List<String> failedMessages = null;
for (ResultMatcher matcher : matchers) {
try {
matcher.match(result);
}
catch (AssertionError assertionException) {
if (failedMessages == null) {
failedMessages = new ArrayList<>();
}
failedMessages.add(assertionException.getMessage());
}
}
if (failedMessages != null) {
throw new AssertionError(String.join("\n", failedMessages));
}
};
}
}