Documentation

ArturRios.Util.Test is a small .NET library of test-support utilities for xUnit projects. It bundles the helpers that come up again and again when testing services and web APIs: extra assertions, environment-aware test attributes, in-memory fakes for repositories and schedulers, and a base class for functional web API tests.

Installation

dotnet add package ArturRios.Util.Test

It is built on xUnit v3, so the test project references xunit.v3, or xunit.v3.mtp-off to keep running through VSTest. Versions before 5.0 are built on xUnit v2.

The package targets net10.0 and builds on other ArturRios.* packages (ArturRios.Util, ArturRios.Data.Relational.Core, ArturRios.Mediator, ArturRios.Configuration and ArturRios.Util.WebApi) plus xUnit v3’s xunit.v3.extensibility.core and xunit.v3.assert, Microsoft.AspNetCore.Mvc.Testing and Microsoft.EntityFrameworkCore.

What’s inside

Guides

• Assertions & Attributes — CustomAssert and the environment-aware test attributes.
• Fakes — FakeRepository<T, TKey>, AsyncFakeRepository<T, TKey> and FakeScheduler.
• Web API Testing — the WebApiTest<T> base class.

Quick Start

Custom assertions

CustomAssert.NullOrEmpty(collection);      // passes for null or empty
CustomAssert.NotNullOrEmpty(collection);   // passes only for a non-empty collection
CustomAssert.NullOrWhiteSpace(text);
CustomAssert.NotNullOrWhiteSpace(text);

Environment-aware attributes

// Runs everywhere except Production.
[UnitFact([EnvironmentType.Production])]
public void Calculates_totals() { /* ... */ }

In-memory repository

var repository = new FakeRepository<Person, long>();   // Person : Entity<long>

var id = repository.Create(new Person { Name = "Ann" }).Data;   // long and int ids start at 1
var person = repository.GetById(id).Data;

Functional web API test

public class ProductsApiTests : WebApiTest<Program>
{
    public ProductsApiTests() : base(EnvironmentType.Local) { }

    [Fact]
    public async Task Creates_a_product()
    {
        await AuthenticateAndAuthorizeAsync(new Credentials("user@test.com", "secret123"), "/auth");

        var response = await Gateway.PostAsync<DataOutput<ProductOutput>>("/products", new { Name = "Widget" });

        Assert.Equal(HttpStatusCode.OK, response.StatusCode);
    }
}

Upgrading

• From 4.x to 5.0: Upgrading from 4.x to 5.0
• From 3.x to 4.0: Upgrading from 3.x to 4.0

Legal Details

This project is licensed under the MIT License. A copy of the license is available at LICENSE in the repository.