Unit tests will often need to assert that a sizeable amount of data matches an expectation, and this is difficult with only the traditional style of assertion. You essentially have the choice of writing a long list of simple assertions, or concatenating the output into a string and using a single assert against that. However, when these assertions fail it can be very hard to determine in what ways the output differs from the expectation.
One solution to this problem is a different workflow from traditional unit testing - instead of making a prediction in the code, and then checking the output against the prediction, what if you formatted the output and displayed it side by side with the last "approved" version. This is what TestConsole.Core provides. On a build server, when the test result does not match the default behaviour is just to fail the test, whereas on a development PC you can configure the library to use an installed file compare utility to display the differences. If the differences are expected, you can copy the new result over to the approved version and the test will pass.
TestConsole.Core inherits all of the formatting capabilities from the original TestConsole project, and adds test approval features. Users of ApprovalTests will recognise the workflow and the functionality, but at the time of publishing, ApprovalTests is full framework only, whereas TestConsole.Core is intended to allow testing in both full framework and .NET core test suites. I did not set out to build an alternative to ApprovalTests, but I need to be able to test netcoreapp code, and the conversion of TestConsole was not difficult. However, ApprovalTests did not support netstandard or netcoreapp test suites and I couldn't wait any longer, so I built the subset of ApprovalTests features that I needed into TestConsole.Core from scratch. As a result, the syntax is a little different to ApprovalTests, particularly where it relates to selecting a file compare tool, and also relating to what can be directly approved. The intention of the test approval features is to allow data formatted using the TestConsole Output object to be approved, and I've also extended it to handle any plain text.
Install-Package TestConsole -Version 2.5.2-beta
dotnet add package TestConsole --version 2.5.2-beta
<PackageReference Include="TestConsole" Version="2.5.2-beta" />
paket add TestConsole --version 2.5.2-beta
#r "nuget: TestConsole, 2.5.2-beta"
// Install TestConsole as a Cake Addin #addin nuget:?package=TestConsole&version=2.5.2-beta&prerelease // Install TestConsole as a Cake Tool #tool nuget:?package=TestConsole&version=2.5.2-beta&prerelease
Support for approvals in async methods.
Added the ability to set a title for a simple FormatTable call.
- System.Reflection.Emit (>= 4.7.0)
NuGet packages (2)
Showing the top 2 NuGet packages that depend on TestConsole:
SnapshotTests is a library that supports TDD by allowing snapshots to be taken of datasets before and after a test operation. The differences between the snapshots can be computed and formatted for approval. The library relies on TestConsole for formatting and the approval mechanism.
This package is not used by any popular GitHub repositories.