* 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.wamblee.xml;
import java.util.Collections;
import java.util.Comparator;
import java.util.List;
+import java.util.Map;
+import java.util.TreeMap;
import junit.framework.TestCase;
import org.dom4j.Document;
import org.dom4j.Element;
-
-
/**
- * XML test support utilities.
+ * XML test support utilities.
*/
public final class XmlUtils {
/**
- * Disabled constructor.
- *
+ * Disabled constructor.
+ *
*/
- private XmlUtils() {
+ private XmlUtils() {
// Empty
}
-
+
+ /**
+ * Checks equality of two XML documents excluding comment and processing
+ * nodes and trimming the text of the elements. In case of problems, it
+ * provides an xpath-like expression describing where the problem is.
+ *
+ * @param aMsg
+ * @param aExpected
+ * @param aActual
+ */
+ public static void assertEquals(String aMsg,
+ org.w3c.dom.Document aExpected, org.w3c.dom.Document aActual) {
+ assertEquals(aMsg, DomUtils.convert(aExpected), DomUtils
+ .convert(aActual));
+ }
+
/**
- * Checks equality of two XML documents excluding comment and processing nodes and
- * trimming the text of the elements.
+ * Checks equality of two XML documents excluding comment and processing
+ * nodes and trimming the text of the elements. In case of problems, it
+ * provides an xpath-like expression describing where the problem is.
+ *
* @param aMsg
* @param aExpected
* @param aActual
*/
- public static void assertEquals(String aMsg, Document aExpected, Document aActual) {
- assertEquals(aMsg, aExpected.getRootElement(), aActual.getRootElement());
+ public static void assertEquals(String aMsg, Document aExpected,
+ Document aActual) {
+ assertEquals(aMsg + "/" + aExpected.getRootElement().getName(), aExpected.getRootElement(), aActual.getRootElement());
}
-
+
/**
- * Checks equality of two XML elements excluding comment and processing nodes and trimming
- * the text of the elements.
+ * Checks equality of two XML elements excluding comment and processing
+ * nodes and trimming the text of the elements. In case of problems, it
+ * provides an xpath-like expression describing where the problem is.
+ *
* @param aMsg
* @param aExpected
* @param aActual
*/
- public static void assertEquals(String aMsg, Element aExpected, Element aActual) {
-
+ public static void assertEquals(String aMsg, Element aExpected,
+ Element aActual) {
+
// Name.
- TestCase.assertEquals(aMsg + "/name()", aExpected.getName(), aActual.getName());
-
+ TestCase.assertEquals(aMsg + "/name()", aExpected.getName(), aActual
+ .getName());
+
// Text
- TestCase.assertEquals(aMsg + "/text()", aExpected.getTextTrim(), aActual.getTextTrim());
-
+ TestCase.assertEquals(aMsg + "/text()", aExpected.getTextTrim(),
+ aActual.getTextTrim());
+
// Attributes
- List<Attribute> expectedAttrs = aExpected.attributes();
+ List<Attribute> expectedAttrs = aExpected.attributes();
Collections.sort(expectedAttrs, new AttributeComparator());
- List<Attribute> actualAttrs = aActual.attributes();
+ List<Attribute> actualAttrs = aActual.attributes();
Collections.sort(actualAttrs, new AttributeComparator());
-
- TestCase.assertEquals(aMsg + "/#attributes", expectedAttrs.size(), actualAttrs.size());
- for (int i = 0; i < expectedAttrs.size(); i++) {
- String msg = aMsg + "/attribute(" + i + ")";
+
+ TestCase.assertEquals(aMsg + "/count(@*)", expectedAttrs.size(),
+ actualAttrs.size());
+ for (int i = 0; i < expectedAttrs.size(); i++) {
+ String msg = aMsg + "/@" + expectedAttrs.get(i).getName();
assertEquals(msg, expectedAttrs.get(i), actualAttrs.get(i));
}
-
- // Nested elements.
+
+ // Nested elements.
List<Element> expectedElems = aExpected.elements();
- List<Element> actualElems = aActual.elements();
- TestCase.assertEquals(aMsg + "/#elements", expectedElems.size(), actualElems.size());
- for (int i = 0; i < expectedElems.size(); i++) {
- String msg = aMsg + "/element(" + i + ")";
+ List<Element> actualElems = aActual.elements();
+ TestCase.assertEquals(aMsg + "/count(*)", expectedElems.size(),
+ actualElems.size());
+ // determine the how-manyth element of the given name we are at.
+ // Maps element name to the last used index (or null if not yet used)
+ Map<String, Integer> elementIndex = new TreeMap<String, Integer>();
+ for (int i = 0; i < expectedElems.size(); i++) {
+ String elemName = expectedElems.get(i).getName();
+ Integer index = elementIndex.get(elemName);
+ if (index == null) {
+ index = 1;
+ } else {
+ index++;
+ }
+ elementIndex.put(elemName, index);
+ String msg = aMsg + "/" + expectedElems.get(i).getName() + "["
+ + index + "]";
+
assertEquals(msg, expectedElems.get(i), actualElems.get(i));
}
}
-
+
/**
- * Checks equality of two attributes.
+ * Checks equality of two attributes. In case of problems, it
+ * provides an xpath-like expression describing where the problem is.
+ *
* @param aMsg
* @param aExpected
* @param aActual
*/
- public static void assertEquals(String aMsg, Attribute aExpected, Attribute aActual) {
- TestCase.assertEquals(aMsg + "@", aExpected.getName() + ":name", aActual.getName());
- TestCase.assertEquals(aMsg + "@" + aExpected.getName() + ":value",
- aExpected.getValue(), aActual.getValue());
+ public static void assertEquals(String aMsg, Attribute aExpected,
+ Attribute aActual) {
+ TestCase.assertEquals(aMsg + ":name", aExpected.getName(), aActual
+ .getName());
+ TestCase.assertEquals(aMsg + ":value", aExpected.getValue(), aActual
+ .getValue());
}
-
+
/**
- * Comparator which compares attributes by name.
+ * Comparator which compares attributes by name.
*/
- private static final class AttributeComparator implements Comparator<Attribute> {
- /* (non-Javadoc)
+ private static final class AttributeComparator implements
+ Comparator<Attribute> {
+ /*
+ * (non-Javadoc)
+ *
* @see java.util.Comparator#compare(T, T)
*/
public int compare(Attribute aAttribute1, Attribute aAttribute2) {