Meziantou.Framework.InlineSnapshotTesting 1.0.5

Prefix Reserved
There is a newer version of this package available.
See the version list below for details.
dotnet add package Meziantou.Framework.InlineSnapshotTesting --version 1.0.5                
NuGet\Install-Package Meziantou.Framework.InlineSnapshotTesting -Version 1.0.5                
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="Meziantou.Framework.InlineSnapshotTesting" Version="1.0.5" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Meziantou.Framework.InlineSnapshotTesting --version 1.0.5                
#r "nuget: Meziantou.Framework.InlineSnapshotTesting, 1.0.5"                
#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.
// Install Meziantou.Framework.InlineSnapshotTesting as a Cake Addin
#addin nuget:?package=Meziantou.Framework.InlineSnapshotTesting&version=1.0.5

// Install Meziantou.Framework.InlineSnapshotTesting as a Cake Tool
#tool nuget:?package=Meziantou.Framework.InlineSnapshotTesting&version=1.0.5                

Meziantou.Framework.InlineSnapshotTesting

Meziantou.Framework.InlineSnapshotTesting is a snapshot tool that simplifies the assertion of complex data models and documents. It is inspired on Verify.

InlineSnapshot is called on the test result during the assertion phase. It serializes that result and update the expected value. On the next test execution, the result is again serialized and compared to the existing value. The test will fail if the two snapshots do not match: either the change is unexpected, or the reference snapshot needs to be updated to the new result.

On the development machine, a diff tool prompt to compare the expected snapshot with the current snapshot. So, you can accept the new value or cancel. So, you can quickly iterate on your code and update snapshots.

How does it work

First you can write a test with the following code:

var data = new
{
    FirstName = "G�rald",
    LastName = "Barr�",
    NickName = "meziantou",
};

// No need to write the expected value
InlineSnapshot.Validate(data, "");

Then, run the tests. It will show you a diff tool where you can compare the expected value and the new value. Once you accept the change, the test is updated:

var data = new
{
    FirstName = "G�rald",
    LastName = "Barr�",
    NickName = "meziantou",
};
InlineSnapshot.Validate(data, """
    FirstName: G�rald,
    LastName: Barr�,
    NickName: meziantou
    """);

Other features

Configuration

You can configure the default behavior of Validate() by settings InlineSnapshotSettings.Default. In the case of unit tests, you may want to update the configuration before running tests. You can use a ModuleInitializer to do so.

static class AssemblyInitializer
{
    [ModuleInitializer]
    public static void Initialize()
    {
        InlineSnapshotSettings.Default.SnapshotUpdateStrategy = SnapshotUpdateStrategy.MergeTool;
        InlineSnapshotSettings.Default.DiffTool = DiffTool.VisualStudioCode;
    }
}

You can also set the configuration per assert.

// InlineSnapshotSettings is a record, so you can use the "with" keyword to create a new instance
var settings = InlineSnapshotSettings.Default with
{
    SnapshotUpdateStrategy = SnapshotUpdateStrategy.Overwrite,
};

InlineSnapshot.Validate(data, settings, "");

Environment variables

  • DiffEngine_Tool: Set the default merge tool

Using helper methods

If you want to use helper methods before calling Validate(), you need to decorate the methods with [InlineSnapshotAssertion] and use [CallerFilePath] and [CallerLineNumber].

Helper(""); // This string will be updated
            
[InlineSnapshotAssertion(nameof(expected))]
static void Helper(string expected, [CallerFilePath] string filePath = null, [CallerLineNumber] int lineNumber = -1)
{
    InlineSnapshot.Validate(new object(), null, expected, filePath, lineNumber);
}
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  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 is compatible.  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. 
.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 (2)

Showing the top 2 NuGet packages that depend on Meziantou.Framework.InlineSnapshotTesting:

Package Downloads
FunFair.Test.Common

FunFair Common Test Infrastructure for building xUnit tests on top of.

Meziantou.Framework.InlineSnapshotTesting.Serializers.Argon

Serializer based on Argon for Meziantou.Framework.InlineSnapshotTesting

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
3.3.5 4,037 12/17/2024
3.3.4 64 12/17/2024
3.3.3 278 11/28/2024
3.3.2 127 11/24/2024
3.3.1 158 11/22/2024
3.3.0 134 11/20/2024
3.2.1 111 11/17/2024
3.2.0 7,258 10/28/2024
3.1.1 368 10/27/2024
3.1.0 115 10/27/2024
3.0.11 1,120 10/20/2024
3.0.10 2,042 10/19/2024
3.0.9 563 10/18/2024
3.0.8 704 9/23/2024
3.0.7 5,796 8/1/2024
3.0.6 91 7/31/2024
3.0.5 3,017 6/24/2024
3.0.4 130 6/24/2024
3.0.3 103 6/24/2024
3.0.1 7,387 3/29/2024
3.0.0 13,616 1/6/2024
2.0.2 1,062 1/3/2024
2.0.1 2,523 12/29/2023
2.0.0 5,199 12/15/2023
1.0.28 2,932 12/6/2023
1.0.27 238 11/15/2023
1.0.26 210 9/29/2023
1.0.25 150 9/29/2023
1.0.24 323 7/22/2023
1.0.23 197 7/18/2023
1.0.22 191 7/10/2023
1.0.20 162 7/10/2023
1.0.19 371 5/31/2023
1.0.17 166 5/31/2023
1.0.16 159 5/30/2023
1.0.15 173 5/30/2023
1.0.14 155 5/27/2023
1.0.13 224 5/25/2023
1.0.12 163 5/25/2023
1.0.11 190 5/24/2023
1.0.9 228 4/28/2023
1.0.8 193 4/27/2023
1.0.7 186 4/25/2023
1.0.6 194 4/21/2023
1.0.5 214 4/12/2023
1.0.4 214 4/1/2023
1.0.3 248 3/24/2023
1.0.2 228 3/21/2023
1.0.1 225 3/19/2023
1.0.0 327 3/13/2023