我正在测试运行状况检查端点。
我已经实现了与。net core和WebApplicationFactory和TestServer的集成测试,以测试我的API端点。
我写了测试用例(xUnit)来测试我的API端点,简单的API控制器工作得很好,但没有找到健康检查端点-它不是控制器,它是一个可配置的端点
服务配置
services.AddHealthChecks().AddCheck<PingHealthCheck>("ping_health_check");
下面是配置
endpoints.MapHealthChecks("/health", new HealthCheckOptions()
{
// Prevent response caching
AllowCachingResponses = false,
ResponseWriter = (context, report) => context.Response
//Return an object instead of a plain text
.WriteAsync(JsonConvert.SerializeObject(new {status= report.Status.ToString() })),
ResultStatusCodes =
{
[HealthStatus.Healthy] = StatusCodes.Status200OK,
[HealthStatus.Degraded] = StatusCodes.Status200OK,
[HealthStatus.Unhealthy] = StatusCodes.Status503ServiceUnavailable
}
})
这里是测试用例
[Fact]
public async Task Call_Health_Return_Healthy()
{
//Arrange
//Act
var response = await _factory.TestHttpClient
.GetAsync("/health");
//Assert
response.StatusCode.Should().BeEquivalentTo(HttpStatusCode.OK);
}
我成功解决了我的问题。原因是允许其主机访问运行状况端点的配置。
问题是,我限制访问(在本地主机)端口5001,但在ApplicationFactory TestServer没有任何端口。
下面是配置代码
/// <summary>
/// Configures the endpoint.
/// </summary>
/// <param name="builder">The application builder. <see cref="IApplicationBuilder"/></param>
/// <param name="configuration">The IConfiguration builder instance</param>
public static void ConfigureEndpoint(this IApplicationBuilder builder, IConfiguration configuration)
{
var healthConfiguration = configuration.GetSection(nameof(HealthConfiguration)).Get<HealthConfiguration>();
builder.UseEndpoints(endpoints =>
{
endpoints.MapControllers();
endpoints.MapHealthChecks("/health", new HealthCheckOptions()
{
// Prevent response caching
AllowCachingResponses = false,
ResponseWriter = (context, report) => context.Response
//Return an object instead of a plain text
.WriteAsync(JsonConvert.SerializeObject(new {status = report.Status.ToString()})),
ResultStatusCodes =
{
[HealthStatus.Healthy] = StatusCodes.Status200OK,
[HealthStatus.Degraded] = StatusCodes.Status200OK,
[HealthStatus.Unhealthy] = StatusCodes.Status503ServiceUnavailable
}
}).RequireHost(string.Join(",",healthConfiguration.Hosts.Select(host=>host)));
});
}
而config部分改为
"HealthConfiguration": {
"Hosts": ["localhost"]
},