XML Pre Diff Tool

This is the ancestor of libxmldiff ; you should really consider using the new one but the method below is not uninteresting.


Why ?

Diff on XML files is a really tough problem, and there is few free solutions. Here is a method for using the standart unix diff command with xml files, with an understable result.

How ?

This method is based on the idea that for an xml diff to be usable, you must have the element changed, and all his ancestors. In order to use the standart diff tool, I set up a flat xml format which consists in putting on the same line the ancestors with their attributes, the element, the attributes and the value. For example :

will output in flat xml as

As you can see, all the ancestor information is summerized on a single line.

Limitations

  • Does not work with xml files with multi line contents.
  • Does not work with namespaces, or xml comments.
  • Does not restore xml declaration and encodings.
  • Does not work with flatxml lines of more than 65535 characters.
  • Is not very usefull when there is differences on root or top level elements.

Possible improvements

Main improvements possibilities rely on the filtering possibilities in the xsl files. For instance, in the previous example, the xsl file should have been set up to output a line only for the element child, because the two first lines are neither relevant nor usefull.

 

Tools

  • xml2flat.xsl : convert xml to a flat xml file. (MSXSL Tool)
  • flat2xml.exe : convert flat xml back to xml file. This is a win32 binary, but the code (flat2xml.cpp) should compile everywhere.
  • rediff.sh : with large files, diff sometimes find false differences. This script splits the results and rediff again. To use this under windows, check out cygwin environnement, or win32 unix tools.
  • undiff.sh : split the diff result in two files.

 

Usage

Just follow these steps :

  1. Remove from the xml file all information in the header you don’t want to see in the diff, like the timestamp of generated files…
  2. Convert both xml files to flat xml files, with the xml2flat.xsl provided (for instance, using xsltproc or cooktop). [file1.xml -> file1.txt and file2.xml -> file2.txt]
  3. Diff / Rediff the flat xml files. [./rediff.sh file1.txt file2.txt produces diff.txt]
  4. Undiff the result file, in two files. [./undiff.sh diff.txt diff.before.txt diff.after.txt]
  5. Convert back to xml files using flat2xml. [./flat2xml diff.before.txt diff.before.xml.]

You now have in the two xml files the only differences between them. You can no use visualization tools like IBM’s XML Diff (warning : this tool is no more free) to view these differences in a graphical view.

Using this method, you now have shrinked your source xml files to their only differences. This allow you to use standart xml diff tools (non free : IBM XML Diff, Delta XMl,…) with very large xml files (50Mb or more) containing few differences (30ko). With the large xml files these tools usually become unusable (unless you do have 5Go of memory), but will work properly with the shrinked files, providing you exactly the same results.

Leave a Reply

This site uses Akismet to reduce spam. Learn how your comment data is processed.

Close Menu