diff --git a/spring-test/src/main/java/org/springframework/test/util/XpathExpectationsHelper.java b/spring-test/src/main/java/org/springframework/test/util/XpathExpectationsHelper.java index 6c5a61cd3f2487f06a4f6d5f53197751bbb3535c..028d8b06c5cab16e185c1dc95063aee80982e365 100644 --- a/spring-test/src/main/java/org/springframework/test/util/XpathExpectationsHelper.java +++ b/spring-test/src/main/java/org/springframework/test/util/XpathExpectationsHelper.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2018 the original author or authors. + * 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. @@ -103,6 +103,19 @@ public class XpathExpectationsHelper { MatcherAssert.assertThat("XPath " + this.expression, node, matcher); } + /** + * Parse the content, evaluate the XPath expression as a {@link NodeList}, + * and assert it with the given {@code Matcher}. + * @since 5.2.2 + */ + public void assertNodeList(byte[] content, @Nullable String encoding, final Matcher matcher) + throws Exception { + + Document document = parseXmlByteArray(content, encoding); + NodeList nodeList = evaluateXpath(document, XPathConstants.NODESET, NodeList.class); + MatcherAssert.assertThat("XPath " + this.getXpathExpression(), nodeList, matcher); + } + /** * Apply the XPath expression and assert the resulting content exists. * @throws Exception if content parsing or expression evaluation fails diff --git a/spring-test/src/main/java/org/springframework/test/web/servlet/result/XpathResultMatchers.java b/spring-test/src/main/java/org/springframework/test/web/servlet/result/XpathResultMatchers.java index 15eebbfcae97659b8d42bfe2cb99f80b2f8ee701..0010ec9dabea3054d4bd1ff9df7bb615cb8a1179 100644 --- a/spring-test/src/main/java/org/springframework/test/web/servlet/result/XpathResultMatchers.java +++ b/spring-test/src/main/java/org/springframework/test/web/servlet/result/XpathResultMatchers.java @@ -22,6 +22,7 @@ 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; @@ -69,6 +70,18 @@ public class XpathResultMatchers { }; } + /** + * Evaluate the XPath and assert the {@link NodeList} content found with the + * given Hamcrest {@link Matcher}. + * @since 5.2.2 + */ + public ResultMatcher nodeList(final Matcher 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. */ diff --git a/spring-test/src/test/java/org/springframework/test/web/servlet/result/XpathResultMatchersTests.java b/spring-test/src/test/java/org/springframework/test/web/servlet/result/XpathResultMatchersTests.java index f62ca5e4e2db0ed03ac4d94830cdf5570fd4fbc5..7a61272472ab51ac6b059195e0f7fd60d0a2a45a 100644 --- a/spring-test/src/test/java/org/springframework/test/web/servlet/result/XpathResultMatchersTests.java +++ b/spring-test/src/test/java/org/springframework/test/web/servlet/result/XpathResultMatchersTests.java @@ -43,18 +43,29 @@ public class XpathResultMatchersTests { } @Test - public void nodeNoMatch() throws Exception { + public void nodeNoMatch() { assertThatExceptionOfType(AssertionError.class).isThrownBy(() -> new XpathResultMatchers("/foo/bar", null).node(Matchers.nullValue()).match(getStubMvcResult())); } + @Test + public void nodeList() throws Exception { + new XpathResultMatchers("/foo/bar", null).nodeList(Matchers.notNullValue()).match(getStubMvcResult()); + } + + @Test + public void nodeListNoMatch() { + assertThatExceptionOfType(AssertionError.class).isThrownBy(() -> + new XpathResultMatchers("/foo/bar", null).nodeList(Matchers.nullValue()).match(getStubMvcResult())); + } + @Test public void exists() throws Exception { new XpathResultMatchers("/foo/bar", null).exists().match(getStubMvcResult()); } @Test - public void existsNoMatch() throws Exception { + public void existsNoMatch() { assertThatExceptionOfType(AssertionError.class).isThrownBy(() -> new XpathResultMatchers("/foo/Bar", null).exists().match(getStubMvcResult())); } @@ -65,7 +76,7 @@ public class XpathResultMatchersTests { } @Test - public void doesNotExistNoMatch() throws Exception { + public void doesNotExistNoMatch() { assertThatExceptionOfType(AssertionError.class).isThrownBy(() -> new XpathResultMatchers("/foo/bar", null).doesNotExist().match(getStubMvcResult())); } @@ -76,7 +87,7 @@ public class XpathResultMatchersTests { } @Test - public void nodeCountNoMatch() throws Exception { + public void nodeCountNoMatch() { assertThatExceptionOfType(AssertionError.class).isThrownBy(() -> new XpathResultMatchers("/foo/bar", null).nodeCount(1).match(getStubMvcResult())); } @@ -87,7 +98,7 @@ public class XpathResultMatchersTests { } @Test - public void stringNoMatch() throws Exception { + public void stringNoMatch() { assertThatExceptionOfType(AssertionError.class).isThrownBy(() -> new XpathResultMatchers("/foo/bar[1]", null).string("112").match(getStubMvcResult())); } @@ -98,7 +109,7 @@ public class XpathResultMatchersTests { } @Test - public void numberNoMatch() throws Exception { + public void numberNoMatch() { assertThatExceptionOfType(AssertionError.class).isThrownBy(() -> new XpathResultMatchers("/foo/bar[1]", null).number(111.1).match(getStubMvcResult())); } @@ -109,7 +120,7 @@ public class XpathResultMatchersTests { } @Test - public void booleanValueNoMatch() throws Exception { + public void booleanValueNoMatch() { assertThatExceptionOfType(AssertionError.class).isThrownBy(() -> new XpathResultMatchers("/foo/bar[2]", null).booleanValue(false).match(getStubMvcResult())); }