ApprovalTests
Capturing Human Intelligence - ApprovalTests is an open source assertion/verification library to aid unit testing.
It is compatible with most .Net unit testing frameworks (Nunit, MsTest, Xunit, MBUnit)
What can it be used for?
Approval Tests can be used for verifying objects that require more than a simple assert. They also come prepackaged with utilities for some common .Net scenarios including
- Dictionaries & Collections
- Long Strings
- Log Files
- Asp.Net
- Asp.Net Mvc
- Winforms
- Wpf
- Entity Framework
- Rdlc reports
Video Tutorials
You can watch a bunch of short videos on getting started and using ApprovalTests in .Net at YouTube
Podcasts
If you prefer auditory learning, you might enjoy the following podcast
Available on NuGet
Nightly (CI) Builds available at myget.org:
ApprovalTests on the MyGet Gallery
Note: Select "Include Prerelease" instead of "Stable Only" (-IncludePrerelease
in powershell)
Examples
[UseReporter(typeof(DiffReporter))]
[TestFixture]
public class SampleTest
{
[Test]
public void TestList()
{
var names = new[] {"Llewellyn", "James", "Dan", "Jason", "Katrina"};
Array.Sort(names);
Approvals.VerifyAll(names, "");
}
}
Will Produce a File
SampleTest.TestList.received.txt
[0] = Dan
[1] = James
[2] = Jason
[3] = Katrina
[4] = Llewellyn
Simply rename this to SampleTest.TestList.approved.txt and the test will now pass.
Approved File Artifacts
The *.approved.*
files must be checked into source your source control. ApprovalTests now ignores line endings by default (so you can remove *.approved.* binary
from your .gitattributes file if you added previously).
If you would like to verify line endings, simply add [assembly: IgnoreLineEndingsAttribute(false)]
to your AssemblyInfo.cs
Do not add *.received.*
files to your source control (they are transitory, and some SCMs like TFS will lock them or mark them read-only, which will break every dependent test).
More Info
LICENSE
Questions?
ask on twitter: @LlewellynFalco or #ApprovalTests