add xml diff with tolerance

 # Changes to be committed:

test/Library_test.mk

@@ -38,6 +38,10 @@ $(eval $(call gb_Library_use_api,test,\
     udkapi \
 ))
 
+$(eval $(call gb_Library_use_externals,test,\
+	libxml2 \
+))
+
 $(eval $(call gb_Library_use_libraries,test,\
     comphelper \
     cppu \
@@ -63,6 +67,7 @@ $(eval $(call gb_Library_use_external,test,cppunit))
 
 $(eval $(call gb_Library_add_exception_objects,test,\
     test/source/bootstrapfixture \
+    test/source/diff/diff \
 ))
 
 # vim: set noet sw=4 ts=4:

test/Package_inc.mk

@@ -26,6 +26,7 @@
 # instead of those above.
 
 $(eval $(call gb_Package_Package,test_inc,$(SRCDIR)/test/inc))
+$(eval $(call gb_Package_add_file,test_inc,inc/test/xmldiff.hxx,test/xmldiff.hxx))
 $(eval $(call gb_Package_add_file,test_inc,inc/test/bootstrapfixture.hxx,test/bootstrapfixture.hxx))
 $(eval $(call gb_Package_add_file,test_inc,inc/test/testdllapi.hxx,test/testdllapi.hxx))
 $(eval $(call gb_Package_add_file,test_inc,inc/test/unoapi_test.hxx,test/unoapi_test.hxx))

test/inc/test/xmldiff.hxx

+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * Version: MPL 1.1 / GPLv3+ / LGPLv3+
+ *
+ * The contents of this file are subject to the Mozilla Public License Version
+ * 1.1 (the "License"); you may not use this file except in compliance with
+ * the License or as specified alternatively below. You may obtain a copy of
+ * the License at http://www.mozilla.org/MPL/
+ *
+ * Software distributed under the License is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
+ * for the specific language governing rights and limitations under the
+ * License.
+ *
+ * Major Contributor(s):
+ * Copyright (C) 2012 Markus Mohrhard <markus.mohrhard@googlemail.com> (initial developer)
+ *
+ * All Rights Reserved.
+ *
+ * For minor contributions see the git repository.
+ *
+ * Alternatively, the contents of this file may be used under the terms of
+ * either the GNU General Public License Version 3 or later (the "GPLv3+"), or
+ * the GNU Lesser General Public License Version 3 or later (the "LGPLv3+"),
+ * in which case the provisions of the GPLv3+ or the LGPLv3+ are applicable
+ * instead of those above.
+ */
+
+#include <libxml/parser.h>
+#include <libxml/tree.h>
+#include <libxml/xmlmemory.h>
+#include <string>
+#include <set>
+
+struct tolerance
+{
+    ~tolerance()
+    {
+        xmlFree(elementName);
+        xmlFree(attribName);
+    }
+
+    tolerance() {}
+
+    tolerance(const tolerance& tol)
+    {
+        elementName = xmlStrdup(tol.elementName);
+        attribName = xmlStrdup(tol.attribName);
+        relative = tol.relative;
+        value = tol.value;
+    }
+
+    xmlChar* elementName;
+    xmlChar* attribName;
+    bool relative;
+    double value;
+    bool operator==(const tolerance& rTol) const { return xmlStrEqual(elementName, rTol.elementName) && xmlStrEqual(attribName, rTol.attribName); }
+    bool operator<(const tolerance& rTol) const
+    {
+        int cmp = xmlStrcmp(elementName, rTol.elementName);
+        if(cmp == 0)
+        {
+            cmp = xmlStrcmp(attribName, rTol.attribName);
+        }
+
+        if(cmp>=0)
+            return false;
+        else
+            return true;
+    }
+};
+
+class XMLDiff
+{
+public:
+    XMLDiff(const std::string& file1, const std::string& file2, const std::string& toleranceFile);
+    XMLDiff(const std::string& file1, const std::string& file2);
+    ~XMLDiff();
+
+    bool compare();
+private:
+    typedef std::set<tolerance> ToleranceContainer;
+
+    void loadToleranceFile(xmlDocPtr xmlTolerance);
+    bool compareAttributes(xmlNodePtr node1, xmlNodePtr node2);
+    bool compareElements(xmlNodePtr node1, xmlNodePtr node2);
+
+    ToleranceContainer toleranceContainer;
+    xmlDocPtr xmlFile1;
+    xmlDocPtr xmlFile2;
+};
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */

test/source/diff/diff.cxx

+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * Version: MPL 1.1 / GPLv3+ / LGPLv3+
+ *
+ * The contents of this file are subject to the Mozilla Public License Version
+ * 1.1 (the "License"); you may not use this file except in compliance with
+ * the License or as specified alternatively below. You may obtain a copy of
+ * the License at http://www.mozilla.org/MPL/
+ *
+ * Software distributed under the License is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
+ * for the specific language governing rights and limitations under the
+ * License.
+ *
+ * Major Contributor(s):
+ * Copyright (C) 2012 Markus Mohrhard <markus.mohrhard@googlemail.com> (initial developer)
+ *
+ * All Rights Reserved.
+ *
+ * For minor contributions see the git repository.
+ *
+ * Alternatively, the contents of this file may be used under the terms of
+ * either the GNU General Public License Version 3 or later (the "GPLv3+"), or
+ * the GNU Lesser General Public License Version 3 or later (the "LGPLv3+"),
+ * in which case the provisions of the GPLv3+ or the LGPLv3+ are applicable
+ * instead of those above.
+ */
+
+
+#include "test/xmldiff.hxx"
+#include <libxml/xpath.h>
+#include <cstring>
+#include <cmath>
+#include <cassert>
+
+#if USE_CPPUNIT
+#include <cppunit/extensions/HelperMacros.h>
+#endif
+
+XMLDiff::XMLDiff(const std::string& file1, const std::string& file2, const std::string& toleranceFile)
+{
+    xmlFile1 = xmlParseFile(file1.c_str());
+    xmlFile2 = xmlParseFile(file2.c_str());
+
+    xmlDocPtr xmlToleranceFile = xmlParseFile(toleranceFile.c_str());
+
+    loadToleranceFile(xmlToleranceFile);
+    xmlFreeDoc(xmlToleranceFile);
+}
+
+XMLDiff::XMLDiff(const std::string& file1, const std::string& file2)
+{
+    xmlFile1 = xmlParseFile(file1.c_str());
+    xmlFile2 = xmlParseFile(file2.c_str());
+}
+
+XMLDiff::~XMLDiff()
+{
+    xmlFreeDoc(xmlFile1);
+    xmlFreeDoc(xmlFile2);
+}
+
+namespace {
+
+void readAttributesForTolerance(xmlNodePtr node, tolerance& tol)
+{
+    xmlChar* elementName = xmlGetProp(node, BAD_CAST("elementName"));
+    tol.elementName = elementName;
+
+    xmlChar* attribName = xmlGetProp(node, BAD_CAST("attribName"));
+    tol.attribName = attribName;
+
+    xmlChar* value = xmlGetProp(node, BAD_CAST("value"));
+    double val = xmlXPathCastStringToNumber(value);
+    xmlFree(value);
+    tol.value = val;
+
+    xmlChar* relative = xmlGetProp(node, BAD_CAST("relative"));
+    bool rel = xmlXPathCastStringToBoolean(relative);
+    xmlFree(relative);
+    tol.relative = rel;
+}
+
+}
+
+void XMLDiff::loadToleranceFile(xmlDocPtr xmlToleranceFile)
+{
+    xmlNodePtr root = xmlDocGetRootElement(xmlToleranceFile);
+#if USE_CPPUNIT
+    CPPUNIT_ASSERT_MESSAGE("did not find tolerance file", xmlStrEqual( root->name, BAD_CAST("tolerances") ));
+#else
+    if(!xmlStrEqual( root->name, BAD_CAST("tolerances") ))
+    {
+        assert(false);
+        return;
+    }
+#endif
+    xmlNodePtr child = NULL;
+    for (child = root->children; child != NULL; child = child->next)
+    {
+        // assume a valid xml file
+        if(child->type != XML_ELEMENT_NODE)
+            continue;
+
+        assert(xmlStrEqual(child->name, BAD_CAST("tolerance")));
+
+        tolerance tol;
+        readAttributesForTolerance(child, tol);
+        toleranceContainer.insert(tol);
+    }
+}
+
+bool XMLDiff::compare()
+{
+    xmlNode* root1 = xmlDocGetRootElement(xmlFile1);
+    xmlNode* root2 = xmlDocGetRootElement(xmlFile2);
+
+#if USE_CPPUNIT
+    CPPUNIT_ASSERT(root1);
+    CPPUNIT_ASSERT(root2);
+    CPPUNIT_ASSERT(xmlStrEqual(root1->name, root2->name));
+#else
+    if (!root1 || !root2)
+        return false;
+    if(!xmlStrEqual(root1->name, root2->name))
+        return false;
+#endif
+    return compareElements(root1, root2);
+}
+
+namespace {
+
+bool checkForEmptyChildren(xmlNodePtr node)
+{
+    if(!node)
+        return true;
+
+    for(; node != NULL; node = node->next)
+    {
+        if (node->type == XML_ELEMENT_NODE)
+            return false;
+    }
+    return true;
+}
+
+}
+
+bool XMLDiff::compareElements(xmlNode* node1, xmlNode* node2)
+{
+#if USE_CPPUNIT
+    CPPUNIT_ASSERT(xmlStrEqual( node1->name, node2->name ));
+#else
+    if (!xmlStrEqual( node1->name, node2->name ))
+        return false;
+#endif
+
+    //compare attributes
+    bool sameAttribs = compareAttributes(node1, node2);
+#if USE_CPPUNIT
+    CPPUNIT_ASSERT(sameAttribs);
+#else
+    if (!sameAttribs)
+        return false;
+#endif
+
+    // compare children
+    xmlNode* child2 = NULL;
+    xmlNode* child1 = NULL;
+    for(child1 = node1->children, child2 = node2->children; child1 != NULL && child2 != NULL; child1 = child1->next, child2 = child2->next)
+    {
+        if (child1->type == XML_ELEMENT_NODE)
+        {
+            bool bCompare = compareElements(child1, child2);
+            if(!bCompare)
+            {
+                return false;
+            }
+        }
+    }
+
+#if USE_CPPUNIT
+    CPPUNIT_ASSERT(checkForEmptyChildren(child1));
+    CPPUNIT_ASSERT(checkForEmptyChildren(child2));
+#else
+    if(!checkForEmptyChildren(child1) || !checkForEmptyChildren(child2))
+        return false;
+#endif
+
+    return true;
+}
+
+namespace {
+
+bool compareValuesWithTolerance(double val1, double val2, double tolerance, bool relative)
+{
+    if(relative)
+    {
+        return (val1/tolerance) <= val2 && val2 <= (val1*tolerance);
+    }
+    else
+    {
+        return (val1 - tolerance) <= val2 && val2 <= (val1 + tolerance);
+    }
+}
+
+}
+
+bool XMLDiff::compareAttributes(xmlNodePtr node1, xmlNodePtr node2)
+{
+    xmlAttrPtr attr1 = NULL;
+    xmlAttrPtr attr2 = NULL;
+    for(attr1 = node1->properties, attr2 = node2->properties; attr1 != NULL && attr2 != NULL; attr1 = attr1->next, attr2 = attr2->next)
+    {
+#if USE_CPPUNIT
+        CPPUNIT_ASSERT(xmlStrEqual( attr1->name, attr2->name ));
+#else
+        if (!xmlStrEqual( attr1->name, attr2->name ))
+            return false;
+#endif
+
+        xmlChar* val1 = xmlGetProp(node1, attr1->name);
+        xmlChar* val2 = xmlGetProp(node2, attr2->name);
+
+        double dVal1 = xmlXPathCastStringToNumber(val1);
+        double dVal2 = xmlXPathCastStringToNumber(val2);
+
+        if(!std::isnan(dVal1) || ! std::isnan(dVal2))
+        {
+            //compare by value and respect tolerance
+            tolerance tol;
+            tol.elementName = xmlStrdup(node1->name);
+            tol.attribName = xmlStrdup(attr1->name);
+            ToleranceContainer::iterator itr = toleranceContainer.find( tol );
+            bool useTolerance = false;
+            if (itr != toleranceContainer.end())
+            {
+                useTolerance = true;
+            }
+
+            if (useTolerance)
+            {
+                bool valInTolerance = compareValuesWithTolerance(dVal1, dVal2, itr->value, itr->relative);
+#if USE_CPPUNIT
+                CPPUNIT_ASSERT(valInTolerance);
+#else
+                if (!valInTolerance)
+                    return false;
+#endif
+            }
+            else
+            {
+#if USE_CPPUNIT
+            CPPUNIT_ASSERT_DOUBLES_EQUAL(dVal1, dVal2, 1e-08);
+#else
+                if (dVal1 != dVal2)
+                    return false;
+#endif
+            }
+        }
+        else
+        {
+
+#if USE_CPPUNIT
+        CPPUNIT_ASSERT(xmlStrEqual(val1, val2));
+#else
+        if(!xmlStrEqual( val1, val2 ))
+            return false;
+#endif
+        }
+
+        xmlFree(val1);
+        xmlFree(val2);
+    }
+
+    // unequal number of attributes
+#if CPPUNIT_ASSERT
+    CPPUNIT_ASSERT(!attr1);
+    CPPUNIT_ASSERT(!attr2);
+#else
+    if (attr1 || attr2)
+        return false;
+#endif
+
+    return true;
+}
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */