如何在WebApplicationFactory的ConfigureTestServices中访问配置？

问题场景 #

使用WebApplicationFactory搭建集成测试时，需要在ConfigureTestServices方法中访问IConfiguration：基于原有配置值保留部分选项，替换部分为测试固定值，再调用外部包提供的ConfigureMyService扩展方法完成服务覆盖。但因外部包中的MyService为internal可见性，无法直接引用或覆盖，只能通过该扩展方法操作；同时不想采用构建服务提供者这种不良实践来获取配置。

相关代码 #

测试工厂代码

public class TestWebApplicationFactory: WebApplicationFactory<Program> 
{
    protected override void ConfigureWebHost(IWebHostBuilder builder)
    {
        builder.ConfigureTestServices(services =>
        {
                 // 希望在此处访问IConfiguration
                 var configuration = ....?

                 // 部分使用配置值，部分替换为测试固定值
                services.ConfigureMyService(new MyOptions           
                {
                    Option1 = config.Option1,
                    Option2 = "new-fixed-value",
                    // 其他选项
                });
        });
    } 
}

生产启动代码

public static class StartupExtensions
{
    public static void ConfigureServices(
        this IServiceCollection services,
        IConfiguration configuration,
        IWebHostEnvironment environment)
    {
        var config = configuration.Get<MyConfig>();
        services.AddSingleton(config);

        services.ConfigureMyService(new MyOptions
        {
            Option1 = config.Option1,
            Option2 = config.Option2,
            // 其他选项
        });
    }
}

public class MyOptions
{
        public string Option1{ get; set; }
        public string Option2{ get; set; }
}

外部包中的扩展方法（无法修改）

// 定义在无权访问的外部包中，MyService为Internal可见性
private static void ConfigureMyService(this IServiceCollection services, MyOptions options)
{
    var someService = new MyService(options.Option1, options.Option2);
    
    services.AddSingleton<MyService>(someService);
}

解决方案 #

方式1：直接从IWebHostBuilder获取配置 #

在ConfigureWebHost中先构建完整配置实例，无需依赖服务提供者：

public class TestWebApplicationFactory : WebApplicationFactory<Program>
{
    protected override void ConfigureWebHost(IWebHostBuilder builder)
    {
        // 构建配置：继承应用原有配置，可按需添加测试专属配置源
        var configuration = new ConfigurationBuilder()
            .AddConfiguration(builder.GetConfiguration())
            // 可选：添加测试配置文件
            .AddJsonFile("appsettings.test.json", optional: true)
            .Build();

        builder.ConfigureTestServices(services =>
        {
            var myConfig = configuration.Get<MyConfig>();
            
            services.ConfigureMyService(new MyOptions
            {
                Option1 = myConfig.Option1,
                Option2 = "new-fixed-value"
                // 其他选项按需设置
            });
        });
    }
}

这种方式直接通过配置构建器获取完整配置，符合最佳实践，避免构建服务提供者的风险。

方式2：预配置测试环境后获取配置 #

如果需要覆盖部分原有配置项，先通过ConfigureAppConfiguration调整配置，再临时获取配置实例：

public class TestWebApplicationFactory : WebApplicationFactory<Program>
{
    protected override void ConfigureWebHost(IWebHostBuilder builder)
    {
        builder.ConfigureAppConfiguration(configBuilder =>
        {
            // 添加内存配置，覆盖原有配置中的特定项
            configBuilder.AddInMemoryCollection(new Dictionary<string, string>
            {
                // 示例：修改MyConfig中的Option1
                // ["MyConfig:Option1"] = "test-specific-value"
            });
        });

        builder.ConfigureTestServices(services =>
        {
            // 临时构建服务提供者获取配置，用完即弃
            using var sp = services.BuildServiceProvider();
            var configuration = sp.GetRequiredService<IConfiguration>();
            var myConfig = configuration.Get<MyConfig>();
            
            services.ConfigureMyService(new MyOptions
            {
                Option1 = myConfig.Option1,
                Option2 = "new-fixed-value"
            });
        });
    }
}

注意：这里使用BuildServiceProvider()仅用于临时获取配置，用using包裹确保资源释放，相对风险较低，但优先推荐方式1。

方式3：复用生产配置逻辑 #

直接利用builder.GetConfiguration()获取当前配置，复用生产代码中的配置绑定逻辑：

public class TestWebApplicationFactory : WebApplicationFactory<Program>
{
    protected override void ConfigureWebHost(IWebHostBuilder builder)
    {
        builder.ConfigureTestServices(services =>
        {
            // 获取应用当前的完整配置
            var configuration = builder.GetConfiguration();
            // 复用生产代码的配置绑定逻辑
            var myConfig = configuration.Get<MyConfig>();
            
            services.ConfigureMyService(new MyOptions
            {
                Option1 = myConfig.Option1,
                Option2 = "new-fixed-value"
            });
        });
    }
}

这种方式最简洁，直接复用现有逻辑，避免重复代码。

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