public async Task MiddlewareTest_ReturnsNotFoundForRequest()
using var host = await new HostBuilder()
.ConfigureWebHost(webBuilder =>
webBuilder
.UseTestServer()
.ConfigureServices(services =>
services.AddMyServices();
.Configure(app =>
app.UseMiddleware
();
.StartAsync();
有关将包添加到 .NET 应用的指南,请参阅
包使用工作流(NuGet 文档)
中“安装和管理包”下的文章。 在
NuGet.org
中确认正确的包版本。
使用 HttpClient 发送请求
使用
HttpClient
发送请求:
[Fact]
public async Task MiddlewareTest_ReturnsNotFoundForRequest()
using var host = await new HostBuilder()
.ConfigureWebHost(webBuilder =>
webBuilder
.UseTestServer()
.ConfigureServices(services =>
services.AddMyServices();
.Configure(app =>
app.UseMiddleware<MyMiddleware>();
.StartAsync();
var response = await host.GetTestClient().GetAsync("/");
断言结果。 首先,将断言语句设置为与预期结果相反的结果。 初次运行时,将断言语句设为假正会在中间件正常执行时确认测试未通过。 运行测试并确认测试未通过。
在下面的示例中,在请求根终结点时,中间件应返回 404 状态代码(找不到)。 使用 Assert.NotEqual( ... );
进行首测测试运行,该运行应该会失败:
[Fact]
public async Task MiddlewareTest_ReturnsNotFoundForRequest()
using var host = await new HostBuilder()
.ConfigureWebHost(webBuilder =>
webBuilder
.UseTestServer()
.ConfigureServices(services =>
services.AddMyServices();
.Configure(app =>
app.UseMiddleware<MyMiddleware>();
.StartAsync();
var response = await host.GetTestClient().GetAsync("/");
Assert.NotEqual(HttpStatusCode.NotFound, response.StatusCode);
更改断言语句以测试正常操作条件下的中间件。 最终测试使用 Assert.Equal( ... );
。 再次运行测试,确认该测试已通过。
[Fact]
public async Task MiddlewareTest_ReturnsNotFoundForRequest()
using var host = await new HostBuilder()
.ConfigureWebHost(webBuilder =>
webBuilder
.UseTestServer()
.ConfigureServices(services =>
services.AddMyServices();
.Configure(app =>
app.UseMiddleware<MyMiddleware>();
.StartAsync();
var response = await host.GetTestClient().GetAsync("/");
Assert.Equal(HttpStatusCode.NotFound, response.StatusCode);
使用 HttpContext 发送请求
测试应用还可以使用 SendAsync(Action<HttpContext>, CancellationToken) 发送请求。 在下面的示例中,当中间件处理 https://example.com/A/Path/?and=query
时,会进行几次检查:
[Fact]
public async Task TestMiddleware_ExpectedResponse()
using var host = await new HostBuilder()
.ConfigureWebHost(webBuilder =>
webBuilder
.UseTestServer()
.ConfigureServices(services =>
services.AddMyServices();
.Configure(app =>
app.UseMiddleware<MyMiddleware>();
.StartAsync();
var server = host.GetTestServer();
server.BaseAddress = new Uri("https://example.com/A/Path/");
var context = await server.SendAsync(c =>
c.Request.Method = HttpMethods.Post;
c.Request.Path = "/and/file.txt";
c.Request.QueryString = new QueryString("?and=query");
Assert.True(context.RequestAborted.CanBeCanceled);
Assert.Equal(HttpProtocol.Http11, context.Request.Protocol);
Assert.Equal("POST", context.Request.Method);
Assert.Equal("https", context.Request.Scheme);
Assert.Equal("example.com", context.Request.Host.Value);
Assert.Equal("/A/Path", context.Request.PathBase.Value);
Assert.Equal("/and/file.txt", context.Request.Path.Value);
Assert.Equal("?and=query", context.Request.QueryString.Value);
Assert.NotNull(context.Request.Body);
Assert.NotNull(context.Request.Headers);
Assert.NotNull(context.Response.Headers);
Assert.NotNull(context.Response.Body);
Assert.Equal(404, context.Response.StatusCode);
Assert.Null(context.Features.Get<IHttpResponseFeature>().ReasonPhrase);
SendAsync 允许直接配置 HttpContext 对象,而不是使用 HttpClient 抽象进行配置。 使用 SendAsync 操作仅在服务器上可用的结构,如 HttpContext 或 HttpContext。
如测试是否出现“404 - 找不到”响应的前述示例一样,请检查前面测试中每个 Assert
语句的相反结果。 该检查确认中间件正常运行时测试是否正常失败。 确认假正测试正常工作后,为测试的预期条件和值设置最终的 Assert
语句。 再次运行测试,确认该测试通过。
TestServer 限制
TestServer:
用于复制服务器行为以测试中间件。
请勿尝试复制所有 HttpClient 行为。
尝试授予客户端对服务器尽可能多控制权的访问权限,并尽可能深入地了解服务器上发生的情况。 例如,它可能引发 HttpClient
通常不会引发的异常,以便直接传输服务器状态。
默认情况下,不会设置某些传输特定标头,因为这些标头通常与中间件无关。 有关更多信息,请参见下一节。
忽略通过 StreamContent 的 Stream
位置。 HttpClient 从起始位置发送整个流,即使设置了定位也是如此。 有关详细信息,请参阅此 GitHub 问题。
Content-Length 和 Transfer-Encoding 标头
TestServer 不设置与传输相关的请求或响应标头,如 Content-Length 或 Transfer-Encoding。 应用程序应避免依赖于这些标头,因为它们的用法因客户端、方案和协议而异。 如果需要 Content-Length
和 Transfer-Encoding
来测试特定方案,则可以在编写 HttpRequestMessage 或 HttpContext 时在测试中指定它们。 有关详细信息,请查看以下 GitHub 问题:
dotnet/aspnetcore#21677
dotnet/aspnetcore#18463
dotnet/aspnetcore#13273