-
Notifications
You must be signed in to change notification settings - Fork 37.7k
/
ResultActions.java
91 lines (85 loc) · 2.7 KB
/
ResultActions.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
/*
* Copyright 2002-2018 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;
/**
* Allows applying actions, such as expectations, on the result of an executed
* request.
*
* <p>See static factory methods in
* {@link org.springframework.test.web.servlet.result.MockMvcResultMatchers} and
* {@link org.springframework.test.web.servlet.result.MockMvcResultHandlers}.
*
* @author Rossen Stoyanchev
* @since 3.2
*/
public interface ResultActions {
/**
* Perform an expectation.
*
* <h4>Example</h4>
* <pre class="code">
* static imports: MockMvcRequestBuilders.*, MockMvcResultMatchers.*
*
* mockMvc.perform(get("/person/1"))
* .andExpect(status().isOk())
* .andExpect(content().contentType(MediaType.APPLICATION_JSON))
* .andExpect(jsonPath("$.person.name").value("Jason"));
* </pre>
*
* <p>Either provide all matchers as a vararg:
* <pre class="code">
* static imports: MockMvcRequestBuilders.*, MockMvcResultMatchers.*, ResultMatcher.matchAll
*
* mockMvc.perform(post("/form"))
* .andExpect(matchAll(
* status().isOk(),
* redirectedUrl("/person/1"),
* model().size(1),
* model().attributeExists("person"),
* flash().attributeCount(1),
* flash().attribute("message", "success!"))
* );
* </pre>
*
* <p>Or provide all matchers to be evaluated no matter if one of them fail:
* <pre class="code">
* static imports: MockMvcRequestBuilders.*, MockMvcResultMatchers.*, ResultMatcher.matchAllSoftly
* mockMvc.perform(post("/form"))
* .andExpect(matchAllSoftly(
* status().isOk(),
* redirectedUrl("/person/1")
* );
* </pre>
*/
ResultActions andExpect(ResultMatcher matcher) throws Exception;
/**
* Perform a general action.
*
* <h4>Example</h4>
* <pre class="code">
* static imports: MockMvcRequestBuilders.*, MockMvcResultMatchers.*
*
* mockMvc.perform(get("/form")).andDo(print());
* </pre>
*/
ResultActions andDo(ResultHandler handler) throws Exception;
/**
* Return the result of the executed request for direct access to the results.
*
* @return the result of the request
*/
MvcResult andReturn();
}