Integrated XML namespace support for XPath matcher

neildunn · neildunn · commit 65b1166161cb · 2007-11-17T12:45:07.000Z
diff --git a/hamcrest-library/src/main/java/org/hamcrest/xml/HasXPath.java b/hamcrest-library/src/main/java/org/hamcrest/xml/HasXPath.java
@@ -6,6 +6,7 @@
 import org.hamcrest.TypeSafeMatcher;
 import org.w3c.dom.Node;
 
+import javax.xml.namespace.NamespaceContext;
 import javax.xml.xpath.XPath;
 import javax.xml.xpath.XPathConstants;
 import javax.xml.xpath.XPathExpression;
@@ -29,8 +30,22 @@ public class HasXPath extends TypeSafeMatcher<Node> {
      *                     May be null to specify that the XPath must exist but the value is irrelevant.
      */
     public HasXPath(String xPathExpression, Matcher<String> valueMatcher) {
+	    this(xPathExpression, null, valueMatcher);
+	}
+
+    /**
+     * @param xPathExpression XPath expression.
+	 * @param namespaceContext Resolves XML namespace prefixes in the XPath expression
+     * @param valueMatcher Matcher to use at given XPath.
+     *                     May be null to specify that the XPath must exist but the value is irrelevant.
+     */
+    public HasXPath(String xPathExpression, NamespaceContext namespaceContext, Matcher<String> valueMatcher) {
         try {
             XPath xPath = XPathFactory.newInstance().newXPath();
+			if (namespaceContext != null)
+			{
+				xPath.setNamespaceContext(namespaceContext);
+			}
             compiledXPath = xPath.compile(xPathExpression);
             this.xpathString = xPathExpression;
             this.valueMatcher = valueMatcher;
@@ -63,12 +78,21 @@ public void describeTo(Description description) {
     
     @Factory
     public static Matcher<Node> hasXPath(String xPath, Matcher<String> valueMatcher) {
-        return new HasXPath(xPath, valueMatcher);
+        return hasXPath(xPath, null, valueMatcher);
+    }
+
+	@Factory
+    public static Matcher<Node> hasXPath(String xPath, NamespaceContext namespaceContext, Matcher<String> valueMatcher) {
+        return new HasXPath(xPath, namespaceContext, valueMatcher);
     }
 
     @Factory
     public static Matcher<Node> hasXPath(String xPath) {
-        return hasXPath(xPath, null);
+        return hasXPath(xPath, null, null);
     }
 
+	@Factory
+    public static Matcher<Node> hasXPath(String xPath, NamespaceContext namespaceContext) {
+        return hasXPath(xPath, namespaceContext, null);
+    }
 }
diff --git a/hamcrest-unit-test/src/main/java/org/hamcrest/xml/HasXPathTest.java b/hamcrest-unit-test/src/main/java/org/hamcrest/xml/HasXPathTest.java
@@ -9,9 +9,12 @@
 import static org.hamcrest.xml.HasXPath.hasXPath;
 import org.w3c.dom.Document;
 
+import javax.xml.namespace.NamespaceContext;
 import javax.xml.parsers.DocumentBuilder;
 import javax.xml.parsers.DocumentBuilderFactory;
 import java.io.ByteArrayInputStream;
+import java.util.HashSet;
+import java.util.Iterator;
 
 /**
  * @author Joe Walnes
@@ -25,6 +28,7 @@ protected void setUp() throws Exception {
                 + "<root type='food'>\n"
                 + "  <something id='a'><cheese>Edam</cheese></something>\n"
                 + "  <something id='b'><cheese>Cheddar</cheese></something>\n"
+				+ "  <f:foreignSomething xmlns:f=\"http://cheese.com\" milk=\"camel\">Caravane</f:foreignSomething>\n"
                 + "</root>\n"
         );
     }
@@ -47,6 +51,31 @@ public void testFailsIfNodeIsMissing() throws Exception {
         assertThat(xml, not(hasXPath("//something[@id='c']/cheese")));
     }
 
+	public void testMatchesWithNamespace() throws Exception {
+		NamespaceContext ns = new NamespaceContext() {
+            public String getNamespaceURI(String prefix) {
+			    return ("cheese".equals(prefix) ? "http://cheese.com" : null);
+			}
+
+			public String getPrefix(String namespaceURI) {
+			    return ("http://cheese.com".equals(namespaceURI) ? "cheese" : null);
+			}
+
+			public Iterator getPrefixes(String namespaceURI) {
+			    HashSet<String> prefixes = new HashSet<String>();
+				String prefix = getPrefix(namespaceURI);
+				if (prefix != null)	{
+					prefixes.add(prefix);
+				}
+				return prefixes.iterator();
+			}
+		};
+
+        assertThat(xml, hasXPath("//cheese:foreignSomething", ns));
+		assertThat(xml, hasXPath("//cheese:foreignSomething/@milk", ns, equalTo("camel")));
+        assertThat(xml, hasXPath("//cheese:foreignSomething/text()", ns, equalTo("Caravane")));
+	}
+
     public void testThrowsIllegalArgumentExceptionIfGivenIllegalExpression() {
         try {
             hasXPath("\\g:dfgd::DSgf/root/something[2]/cheese", equalTo("blah"));
@@ -65,6 +94,7 @@ public void testDescribesItself() throws Exception {
 
     private Document parse(String xml) throws Exception {
         DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
+		documentBuilderFactory.setNamespaceAware(true);
         DocumentBuilder documentBuilder = documentBuilderFactory.newDocumentBuilder();
         return documentBuilder.parse(new ByteArrayInputStream(xml.getBytes()));
     }
