Meziantou.Framework.InlineSnapshotTesting 1.0.26

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 = InlineSnapshotSettings.Default with
        {
            SnapshotUpdateStrategy = SnapshotUpdateStrategy.MergeTool,
            MergeTool = 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.CreateBuilder()
    .WithSettings(settings)
    .Validate(data, "");

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(), expected, filePath, lineNumber);
}