ASP.NET Core 测试新特性：WebApplicationFactory 支持真实 Kestrel 服务器

在 ASP.NET Core 的自动化测试中，WebApplicationFactory 是一个常用的测试工具类，它允许开发者创建测试服务器并发送 HTTP 请求来测试应用程序。然而，长期以来存在一个限制：WebApplicationFactory 默认使用 TestServer 实现，无法直接使用真实的 Kestrel 服务器进行测试。

这一限制给浏览器自动化测试场景带来了不便。开发者通常需要编写额外的代码来绕过这一限制，或者采用不太优雅的解决方案。为了解决这个问题，ASP.NET Core 团队在最新版本中为 WebApplicationFactory 添加了对 Kestrel 服务器的原生支持。

新 API 介绍

新版本引入了两个核心方法：

1. UseKestrel() 方法系列：

   • 无参数版本：使用默认配置启动 Kestrel 服务器
   • 带端口参数版本：指定 Kestrel 监听的端口号
   • 带配置委托版本：允许自定义 Kestrel 服务器选项

2. StartServer() 方法：

   • 显式启动服务器而无需创建 HttpClient 实例
   • 特别适用于浏览器自动化测试场景

使用示例

基本用法

创建一个继承自 WebApplicationFactory 的测试工厂类，并在构造函数中配置使用 Kestrel：

public class KestrelBasedWapFactory : WebApplicationFactory<SimpleWebSite.Startup>
{
    public KestrelBasedWapFactory()
    {
        this.UseKestrel();
    }
}

高级配置

如果需要更精细的控制，可以组合使用多个配置方法：

int dynamicPortNumber = 0;
this.UseKestrel(dynamicPortNumber);
this.UseKestrel(options => {
    options.AllowSynchronousIO = true;
    // 其他 Kestrel 配置
});

浏览器测试场景

在浏览器自动化测试中，可以这样使用：

public BrowserBasedTests(WebApplicationFactory<MyApp.Program> factory)
{
    _factory = factory;
    _factory.StartServer(); // 显式启动服务器
}

[Fact]
public void BrowserBasedTest()
{
    Browser.Navigate().GoToUrl("[服务器监听的URL]");
    var selector = By.TagName("h1");
    Assert.Equal("页面标题在这里", Browser.FindElement(selector).Text);
}

设计考量

在 API 设计过程中，团队考虑了多种方案：

1. 最初考虑解耦 WebApplicationFactory 和 TestServer，允许替换实现
2. 最终选择了更直接的 Kestrel 集成方案
3. 保留了方法调用的灵活性，允许组合多个配置
4. 没有采用链式调用设计，因为 WebApplicationFactory 不是典型的构建器模式

对开发者的价值

这一改进为 ASP.NET Core 测试带来了几个重要优势：

1. 更真实的测试环境：使用实际生产环境中的 Kestrel 服务器，减少测试与生产环境的差异
2. 简化浏览器测试：无需额外代码就能支持 Selenium 等浏览器自动化工具
3. 更好的灵活性：可以根据测试需求精细控制服务器配置
4. 更直观的 API：消除了之前需要创建不必要 HttpClient 实例的奇怪模式

总结

ASP.NET Core 测试框架的这一增强为开发者提供了更强大、更灵活的测试工具。特别是对于需要真实浏览器交互的端到端测试场景，新的 Kestrel 支持将大大简化测试代码的编写和维护。随着这一功能的推出，开发者可以更自信地编写覆盖更全面的自动化测试套件，确保应用程序在生产环境中的可靠性。