Skip to content

Add BeSupersetOf, BeProperSubsetOf and BeProperSupersetOf collection assertions - #3271

Open
dennisdoomen wants to merge 1 commit into
fluentassertions:mainfrom
dennisdoomen:feature/subset-superset-collections
Open

Add BeSupersetOf, BeProperSubsetOf and BeProperSupersetOf collection assertions#3271
dennisdoomen wants to merge 1 commit into
fluentassertions:mainfrom
dennisdoomen:feature/subset-superset-collections

Conversation

@dennisdoomen

Copy link
Copy Markdown
Member

Ports the work originally submitted in #2432 by @Meir017 ( Meir017:feature/api-subset-and-superset), which added BeSupersetOf, BeProperSubsetOf and BeProperSupersetOf collection assertions.

That PR could not be reopened because its base branch (develop) has since been deleted/renamed to main, so this PR recreates the same feature against current main.

What's included

  • BeSupersetOf / BeProperSubsetOf / BeProperSupersetOf assertions on GenericCollectionAssertions
  • ConvertOrCastToSet extension in EnumerableExtensions
  • Extracted AssertSubsetOf / AssertContainment helpers so BeSubsetOf / Contain share logic with the new assertions
  • Ported and adjusted spec tests from the original PR (adapted to the current AssertionChain API; fixed a couple of tests that relied on .And.-chaining the same assertions instance, which no longer replays a second failing assertion once the chain has already failed)
  • Updated docs/_pages/collections.md and docs/_pages/releases.md
  • Regenerated API approval baselines (AcceptApiChanges.ps1)

Closes #2432
Resolves #2363

All credit for the original design and implementation goes to @Meir017.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds new set-containment style collection assertions to FluentAssertions (BeSupersetOf, BeProperSubsetOf, BeProperSupersetOf) and factors shared subset/containment logic to reduce duplication, along with tests, docs, and updated API approval baselines.

Changes:

  • Added BeSupersetOf, BeProperSubsetOf, and BeProperSupersetOf to GenericCollectionAssertions.
  • Extracted shared helpers (AssertSubsetOf, AssertContainment) and introduced ConvertOrCastToSet for set-based checks.
  • Added/ported specs and updated collection docs + release notes + API approval baselines.

Reviewed changes

Copilot reviewed 11 out of 12 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
Tests/FluentAssertions.Specs/Collections/CollectionAssertionSpecs.BeSupersetOf.cs New specs covering BeSupersetOf success/failure and scope behavior.
Tests/FluentAssertions.Specs/Collections/CollectionAssertionSpecs.BeProperSupersetOf.cs New specs covering BeProperSupersetOf, including equivalence and duplicates scenarios.
Tests/FluentAssertions.Specs/Collections/CollectionAssertionSpecs.BeProperSubsetOf.cs New specs covering BeProperSubsetOf, including equivalence and null/empty scenarios.
Tests/Approval.Tests/ApprovedApi/FluentAssertions/netstandard2.1.verified.txt API baseline updated for new assertions.
Tests/Approval.Tests/ApprovedApi/FluentAssertions/netstandard2.0.verified.txt API baseline updated for new assertions.
Tests/Approval.Tests/ApprovedApi/FluentAssertions/net6.0.verified.txt API baseline updated for new assertions.
Tests/Approval.Tests/ApprovedApi/FluentAssertions/net47.verified.txt API baseline updated for new assertions.
Src/FluentAssertions/Common/EnumerableExtensions.cs Adds internal ConvertOrCastToSet helper for set-based operations.
Src/FluentAssertions/Collections/GenericCollectionAssertions.cs Implements the new assertions and refactors subset/containment logic into helpers.
docs/_pages/releases.md Adds an “Unreleased” note about the new collection assertions.
docs/_pages/collections.md Documents usage examples for the new assertions.
.gitignore Fixes .junie/memory/ ignore entry and adds .nuke/temp.
Suppressed comments (1)

Tests/FluentAssertions.Specs/Collections/CollectionAssertionSpecs.BeProperSupersetOf.cs:68

  • Test name says "proper subset" but this spec is for BeProperSupersetOf. Rename to "proper superset" to match the behavior under test.
        public void A_collection_with_duplicates_is_not_a_proper_subset_of_another_with_duplicates()

Comment thread Src/FluentAssertions/Collections/GenericCollectionAssertions.cs
Comment thread Src/FluentAssertions/Collections/GenericCollectionAssertions.cs
Comment thread docs/_pages/releases.md Outdated
…assertions

Ports the work originally submitted in PR fluentassertions#2432 by @Meir017, adapted to
the current AssertionChain-based assertion API. The original PR could
not be reopened because its base branch (develop) no longer exists.

- Add ConvertOrCastToSet extension to EnumerableExtensions
- Extract AssertSubsetOf and AssertContainment helpers in
  GenericCollectionAssertions to share logic with the new assertions
- Add BeSupersetOf, BeProperSubsetOf and BeProperSupersetOf methods
- Add spec tests ported from the original PR
- Update collections.md docs and releases.md

Co-authored-by: Meir017 <Meir017@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings August 1, 2026 08:24
@dennisdoomen
dennisdoomen force-pushed the feature/subset-superset-collections branch from f6d8d37 to eb4bd82 Compare August 1, 2026 08:24

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 11 out of 12 changed files in this pull request and generated no new comments.

Suppressed comments (2)

Tests/FluentAssertions.Specs/Collections/CollectionAssertionSpecs.BeProperSubsetOf.cs:54

  • This test name says the collection "has extra items", but the Arrange section is asserting that duplicates do not make a collection a proper subset when the distinct items are equivalent to the superset. Rename the test to describe equivalence rather than extra elements.
        public void A_collection_with_all_items_and_duplicates_of_a_superset_but_has_extra_items_is_not_a_proper_subset()

Tests/FluentAssertions.Specs/Collections/CollectionAssertionSpecs.BeProperSubsetOf.cs:38

  • This test name says the collection "has extra items", but the Arrange section uses two collections with the same distinct items (they're equivalent as sets). Rename the test to reflect that the failure is due to equivalence (not extra elements).

This issue also appears on line 54 of the same file.

        public void A_collection_with_all_items_of_a_superset_but_has_extra_items_is_not_a_proper_subset()

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

BeProperSubsetOf and BeProperSupersetOf

2 participants