Xunit Dependency Injection framework
(The source code of the .NET 7.0 version of this library is retained in the fork of this repo while the .NET 6.0 version of this library is maintained and supported in this repo.)
Xunit does not support any built-in dependency injection features, therefore developers have to come up with a solution to recruit their favourite dependency injection framework in their tests.
This library brings in Microsoft's dependency injection container to Xunit by leveraging Xunit's fixture.
Getting started
Nuget package
First add the following nuget package to your Xunit project:
Install-Package Xunit.Microsoft.DependencyInjection
Setup your fixture
The abstract class of Xunit.Microsoft.DependencyInjection.Abstracts.TestBedFixture contains the necessary functionalities to add services and configurations to Microsoft's dependency injection container. Your concrete test fixture class must derive from this abstract class and implement the following two abstract methods:
protected abstract IEnumerable<string> GetConfigurationFiles();
protected abstract void AddServices(IServiceCollection services, IConfiguration configuration);GetConfigurationFiles(...) method returns a collection of the configuration files in your Xunit test project to the framework. AddServices(...) method must be used to wire up the implemented services.
Access the wired up services
There are two method that you can use to access the wired up service depending on your context:
public T GetScopedService<T>(ITestOutputHelper testOutputHelper);
public T GetService<T>(ITestOutputHelper testOutputHelper);Adding custom logging provider
Test developers can add their own desired logger provider by overriding AddLoggingProvider(...) virtual method defined in TestBedFixture class.
Preparing Xunit test classes
Your Xunit test class must be derived from Xunit.Microsoft.DependencyInjection.Abstracts.TestBed<T> class where T should be your fixture class derived from TestBedFixture.
Also, the test class should be decorated by the following attribute:
[CollectionDefinition("Dependency Injection")]Clearing managed resources
To have managed resources cleaned up, simply override the virtual method of Clear(). This is an optional step.
Clearing managed resourced asynchronously
Simply override the virtual method of DisposeAsyncCore() for this purpose. This is also an optional step.
Running tests in order
The library also has a bonus feature that simplifies running tests in order. The test class does not have to be derived from TestBed<T> class though and it can apply to all Xunit classes.
Decorate your Xunit test class with the following attribute and associate TestOrder(...) with Fact and Theory:
[TestCaseOrderer("Xunit.Microsoft.DependencyInjection.TestsOrder.TestPriorityOrderer", "Xunit.Microsoft.DependencyInjection")]Supporting configuration from UserSecrets
This library's TestBedFixture abstract class exposes an instance of IConfigurationBuilder that can be used to support UserSecrets when configuring the test projects:
public IConfigurationBuilder ConfigurationBuilder { get; private set; }Examples
- Please follow this link to view a couple of examples on utilizing this library.
- Digital Silo's unit tests and integration tests are using this library.
One more thing
Do not forget to include the following nuget packages to your Xunit project:
- Microsoft.Extensions.DependencyInjection
- Microsoft.Extensions.Configuration
- Microsoft.Extensions.Options
- Microsoft.Extensions.Configuration.Binder
- Microsoft.Extensions.Configuration.FileExtensions
- Microsoft.Extensions.Configuration.Json
- Microsoft.Extensions.Logging