集成测试中向ASP.NET控制器注入自定义DbContext异常排查

核心问题分析 #

你注入的是Func<DataContext>工厂而非直接注入DataContext，仅替换DataContext的服务注册不足以生效——原有Func<DataContext>仍会生成使用真实数据库配置的上下文实例。

具体修复步骤 #

1. 确保测试工厂正确覆盖Func<DataContext>的注册 #

在自定义WebApplicationFactory的ConfigureServices方法中，除了重新注册DataContext，必须替换Func<DataContext>的实现，让它返回测试容器的上下文实例。

示例代码：

public class CustomWebApplicationFactory<TProgram> : WebApplicationFactory<TProgram> where TProgram : class
{
    private readonly TestcontainerDatabase _testContainer;

    public CustomWebApplicationFactory()
    {
        // 初始化Testcontainers（以PostgreSQL为例）
        _testContainer = new PostgreSqlBuilder()
            .WithImage("postgres:15")
            .WithDatabase("testdb")
            .WithUsername("testuser")
            .WithPassword("testpass")
            .Build();
        _testContainer.StartAsync().Wait();
    }

    protected override void ConfigureWebHost(IWebHostBuilder builder)
    {
        builder.ConfigureServices(services =>
        {
            // 移除原有的DataContext配置项
            var descriptor = services.SingleOrDefault(
                d => d.ServiceType == typeof(DbContextOptions<DataContext>));
            if (descriptor != null)
                services.Remove(descriptor);

            // 注册测试用DataContext
            services.AddDbContext<DataContext>(options =>
            {
                options.UseNpgsql(_testContainer.GetConnectionString());
                // 可选：启用日志排查连接字符串问题
                options.LogTo(Console.WriteLine, LogLevel.Information);
            });

            // 关键：替换Func<DataContext>，让它从容器获取测试上下文
            services.AddScoped<Func<DataContext>>(sp => () => sp.GetRequiredService<DataContext>());
        });

        builder.UseEnvironment("Development");
    }

    protected override void Dispose(bool disposing)
    {
        base.Dispose(disposing);
        _testContainer.DisposeAsync().Wait();
    }
}

2. 验证控制器的注入与使用逻辑 #

确保控制器正确接收Func<DataContext>并生成上下文：

public class CustomersController : ControllerBase
{
    private readonly Func<DataContext> _contextFactory;
    private readonly IUnitOfWork _unitOfWork;

    public CustomersController(Func<DataContext> contextFactory, IUnitOfWork unitOfWork)
    {
        _contextFactory = contextFactory;
        _unitOfWork = unitOfWork;
    }

    [HttpPost]
    public async Task<IActionResult> Create(CustomerDto dto)
    {
        using var context = _contextFactory();
        var customer = new Customer { Name = dto.Name, Email = dto.Email };
        context.Customers.Add(customer);
        await _unitOfWork.SaveChangesAsync(context);
        return CreatedAtAction(nameof(Get), new { id = customer.Id }, customer);
    }
}

3. 检查测试类的工厂使用 #

确保测试类正确继承并初始化自定义工厂：

public class CustomersControllerTests : IClassFixture<CustomWebApplicationFactory<Program>>
{
    private readonly HttpClient _client;
    private readonly CustomWebApplicationFactory<Program> _factory;

    public CustomersControllerTests(CustomWebApplicationFactory<Program> factory)
    {
        _factory = factory;
        _client = factory.CreateClient(new WebApplicationFactoryClientOptions
        {
            AllowAutoRedirect = false
        });
    }

    [Fact]
    public async Task Create_ShouldAddCustomerToTestDatabase()
    {
        var dto = new CustomerDto { Name = "Test User", Email = "test@example.com" };
        var content = new StringContent(JsonSerializer.Serialize(dto), Encoding.UTF8, "application/json");

        var response = await _client.PostAsync("/api/customers", content);
        response.EnsureSuccessStatusCode();

        // 验证测试数据库中是否存在该客户
        using var context = _factory.Services.GetRequiredService<DataContext>();
        var customer = await context.Customers.FirstOrDefaultAsync(c => c.Email == "test@example.com");
        Assert.NotNull(customer);
        Assert.Equal("Test User", customer.Name);
    }
}

4. 排查常见坑点 #

• 确保Program.cs中DataContext注册从配置读取连接字符串，而非硬编码：

  builder.Services.AddDbContext<DataContext>(options =>
      options.UseNpgsql(builder.Configuration.GetConnectionString("DefaultConnection")));
  

• 检查是否在其他扩展方法/模块中重复注册Func<DataContext>，导致测试注册被覆盖。
• 通过EF Core日志确认测试时使用的连接字符串是否为测试容器地址。

内容的提问来源于stack exchange，提问作者SetNug