如何测试.NET 6.0的Program.cs？破解启动文件测试覆盖率困境

一、优先选择：合理排除启动文件的覆盖率统计 #

启动文件以服务注册、应用配置为主，属于无业务逻辑的基础设施代码，这类代码通常不需要纳入业务模块的覆盖率考核。使用[ExcludeFromCodeCoverage]是完全合理的选择，理由如下：

• 配置代码的正确性更多依赖集成验证而非单元测试，硬写单元测试只会增加维护成本，无法带来实际业务价值。
• 多数企业和开源项目都会将启动配置、DI注册类排除在覆盖率统计外，这是行业通用实践。

具体实现方式 #

1. 特性标记：在Program.cs文件顶部添加程序集级别的排除特性：

   [assembly: ExcludeFromCodeCoverage]
   namespace YourProjectNamespace;
   
   var builder = WebApplication.CreateBuilder(args);
   // ... 配置代码
   

2. 覆盖率工具配置：如果不想修改代码，可以通过覆盖率工具（如Coverlet）的命令行参数或配置文件排除：
   • 命令行示例：dotnet test /p:CollectCoverage=true /p:Exclude="[*]Program"
   • 配置文件（如coverlet.runsettings）中添加排除规则：

     <RunSettings>
       <DataCollectionRunSettings>
         <DataCollectors>
           <DataCollector friendlyName="XPlat Code Coverage">
             <Configuration>
               <Exclude>[*]Program</Exclude>
             </Configuration>
           </DataCollector>
         </DataCollectors>
       </DataCollectionRunSettings>
     </RunSettings>
     

二、若需验证配置正确性：针对性测试方案 #

如果团队要求必须验证启动配置的正确性，无需写单元测试覆盖整个Program.cs，而是拆分逻辑后做针对性测试：

1. 拆分配置逻辑到独立类 #

将服务注册、配置逻辑从Program.cs中提取到静态类，方便单独测试：

// ServiceConfigurations.cs
public static class ServiceConfigurations
{
    public static void AddApplicationServices(this IServiceCollection services, IConfiguration config)
    {
        services.AddScoped<IUserService, UserService>();
        services.AddDbContext<AppDbContext>(options => 
            options.UseSqlServer(config.GetConnectionString("Default")));
        // ... 其他服务注册
    }
}

// Program.cs中调用
builder.Services.AddApplicationServices(builder.Configuration);

2. 单元测试验证服务注册 #

针对拆分后的配置类编写单元测试，验证服务是否正确注册：

[TestClass]
public class ServiceConfigurationsTests
{
    [TestMethod]
    public void AddApplicationServices_RegistersUserService()
    {
        // Arrange
        var services = new ServiceCollection();
        var config = new ConfigurationBuilder().Build();

        // Act
        services.AddApplicationServices(config);

        // Assert
        var serviceDescriptor = services.FirstOrDefault(s => s.ServiceType == typeof(IUserService));
        Assert.IsNotNull(serviceDescriptor);
        Assert.AreEqual(ServiceLifetime.Scoped, serviceDescriptor.Lifetime);
        Assert.AreEqual(typeof(UserService), serviceDescriptor.ImplementationType);
    }
}

3. 集成测试验证应用启动 #

使用WebApplicationFactory编写集成测试，验证应用能正常启动且依赖注入有效：

public class ApplicationStartupTests : IClassFixture<WebApplicationFactory<Program>>
{
    private readonly WebApplicationFactory<Program> _factory;

    public ApplicationStartupTests(WebApplicationFactory<Program> factory)
    {
        _factory = factory;
    }

    [TestMethod]
    public void Application_Starts_Successfully()
    {
        // Act
        var client = _factory.CreateClient();

        // Assert
        var response = client.GetAsync("/").Result;
        response.EnsureSuccessStatusCode();
    }

    [TestMethod]
    public void ServiceProvider_ResolvesRequiredServices()
    {
        // Act
        var scope = _factory.Services.CreateScope();
        var userService = scope.ServiceProvider.GetService<IUserService>();

        // Assert
        Assert.IsNotNull(userService);
        Assert.IsInstanceOfType(userService, typeof(UserService));
    }
}

三、核心参考资料要点 #

• Microsoft .NET测试文档：明确指出基础设施代码（如DI配置）无需强制覆盖，建议通过集成测试验证配置正确性，而非单元测试硬凑覆盖率。
• Coverlet官方指南：详细说明如何通过特性、命令行或配置文件排除特定文件/程序集的覆盖率统计。
• .NET集成测试最佳实践：介绍使用WebApplicationFactory验证应用启动、服务注册的标准流程，确保配置生效。

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