Format records and anonymous types with their member values #2144

benagain · 2023-03-11T08:06:30Z

#2140 - Enhance the output formatter so that record, anonymous types and tuples output are displayed as their member values rather than their ToString implementation.

Before:

Expected object to be <null> because classes without ToString output members, but found FluentAssertions.Specs.Formatting.FormatterSpecs+Stuff`1[[System.Int32, System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]
{
    Children = {1, 2, 3, 4}, 
    Description = <null>, 
    StuffId = 1
}.
Expected object to be <null> because anonymous classes output members, but found { AnonymousClassId = 1, Children = System.Int32[] }.
Expected object to be <null> because records output members, but found StuffRecord { RecordId = 1, RecordDescription = description, RecordChildren = System.Collections.Generic.List`1[System.Int32] }.
Expected tuple to be <null> because tuples output members, but found (1, description, System.Collections.Generic.List`1[System.Int32]).

After:

Expected object to be <null> because classes without ToString output members, but found FluentAssertions.Specs.Formatting.FormatterSpecs+Stuff`1[[System.Int32, System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]
{
    Children = {1, 2, 3, 4}, 
    Description = <null>, 
    StuffId = 1
}.
Expected object to be <null> because anonymous classes output members, but found {
    AnonymousClassId = 1, 
    Children = {1, 2, 3, 4}
}.
Expected object to be <null> because records output members, but found FluentAssertions.Specs.Formatting.FormatterSpecs+StuffRecord
{
    RecordChildren = {1, 2, 3, 4}, 
    RecordDescription = "description", 
    RecordId = 1, 
    SingleChild = 
    FluentAssertions.Specs.Formatting.FormatterSpecs+ChildRecord
    {
        ChildRecordId = 80
    }
}.
Expected tuple to be <null> because tuples output members, but found {
    Item1 = 1, 
    Item2 = "description", 
    Item3 = {1, 2, 3, 4}
}.

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

coveralls · 2023-03-11T10:47:25Z

Pull Request Test Coverage Report for Build 4643984026

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

45 of 45 (100.0%) changed or added relevant lines in 6 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage increased (+0.01%) to 97.2%

Totals
Change from base Build 4629906477:	0.01%
Covered Lines:	12881
Relevant Lines:	13124

💛 - Coveralls

dennisdoomen

🤔 Would be nice to have an example of the before and after situations in the PR description

Src/FluentAssertions/Formatting/DefaultValueFormatter.cs

Tests/FluentAssertions.Equivalency.Specs/CollectionSpecs.cs

Tests/FluentAssertions.Specs/Primitives/ReferenceTypeAssertionsSpecs.cs

benagain · 2023-03-20T06:19:45Z

Hi @dennisdoomen @lg2de, is there anything else to do for this PR?

dennisdoomen · 2023-03-20T08:38:52Z

Hi @dennisdoomen @lg2de, is there anything else to do for this PR?

No, waiting for @jnyrup to find some time to review the PR as well.

Src/FluentAssertions/Common/TypeExtensions.cs

Tests/FluentAssertions.Equivalency.Specs/CollectionSpecs.cs

Src/FluentAssertions/Formatting/StringValueFormatter.cs

Tests/FluentAssertions.Specs/Formatting/FormatterSpecs.cs

Src/FluentAssertions/Formatting/DefaultValueFormatter.cs

Tests/FluentAssertions.Specs/Formatting/FormatterSpecs.cs

jnyrup

Great work.
I really liked reviewing this and how we gradually improved it one step a time.

jnyrup · 2023-03-29T18:21:09Z

@dennisdoomen Will you have another look since the implementation changed some since your approval.

dennisdoomen

❓Wouldn't it make the output better readable if we add an empty line after a multi-line "Expected..." statement? Just like we do in C#.

@benagain sorry for some of the new comments. But as @jnyrup requested, I had a bit of a more thorough look at the PR (and the output we used to generate). Very happy with the improvements. We just need to make sure it's picture perfect.

Src/FluentAssertions/Common/TypeExtensions.cs

Src/FluentAssertions/Formatting/FormattedObjectGraph.cs

Src/FluentAssertions/Formatting/DefaultValueFormatter.cs

Src/FluentAssertions/Formatting/StringValueFormatter.cs

Tests/FluentAssertions.Specs/Formatting/FormatterSpecs.cs

benagain · 2023-04-02T08:19:48Z

❓Wouldn't it make the output better readable if we add an empty line after a multi-line "Expected..." statement? Just like we do in C#.

I'm not entirely sure what you mean here @dennisdoomen, is this the same as #2144 (comment)? If not, could you elaborate a little please?

@benagain sorry for some of the new comments. But as @jnyrup requested, I had a bit of a more thorough look at the PR (and the output we used to generate). Very happy with the improvements. We just need to make sure it's picture perfect.

No problem, I'm quite enjoying polishing it to get it right.

dennisdoomen · 2023-04-02T08:37:14Z

I'm not entirely sure what you mean here @dennisdoomen, is this the same as #2144 (comment)? If not, could you elaborate a little please?

Yeah, I meant the same thing there.

Tests/FluentAssertions.Specs/Types/TypeExtensionsSpecs.cs

dennisdoomen · 2023-04-07T06:28:38Z

@benagain I assume you're still working on this PR. Ping me when you're done and I can conclude the review.

benagain · 2023-04-07T06:43:33Z

@benagain I assume you're still working on this PR. Ping me when you're done and I can conclude the review.

Hi @dennisdoomen, I found an annoying problem that has been tricky to resolve. As it currently stands a list of objects will be formatted with the list's opening brace and the first object's name on the same line as "Expected...", rather than on a new line:

  Expected stuff to be equal to {FluentAssertions.Specs.Formatting.FormatterSpecs+Stuff`1[[System.Int32*]]
      {
          Children = {1, 2, 3, 4}, 
  ...

This comes down to the interplay between EnumerableValueFormatter and FormattedObjectGraph and is challenging because simple, short lists should be formatted on the original line:

Expected list to be equal to {1,2,3,4}

I'm fairly close to a solution but I will be the first to say it's a touch convoluted. Maybe when I show the code someone will have a better idea.

benagain · 2023-04-08T07:23:21Z

@dennisdoomen, @lg2de, @jnyrup, and anyone else interested!..

I'd like to draw your attention to the test When_the_object_is_a_generic_type_without_custom_string_representation_it_should_show_the_properties:

fluentassertions/Tests/FluentAssertions.Specs/Formatting/FormatterSpecs.cs

Lines 213 to 223 in 0d74c41

    
                   act.Should().Throw<XunitException>() 
        
                       .And.Message.Should().Match( 
        
                       """ 
        
                       Expected stuff to be equal to  
        
                       { 
        
                           FluentAssertions.Specs.Formatting.FormatterSpecs+Stuff`1[[System.Int32*]] 
        
                           { 
        
                               Children = {1, 2, 3, 4},  
        
                               Description = "Stuff_1",  
        
                               StuffId = 1 
        
                           },

I think this formatting is what we're after, especially the newline after "expected stuff to be", and indentation of the type name to match the type contents.

This particular stuff is a list of complex objects, and the EnumerableFormatter does not know whether or not to put that opening brace on a newline until it has formatted at least one child. Lists of integers should be formatted on a single line:

Expected numbers to be {1, 2, 3, 4}

I tried a few different things, then came up with PossibleMultilineFragment formatter which tracks where the brace should go in the output, and then insert it later on after we know if this enumerable is single-line or spans multiple lines. EnumerableFormatter was already making a "single or multi-line" decision so I think this follow that pattern. Inserting content into the graph post-hoc required more access to the internals of FormattedObjectGraph so I felt it should be a responsibility of that now.

Please have a look. It seems a bit overly complicated for what should be something simple but I have not yet thought of a better solution whilst keeping the desired formatting.

lg2de · 2023-04-11T16:44:51Z

I like what I see in the new tests!

Tests/FluentAssertions.Specs/Formatting/FormatterSpecs.cs

Tests/FluentAssertions.Specs/Primitives/ReferenceTypeAssertionsSpecs.cs

These show the expected output much more clearly.

Co-authored-by: IT-VBFK <49762557+IT-VBFK@users.noreply.github.com>

benagain · 2023-05-06T06:54:35Z

Hi @dennisdoomen, could you have another look at this please. I think I have covered all of the comments 🤞

dennisdoomen

Impressive work. This entire graph formatting has become pretty complicated, so kudos for you to grasp that complexity and improve on it.

benagain · 2023-05-08T18:24:58Z

Thanks everyone for the robust review! 😃

benagain force-pushed the anonymous-types-formatting branch 2 times, most recently from 0bb526f to 536b008 Compare March 11, 2023 08:13

dennisdoomen requested changes Mar 11, 2023

View reviewed changes

Src/FluentAssertions/Formatting/DefaultValueFormatter.cs Outdated Show resolved Hide resolved

Src/FluentAssertions/Formatting/DefaultValueFormatter.cs Show resolved Hide resolved

Tests/FluentAssertions.Equivalency.Specs/CollectionSpecs.cs Outdated Show resolved Hide resolved

benagain force-pushed the anonymous-types-formatting branch 2 times, most recently from b52e40f to 5829a5f Compare March 12, 2023 10:09

dennisdoomen approved these changes Mar 12, 2023

View reviewed changes

dennisdoomen requested a review from jnyrup March 12, 2023 10:56

lg2de reviewed Mar 12, 2023

View reviewed changes

Tests/FluentAssertions.Specs/Primitives/ReferenceTypeAssertionsSpecs.cs Outdated Show resolved Hide resolved

jnyrup reviewed Mar 25, 2023

View reviewed changes

benagain force-pushed the anonymous-types-formatting branch from 54cebd5 to cf68b01 Compare March 28, 2023 14:47

jnyrup reviewed Mar 28, 2023

View reviewed changes

Src/FluentAssertions/Formatting/DefaultValueFormatter.cs Outdated Show resolved Hide resolved

Tests/FluentAssertions.Specs/Formatting/FormatterSpecs.cs Outdated Show resolved Hide resolved

Tests/FluentAssertions.Specs/Formatting/FormatterSpecs.cs Show resolved Hide resolved

jnyrup approved these changes Mar 29, 2023

View reviewed changes

dennisdoomen self-requested a review March 30, 2023 05:22

dennisdoomen requested changes Apr 1, 2023

View reviewed changes

benagain force-pushed the anonymous-types-formatting branch from a4c784f to daf9ac3 Compare April 2, 2023 09:27

IT-VBFK reviewed Apr 2, 2023

View reviewed changes

Tests/FluentAssertions.Specs/Types/TypeExtensionsSpecs.cs Outdated Show resolved Hide resolved

Tests/FluentAssertions.Specs/Types/TypeExtensionsSpecs.cs Outdated Show resolved Hide resolved

ITaluone reviewed Apr 6, 2023

View reviewed changes

Tests/FluentAssertions.Specs/Types/TypeExtensionsSpecs.cs Outdated Show resolved Hide resolved

benagain force-pushed the anonymous-types-formatting branch from 10b3abc to 0d74c41 Compare April 8, 2023 07:08

lg2de reviewed Apr 11, 2023

View reviewed changes

Tests/FluentAssertions.Specs/Formatting/FormatterSpecs.cs Outdated Show resolved Hide resolved

lg2de reviewed Apr 11, 2023

View reviewed changes

Tests/FluentAssertions.Specs/Primitives/ReferenceTypeAssertionsSpecs.cs Outdated Show resolved Hide resolved

benagain and others added 12 commits April 26, 2023 05:35

Inline methods to improve readability

1466fe8

Use multiline string literals for formatting tests

791b945

These show the expected output much more clearly.

Remove unnecessary tests that are now covered by full output assertions

683e2e5

Use original output from develop branch for generic type format test

5d3e1a2

Update Tests/FluentAssertions.Specs/Types/TypeExtensionsSpecs.cs

f809a27

Co-authored-by: IT-VBFK <49762557+IT-VBFK@users.noreply.github.com>

Update Tests/FluentAssertions.Specs/Types/TypeExtensionsSpecs.cs

3b4af71

Co-authored-by: IT-VBFK <49762557+IT-VBFK@users.noreply.github.com>

Enumerable opening brace may be on a new line if children are large

169595a

Improved names and readability of PossibleMultilineFragment

5126459

Improve test formatting

8aea677

Handle mixed collections of simple and complex types

42d3bd2

Multi-line enumeration formatting starts on a new line

b29feb1

Do not wrap newlines with quotes when formatting enumerable equivalency

9ad585b

benagain force-pushed the anonymous-types-formatting branch from 5b3368a to 9ad585b Compare April 26, 2023 04:40

dennisdoomen approved these changes May 7, 2023

View reviewed changes

dennisdoomen merged commit f6f02c9 into fluentassertions:develop May 7, 2023

jnyrup mentioned this pull request May 7, 2023

Avoid quoting newlines #2202

Merged

7 tasks

benagain deleted the anonymous-types-formatting branch May 8, 2023 18:23

jnyrup added the enhancement label Aug 23, 2023

ITaluone mentioned this pull request Aug 23, 2023

Move "Format records and anonymous objects with their member values" to the correct release #2271

Merged

7 tasks

jnyrup mentioned this pull request Oct 15, 2023

A few fixed qodana issues #2379

Merged

7 tasks

ITaluone mentioned this pull request Jun 20, 2024

Improve code coverage in ...Formatters #2679

Merged

7 tasks

jnyrup mentioned this pull request Jul 15, 2024

ArgumentOutOfRangeException when formatting objects using UseLineBreaks #2695

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Format records and anonymous types with their member values #2144

Format records and anonymous types with their member values #2144

benagain commented Mar 11, 2023 •

edited

Loading

coveralls commented Mar 11, 2023 •

edited

Loading

dennisdoomen left a comment

benagain commented Mar 20, 2023

dennisdoomen commented Mar 20, 2023

jnyrup left a comment

jnyrup commented Mar 29, 2023

dennisdoomen left a comment •

edited

Loading

benagain commented Apr 2, 2023

dennisdoomen commented Apr 2, 2023

dennisdoomen commented Apr 7, 2023

benagain commented Apr 7, 2023

benagain commented Apr 8, 2023

lg2de commented Apr 11, 2023

benagain commented May 6, 2023

dennisdoomen left a comment

benagain commented May 8, 2023

Format records and anonymous types with their member values #2144

Format records and anonymous types with their member values #2144

Conversation

benagain commented Mar 11, 2023 • edited Loading

IMPORTANT

coveralls commented Mar 11, 2023 • edited Loading

Pull Request Test Coverage Report for Build 4643984026

Warning: This coverage report may be inaccurate.

Details

💛 - Coveralls

dennisdoomen left a comment

Choose a reason for hiding this comment

benagain commented Mar 20, 2023

dennisdoomen commented Mar 20, 2023

jnyrup left a comment

Choose a reason for hiding this comment

jnyrup commented Mar 29, 2023

dennisdoomen left a comment • edited Loading

Choose a reason for hiding this comment

benagain commented Apr 2, 2023

dennisdoomen commented Apr 2, 2023

dennisdoomen commented Apr 7, 2023

benagain commented Apr 7, 2023

benagain commented Apr 8, 2023

lg2de commented Apr 11, 2023

benagain commented May 6, 2023

dennisdoomen left a comment

Choose a reason for hiding this comment

benagain commented May 8, 2023

benagain commented Mar 11, 2023 •

edited

Loading

coveralls commented Mar 11, 2023 •

edited

Loading

dennisdoomen left a comment •

edited

Loading