Class ApplicationTestFactory

Namespace

Codebelt.Extensions.Xunit.Hosting

Assembly

Codebelt.Extensions.Xunit.Hosting.dll

Provides a set of static methods for IHost testing that bootstraps an existing .NET application entry point.

public static class ApplicationTestFactory

Inheritance

object

ApplicationTestFactory

Examples

The test project references a worker application whose entry point registers WorkerIdentity. ApplicationTestFactory uses ManagedApplicationFixture<TEntryPoint> by default, runs that application's real host setup, and exposes its services and environment through an owned test context so the test can verify application behavior without recreating Program configuration. Pass an explicit IApplicationFixture<TEntryPoint> when the test needs a different lifecycle.

using Codebelt.Extensions.Xunit.Hosting;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using Xunit;

namespace WorkerApp.Tests;

public sealed class ApplicationTestFactoryExample
{
    [Fact]
    public void Create_BootstrapsWorkerApplicationServices()
    {
        using var application = ApplicationTestFactory.Create<WorkerProgram>();

        var identity = application.Host.Services.GetRequiredService<WorkerIdentity>();

        Assert.Equal("Inventory worker", identity.Name);
        Assert.Equal(Environments.Development, application.Environment.EnvironmentName);
    }
}

public sealed record WorkerIdentity(string Name);

public sealed class WorkerProgram
{
    public static void Main(string[] args)
    {
        var builder = Host.CreateApplicationBuilder(args);
        builder.Services.AddSingleton(new WorkerIdentity("Inventory worker"));

        using var host = builder.Build();
        host.Run();
    }
}

Methods

Create<TEntryPoint>(Action<IHostBuilder>, IApplicationFixture<TEntryPoint>)

Creates and returns an IHostTest implementation.

public static IHostTest Create<TEntryPoint>(Action<IHostBuilder> hostSetup = null, IApplicationFixture<TEntryPoint> hostFixture = null) where TEntryPoint : class

Parameters

hostSetup Action<IHostBuilder>

The IHostBuilder which may be configured.

hostFixture IApplicationFixture<TEntryPoint>

An optional IApplicationFixture<TEntryPoint> implementation to use instead of the default ManagedApplicationFixture<TEntryPoint> instance.

Returns

IHostTest

An instance of an IHostTest implementation.

Type Parameters

TEntryPoint

A type in the entry point assembly of the application.

Remarks

When hostFixture is omitted, the factory uses ManagedApplicationFixture<TEntryPoint> so the application entry point owns deferred host startup. Pass another IApplicationFixture<TEntryPoint> implementation when the test requires a different lifecycle.