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 junit.framework.TestCase;
20 import org.dom4j.Attribute;
21 import org.dom4j.Document;
22 import org.dom4j.Element;
24 import java.util.Collections;
25 import java.util.Comparator;
26 import java.util.List;
28 import java.util.TreeMap;
31 * XML test support utilities.
33 * @author Erik Brakkee
35 public final class XmlUtils {
37 * Disabled constructor.
45 * Checks equality of two XML documents excluding comment and processing
46 * nodes and trimming the text of the elements. In case of problems, it
47 * provides an xpath-like expression describing where the problem is.
53 public static void assertEquals(String aMsg,
54 org.w3c.dom.Document aExpected, org.w3c.dom.Document aActual) {
55 assertEquals(aMsg, DomUtils.convert(aExpected), DomUtils
60 * Checks equality of two XML documents excluding comment and processing
61 * nodes and trimming the text of the elements. In case of problems, it
62 * provides an xpath-like expression describing where the problem is.
68 public static void assertEquals(String aMsg, Document aExpected,
70 assertEquals(aMsg + "/" + aExpected.getRootElement().getName(),
71 aExpected.getRootElement(), aActual.getRootElement());
75 * Checks equality of two XML elements excluding comment and processing
76 * nodes and trimming the text of the elements. In case of problems, it
77 * provides an xpath-like expression describing where the problem is.
83 public static void assertEquals(String aMsg, Element aExpected,
86 TestCase.assertEquals(aMsg + "/name()", aExpected.getName(), aActual
90 TestCase.assertEquals(aMsg + "/text()", aExpected.getTextTrim(),
91 aActual.getTextTrim());
94 List<Attribute> expectedAttrs = aExpected.attributes();
95 Collections.sort(expectedAttrs, new AttributeComparator());
97 List<Attribute> actualAttrs = aActual.attributes();
98 Collections.sort(actualAttrs, new AttributeComparator());
100 TestCase.assertEquals("count(" + aMsg + "/@*)", expectedAttrs.size(),
103 for (int i = 0; i < expectedAttrs.size(); i++) {
104 String msg = aMsg + "/@" + expectedAttrs.get(i).getName();
105 assertEquals(msg, expectedAttrs.get(i), actualAttrs.get(i));
109 List<Element> expectedElems = aExpected.elements();
110 List<Element> actualElems = aActual.elements();
111 TestCase.assertEquals("count(" + aMsg + "/*)", expectedElems.size(),
114 // determine the how-manyth element of the given name we are at.
115 // Maps element name to the last used index (or null if not yet used)
116 Map<String, Integer> elementIndex = new TreeMap<String, Integer>();
118 for (int i = 0; i < expectedElems.size(); i++) {
119 String elemName = expectedElems.get(i).getName();
120 Integer index = elementIndex.get(elemName);
128 elementIndex.put(elemName, index);
130 String msg = aMsg + "/" + expectedElems.get(i).getName() + "[" +
133 assertEquals(msg, expectedElems.get(i), actualElems.get(i));
138 * Checks equality of two attributes. In case of problems, it provides an
139 * xpath-like expression describing where the problem is.
145 public static void assertEquals(String aMsg, Attribute aExpected,
147 TestCase.assertEquals(aMsg + ":name", aExpected.getName(), aActual
149 TestCase.assertEquals(aMsg + ":value", aExpected.getValue(), aActual
154 * Comparator which compares attributes by name.
156 private static final class AttributeComparator implements
157 Comparator<Attribute> {
161 * @see java.util.Comparator#compare(T, T)
163 public int compare(Attribute aAttribute1, Attribute aAttribute2) {
164 return aAttribute1.getName().compareTo(aAttribute2.getName());