Improve error messages for accidental `Equals` usage by nycdotnet · Pull Request #2006 · fluentassertions/fluentassertions

nycdotnet · 2022-09-25T01:39:52Z

PR for #1997 . I think it would also be good to have this exact error message in the docs somewhere with a little explainer, so I added that.

Todo:

PropertyInfoSelectorAssertions
TypeSelectorAssertions
Fix warning pragma based on feedback
Address this comment
GenericCollectionAssertions (see this comment on original issue)
Doc tweaks to try to make new errors appear on search engines.
Release notes

IMPORTANT

The code complies with the Coding Guidelines for C#.
The changes are covered by unit tests which follow the Arrange-Act-Assert syntax and the naming conventions such as is used in these tests.
If the PR adds a feature or fixes a bug, please update the release notes with a functional description that explains what the change means to consumers of this library, which are published on the website.
If the PR changes the public API the changes needs to be included by running AcceptApiChanges.ps1 or AcceptApiChanges.sh. 🚫
If the PR affects the documentation, please include your changes in this pull request so the documentation will appear on the website.

Src/FluentAssertions/Primitives/ObjectAssertions.cs

Src/FluentAssertions/Numeric/NumericAssertions.cs

Src/FluentAssertions/Primitives/ObjectAssertions.cs

Tests/Approval.Tests/ApprovedApi/FluentAssertions/net47.verified.txt

nycdotnet · 2022-09-25T03:01:47Z

Src/FluentAssertions/Primitives/ObjectAssertions.cs

+#pragma warning restore CA1065
+
+    /// <inheritdoc/>
+    public override int GetHashCode() => base.GetHashCode();


The configured linting rules were upset that I overrode Equals without also overriding GetHashCode().

Src/FluentAssertions/Primitives/DateTimeOffsetRangeAssertions.cs

Tests/FluentAssertions.Specs/Primitives/DateTimeOffsetAssertionSpecs.cs

Tests/FluentAssertions.Specs/Primitives/DateTimeAssertionSpecs.cs

Src/FluentAssertions/Numeric/NumericAssertions.cs

Src/FluentAssertions/Primitives/DateTimeOffsetRangeAssertions.cs

Src/FluentAssertions/Primitives/ObjectAssertions.cs

Tests/FluentAssertions.Specs/Primitives/DateTimeAssertionSpecs.cs

coveralls · 2022-09-25T14:24:40Z

Pull Request Test Coverage Report for Build 3222617057

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

For more information on this, see Tracking coverage changes with pull request builds.
To avoid this issue with future PRs, see these Recommended CI Configurations.
For a quick fix, rebase this PR at GitHub. Your next report should be accurate.

Details

7 of 7 (100.0%) changed or added relevant lines in 7 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage increased (+0.001%) to 96.657%

Totals
Change from base Build 3054928487:	0.001%
Covered Lines:	12357
Relevant Lines:	12622

💛 - Coveralls

jnyrup · 2022-09-25T15:15:01Z

Just wanted to see if this is the right idea. If this looks good, I will go through the rest of the corresponding errors

It looks good 👍

Note: The decrease in code coverage is because Guarding_equals_throws uses ObjectAssertions to exercise the abstract ReferenceTypeAssertions.
You can just add another deriving class to ClassesWithGuardEquals.

Tests/FluentAssertions.Specs/Primitives/ReferenceTypeAssertionsSpecs.cs

Tests/FluentAssertions.Specs/Specialized/ExecutionTimeAssertionsSpecs.cs

dennisdoomen · 2022-09-27T17:37:56Z

What a nice PR. I especially love the positive comments from @nycdotnet

nycdotnet added 4 commits September 24, 2022 21:27

update NumericAssertions

90e8218

improve test name

a8d4e87

Implement for BooleanAssertions and ObjectAsserions

eef3fe7

update verified API surface

3659b5d