/
XpathResultMatchers.java
184 lines (161 loc) · 6.11 KB
/
XpathResultMatchers.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
184
/*
* 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
*
* http://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.result;
import java.util.Map;
import javax.xml.xpath.XPathExpressionException;
import org.hamcrest.Matcher;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.springframework.lang.Nullable;
import org.springframework.mock.web.MockHttpServletResponse;
import org.springframework.test.util.XpathExpectationsHelper;
import org.springframework.test.web.servlet.ResultMatcher;
/**
* Factory for assertions on the response content using XPath expressions.
*
* <p>An instance of this class is typically accessed via
* {@link MockMvcResultMatchers#xpath}.
*
* @author Rossen Stoyanchev
* @since 3.2
*/
public class XpathResultMatchers {
private final XpathExpectationsHelper xpathHelper;
/**
* Protected constructor, not for direct instantiation. Use
* {@link MockMvcResultMatchers#xpath(String, Object...)} or
* {@link MockMvcResultMatchers#xpath(String, Map, Object...)}.
* @param expression the XPath expression
* @param namespaces the XML namespaces referenced in the XPath expression, or {@code null}
* @param args arguments to parameterize the XPath expression with using the
* formatting specifiers defined in {@link String#format(String, Object...)}
*/
protected XpathResultMatchers(String expression, @Nullable Map<String, String> namespaces, Object ... args)
throws XPathExpressionException {
this.xpathHelper = new XpathExpectationsHelper(expression, namespaces, args);
}
/**
* Evaluate the XPath and assert the {@link Node} content found with the
* given Hamcrest {@link Matcher}.
*/
public ResultMatcher node(final Matcher<? super Node> matcher) {
return result -> {
MockHttpServletResponse response = result.getResponse();
this.xpathHelper.assertNode(response.getContentAsByteArray(), getDefinedEncoding(response), matcher);
};
}
/**
* Evaluate the XPath and assert the {@link NodeList} content found with the
* given Hamcrest {@link Matcher}.
*/
public ResultMatcher nodeList(final Matcher<? super NodeList> matcher) {
return result -> {
MockHttpServletResponse response = result.getResponse();
this.xpathHelper.assertNodeList(response.getContentAsByteArray(), getDefinedEncoding(response), matcher);
};
}
/**
* Get the response encoding if explicitly defined in the response, {code null} otherwise.
*/
@Nullable
private String getDefinedEncoding(MockHttpServletResponse response) {
return (response.isCharset() ? response.getCharacterEncoding() : null);
}
/**
* Evaluate the XPath and assert that content exists.
*/
public ResultMatcher exists() {
return result -> {
MockHttpServletResponse response = result.getResponse();
this.xpathHelper.exists(response.getContentAsByteArray(), getDefinedEncoding(response));
};
}
/**
* Evaluate the XPath and assert that content doesn't exist.
*/
public ResultMatcher doesNotExist() {
return result -> {
MockHttpServletResponse response = result.getResponse();
this.xpathHelper.doesNotExist(response.getContentAsByteArray(), getDefinedEncoding(response));
};
}
/**
* Evaluate the XPath and assert the number of nodes found with the given
* Hamcrest {@link Matcher}.
*/
public ResultMatcher nodeCount(final Matcher<Integer> matcher) {
return result -> {
MockHttpServletResponse response = result.getResponse();
this.xpathHelper.assertNodeCount(response.getContentAsByteArray(), getDefinedEncoding(response), matcher);
};
}
/**
* Evaluate the XPath and assert the number of nodes found.
*/
public ResultMatcher nodeCount(final int expectedCount) {
return result -> {
MockHttpServletResponse response = result.getResponse();
this.xpathHelper.assertNodeCount(response.getContentAsByteArray(), getDefinedEncoding(response), expectedCount);
};
}
/**
* Apply the XPath and assert the {@link String} value found with the given
* Hamcrest {@link Matcher}.
*/
public ResultMatcher string(final Matcher<? super String> matcher) {
return result -> {
MockHttpServletResponse response = result.getResponse();
this.xpathHelper.assertString(response.getContentAsByteArray(), getDefinedEncoding(response), matcher);
};
}
/**
* Apply the XPath and assert the {@link String} value found.
*/
public ResultMatcher string(final String expectedValue) {
return result -> {
MockHttpServletResponse response = result.getResponse();
this.xpathHelper.assertString(response.getContentAsByteArray(), getDefinedEncoding(response), expectedValue);
};
}
/**
* Evaluate the XPath and assert the {@link Double} value found with the
* given Hamcrest {@link Matcher}.
*/
public ResultMatcher number(final Matcher<? super Double> matcher) {
return result -> {
MockHttpServletResponse response = result.getResponse();
this.xpathHelper.assertNumber(response.getContentAsByteArray(), getDefinedEncoding(response), matcher);
};
}
/**
* Evaluate the XPath and assert the {@link Double} value found.
*/
public ResultMatcher number(final Double expectedValue) {
return result -> {
MockHttpServletResponse response = result.getResponse();
this.xpathHelper.assertNumber(response.getContentAsByteArray(), getDefinedEncoding(response), expectedValue);
};
}
/**
* Evaluate the XPath and assert the {@link Boolean} value found.
*/
public ResultMatcher booleanValue(final Boolean value) {
return result -> {
MockHttpServletResponse response = result.getResponse();
this.xpathHelper.assertBoolean(response.getContentAsByteArray(), getDefinedEncoding(response), value);
};
}
}