2 * Copyright 2005-2010 the original author or authors.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
16 package org.wamblee.xml;
18 import java.io.Serializable;
19 import java.util.Collections;
20 import java.util.Comparator;
21 import java.util.List;
23 import java.util.TreeMap;
25 import junit.framework.TestCase;
27 import org.dom4j.Attribute;
28 import org.dom4j.Document;
29 import org.dom4j.Element;
32 * XML test support utilities.
34 * @author Erik Brakkee
36 public final class XmlUtils {
38 * Disabled constructor.
46 * Checks equality of two XML documents excluding comment and processing
47 * nodes and trimming the text of the elements. In case of problems, it
48 * provides an xpath-like expression describing where the problem is.
54 public static void assertEquals(String aMsg,
55 org.w3c.dom.Document aExpected, org.w3c.dom.Document aActual) {
56 assertEquals(aMsg, DomUtils.convert(aExpected), DomUtils
61 * Checks equality of two XML documents excluding comment and processing
62 * nodes and trimming the text of the elements. In case of problems, it
63 * provides an xpath-like expression describing where the problem is.
69 public static void assertEquals(String aMsg, Document aExpected,
71 assertEquals(aMsg + "/" + aExpected.getRootElement().getName(),
72 aExpected.getRootElement(), aActual.getRootElement());
76 * Checks equality of two XML elements excluding comment and processing
77 * nodes and trimming the text of the elements. In case of problems, it
78 * provides an xpath-like expression describing where the problem is.
84 public static void assertEquals(String aMsg, Element aExpected,
87 TestCase.assertEquals(aMsg + "/name()", aExpected.getName(), aActual
91 TestCase.assertEquals(aMsg + "/text()", aExpected.getTextTrim(),
92 aActual.getTextTrim());
95 List<Attribute> expectedAttrs = aExpected.attributes();
96 Collections.sort(expectedAttrs, new AttributeComparator());
98 List<Attribute> actualAttrs = aActual.attributes();
99 Collections.sort(actualAttrs, new AttributeComparator());
101 TestCase.assertEquals("count(" + aMsg + "/@*)", expectedAttrs.size(),
104 for (int i = 0; i < expectedAttrs.size(); i++) {
105 String msg = aMsg + "/@" + expectedAttrs.get(i).getName();
106 assertEquals(msg, expectedAttrs.get(i), actualAttrs.get(i));
110 List<Element> expectedElems = aExpected.elements();
111 List<Element> actualElems = aActual.elements();
112 TestCase.assertEquals("count(" + aMsg + "/*)", expectedElems.size(),
115 // determine the how-manyth element of the given name we are at.
116 // Maps element name to the last used index (or null if not yet used)
117 Map<String, Integer> elementIndex = new TreeMap<String, Integer>();
119 for (int i = 0; i < expectedElems.size(); i++) {
120 String elemName = expectedElems.get(i).getName();
121 Integer index = elementIndex.get(elemName);
129 elementIndex.put(elemName, index);
131 String msg = aMsg + "/" + expectedElems.get(i).getName() + "[" +
134 assertEquals(msg, expectedElems.get(i), actualElems.get(i));
139 * Checks equality of two attributes. In case of problems, it provides an
140 * xpath-like expression describing where the problem is.
146 public static void assertEquals(String aMsg, Attribute aExpected,
148 TestCase.assertEquals(aMsg + ":name", aExpected.getName(), aActual
150 TestCase.assertEquals(aMsg + ":value", aExpected.getValue(), aActual
155 * Comparator which compares attributes by name.
157 private static final class AttributeComparator implements
158 Comparator<Attribute>, Serializable {
160 private static final long serialVersionUID = 7897287273519886301L;
165 * @see java.util.Comparator#compare(T, T)
167 public int compare(Attribute aAttribute1, Attribute aAttribute2) {
168 return aAttribute1.getName().compareTo(aAttribute2.getName());