Socolin.TestUtils.JsonComparer 1.6.0

.NET Standard 2.0 This package targets .NET Standard 2.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package Socolin.TestUtils.JsonComparer --version 1.6.0
                    


                    

                
NuGet\Install-Package Socolin.TestUtils.JsonComparer -Version 1.6.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Socolin.TestUtils.JsonComparer" Version="1.6.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Socolin.TestUtils.JsonComparer" Version="1.6.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Socolin.TestUtils.JsonComparer" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add Socolin.TestUtils.JsonComparer --version 1.6.0
                    


                    

                
#r "nuget: Socolin.TestUtils.JsonComparer, 1.6.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package Socolin.TestUtils.JsonComparer@1.6.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=Socolin.TestUtils.JsonComparer&version=1.6.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Socolin.TestUtils.JsonComparer&version=1.6.0
                    


                            Install as a Cake Tool

This library provides a simple way to compare two JSON, with an easily readable output to find what differs.

Features:

  • Compare JSON and returns a list of errors.
  • Compare a value using a regex, range
  • Capture a value
  • Compare a number to match a range

Simple compare

Example

Code
const string expectedJson = @"{
    ""a"":1,
    ""b"":""abc""
}";
const string actualJson = @"{
    ""a"":42,
    ""b"":""abc""
}";
var jsonComparer = TestUtils.JsonComparer.JsonComparer.GetDefault();
var errors = jsonComparer.Compare(expectedJson, actualJson);
Console.WriteLine(JsonComparerOutputFormatter.GetReadableMessage(expectedJson, actualJson, errors));
Output
Given json does not match expected one:
  - a: Invalid value, expected '1' but found '42'

--- expected
+++ actual
 {
-  "a": 1,
+  "a": 42,
   "b": "abc"
 }

Compare using regex

It's possible to compare strings with a regex, using a custom object with a property __match.

For example, in the following json, to compare the key compareMeWithARegex with the [a-z]+

{
  "compareMeWithARegex": "something"
}

The expected json given to the comparer should be

{
  "compareMeWithARegex": {
    "__match": {
      "regex": "[a-z]+"
    }
  }
}

Example 1

Code
Console.WriteLine("==== MatchExample.Test1 ==== ");
const string expectedJson = @"{
    ""a"":{
        ""__match"":{
            ""regex"": ""\\d+""
        }
    },
    ""b"":""abc""
}";
const string actualJson = @"{
    ""a"":""42"",
    ""b"":""abc""
}";
var jsonComparer = TestUtils.JsonComparer.JsonComparer.GetDefault();
var errors = jsonComparer.Compare(expectedJson, actualJson);
Console.WriteLine(JsonComparerOutputFormatter.GetReadableMessage(expectedJson, actualJson, errors));
Output
No differences found
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Socolin.TestUtils.JsonComparer:

Package Downloads
Socolin.TestUtils.JsonComparer.NUnitExtensions

Extensions of NUnit to easily use Socolin.TestUtils.JsonComparer.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.16.0 15,222 1/22/2023
1.15.1 726 12/24/2022
1.15.0 587 12/24/2022
1.14.0 5,090 6/12/2022
1.13.0 1,305 3/20/2022
1.12.0 72,101 12/27/2020
1.11.0 557 12/26/2020
1.10.2 610 12/15/2020
1.10.1 635 11/19/2020
1.10.0 954 11/19/2020
1.9.0 2,807 8/14/2020
1.8.1 2,087 7/1/2020
1.8.0 868 6/30/2020
1.7.1 1,252 3/19/2020
1.7.0 2,612 2/26/2020
1.6.0 727 1/14/2020
1.5.1 969 6/23/2019
1.5.0 791 4/26/2019
1.4.0 1,009 12/28/2018
1.3.0 822 12/27/2018
1.2.0 1,637 12/6/2018
1.1.0 797 12/5/2018
1.0.0 851 12/4/2018