ArwynFr.IntegrationTesting

This library provides utility classes for writing integration tests in dotnet using XUnit and WebApplicationFactory.

Installation

dotnet new classlib -n MyTestProject

dotnet add package ArwynFr.IntegrationTesting
dotnet add package Microsoft.NET.Test.Sdk
dotnet add package xunit.runner.visualstudio

Usage

Read advanced usage documentation for further details.

By default, the lib redirects the tested application logs to XUnit output, so you get them in the test output in case of failure. It also overwrites the application configuration with values from user secrets and environement variables.

public class MyTest : IntegrationTestBase<Program>
{
    public MyTest(ITestOutputHelper output) : base(output) { }

    [Fact]
    public async Task OnTest()
    {
        // Call system under test
        var response = await Client.GetFromJsonAsync<OrderDto>($"/order");

        response.Should().HaveValue();
    }

    // Override a service with fake implementation in the tested app
    protected override void ConfigureAppServices(IServiceCollection services)
        => services.AddSingleton<IMyService, FakeService>();
}

EntityFrameworkCore integration

public class TestBaseDb : IntegrationTestBase<Program, MyDbContext>
{
    public TestBaseDb(ITestOutputHelper output) : base(output) { }

    [Fact]
    public async Task OnTest()
    {
        // Access the injected dbcontext
        var value = await Database.Values
            .Where(val => val.Id == 1)
            .Select(val => val.Result)
            .FirstOrDefaultAsync();

        // Call system under test
        var result = await Client.GetFromJsonAsync<int>("/api/value/1");

        result.Should().Be(value + 1);
    }

    // Create and drop a database for every test execution
    protected override IDatabaseTestStrategy<Context> DatabaseTestStrategy
        => IDatabaseTestStrategy<MyDbContext>.DatabasePerTest;

    // Configure EFcore with a random database name
    protected override void ConfigureDbContext(DbContextOptionsBuilder builder)
        => builder.UseSqlite($"Data Source={Guid.NewGuid()}.sqlite");
}

Fluent specification-based testing

// Actual code redacted for brievty
// Write a test driver that implements specifications:
private class MySpecDriver(MyDbContext dbContext, HttpClient client) : TestDriverBase<SpecDriver>
{
    // Arranges
    public async Task ThereIsEntityWithName(string name) { }
    public async Task ThereIsNoEntityWithName(string name) { }

    // Acts
    public async Task ListAllEntities() { }
    public async Task FindEntityWithName(string name) { }
    public async Task CreateEntity(EntityDetails payload) { }

    // Asserts
    public async Task ResultShouldBe(string name) { }
    public async Task DetailsCountShouldBe(int number) { }
}

public class MySpecTest(ITestOutputHelper output) : TestBaseDb
{
    // Write fluent specifiation test:
    [Theory, InlineData("ArwynFr")]
    public async Task OnTest(string name)
    {
        await Services.GetRequiredService<MySpecDriver>()
            .Given(x => x.ThereIsEntityWithName(name))
            .When(x => x.FindEntityWithName(name))
            .Then(x => x.ResultShouldBe(name))
            .ExecuteAsync();
    }

    // Configure DI library
    protected override void ConfigureAppServices(IServiceCollection services)
    {
        base.ConfigureAppServices(services);
        services.AddSingleton(_ => new MySpecDriver(Database, Client));
    }
}

Contributing

This project welcomes contributions:

Request for support:
TBD

Disclose vulnerability:
Please create a new security advisory on GitHub
Read our security policy

Report malfunctions:
Please create a new issue on GitHub

Suggest a feature:
Please create a new issue on GitHub

Offer some code:
Please fork the repository and submit a pull-request
Read our definition of done in contributing guidelines