TUnit项目中WebApplicationFactory与自定义依赖注入的整合挑战

引言

在ASP.NET Core应用程序的集成测试中，WebApplicationFactory是一个强大的工具，它允许开发者创建测试服务器并执行端到端测试。然而，当我们需要在测试类中注入自定义依赖项时，特别是在这些依赖项需要与WebApplicationFactory共享相同服务实例的情况下，会遇到一些技术挑战。

核心问题分析

问题的本质在于测试框架中的两个独立服务容器无法共享服务实例。具体表现为：

1. WebApplicationFactory创建的服务容器与测试类中通过ClassConstructor创建的服务容器是隔离的
2. 当测试类中的依赖项（如DbContext）需要与WebApplicationFactory中的服务实例相同时，无法直接实现
3. 特别是在需要每个测试使用独立数据库实例的场景下，配置变得更加复杂

解决方案探索

基础整合方案

通过创建一个自定义的FromWebApplicationFactoryAttribute，我们可以实现从WebApplicationFactory的服务容器中解析依赖项：

public class FromWebApplicationFactoryAttribute : NonTypedDataSourceGeneratorAttribute
{
    public override IEnumerable<Func<object?[]?>> GenerateDataSources(DataGeneratorMetadata dataGeneratorMetadata)
    {
        var webApplicationFactory = dataGeneratorMetadata.ClassInstanceArguments
            .OfType<WebApplicationFactory<Program>>()
            .FirstOrDefault();
        
        var serviceProvider = webApplicationFactory.Server.Services;
        var scope = serviceProvider.CreateAsyncScope();
        
        dataGeneratorMetadata.TestBuilderContext.Current.Events.OnDispose += async (_, _) =>
        {
            await scope.DisposeAsync();
        };
        
        yield return () => dataGeneratorMetadata.MembersToGenerate
            .Select(x => ActivatorUtilities.GetServiceOrCreateInstance(scope.ServiceProvider, x.Type))
            .ToArray();
    }
}

测试类实现

在测试类中，我们可以这样使用：

[ClassDataSource<WebApplicationFactory<Program>>(Shared = SharedType.PerTestSession)]
public class MyTests
{
    [FromWebApplicationFactory]
    public required DbContext DbContext { get; init; }
    
    [Test]
    public void Test()
    {
        // 使用共享的DbContext实例
    }
}

高级场景处理

对于更复杂的场景，如每个测试使用独立数据库实例，我们需要：

1. 确保WebApplicationFactory不被共享（SharedType.None）
2. 在ConfigureWebHost中动态配置连接字符串
3. 实现IAsyncInitializer接口确保服务正确初始化

public class WebApplicationFactory : WebApplicationFactory<Program>, IAsyncInitializer
{
    public Task InitializeAsync()
    {
        _ = Server; // 强制初始化服务器
        return Task.CompletedTask;
    }

    protected override void ConfigureWebHost(IWebHostBuilder builder)
    {        
        builder.ConfigureAppConfiguration((context, configBuilder) =>
        {
            var testName = TestContext.Current!.TestDetails.TestName;
            var connectionString = $"{testName}-DummyConnectionString";
            
            configBuilder.AddInMemoryCollection(new Dictionary<string, string?>
            {
                { "ConnectionStrings:DefaultConnection", connectionString }
            });
        });
    }
}

最佳实践建议

1. 服务生命周期管理：确保正确管理服务作用域，避免内存泄漏
2. 测试隔离：对于需要独立数据库的测试，使用SharedType.None
3. 资源清理：实现IDisposable或IAsyncDisposable来清理测试资源
4. 异常处理：添加适当的异常处理逻辑，确保测试失败时资源也能被正确释放
5. 性能考虑：权衡测试隔离级别与测试执行速度的关系

结论

通过TUnit框架提供的扩展点，我们可以有效地解决WebApplicationFactory与自定义依赖注入整合的挑战。关键在于理解服务容器的生命周期管理，并利用框架提供的钩子函数来实现服务实例的共享。对于更复杂的场景，如每个测试使用独立数据库，则需要更精细的控制服务初始化和配置过程。

这种整合方案不仅适用于DbContext，也可以扩展到任何需要在测试类和WebApplicationFactory之间共享的服务实例，为ASP.NET Core应用程序的集成测试提供了更大的灵活性和控制力。