asp.net core 使用 TestServer 来做集成测试

asp.net core 使用 TestServer 来做集成测试

Intro

之前我的项目里的集成测试是随机一个端口，每次都真实的启动一个 WebServer，之前也有看到过微软文档上 TestServer 的介绍，当时以为差不多就没用，一直是启动了一个真正的 WebServer 去跑集成测试的，上次分享 Xunit.DependencyInjection 改造测试项目的时候，写的烂代码被大师看到了之后， 大师建议用 TestServer 来做集成测试，使用 TestServer 不会真正的占用端口号，不会出现权限问题，于是扒了扒 TestServer 的源码，并用 TestServer 改进了集成测试项目，感谢大师[献花鲜花]~~

Sample

之前的集成测试监听了一个端口号，使用了一个真实的 WebServer，下面改成使用 TestServer

TestServer 现在是在 Microsoft.AspNetCore.TestHost 这个 Nuget 包中，引用这个包就可以使用了

在服务注册的时候调用 UseTestServer 这一扩展方法就可以注入 TestServer 了，集成测试一般会用 HttpClient 来请求服务器端的 API 地址或页面，TestServer 提供了一个方便的 CreateClient 的方法可以很方便的创建一个用来请求 TestServer 的 HttpClient，微软也提供了一些比较方便的扩展方法，可以使用 IHost 的 GetTestClient 扩展方法来获取 HttpClient

改成使用 TestServer 很简单，引用 nuget 包 Microsoft.AspNetCore.TestHost，变更对比如下：

源码概览

TestServer 在启动的时候并没有监听端口，可以参考源码 IServer 的 Start

TestServer 通过 CreateClient 方法来创建调用 TestServer 接口的 HttpClient

通过上面的代码可以看的出来核心代码是在 ClientHandler 中定义的，源码有点多，详细可以直接看源码 https://github.com/dotnet/aspnetcore/blob/v5.0.0/src/Hosting/TestHost/src/ClientHandler.cs#L58

ClientHandler 重写了 HttpClientHandler 的 SendAsync 方法，使得请求直接拦截掉，不会真正的发生 Http 请求，实际的请求过程首先将 Http 请求的信息转换成 HttpRquestFeature 然后直接交给 TestServer 处理，其实也就是直接交给 asp.net core 的请求管道去处理，请求处理结束之后，获取响应，获取 HttpResponseFeature 然后转换成 HttpClient 需要的 HttpResponseMessage.

More

TestServer 不仅仅可以支持 HTTP 请求的处理，还支持 WebSocket 的处理，WebSocket 的集成测试也可以使用 TestServer 来处理。

你如果还是比较怀疑是否真的没有 HTTP 请求，可以用 Fildder 之类的 HTTP 抓包工具监控在跑测试的期间是否真的有 HTTP 请求，如果是真正的 WebServer 会有 HTTP 请求，TestServer 不会有 HTTP 请求。

Reference

• https://docs.microsoft.com/en-us/aspnet/core/test/integration-tests?view=aspnetcore-5.0
• https://github.com/dotnet/aspnetcore/tree/v5.0.0/src/Hosting/TestHost/src
• https://github.com/dotnet/aspnetcore/tree/v5.0.0/src/Hosting/TestHost/src/TestServer.cs
• https://github.com/dotnet/aspnetcore/blob/v5.0.0/src/Hosting/TestHost/src/ClientHandler.cs#L58
• https://github.com/OpenReservation/ReservationServer/blob/3.1.0/OpenReservation.API.Test/Startup.cs#L26
• https://github.com/OpenReservation/ReservationServer/commit/e683065bf76e3c51688238c382b2c1f0c8028e7d