Snapshot 0.2.0-alpha

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

// Install Snapshot as a Cake Tool
#tool nuget:?package=Snapshot&version=0.2.0-alpha&prerelease

Snapshot

Snapshot aims to reduce the complexity of unit tests, and provide test documentation in the form of JSON files.

It is an implementation of the Jest Snapshot Testing concept that is found in React Javascript unit testing.

Setup

First install the NuGet package Snapshot. Currently only a pre-release version exists: 0.1.0-alpha.

Next use SnapshotAssert to generate Snapshot files. See these tests for an example of the expected behaviour.

Use Cases

  • Testing the output of mapping logic, replace multiple assertions with a single snapshot.
  • Asserting that there are no changes in the response of an API.

Known Issues

  • Not possible to update a snapshot programmatically.
  • No test runner output / warnings.
  • Calling .Snapshot(..) from a non-Fact/Theory method will use that method name for the naming of the snapshot JSON file. This can cause issues when using that non-Fact/Theory method for multiple tests.

Contributing

See Contributing.md.

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. 
.NET Core netcoreapp2.0 is compatible.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.4.0-alpha 817 2/11/2018
0.3.0-alpha 713 2/11/2018
0.2.0-alpha 624 12/27/2017
0.1.0-alpha 817 12/27/2017

Initial release.