The utilities find the difference between two XML files and support merging a baseline with a difference file.
The motivation is that ordinary line difference programs are not suitable for XML. In XML, order of attributes is always insignificant while an ordinary diff program would show changed order as a difference. In XML, element order is significant for a sequence but not for other uses. The utilities work on any XML files; they are not XML-schema aware. Element order is handled by a switch; it can either be considered significant or insignificant.
These utilities make use of a difference format conformant to standard "An Extensible Markup Language (XML) Patch Operations Framework Utilizing XML Path Language (XPath) Selectors", IETF RFC 5261. Another benefit of these utilities, aside from editing Orchestra files, is that they can be used for HTTP PATCH operations with XML payloads.
The patch format has no way to show moves. If element order is considered, then a move will be displayed as an add and remove.
The XmlDiff utility compares two XML files and generates a third file that represents their differences in RFC 5261 format. Differences are encoded as additions, replacements, or removals of XML elements and attributes.
To run the difference utility, run this command line:
java -jar diff-merge-1.5.1-SNAPSHOT-jar-with-dependencies.jar <arguments>
Usage: XmlDiff <xml-file1> <xml-file2> [diff-file] [-e event-file] [-u|-o]
diff-file defaults to console -u=unordered elements -o=ordered elements
If the output file is not provided, then results go to the console.
Optionally, argument -e <event-filename> can direct errors to a JSON file suitable for UI rendering.
Optionally, argument -u treats XML nodes as unordered so moves among children are not considered significant. Otherwise, a move will result in an add and a remove operation.
The XmlMerge utility takes a base XML file and a difference file and merges the two to produce a new XML file.
To run the merge utility, run this command line:
java io.fixprotocol.xml.XmlMerge <base-xml-file> <diff-file> <output-xml-file>
Optionally, argument -e <event-filename> can direct errors to a JSON file suitable for UI rendering.
The merge utility attempts to continue even if errors occur. Examples of logged errors:
11:12:53.019 [main] ERROR io.fixprotocol.xml.XmlMerge - Target not found for add; /foo
11:12:53.035 [main] ERROR io.fixprotocol.xml.XmlMerge - Invalid XPath expression for remove; /aaa/fff[
© Copyright 2017-2021 FIX Protocol Limited
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, 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.