Added System.Text.Json assertion APIs and BeEquivalentTo support#3094
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive JSON assertion capabilities to FluentAssertions by introducing specialized assertion methods for System.Text.Json.Nodes.JsonNode and enabling equivalency comparisons between JSON nodes and C# objects.
Key changes include:
- New JSON-specific assertion methods for type checking (
BeNumeric(),BeString(),BeBool(),BeLocalDate(),BeUtcDate()) - Property verification methods (
HaveProperty(),NotHaveProperty()) and array checking (BeAnArray(),NotBeAnArray()) BeEquivalentTo()functionality that allows direct comparison of JSON nodes to C# objects with automatic type conversion- Case-insensitive property matching option through
IgnoringJsonPropertyCasing()
Reviewed Changes
Copilot reviewed 37 out of 37 changed files in this pull request and generated 10 comments.
Show a summary per file
| File | Description |
|---|---|
| Tests/FluentAssertions.Specs/Specialized/JsonNodeSpecs.cs | Comprehensive test suite covering all new JSON assertion methods |
| Tests/FluentAssertions.Equivalency.Specs/JsonNodeSpecs.cs | Test cases for JSON equivalency comparisons with various scenarios |
| Tests/FluentAssertions.Extensibility.Specs/JsonWithInlineAssertionsSpecs.cs | Tests demonstrating JSON assertions with inline predicates and assertions |
| Tests/FluentAssertions.Extensibility.Specs/HttpResponseMessageAssertions.cs | Extension methods for HTTP response JSON assertion support |
| Src/FluentAssertions/Specialized/JsonNodeAssertions.cs | Main assertion class providing JSON-specific assertion methods |
| Src/FluentAssertions/Formatting/JsonNodeFormatter.cs | Custom formatter for rendering JSON nodes in assertion messages |
| Src/FluentAssertions/Equivalency/Steps/JsonConversionStep.cs | Equivalency step for converting JSON values to appropriate .NET types |
| Src/FluentAssertions/Equivalency/JsonProperty.cs | JSON property representation for equivalency matching |
| Src/FluentAssertions/Equivalency/Matching/*.cs | JSON-aware matching rules for property comparison |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Tests/FluentAssertions.Extensibility.Specs/JsonWithInlineAssertionsSpecs.cs
Outdated
Show resolved
Hide resolved
3ca68d4 to
a534045
Compare
Qodana for .NETIt seems all right 👌 No new problems were found according to the checks applied 💡 Qodana analysis was run in the pull request mode: only the changed files were checked Contact Qodana teamContact us at qodana-support@jetbrains.com
|
90ce2b6 to
5995d90
Compare
Tests/FluentAssertions.Extensibility.Specs/HttpResponseMessageAssertions.cs
Outdated
Show resolved
Hide resolved
Tests/FluentAssertions.Extensibility.Specs/JsonWithInlineAssertionsSpecs.cs
Outdated
Show resolved
Hide resolved
Tests/FluentAssertions.Extensibility.Specs/JsonWithInlineAssertionsSpecs.cs
Outdated
Show resolved
Hide resolved
Tests/FluentAssertions.Equivalency.Specs/FluentAssertions.Equivalency.Specs.csproj
Outdated
Show resolved
Hide resolved
5995d90 to
6ed1e49
Compare
Tests/FluentAssertions.Extensibility.Specs/JsonWithInlineAssertionsSpecs.cs
Outdated
Show resolved
Hide resolved
6a0cc0c to
3f5a206
Compare
Pull Request Test Coverage Report for Build 17881824721Details
💛 - Coveralls |
3f5a206 to
3b050a8
Compare
3b050a8 to
e8d5da8
Compare
jnyrup
left a comment
There was a problem hiding this comment.
Coveralls seems down for me, but have you checked the missing lines if they warrant extra tests?
e8d5da8 to
a5f0796
Compare
Updated [FluentAssertions](https://github.com/fluentassertions/fluentassertions) from 8.0.0 to 8.8.0. <details> <summary>Release notes</summary> _Sourced from [FluentAssertions's releases](https://github.com/fluentassertions/fluentassertions/releases)._ ## 8.8.0 <!-- Release notes generated using configuration in .github/release.yml at main --> ## What's Changed ### New features * Add support for MSTest4 by @jnyrup in fluentassertions/fluentassertions#3111 ### Improvements * Allow WithoutMessage when using Should().Throw() and ThrowAsync() by @dennisdoomen in fluentassertions/fluentassertions#3100 * Improve reporting of the differences between long strings by @dennisdoomen in fluentassertions/fluentassertions#3101 * Allow customizing the equivalency behavior for BeXmlSerializable by @logiclrd in fluentassertions/fluentassertions#3107 ### Documentation * Add docs for `config` parameter by @jnyrup in fluentassertions/fluentassertions#3104 ### Others * Refreshed readme by @dennisdoomen in fluentassertions/fluentassertions#3106 * Merge hotfix 8.7.1 back to main by @dennisdoomen in fluentassertions/fluentassertions#3109 * Fix release notes by @jnyrup in fluentassertions/fluentassertions#3112 * Bump github/codeql-action from 3 to 4 by @dependabot[bot] in fluentassertions/fluentassertions#3113 **Full Changelog**: fluentassertions/fluentassertions@8.7.1...8.8.0 ## 8.7.1 <!-- Release notes generated using configuration in .github/release.yml at hotfix/8.7.1 --> ## What's Changed ### Others * JSON assertions did not properly handle floats, doubles and unsigned … by @dennisdoomen in fluentassertions/fluentassertions#3105 * Fixed ambiguity when using Should on a JsonNode derived class ... by @JSkimming in fluentassertions/fluentassertions#3102 **Full Changelog**: fluentassertions/fluentassertions@8.7.0...8.7.1 ## 8.7.0 <!-- Release notes generated using configuration in .github/release.yml at ae620add07cf6666841e568fd3bf8a0733478bb5 --> ## What's Changed ### New features * Added System.Text.Json assertion APIs and BeEquivalentTo support by @dennisdoomen in fluentassertions/fluentassertions#3094 ### Others * Address a bunch of Qodana issues by @dennisdoomen in fluentassertions/fluentassertions#3082 * Bump actions/checkout from 4 to 5 by @dependabot[bot] in fluentassertions/fluentassertions#3085 * Bump JetBrains/qodana-action from 2025.1 to 2025.2 by @dependabot[bot] in fluentassertions/fluentassertions#3086 * Bump actions/download-artifact from 4 to 5 by @dependabot[bot] in fluentassertions/fluentassertions#3087 * Bump cspell from 9.2.0 to 9.2.1 by @dependabot[bot] in fluentassertions/fluentassertions#3090 * Bump actions/setup-dotnet from 4 to 5 by @dependabot[bot] in fluentassertions/fluentassertions#3092 * Add lock file for nuget packages by @jnyrup in fluentassertions/fluentassertions#3084 * Set `DisableImplicitNuGetFallbackFolder` by @jnyrup in fluentassertions/fluentassertions#3095 * Bump Nugets by @jnyrup in fluentassertions/fluentassertions#3096 * Revert package locking by @jnyrup in fluentassertions/fluentassertions#3098 * Clean-up tests related to exceptions by @dennisdoomen in fluentassertions/fluentassertions#3099 **Full Changelog**: fluentassertions/fluentassertions@8.6.0...8.7.0 ## 8.6.0 <!-- Release notes generated using configuration in .github/release.yml at main --> ## What's Changed ### Improvements * Add support for inline assertions using `Value.ThatMatches` and `Value.ThatSatisfies` by @dennisdoomen in fluentassertions/fluentassertions#3076 ### Others * Remove Microsoft.SourceLink.GitHub by @SimonCropp in fluentassertions/fluentassertions#3072 * Bump cspell from 9.1.3 to 9.1.5 by @dependabot[bot] in fluentassertions/fluentassertions#3073 * Added PackageGuard to the build pipeline by @dennisdoomen in fluentassertions/fluentassertions#3075 * Bump cspell from 9.1.5 to 9.2.0 by @dependabot[bot] in fluentassertions/fluentassertions#3077 * Remove dependencies on Bogus by @jnyrup in fluentassertions/fluentassertions#3080 * Update nuget packages by @jnyrup in fluentassertions/fluentassertions#3081 * Follow-up to #3076 by @jnyrup in fluentassertions/fluentassertions#3079 * Documentation and typo fixes by @jnyrup in fluentassertions/fluentassertions#3078 ## New Contributors * @SimonCropp made their first contribution in fluentassertions/fluentassertions#3072 **Full Changelog**: fluentassertions/fluentassertions@8.5.0...8.6.0 ## 8.5.0 <!-- Release notes generated using configuration in .github/release.yml at main --> ## What's Changed ### New features * Extended BeEquivalentTo with support for checking the type of the properties by @dennisdoomen in fluentassertions/fluentassertions#3066 ### Fixes * Ensured WithTracing is safe when used with BeEquivalentTo globally by @dennisdoomen in fluentassertions/fluentassertions#3067 ### Others * Revisit the .editorconfig rules by @dennisdoomen in fluentassertions/fluentassertions#3063 * Bump cspell from 9.1.1 to 9.1.2 by @dependabot[bot] in fluentassertions/fluentassertions#3068 * Use .NET 9 SDK by @jnyrup in fluentassertions/fluentassertions#3069 * Bump cspell from 9.1.2 to 9.1.3 by @dependabot[bot] in fluentassertions/fluentassertions#3071 **Full Changelog**: fluentassertions/fluentassertions@8.4.0...8.5.0 ## 8.4.0 <!-- Release notes generated using configuration in .github/release.yml at main --> ## What's Changed ### Improvements * Allow excluding properties by name anywhere in the graph by @dennisdoomen in fluentassertions/fluentassertions#3062 * Added Should().Throw(), ThrowAsync() and ThrowWithinAsync() flavors that don’t require a specific exception type by @Xceed-DelvaJB in fluentassertions/fluentassertions#3059 ### Others * Bump cspell from 9.0.1 to 9.0.2 by @dependabot in fluentassertions/fluentassertions#3050 * Bump JetBrains/qodana-action from 2024.2 to 2025.1 by @dependabot in fluentassertions/fluentassertions#3044 * Fix qodana warnings by @jnyrup in fluentassertions/fluentassertions#3053 * Add contributor grant by @dennisdoomen in fluentassertions/fluentassertions#3055 * Bump cspell from 9.0.2 to 9.1.1 by @dependabot in fluentassertions/fluentassertions#3058 ## New Contributors * @Xceed-DelvaJB made their first contribution in fluentassertions/fluentassertions#3059 **Full Changelog**: fluentassertions/fluentassertions@8.3.0...8.4.0 ## 8.3.0 <!-- Release notes generated using configuration in .github/release.yml at main --> ## What's Changed ### Improvements * Improve rendering of exception messages when using WithMessage by @dennisdoomen in fluentassertions/fluentassertions#3039 * Clarify the date/time type when comparing dates, times and combinations of those by @dennisdoomen in fluentassertions/fluentassertions#3049 ### Others * Bump cspell from 8.17.5 to 8.18.1 by @dependabot in fluentassertions/fluentassertions#3041 * Bump cspell from 8.18.1 to 8.19.2 by @dependabot in fluentassertions/fluentassertions#3042 * Bump cspell from 8.19.2 to 8.19.3 by @dependabot in fluentassertions/fluentassertions#3043 * Bump cspell from 8.19.3 to 9.0.0 by @dependabot in fluentassertions/fluentassertions#3045 * Bump cspell from 9.0.0 to 9.0.1 by @dependabot in fluentassertions/fluentassertions#3046 * Fix links to test suites in bug report template by @robvanuden in fluentassertions/fluentassertions#3047 **Full Changelog**: fluentassertions/fluentassertions@8.2.0...8.3.0 ## 8.2.0 <!-- Release notes generated using configuration in .github/release.yml at main --> ## What's Changed ### Improvements * Optimize various string operations by @jnyrup in fluentassertions/fluentassertions#3037 * Reworked formatting and support multi-dimensional arrays. by @dennisdoomen in fluentassertions/fluentassertions#3009 ### Fixes * Restore `StringSyntax` annotations by @jnyrup in fluentassertions/fluentassertions#3033 * Regex fixups by @jnyrup in fluentassertions/fluentassertions#3034 * Handle missing caller identifier by @jnyrup in fluentassertions/fluentassertions#3036 ### Others * Bump cspell from 8.17.3 to 8.17.5 by @dependabot in fluentassertions/fluentassertions#3035 **Full Changelog**: fluentassertions/fluentassertions@8.1.1...8.2.0 ## 8.1.1 <!-- Release notes generated using configuration in .github/release.yml at main --> ## What's Changed ### Fixes * Fix a formatting exception when {} is used as a dictionary key. by @dennisdoomen in fluentassertions/fluentassertions#3029 * Removed the PS script that opens the FA website because it misbehaves. by @dennisdoomen in fluentassertions/fluentassertions#3030 **Full Changelog**: fluentassertions/fluentassertions@8.1.0...8.1.1 ## 8.1.0 <!-- Release notes generated using configuration in .github/release.yml at main --> ## What's Changed ### Improvements * Add [NotNull] attribute on the Should() method for object assertions by @0xced in fluentassertions/fluentassertions#2987 * Improves the subject identification for chained assertions and those that use Which by @dennisdoomen in fluentassertions/fluentassertions#3000 ### Fixes * Fixed a regression in which CompleteWithinAsync treated a canceled task as an exception by @dennisdoomen in fluentassertions/fluentassertions#2853 ### Documentation * Reconnected the new license to the history of the old license by @dennisdoomen in fluentassertions/fluentassertions#2985 * Removed an incorrect date/time example from the docs by @dennisdoomen in fluentassertions/fluentassertions#2989 ### Others * Make sure developers don't accidentally update to v8 without understanding the new license by @dennisdoomen in fluentassertions/fluentassertions#2988 * Bump Microsoft.Testing.Extensions.TrxReport from 1.5.1 to 1.5.3 by @dependabot in fluentassertions/fluentassertions#2993 * Bump TUnit from 0.6.154 to 0.7.24 by @dependabot in fluentassertions/fluentassertions#2992 * Bump the mstest group with 2 updates by @dependabot in fluentassertions/fluentassertions#2991 * Backport updates to pipelines by @jnyrup in fluentassertions/fluentassertions#3001 * Bump cspell from 8.17.2 to 8.17.3 by @dependabot in fluentassertions/fluentassertions#3005 * Bump Roslynator.Analyzers from 4.12.10 to 4.12.11 by @dependabot in fluentassertions/fluentassertions#3004 * Bump TUnit from 0.7.24 to 0.10.6 by @dependabot in fluentassertions/fluentassertions#3002 * Upmerge from v7 by @dennisdoomen in fluentassertions/fluentassertions#3006 * Renamed CallerStatementBuilder to StatementParser by @dennisdoomen in fluentassertions/fluentassertions#3007 * Bump Meziantou.Analyzer and Microsoft.NETFramework.ReferenceAssemblies by @dependabot in fluentassertions/fluentassertions#3014 * Bump Microsoft.NET.Test.Sdk, Microsoft.NETFramework.ReferenceAssemblies and Newtonsoft.Json by @dependabot in fluentassertions/fluentassertions#3013 * Bump Microsoft.NETFramework.ReferenceAssemblies and Roslynator.Analyzers by @dependabot in fluentassertions/fluentassertions#3012 * Bump the xunit group with 3 updates by @dependabot in fluentassertions/fluentassertions#3010 * Adjust dependencies by @jnyrup in fluentassertions/fluentassertions#3015 * Bump NUnit3TestAdapter from 4.6.0 to 5.0.0 in the nunit group by @dependabot in fluentassertions/fluentassertions#3011 * Fixed typo in introduction page by @tealamore in fluentassertions/fluentassertions#3019 * Bump Verify.Xunit from 28.10.1 to 28.11.0 in the xunit group by @dependabot in fluentassertions/fluentassertions#3022 * Bump TUnit from 0.10.6 to 0.13.3 by @dependabot in fluentassertions/fluentassertions#3026 * Bump Microsoft.Testing.Extensions.CodeCoverage from 17.13.1 to 17.14.1 by @dependabot in fluentassertions/fluentassertions#3024 * Bump the mstest group with 2 updates by @dependabot in fluentassertions/fluentassertions#3023 * Bump Microsoft.NETFramework.ReferenceAssemblies, System.Collections.Immutable and System.Reflection.Metadata by @dependabot in fluentassertions/fluentassertions#3025 * Upmerge from v7 by @jnyrup in fluentassertions/fluentassertions#3028 * Fixed a regression in which CompleteWithinAsync treated a canceled ta… by @dennisdoomen in fluentassertions/fluentassertions#3027 ## New Contributors * @tealamore made their first contribution in fluentassertions/fluentassertions#3019 **Full Changelog**: fluentassertions/fluentassertions@8.0.1...8.1.0 ## 8.0.1 <!-- Release notes generated using configuration in .github/release.yml at main --> ## What's Changed ### Improvements * Provide a toggle to suppress the soft warning about commercial use by @dennisdoomen in fluentassertions/fluentassertions#2984 ### Others * Update docs to make license change more clear by @jnyrup in fluentassertions/fluentassertions#2953 * Bump all dependencies by @dennisdoomen in fluentassertions/fluentassertions#2962 * Bump System.Collections.Immutable and System.Reflection.Metadata by @dependabot in fluentassertions/fluentassertions#2969 * Bump SharpCompress from 0.38.0 to 0.39.0 by @dependabot in fluentassertions/fluentassertions#2968 * Bump the nuke group with 2 updates by @dependabot in fluentassertions/fluentassertions#2967 * Bump Verify.Xunit from 28.8.1 to 28.9.0 in the xunit group by @dependabot in fluentassertions/fluentassertions#2965 * Bump the mstest group with 2 updates by @dependabot in fluentassertions/fluentassertions#2966 * Bump cspell from 8.17.1 to 8.17.2 by @dependabot in fluentassertions/fluentassertions#2964 * Discard backported changes from 7 by @dennisdoomen in fluentassertions/fluentassertions#2974 * Various textual and styling fixes as well as some clarification of v7 and v8. by @dennisdoomen in fluentassertions/fluentassertions#2978 * Bump Xunit.StaFact from 1.1.11 to 1.2.69 in the xunit group by @dependabot in fluentassertions/fluentassertions#2979 * Bump TUnit from 0.6.33 to 0.6.154 by @dependabot in fluentassertions/fluentassertions#2980 * Bump Reflectify from 1.4.0 to 1.5.0 by @dependabot in fluentassertions/fluentassertions#2981 * Bump System.Formats.Asn1 from 9.0.0 to 9.0.1 by @dependabot in fluentassertions/fluentassertions#2983 * Bump coverlet.collector from 6.0.3 to 6.0.4 by @dependabot in fluentassertions/fluentassertions#2982 **Full Changelog**: fluentassertions/fluentassertions@8.0.0...8.0.1 Commits viewable in [compare view](fluentassertions/fluentassertions@8.0.0...8.8.0). </details> [](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show <dependency name> ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) </details> Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
This PR adds comprehensive support for JSON assertion APIs in FluentAssertions along with
BeEquivalentTofunctionality for JSON nodes.The PR introduces new assertion methods for
System.Text.Json.Nodes.JsonNodeandJsonArraytypes, including type checking methods likeBeNumeric(),BeString(),BeBool(),BeLocalDate(), andBeUtcDate(). It also adds property verification methods such asHaveProperty()and array checking withBeAnArray().A key feature is the
BeEquivalentTo()method that allows comparing JSON nodes directly to C# objects, with automatic conversion of JSON values to appropriate .NET types (including ISO 8601 date parsing). This comparison supports case-insensitive property matching through theIgnoringJsonPropertyCasing()option.The implementation includes new matching rules specifically for JSON properties that work alongside existing member matching, and a JSON conversion step that automatically handles type conversions during equivalency comparisons. The system seamlessly integrates with the existing equivalency framework, allowing JSON nodes to be compared against complex object graphs with nested properties and collections.
Closes #2205