iframe-proxy

vbreuss · 2023-09-18T07:40:27Z

When asserting that two strings are equal, and one of the strings is longer than 8 characters or contains a NewLine, instead of simply stating at which index the first difference occurs, this difference is made visible using arrows, e.g.

var subject = "this is a long text that differs in between";
var expected = "this was too short";
subject.Should().Be(expected, "because we use arrows now");

throws with message

Expected subject to be the same string because we use arrows now, but they differ at index 5:
        ↓ (actual)
  "this is a long text…"
  "this was too short"
        ↑ (expected)."

For multi-line strings, instead of only providing information about the index, the failure message also contains the line and column information, e.g. …but they differ on line 5 and column 1 (index 93):

For short single-line strings the behaviour remains unchanged!

This closes #2050.

IMPORTANT

If the PR touches the public API, the changes have been approved in a separate issue with the "api-approved" label.
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.
- Please also run ./build.sh --target spellcheck or .\build.ps1 --target spellcheck before pushing and check the good outcome

github-actions · 2023-09-18T07:53:06Z

dennisdoomen

That's a pretty impressive improvement. I had some quite some issues understanding the algorithm, so I've gone through a pretty thorough review.

…lityStrategy` class

…y algorithm

…com/en-us/dotnet/csharp/programming-guide/strings/#raw-string-literals)

vbreuss · 2023-10-02T08:37:11Z

That's a pretty impressive improvement. I had some quite some issues understanding the algorithm, so I've gone through a pretty thorough review.

@dennisdoomen. Thanks for the extensive review. It's really appreciated!

I implemented your requested changes and answered your questions. I hope I didn't overlook anything :-)
I also added this change to the releases.md

jnyrup

This is really great!

I haven't gone through all the relational operators to check if they are correct.
I'll try to run mutation tests on StringEqualityStrategy.cs sometime this week to help verifying this. If you want to try mutation tests before I get to it, there are some pointers in #1068 and jnyrup#6

ITaluone · 2023-10-03T06:30:37Z

I'll try to run mutation tests on StringEqualityStrategy.cs sometime this week to help verifying this.

Shall we add that to our pipeline?

jnyrup · 2023-10-03T07:28:53Z

I'll try to run mutation tests on StringEqualityStrategy.cs sometime this week to help verifying this.

Shall we add that to our pipeline?

That's my plan.
It takes quite a while to do a full run, so my current idea is to only consider the changed files in PRs and then do a scheduled full run e.g. once a week.

vbreuss · 2023-10-03T07:31:17Z

I'll try to run mutation tests on StringEqualityStrategy.cs sometime this week to help verifying this. If you want to try mutation tests before I get to it, there are some pointers in #1068 and jnyrup#6

I also use Stryker in my project and just ran it against fluentassertions

Mutation Testing Summary

File	Score	Killed	Survived	Timeout	No Coverage	Ignored	Compile Errors	Total Detected	Total Undetected	Total Mutants
Primitives\StringEqualityStrategy.cs	97,12%	101	3	0	0	21	8	101	3	133

I will add tests for the 3 survived mutants together with the changes for your review :-)

vbreuss · 2023-10-03T08:52:43Z

@jnyrup
I implemented your review comments and added the missing tests for the surviving mutants.

Mutation Testing Summary

dennisdoomen

As I said before, great work. The new comments and improved naming really helps (even though it is still quite an algorithm).

Since we've tried to get rid of words like when and should in test names and focus more on the fact that such a test covers, I've suggested some improvements. Up to you if you want to include them now. Otherwise, I'll do it at a later point.

Draft improved failure message when checking for equality.

c614d88

vbreuss mentioned this pull request Sep 18, 2023

Improve failure message for StringAssertions.Be #2050

Closed

Use line and column for multiline strings

84721b3

vbreuss marked this pull request as ready for review September 27, 2023 11:53

vbreuss changed the title ~~Draft: Improve failure message for string assertions when checking for equality~~ Improve failure message for string assertions when checking for equality Sep 27, 2023

vbtig added 6 commits September 29, 2023 09:45

Fix failing tests

e76ffdf

Fix Qodana issues

8cc6cb0

Fix further failing tests

3c345a7

Also fix tests on MacOS (due to different newline)

9706259

Calculate expected index

dd0b674

Fix paranthesis

25a4bde

dennisdoomen added the enhancement label Oct 1, 2023

dennisdoomen self-requested a review October 1, 2023 16:03

dennisdoomen requested changes Oct 1, 2023

View reviewed changes

vbreuss added 3 commits October 2, 2023 07:52

Move specific methods from common StringExtensions to the `StringEqua…

0ea0cda

…lityStrategy` class

Fix review comments from @dennisdoomen and add tests for word boundar…

9becb00

…y algorithm

Improve tests by using [raw string literals](https://learn.microsoft.…

6cbf802

…com/en-us/dotnet/csharp/programming-guide/strings/#raw-string-literals)

ITaluone reviewed Oct 2, 2023

View reviewed changes

Comment thread Tests/FluentAssertions.Specs/Primitives/StringAssertionSpecs.Be.cs Outdated

Update releases.md

e3fffac

jnyrup reviewed Oct 2, 2023

View reviewed changes

jnyrup mentioned this pull request Oct 2, 2023

Allow IEqualityComparer in string equality assertion #2339

Closed

vbreuss added 2 commits October 3, 2023 10:14

Implement review comments from @jnyrup

110ed76

Adapt due to survived mutants

6ca90dd

dennisdoomen approved these changes Oct 4, 2023

View reviewed changes

Sunbelt Computer Software

PL/B Language Development and Support

Uh oh!

Conversation

vbreuss commented Sep 18, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

IMPORTANT

Uh oh!

github-actions Bot commented Sep 18, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Qodana for .NET

Uh oh!

dennisdoomen left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

vbreuss commented Oct 2, 2023

Uh oh!

jnyrup left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ITaluone commented Oct 3, 2023

Uh oh!

jnyrup commented Oct 3, 2023

Uh oh!

vbreuss commented Oct 3, 2023

Mutation Testing Summary

Uh oh!

vbreuss commented Oct 3, 2023

Mutation Testing Summary

Uh oh!

dennisdoomen left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

vbreuss commented Sep 18, 2023 •

edited

Loading

github-actions Bot commented Sep 18, 2023 •

edited

Loading