Write maintainable unit tests, faster.
AutoFixture makes it easier for developers to do Test-Driven Development by automating non-relevant Test Fixture Setup, allowing the Test Developer to focus on the essentials of each test case.
(Jump straight to the CheatSheet if you just want to see some code samples right away.)
AutoFixture is designed to make Test-Driven Development more productive and unit tests more refactoring-safe. It does so by removing the need for hand-coding anonymous variables as part of a test's Fixture Setup phase. Among other features, it offers a generic implementation of the Test Data Builder pattern.
When writing unit tests, you typically need to create some objects that represent the initial state of the test. Often, an API will force you to specify much more data than you really care about, so you frequently end up creating objects that has no influence on the test, simply to make the code compile.
AutoFixture can help by creating such Anonymous Variables for you. Here's a simple example:
[Fact]
public void IntroductoryTest()
{
// Arrange
Fixture fixture = new Fixture();
int expectedNumber = fixture.Create<int>();
MyClass sut = fixture.Create<MyClass>();
// Act
int result = sut.Echo(expectedNumber);
// Assert
Assert.Equal(expectedNumber, result);
}This example illustrates the basic principle of AutoFixture: It can create values of virtually any type without the need for you to explicitly define which values should be used. The number expectedNumber is created by a call to Create - this will create a 'nice', regular integer value, saving you the effort of explicitly coming up with one.
The example also illustrates how AutoFixture can be used as a SUT Factory that creates the actual System Under Test (the MyClass instance).
Given the right combination of unit testing framework and extensions for AutoFixture, we can further reduce the above test to be even more declarative:
[Theory, AutoData]
public void IntroductoryTest(
int expectedNumber, MyClass sut)
{
int result = sut.Echo(expectedNumber);
Assert.Equal(expectedNumber, result);
}and
[Test, AutoData]
public void IntroductoryTest(
int expectedNumber, MyClass sut)
{
int result = sut.Echo(expectedNumber);
Assert.Equal(expectedNumber, result);
}Notice how we can reduce unit tests to state only the relevant parts of the test. The rest (variables, Fixture object) is relegated to attributes and parameter values that are supplied automatically by AutoFixture. The test is now only two lines of code.
Using AutoFixture is as easy as referencing the library and creating a new instance of the Fixture class!
| Product | .NET Framework | .NET Standard |
|---|---|---|
| AutoFixture | ✔️ 4.5.2 | ✔️ 1.5, 2.0 |
| AutoFixture.SeedExtensions | ✔️ 4.5.2 | ✔️ 1.5, 2.0 |
| AutoFixture.xUnit | ✔️ 4.5.2 | ➖ |
| AutoFixture.xUnit2 | ✔️ 4.5.2 | ✔️ 1.5, 2.0 |
| AutoFixture.NUnit2 | ✔️ 4.5.2 | ➖ |
| AutoFixture.NUnit3 | ✔️ 4.5.2 | ✔️ 1.5, 2.0 |
| AutoFakeItEasy | ✔️ 4.5.2 | ✔️ 1.6, 2.0 |
| AutoFoq | ✔️ 4.5.2 | ➖ |
| AutoMoq | ✔️ 4.5.2 | ✔️ 1.5, 2.0 |
| AutoNSubstitute | ✔️ 4.5.2 | ✔️ 1.5, 2.0 |
| AutoRhinoMock | ✔️ 4.5.2 | ➖ |
| Idioms | ✔️ 4.5.2 | ✔️ 2.0 |
| Idioms.FsCheck | ✔️ 4.5.2 | ✔️ 2.0 |
AutoFixture is available via NuGet:
- AutoFixture
- AutoFixture.SeedExtensions
- AutoFixture.AutoMoq
- AutoFixture.AutoRhinoMocks
- AutoFixture.AutoFakeItEasy
- AutoFixture.AutoNSubstitute
- AutoFixture.AutoFoq
- AutoFixture.Xunit
- AutoFixture.Xunit2
- AutoFixture.NUnit2
- AutoFixture.NUnit3
- AutoFixture.Idioms
The artifacts of the next major version are published to the MyGet feed:
https://www.myget.org/F/autofixture/api/v3/index.json(Visual Studio 2015+)https://www.myget.org/F/autofixture/api/v2(Visual Studio 2012+)
You can use this feed to early access and test the next major version of the AutoFixture.
Notice, this feed exists for the preview purpose only, so use it with caution:
- new versions of packages might contain breaking changes and API could change drastically from package to package. By other words, we don't follow the SemVer policy for the packages in this feed;
- packages might be cleaned up over time (MyGet has storage limits), so don't consider this feed for the permanent usage (or at least ensure to make a copy of the used packages somewhere else).
AutoFixture follows Semantic Versioning 2.0.0 for the public releases (published to the nuget.org).
AutoFixture uses FAKE as a build engine. If you would like to build the AutoFixture locally, run the build.cmd file and wait for the result.
The repository state (the last tag name and number of commits since the last tag) is used to determine the build version. If you would like to override the auto-generated AutoFixture version, set the BUILD_VERSION environment variable before calling the build.cmd file. Example for PowerShell:
$env:BUILD_VERSION='3.52.0'; .\build.cmd
Refer to the Build.fsx file to get information about all the supported build keys.
If you have questions, feel free to ask. The best places to ask are:
AutoFixture is used around the world, as the following quotes testify:
"I’ve introduced AutoFixture to my developers (at www.gab.de ) some time ago. We’ve been using it successfully with xunit in multiple projects all across the .NET technology stack. We also use it for feeding dummy data to the UI when developing prototypes. That saved us quite some time.
"I have used AutoFixture for 3 years, it's a vital tool in my TDD toolbox, a real time-saver. Setting up maintainable and robust unit tests with AutoFixture is easy and straightforward - highly recommendable"
-Mads Tjørnelund Toustrup, Senior .Net Developer, d60 a/s
"Autofixture is more than just another test data generator. It helps me to write tests faster, which are robust against changes in my production code. Moreover, with Autofixture I can focus the tests on the behavior I want to check which why they are easier to read and understand."
If you want to add your own testimonial to this list, we (the AutoFixture maintainers) would be very grateful. Send us a pull request to this README.md file.