fix: Contains for collections with duplicates in expected#642
Merged
Conversation
Ensure that the following test succeeds:
```csharp
[Fact]
public async Task WhenExpectedContainsDuplicateButMissingItems_ShouldFail()
{
int[] collection = [1, 2, 1, 3, 12, 2, 2,];
async Task Act()
=> await That(collection).Contains([1, 2, 1, 1, 2,]);
await That(Act).Throws<XunitException>()
.WithMessage("""
Expected that collection
contains collection [1, 2, 1, 1, 2,] in order,
but it
contained item 3 at index 3 instead of 1 and
contained item 12 at index 4 instead of 2
Collection:
[1, 2, 1, 3, 12, 2, 2]
Expected:
[1, 2, 1, 1, 2]
""");
}
```
There was a problem hiding this comment.
Pull Request Overview
This PR fixes the behavior of the Contains assertion when the expected collection includes duplicates yet some expected items are missing. The changes improve the error messages by including detailed information about mismatches and adjust the underlying options for duplicate handling.
- Added a new test to verify failure when duplicates in the expected collection are partially missing.
- Updated multiple test files to refine error message output with precise mismatch information.
- Modified the CollectionMatchOptions to remove a conditional check that filtered out duplicate discrepancies.
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| Tests/aweXpect.Tests/Collections/ThatEnumerable.Contains.CollectionTests.cs | Added a new test and updated error message formatting for duplicate checks. |
| Tests/aweXpect.Tests/Collections/ThatEnumerable.Contains.CollectionImmutableTests.cs | Updated error messages to include item mismatch details. |
| Tests/aweXpect.Tests/Collections/ThatEnumerable.Contains.CollectionEnumerableTests.cs | Updated error messages to include item mismatch details. |
| Tests/aweXpect.Tests/Collections/ThatAsyncEnumerable.Contains.CollectionTests.cs | Updated error messages to include item mismatch details. |
| Source/aweXpect.Core/Options/CollectionMatchOptions.cs | Removed a duplicate filtering condition to improve error reporting on mismatches. |
Comments suppressed due to low confidence (1)
Source/aweXpect.Core/Options/CollectionMatchOptions.cs:166
- Removing the duplicate check now causes all mismatches to be reported, including for collections without duplicates. Verify that this behavior is aligned with the desired user experience, and consider adding tests for non-duplicate scenarios to confirm the change.
}
Contributor
Test Results 4 files - 34 4 suites - 34 20s ⏱️ - 2m 23s Results for commit 9c8d809. ± Comparison against base commit 56b575b. This pull request removes 12783 and adds 54 tests. Note that renamed tests count towards both.♻️ This comment has been updated with latest results. |
|
Contributor
🚀 Benchmark ResultsDetails
|
Contributor
👽 Mutation ResultsaweXpectDetails
The final mutation score is NaN%Coverage Thresholds: high:80 low:60 break:0aweXpect.CoreDetails
The final mutation score is 100.00%Coverage Thresholds: high:80 low:60 break:0 |
vbreuss
deleted the
topic/fix-collection-contains-with-duplicate-in-expected
branch
Contributor
|
This is addressed in release v2.17.0. |
This was referenced Sep 1, 2025
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
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.
Fixes the behavior of the Contains assertion when the expected collection includes duplicates yet some expected items are missing.
Ensure that the following test succeeds: