Skip to content

Add Assert.AreEquivalent for deep structural comparison #8266

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Evangelink merged 8 commits into from
May 16, 2026
Merged

Add Assert.AreEquivalent for deep structural comparison #8266

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
523f1fd
Add Assert.AreEquivalent for deep structural comparison
Evangelink May 15, 2026
19b9599
Address AreEquivalent review feedback
Evangelink May 15, 2026
8f73a91
Tighten AreEquivalent RFC test
Evangelink May 15, 2026
d1910d0
Address AreEquivalent review feedback
Evangelink May 15, 2026
c7ec8ee
Fix IDE0046 build errors and align AreNotEquivalent evidence label wi…
Evangelink May 16, 2026
50b5c61
Address expert-review findings: RFC 012 alignment and equivalence com…
Evangelink May 16, 2026
fe26ee2
Address round-2 expert-review findings on AreEquivalent
Evangelink May 16, 2026
f2417ff
Use ExceptionDispatchInfo to preserve stack trace when rethrowing use…
Evangelink May 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1,248 changes: 1,248 additions & 0 deletions src/TestFramework/TestFramework/Assertions/Assert.AreEquivalent.Comparer.cs
View file
Open in desktop

Large diffs are not rendered by default.

347 changes: 347 additions & 0 deletions src/TestFramework/TestFramework/Assertions/Assert.AreEquivalent.cs
View file
Open in desktop

Large diffs are not rendered by default.

