如何为无返回值的配置读取方法编写单元测试？

是否需要Mock ConfigurationBuilder？ #

需要，但原代码直接硬编码new ConfigurationBuilder并读取物理文件的写法无法直接Mock，必须先重构代码解耦配置依赖——不然单元测试会绑定真实的JSON文件，失去单元测试的独立性。

第一步：重构原代码 #

通过两种方式重构，让配置逻辑可测试：

方案1：依赖注入IConfiguration #

修改类的构造函数注入IConfiguration，直接使用注入的配置对象读取数据：

private readonly IConfiguration _configuration;

// 构造函数注入配置
public YourClassName(IConfiguration configuration)
{
    _configuration = configuration;
}

public void GetConfig()
{
    UserInputRequest = _configuration.GetSection("AppIdentitySettings")
                                     .Get<List<UserRequest>>().First(); 
    appSettings = _configuration.GetSection("somesettingssection")
                                .GetChildren()
                                .ToDictionary(x => x.Key, x => x.Value);
}

方案2：提取可覆写的配置构建方法 #

如果无法使用依赖注入，可把创建配置的逻辑提取为protected虚方法，测试时通过子类覆写替换：

public void GetConfig()
{
    var userConfig = BuildUserSettingsConfig();
    UserInputRequest = userConfig.GetSection("AppIdentitySettings")
                                 .Get<List<UserRequest>>().First(); 
    
    var appConfig = BuildAppSettingsConfig();
    appSettings = appConfig.GetSection("somesettingssection")
                           .GetChildren()
                           .ToDictionary(x => x.Key, x => x.Value);
}

// 提取为虚方法，测试时可覆写
protected virtual IConfigurationRoot BuildUserSettingsConfig()
{
    return new ConfigurationBuilder()            
        .AddJsonFile("usersettings.json", optional: false, reloadOnChange: true)
        .Build();
}

protected virtual IConfigurationRoot BuildAppSettingsConfig()
{
    return new ConfigurationBuilder()            
        .AddJsonFile("appsettings.json", optional: false, reloadOnChange: true)
        .Build();
}

第二步：编写单元测试 #

以方案1为例，用Moq+XUnit编写测试：

using Xunit;
using Moq;
using Microsoft.Extensions.Configuration;

public class YourClassNameTests
{
    [Fact]
    public void GetConfig_ShouldPopulateUserInputRequestAndAppSettings()
    {
        // 1. 构造模拟配置数据
        var mockConfig = new Mock<IConfiguration>();
        
        // 模拟AppIdentitySettings节点
        var userRequestSection = new Mock<IConfigurationSection>();
        userRequestSection.Setup(s => s.Get<List<UserRequest>>())
                          .Returns(new List<UserRequest> { new UserRequest { /* 设置预期属性，比如Id=1, Name="Test" */ } });
        mockConfig.Setup(c => c.GetSection("AppIdentitySettings"))
                  .Returns(userRequestSection.Object);
        
        // 模拟somesettingssection的子节点
        var childSections = new List<IConfigurationSection>
        {
            CreateMockSection("key1", "value1"),
            CreateMockSection("key2", "value2")
        };
        var settingsSection = new Mock<IConfigurationSection>();
        settingsSection.Setup(s => s.GetChildren())
                       .Returns(childSections);
        mockConfig.Setup(c => c.GetSection("somesettingssection"))
                  .Returns(settingsSection.Object);

        // 2. 创建被测类实例
        var sut = new YourClassName(mockConfig.Object);
        
        // 3. 调用测试方法
        sut.GetConfig();
        
        // 4. 断言结果
        // 断言UserInputRequest的属性符合预期
        Assert.NotNull(sut.UserInputRequest);
        Assert.Equal(1, sut.UserInputRequest.Id); // 替换为实际属性和预期值
        
        // 断言appSettings字典的键值对正确
        Assert.Equal(2, sut.appSettings.Count);
        Assert.Equal("value1", sut.appSettings["key1"]);
        Assert.Equal("value2", sut.appSettings["key2"]);
    }

    // 辅助方法：创建模拟配置节点
    private IConfigurationSection CreateMockSection(string key, string value)
    {
        var section = new Mock<IConfigurationSection>();
        section.Setup(s => s.Key).Returns(key);
        section.Setup(s => s.Value).Returns(value);
        return section.Object;
    }
}

需要断言什么内容？ #

• UserInputRequest的状态：断言它不为null，且每个业务属性（如ID、名称等）与模拟配置的预期值一致。
• appSettings字典的状态：断言字典不为null、键的数量正确，每个键对应的value与预期值匹配。
• （可选）异常场景测试：比如模拟配置缺失时，断言方法抛出InvalidOperationException等预期异常。

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