AutoFixture.Xunit 4.19.0

AutoFixture.xUnit

AutoFixture.xUnit is a .NET library that integrates AutoFixture with xUnit 1.x, allowing you to effortlessly generate test data for your unit tests. By automatically populating your test parameters, it helps you write cleaner, more maintainable tests without having to manually construct test objects.

[!WARNING] While this package is still being developed, the xUnit 1 package is deprecated.<br/> This package is intended only for legacy projects that are still using xUnit 1.x.<br/>

Table of Contents

• Installation
• Getting Started
• Integrations
• Contributing
• License

Installation

AutoFixture packages are distributed via NuGet.<br /> To install the packages you can use the integrated package manager of your IDE, the .NET CLI, or reference the package directly in your project file.

dotnet add package AutoFixture.xUnit --version x.x.x

<PackageReference Include="AutoFixture.xUnit" Version="x.x.x" />

Getting Started

Basic Usage

AutoFixture.xUnit provides an [AutoData] attribute that automatically populates test method parameters with generated data.

For example, imagine you have a simple calculator class:

public class Calculator
{
	public int Add(int a, int b) => a + b;
}

You can write a test using AutoFixture to provide the input values:

using Xunit;
using AutoFixture.xUnit;

public class CalculatorTests
{
    [Theory, AutoData]
    public void Add_SimpleValues_ReturnsCorrectResult(
        Calculator calculator, int a, int b)
    {
        // Act
        int result = calculator.Add(a, b);

        // Assert
        Assert.AreEqual(a + b, result);
    }
}

Inline Auto-Data

You can also combine auto-generated data with inline arguments using the [InlineAutoData] attribute. This allows you to specify some parameters while still letting AutoFixture generate the rest.

using Xunit;
using AutoFixture.xUnit;
using AutoFixture;

public class CalculatorTests
{
    [Theory, InlineAutoData(5, 8)]
    public void Add_SpecificValues_ReturnsCorrectResult(
        int a, int b, Calculator calculator)
    {
        // Act
        int result = calculator.Add(a, b);

        // Assert
        Assert.AreEqual(13, result);
    }
}

Freezing Dependencies

AutoFixture's [Frozen] attribute can be used to ensure that the same instance of a dependency is injected into multiple parameters.

For example, if you have a consumer class that depends on a shared dependency:

public class Dependency { }

public class Consumer
{
    public Dependency Dependency { get; }

    public Consumer(Dependency dependency)
    {
        Dependency = dependency;
    }
}

You can freeze the Dependency so that all requests for it within the test will return the same instance:

using Xunit;
using AutoFixture.xUnit;
using AutoFixture;

public class ConsumerTests
{
    [Theory, AutoData]
    public void Consumer_UsesSameDependency(
        [Frozen] Dependency dependency, Consumer consumer)
    {
        // Assert
        Assert.AreSame(dependency, consumer.Dependency);
    }
}

Integrations

AutoFixture offers a variety of utility packages and integrations with most of the major mocking libraries and testing frameworks.

[!NOTE] Since AutoFixture tries maintain compatibility with a large number of package versions, the packages bundled with AutoFixture might not contain the latest features of your (e.g. mocking) library.<br /> Make sure to install the latest version of the integrated library package, alongside the AutoFixture packages.

Core packages

The core packages offer the full set of AutoFixture's features without requring any testing framework or third party integration.

Product	Package	Stable	Preview	Downloads
The core package	AutoFixture
Assertion idioms	AutoFixture.Idioms
Seed extensions	AutoFixture.SeedExtensions

Mocking libraries

AutoFixture offers integations with most major .NET mocking libraries.<br/> These integrations enable such features as configuring mocks, auto-injecting mocks, etc.

Product	Package	Stable	Preview	Downloads
Moq	AutoFixture.AutoMoq
NSubstitute	AutoFixture.AutoNSubstitute
FakeItEasy	AutoFixture.AutoFakeItEasy
Rhino Mocks	AutoFixture.AutoRhinoMocks

Testing frameworks

AutoFixture offers integrations with most major .NET testing frameworks.<br /> These integrations enable auto-generation of test cases, combining auto-generated data with inline arguments, etc.

Product	Package	Stable	Preview	Downloads
xUnit v3	AutoFixture.Xunit3
xUnit v2	AutoFixture.Xunit2
xUnit v1	AutoFixture.Xunit
NUnit v4	AutoFixture.NUnit4
NUnit v3	AutoFixture.NUnit3
NUnit v2	AutoFixture.NUnit2
Foq	AutoFixture.AutoFoq

You can check the compatibility with your target framework version on the wiki or on the NuGet website.

Contributing

Contributions to AutoFixture.xUnit are welcome! If you would like to contribute, please review our contributing guidelines and open an issue or pull request.

License

AutoFixture is Open Source software and is released under the MIT license.<br /> The licenses allows the use of AutoFixture libraries in free and commercial applications and libraries without restrictions.

.NET Foundation

This project is supported by the .NET Foundation.