4 changes: 4 additions & 0 deletions src/TestFramework/TestFramework/PublicAPI/PublicAPI.Unshipped.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,7 @@
[MSTESTEXP]static Microsoft.VisualStudio.TestTools.UnitTesting.Assert.Scope() -> System.IDisposable!
Microsoft.VisualStudio.TestTools.UnitTesting.AssertFailedException.ActualText.get -> string?
Microsoft.VisualStudio.TestTools.UnitTesting.AssertFailedException.ExpectedText.get -> string?
static Microsoft.VisualStudio.TestTools.UnitTesting.Assert.AreEquivalent<T>(T? expected, T? actual, bool strict, string? message = "", string! expectedExpression = "", string! actualExpression = "") -> void
static Microsoft.VisualStudio.TestTools.UnitTesting.Assert.AreEquivalent<T>(T? expected, T? actual, string? message = "", string! expectedExpression = "", string! actualExpression = "") -> void
static Microsoft.VisualStudio.TestTools.UnitTesting.Assert.AreNotEquivalent<T>(T? notExpected, T? actual, bool strict, string? message = "", string! notExpectedExpression = "", string! actualExpression = "") -> void
static Microsoft.VisualStudio.TestTools.UnitTesting.Assert.AreNotEquivalent<T>(T? notExpected, T? actual, string? message = "", string! notExpectedExpression = "", string! actualExpression = "") -> void
Comment on lines +5 to +8
81 changes: 79 additions & 2 deletions src/TestFramework/TestFramework/Resources/FrameworkMessages.resx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,12 +156,89 @@
<data name="AreEqualStringDiffLengthDifferentMsg" xml:space="preserve">
<value>Expected string length {0} but was {1}.</value>
</data>
<data name="AreNotEqualFailMsg" xml:space="preserve">
<value>Expected any value except:&lt;{1}&gt;. Actual:&lt;{2}&gt;. {0}</value>
<data name="AreEquivalentFailedSummary" xml:space="preserve">
<value>Expected values to be structurally equivalent.</value>
</data>
<data name="AreEquivalentFailedSummaryStrict" xml:space="preserve">
<value>Expected values to be structurally equivalent (strict mode).</value>
</data>
<data name="AreEquivalentMismatchActualDictionaryThrew" xml:space="preserve">
<value>reading the actual dictionary threw {0}: {1}.</value>
</data>
<data name="AreEquivalentMismatchActualEnumerationThrew" xml:space="preserve">
<value>enumerating the actual collection threw {0}: {1}.</value>
</data>
<data name="AreEquivalentMismatchActualMemberThrew" xml:space="preserve">
<value>reading the actual member threw {0}: {1}.</value>
</data>
<data name="AreEquivalentMismatchAt" xml:space="preserve">
<value>Mismatch at '{0}': {1}</value>
<comment>{0} is a member path (e.g., 'Order.Items[2].Price'), {1} is a localized reason describing the kind of mismatch.</comment>
</data>
<data name="AreEquivalentMismatchExpectedDictionaryThrew" xml:space="preserve">
<value>reading the expected dictionary threw {0}: {1}.</value>
</data>
<data name="AreEquivalentMismatchExpectedEnumerationThrew" xml:space="preserve">
<value>enumerating the expected collection threw {0}: {1}.</value>
</data>
<data name="AreEquivalentMismatchExpectedMemberThrew" xml:space="preserve">
<value>reading the expected member threw {0}: {1}.</value>
</data>
<data name="AreEquivalentMismatchExtraMembers" xml:space="preserve">
<value>actual has unexpected members not present on expected: {0}.</value>
</data>
<data name="AreEquivalentMismatchIEquatableThrew" xml:space="preserve">
<value>IEquatable.Equals threw {0}: {1}.</value>
</data>
<data name="AreEquivalentMismatchLength" xml:space="preserve">
<value>collections differ in length (expected {0} elements, actual {1}).</value>
</data>
<data name="AreEquivalentMismatchMaxDepth" xml:space="preserve">
<value>comparison exceeded the maximum supported depth of {0}.</value>
</data>
<data name="AreEquivalentMismatchMissingKey" xml:space="preserve">
<value>key {0} present on expected is missing from actual.</value>
</data>
<data name="AreEquivalentMismatchMissingMember" xml:space="preserve">
<value>member '{0}' present on expected is missing from actual.</value>
</data>
<data name="AreEquivalentMismatchNull" xml:space="preserve">
<value>one side is null, the other is not.</value>
</data>
<data name="AreEquivalentMismatchTopology" xml:space="preserve">
<value>graph topology differs (the same reference on one side appears paired with different references on the other side).</value>
</data>
<data name="AreEquivalentMismatchType" xml:space="preserve">
<value>incompatible types (expected '{0}', actual '{1}').</value>
</data>
<data name="AreEquivalentMismatchUnexpectedKey" xml:space="preserve">
<value>key {0} present on actual is not on expected.</value>
</data>
<data name="AreEquivalentMismatchValue" xml:space="preserve">
<value>values are not equal.</value>
</data>
<data name="AreEquivalentRootPath" xml:space="preserve">
<value>&lt;root&gt;</value>
<comment>Placeholder used in equivalence-mismatch messages when the difference is at the top of the object graph.</comment>
</data>
<data name="AreNotEqualDeltaFailMsg" xml:space="preserve">
<value>Expected a difference greater than &lt;{3}&gt; between expected value &lt;{1}&gt; and actual value &lt;{2}&gt;. {0}</value>
</data>
<data name="AreNotEqualFailMsg" xml:space="preserve">
<value>Expected any value except:&lt;{1}&gt;. Actual:&lt;{2}&gt;. {0}</value>
</data>
<data name="AreNotEquivalentComparisonFailedSummary" xml:space="preserve">
<value>Could not complete structural comparison.</value>
</data>
<data name="AreNotEquivalentComparisonFailedSummaryStrict" xml:space="preserve">
<value>Could not complete structural comparison (strict mode).</value>
</data>
Comment thread
Evangelink marked this conversation as resolved.
<data name="AreNotEquivalentFailedSummary" xml:space="preserve">
<value>Expected values to be structurally different.</value>
</data>
<data name="AreNotEquivalentFailedSummaryStrict" xml:space="preserve">
<value>Expected values to be structurally different (strict mode).</value>
</data>
<data name="AreSameExpectedIsNull" xml:space="preserve">
<value>Expected is &lt;null&gt;. {0}</value>
</data>
Expand Down
125 changes: 125 additions & 0 deletions src/TestFramework/TestFramework/Resources/xlf/FrameworkMessages.cs.xlf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,111 @@
<target state="translated">Očekávaná délka řetězce je {0}, ale byla {1}.</target>
<note></note>
</trans-unit>
<trans-unit id="AreEquivalentFailedSummary">
<source>Expected values to be structurally equivalent.</source>
<target state="new">Expected values to be structurally equivalent.</target>
<note />
</trans-unit>
<trans-unit id="AreEquivalentFailedSummaryStrict">
<source>Expected values to be structurally equivalent (strict mode).</source>
<target state="new">Expected values to be structurally equivalent (strict mode).</target>
<note />
</trans-unit>
<trans-unit id="AreEquivalentMismatchActualDictionaryThrew">
<source>reading the actual dictionary threw {0}: {1}.</source>
<target state="new">reading the actual dictionary threw {0}: {1}.</target>
<note />
</trans-unit>
<trans-unit id="AreEquivalentMismatchActualEnumerationThrew">
<source>enumerating the actual collection threw {0}: {1}.</source>
<target state="new">enumerating the actual collection threw {0}: {1}.</target>
<note />
</trans-unit>
<trans-unit id="AreEquivalentMismatchActualMemberThrew">
<source>reading the actual member threw {0}: {1}.</source>
<target state="new">reading the actual member threw {0}: {1}.</target>
<note />
</trans-unit>
<trans-unit id="AreEquivalentMismatchAt">
<source>Mismatch at '{0}': {1}</source>
<target state="new">Mismatch at '{0}': {1}</target>
<note>{0} is a member path (e.g., 'Order.Items[2].Price'), {1} is a localized reason describing the kind of mismatch.</note>
</trans-unit>
<trans-unit id="AreEquivalentMismatchExpectedDictionaryThrew">
<source>reading the expected dictionary threw {0}: {1}.</source>
<target state="new">reading the expected dictionary threw {0}: {1}.</target>
<note />
</trans-unit>
<trans-unit id="AreEquivalentMismatchExpectedEnumerationThrew">
<source>enumerating the expected collection threw {0}: {1}.</source>
<target state="new">enumerating the expected collection threw {0}: {1}.</target>
<note />
</trans-unit>
<trans-unit id="AreEquivalentMismatchExpectedMemberThrew">
<source>reading the expected member threw {0}: {1}.</source>
<target state="new">reading the expected member threw {0}: {1}.</target>
<note />
</trans-unit>
<trans-unit id="AreEquivalentMismatchExtraMembers">
<source>actual has unexpected members not present on expected: {0}.</source>
<target state="new">actual has unexpected members not present on expected: {0}.</target>
<note />
</trans-unit>
<trans-unit id="AreEquivalentMismatchIEquatableThrew">
<source>IEquatable.Equals threw {0}: {1}.</source>
<target state="new">IEquatable.Equals threw {0}: {1}.</target>
<note />
</trans-unit>
<trans-unit id="AreEquivalentMismatchLength">
<source>collections differ in length (expected {0} elements, actual {1}).</source>
<target state="new">collections differ in length (expected {0} elements, actual {1}).</target>
<note />
</trans-unit>
<trans-unit id="AreEquivalentMismatchMaxDepth">
<source>comparison exceeded the maximum supported depth of {0}.</source>
<target state="new">comparison exceeded the maximum supported depth of {0}.</target>
<note />
</trans-unit>
<trans-unit id="AreEquivalentMismatchMissingKey">
<source>key {0} present on expected is missing from actual.</source>
<target state="new">key {0} present on expected is missing from actual.</target>
<note />
</trans-unit>
<trans-unit id="AreEquivalentMismatchMissingMember">
<source>member '{0}' present on expected is missing from actual.</source>
<target state="new">member '{0}' present on expected is missing from actual.</target>
<note />
</trans-unit>
<trans-unit id="AreEquivalentMismatchNull">
<source>one side is null, the other is not.</source>
<target state="new">one side is null, the other is not.</target>
<note />
</trans-unit>
<trans-unit id="AreEquivalentMismatchTopology">
<source>graph topology differs (the same reference on one side appears paired with different references on the other side).</source>
<target state="new">graph topology differs (the same reference on one side appears paired with different references on the other side).</target>
<note />
</trans-unit>
<trans-unit id="AreEquivalentMismatchType">
<source>incompatible types (expected '{0}', actual '{1}').</source>
<target state="new">incompatible types (expected '{0}', actual '{1}').</target>
<note />
</trans-unit>
<trans-unit id="AreEquivalentMismatchUnexpectedKey">
<source>key {0} present on actual is not on expected.</source>
<target state="new">key {0} present on actual is not on expected.</target>
<note />
</trans-unit>
<trans-unit id="AreEquivalentMismatchValue">
<source>values are not equal.</source>
<target state="new">values are not equal.</target>
<note />
</trans-unit>
<trans-unit id="AreEquivalentRootPath">
<source>&lt;root&gt;</source>
<target state="new">&lt;root&gt;</target>
<note>Placeholder used in equivalence-mismatch messages when the difference is at the top of the object graph.</note>
</trans-unit>
<trans-unit id="AreNotEqualFailMsg">
<source>Expected any value except:&lt;{1}&gt;. Actual:&lt;{2}&gt;. {0}</source>
<target state="translated">Nebyla očekávána žádná hodnota kromě:&lt;{1}&gt;. Aktuálně:&lt;{2}&gt;. {0}</target>
Expand All @@ -78,6 +183,26 @@
<target state="translated">Očekáván rozdíl, který je větší jak &lt;{3}&gt; mezi očekávanou hodnotou &lt;{1}&gt; a aktuální hodnotou &lt;{2}&gt;. {0}</target>
<note></note>
</trans-unit>
<trans-unit id="AreNotEquivalentComparisonFailedSummary">
<source>Could not complete structural comparison.</source>
<target state="new">Could not complete structural comparison.</target>
<note />
</trans-unit>
<trans-unit id="AreNotEquivalentComparisonFailedSummaryStrict">
<source>Could not complete structural comparison (strict mode).</source>
<target state="new">Could not complete structural comparison (strict mode).</target>
<note />
</trans-unit>
<trans-unit id="AreNotEquivalentFailedSummary">
<source>Expected values to be structurally different.</source>
<target state="new">Expected values to be structurally different.</target>
<note />
</trans-unit>
<trans-unit id="AreNotEquivalentFailedSummaryStrict">
<source>Expected values to be structurally different (strict mode).</source>
<target state="new">Expected values to be structurally different (strict mode).</target>
<note />
</trans-unit>
<trans-unit id="AreNotSameBothNull">
<source>Both values are &lt;null&gt;. {0}</source>
<target state="translated">Obě hodnoty jsou &lt;null&gt;. {0}</target>
Expand Down
Loading