Switch to xml-simple for document comparison #1567
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
e54db93 to
1243f76
Compare
The switch to compare-xml exhibits non intuitive behaviour in that comparing without use of verbose mode does not detect documents that are identical. The if statement allowed the tests to pass but reads that if the documents compare as true then emit an error message and raise an exception. Since there were concerns about equivalent-xml not being active upstream raised by a distribution maintainer, switching back should be avoided. Attempted use of nokogiri-diff indicated that whitespace changes would be treated as differences with it being unclear how to easily exclude. Moving to xml-simple, which although will treat whitespace as significant and even with NormaliseSpace set to disregard any whitespace around content elements, it requires walking the returned structure to remove the empty content attribute that is left behind to allow a direct comparison between the data structures. To ensure the XML comparison is validated add a test where libvirt returns XML that is different to what was requested, and assert that the expected error is raised, an error message emitted and that the domain define would be reverted to the previous state if possible. Relates-To: #1565 Fixes: #1556
1243f76 to
5b5cd7f
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The switch to compare-xml exhibits non intuitive behaviour in that
comparing without use of verbose mode does not detect documents that are
identical. The if statement allowed the tests to pass but reads that if
the documents compare as true then emit an error message and raise an
exception. However this is because it returns false even with the docs
are the same content. Unfortunately there was no pre-existing test
case added when
Since there were concerns about equivalent-xml not being active upstream
raised by a distribution maintainer, switching back should be avoided.
Attempted use of nokogiri-diff indicated that whitespace changes would
be treated as differences with it being unclear how to easily exclude.
Moving to xml-simple, which although will treat whitespace as
significant and even with NormaliseSpace set to disregard any whitespace
around content elements, it requires walking the returned structure to
remove the empty content attribute that is left behind to allow a direct
comparison between the data structures.
To ensure the XML comparison is validated add a test where libvirt
returns XML that is different to what was requested, and assert that
the expected error is raised, an error message emitted and that the
domain define would be reverted to the previous state if possible.
Relates-To: #1565
Fixes: #1556