fix: avoid duplicate contexts in collection expectations#641
Merged
Conversation
When combining multiple collection expectations with multiple failures, the context contained one collection context for every failure.
There was a problem hiding this comment.
Pull Request Overview
This PR ensures that when multiple collection expectations fail in a single assertion chain, the collection context is only included once. It adds tests across various collection types to verify the behavior and updates the context-addition logic to prevent duplicate contexts.
- Added
WithMultipleFailures_ShouldIncludeCollectionOnlyOncetests for ReadOnlyDictionary, Dictionary, Enumerable, ImmutableArray, and AsyncEnumerable scenarios. - Modified
CollectionHelpersto only add a "Collection" or "Dictionary" context if it hasn't been added already.
Reviewed Changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| Tests/...ThatReadOnlyDictionary.ContainsKey.Tests.cs | Added multi-failure test for IReadOnlyDictionary.ContainsKey |
| Tests/...ThatDictionary.ContainsKey.Tests.cs | Added multi-failure test for IDictionary.ContainsKey |
| Tests/...ThatEnumerable.Contains.Tests.cs | Added multi-failure test for IEnumerable.Contains |
| Tests/...Contains.ImmutableTests.cs | Added multi-failure test for ImmutableArray.Contains |
| Tests/...Contains.EnumerableTests.cs | Added multi-failure test for non-generic IEnumerable.Contains |
| Tests/...ThatAsyncEnumerable.Contains.Tests.cs | Added multi-failure test for IAsyncEnumerable.Contains |
| Source/aweXpect/.../CollectionHelpers.cs | Wrapped context updates in conditional blocks to avoid duplicates |
Comments suppressed due to low confidence (6)
Source/aweXpect/That/Collections/CollectionHelpers.cs:41
- [nitpick] The conditional context-addition logic is duplicated across multiple overloads. Consider extracting a shared helper method to reduce repetition and improve maintainability.
internal static ExpectationBuilder AddCollectionContext<TItem>(this ExpectationBuilder expectationBuilder,
Source/aweXpect/That/Collections/CollectionHelpers.cs:64
- The lambda passed to
UpdateContextsuses a block but never returns the modifiedcontextslist, leading to a compile error or unexpected behavior. Addreturn contexts;before the closing brace.
});
Source/aweXpect/That/Collections/CollectionHelpers.cs:100
- The lambda block in
AddCollectionContext(this ExpectationBuilder, object)does not return the updatedcontexts. You need toreturn contexts;at the end of the block.
});
Source/aweXpect/That/Collections/CollectionHelpers.cs:124
- Missing
return contexts;in theUpdateContextsblock for the.NET 8+overload. Without it, the updated contexts won't be passed back.
});
Source/aweXpect/That/Collections/CollectionHelpers.cs:147
- In the generic dictionary overload, the
UpdateContextslambda block fails to return the modifiedcontexts. Please addreturn contexts;.
});
Source/aweXpect/That/Collections/CollectionHelpers.cs:169
- The
UpdateContextsblock in the second IDictionary overload doesn't returncontexts. Insertreturn contexts;to fix functionality.
});
|
Contributor
Test Results 14 files - 24 14 suites - 24 2m 43s ⏱️ -33s Results for commit 213ec22. ± Comparison against base commit d832baa. This pull request removes 1379 and adds 1356 tests. Note that renamed tests count towards both. |
Contributor
🚀 Benchmark ResultsDetails
|
Contributor
👽 Mutation ResultsaweXpectDetails
The final mutation score is 89.89%Coverage Thresholds: high:80 low:60 break:0aweXpect.CoreDetails
The final mutation score is NaN%Coverage Thresholds: high:80 low:60 break:0 |
github-actions Bot
added a commit
that referenced
this pull request
Jun 19, 2025
…tion expectations (#641) by Valentin Breuß
github-actions Bot
added a commit
that referenced
this pull request
Jun 19, 2025
…tion expectations (#641) by Valentin Breuß
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.
When combining multiple collection expectations with multiple failures, the context contained one collection context for every failure.