Fix XML Equality Check by Comparing Parsed XML Structure Instead of Raw Strings #3166
Conversation
This file contains 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
There was a problem hiding this comment.
Pull Request Overview
This PR improves XML equality comparisons by introducing a type-aware, structure-based check for XML documents, fixing false negatives caused by formatting differences. Key changes include:
- Adding a new AreXmlsEqual method for comparing XDocument objects.
- Incorporating the new XML comparison function into the equality dictionary.
- Updating tests to use XDocument-based comparisons instead of raw string comparisons.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| test/Microsoft.IdentityModel.TestUtils/IdentityComparer.cs | Introduces XML comparison functions and updates equality logic to support XDocument. |
| test/Microsoft.IdentityModel.Xml.Tests/DSigSerializerTests.cs | Modifies tests to compare XML by parsing into XDocument. |
Comments suppressed due to low confidence (2)
test/Microsoft.IdentityModel.TestUtils/IdentityComparer.cs:1189
- The AreXmlsEqual method adds a diff message when xml1 is null but does not return false, which can lead to a NullReferenceException when xml1.Root is accessed later. Consider returning false immediately after detecting a null xml1 and include a properly formatted error message.
if (xml1 == null) localContext.Diffs.Add($"({name1} == null, {name2} == {xml2.ToString()}." );
test/Microsoft.IdentityModel.TestUtils/IdentityComparer.cs:1192
- Similar to the null check for xml1, if xml2 is null the method only adds a diff message without returning false, which may cause a NullReferenceException when xml2.Root is accessed. Consider returning false immediately and correcting the error message formatting.
if (xml2 == null) localContext.Diffs.Add($"({name1} == {xml1.ToString()}, {name2} == null." );
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.
Fix XML Equality Check by Comparing Parsed XML Structure Instead of Raw Strings
Summary of the changes
Ensures XML comparisons are based on structure instead of raw string equality.
Description
Previously, the test compared XML as raw strings, which caused false negatives due to formatting differences, whitespace, and attribute order. While the expected result was different, the discrepancies were due to formatting rather than actual content differences. This fix ensures XML elements are compared meaningfully, preventing incorrect failures.
Fixes & Improvements:
AreXmlsEqualto handle XML documents as objects rather than raw strings.Fixes #3159