feat(health): scaffold ZB.MOM.WW.Health solution + Task 4 (tags + three-tier MapZbHealth)
Consolidates the library into the scadaproj repo (matching the ZB.MOM.WW.Auth convention — tracked in-parent, not a nested repo). 3 dependency-split packages (core / .Akka / .EntityFrameworkCore) + 3 test projects, .slnx, central PM. Task 4: ZbHealthTags + MapZbHealth (/health/ready,/active,/healthz). 8/8 tests.
This commit is contained in:
Joseph Doherty
@@ -0,0 +1,23 @@
|
||||
<Project Sdk="Microsoft.NET.Sdk">
|
||||
|
||||
<PropertyGroup>
|
||||
<IsPackable>false</IsPackable>
|
||||
</PropertyGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<PackageReference Include="coverlet.collector" />
|
||||
<PackageReference Include="Microsoft.NET.Test.Sdk" />
|
||||
<PackageReference Include="xunit" />
|
||||
<PackageReference Include="xunit.runner.visualstudio" />
|
||||
<PackageReference Include="Akka.TestKit.Xunit2" />
|
||||
</ItemGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<Using Include="Xunit" />
|
||||
</ItemGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<ProjectReference Include="..\..\src\ZB.MOM.WW.Health.Akka\ZB.MOM.WW.Health.Akka.csproj" />
|
||||
</ItemGroup>
|
||||
|
||||
</Project>
|
||||
+24
@@ -0,0 +1,24 @@
|
||||
<Project Sdk="Microsoft.NET.Sdk">
|
||||
|
||||
<PropertyGroup>
|
||||
<IsPackable>false</IsPackable>
|
||||
</PropertyGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<PackageReference Include="coverlet.collector" />
|
||||
<PackageReference Include="Microsoft.NET.Test.Sdk" />
|
||||
<PackageReference Include="xunit" />
|
||||
<PackageReference Include="xunit.runner.visualstudio" />
|
||||
<PackageReference Include="Microsoft.EntityFrameworkCore.InMemory" />
|
||||
<PackageReference Include="Microsoft.EntityFrameworkCore.Sqlite" />
|
||||
</ItemGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<Using Include="Xunit" />
|
||||
</ItemGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<ProjectReference Include="..\..\src\ZB.MOM.WW.Health.EntityFrameworkCore\ZB.MOM.WW.Health.EntityFrameworkCore.csproj" />
|
||||
</ItemGroup>
|
||||
|
||||
</Project>
|
||||
@@ -0,0 +1,165 @@
|
||||
using System.Net;
|
||||
using Microsoft.AspNetCore.Builder;
|
||||
using Microsoft.AspNetCore.Hosting;
|
||||
using Microsoft.AspNetCore.TestHost;
|
||||
using Microsoft.Extensions.Diagnostics.HealthChecks;
|
||||
using Microsoft.Extensions.DependencyInjection;
|
||||
using ZB.MOM.WW.Health;
|
||||
|
||||
namespace ZB.MOM.WW.Health.Tests;
|
||||
|
||||
/// <summary>
|
||||
/// Verifies the three-tier <see cref="ZbHealthEndpointExtensions.MapZbHealth"/> convention:
|
||||
/// each endpoint runs only the checks tagged for its tier, /healthz runs nothing, and the
|
||||
/// standard ASP.NET HealthChecks status-to-HTTP mapping (Healthy/Degraded → 200, Unhealthy → 503)
|
||||
/// holds per tier.
|
||||
/// </summary>
|
||||
public sealed class TierMappingTests
|
||||
{
|
||||
/// <summary>
|
||||
/// An <see cref="IHealthCheck"/> test double that records each invocation and returns a
|
||||
/// configurable result, so tests can assert which checks actually ran per tier.
|
||||
/// </summary>
|
||||
private sealed class RecordingHealthCheck : IHealthCheck
|
||||
{
|
||||
private readonly HealthStatus _status;
|
||||
private int _invocations;
|
||||
|
||||
public RecordingHealthCheck(HealthStatus status) => _status = status;
|
||||
|
||||
public int Invocations => Volatile.Read(ref _invocations);
|
||||
|
||||
public Task<HealthCheckResult> CheckHealthAsync(
|
||||
HealthCheckContext context,
|
||||
CancellationToken cancellationToken = default)
|
||||
{
|
||||
Interlocked.Increment(ref _invocations);
|
||||
return Task.FromResult(new HealthCheckResult(_status));
|
||||
}
|
||||
}
|
||||
|
||||
private static async Task<(HttpResponseMessage Response, RecordingHealthCheck Ready, RecordingHealthCheck Active)>
|
||||
RunAsync(string path, HealthStatus readyStatus = HealthStatus.Healthy, HealthStatus activeStatus = HealthStatus.Healthy)
|
||||
{
|
||||
var ready = new RecordingHealthCheck(readyStatus);
|
||||
var active = new RecordingHealthCheck(activeStatus);
|
||||
|
||||
var builder = WebApplication.CreateBuilder();
|
||||
builder.WebHost.UseTestServer();
|
||||
|
||||
builder.Services.AddHealthChecks()
|
||||
.AddCheck("ready-check", ready, tags: new[] { ZbHealthTags.Ready })
|
||||
.AddCheck("active-check", active, tags: new[] { ZbHealthTags.Active });
|
||||
|
||||
await using var app = builder.Build();
|
||||
app.MapZbHealth();
|
||||
await app.StartAsync();
|
||||
|
||||
var client = app.GetTestClient();
|
||||
var response = await client.GetAsync(path);
|
||||
return (response, ready, active);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task ReadyEndpoint_RunsOnlyReadyCheck()
|
||||
{
|
||||
var (response, ready, active) = await RunAsync("/health/ready");
|
||||
|
||||
Assert.Equal(HttpStatusCode.OK, response.StatusCode);
|
||||
Assert.Equal(1, ready.Invocations);
|
||||
Assert.Equal(0, active.Invocations);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task ActiveEndpoint_RunsOnlyActiveCheck()
|
||||
{
|
||||
var (response, ready, active) = await RunAsync("/health/active");
|
||||
|
||||
Assert.Equal(HttpStatusCode.OK, response.StatusCode);
|
||||
Assert.Equal(0, ready.Invocations);
|
||||
Assert.Equal(1, active.Invocations);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task LivenessEndpoint_RunsNoChecks_AndReturns200()
|
||||
{
|
||||
var (response, ready, active) = await RunAsync("/healthz");
|
||||
|
||||
Assert.Equal(HttpStatusCode.OK, response.StatusCode);
|
||||
Assert.Equal(0, ready.Invocations);
|
||||
Assert.Equal(0, active.Invocations);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task ReadyEndpoint_Healthy_Returns200()
|
||||
{
|
||||
var (response, _, _) = await RunAsync("/health/ready", readyStatus: HealthStatus.Healthy);
|
||||
|
||||
Assert.Equal(HttpStatusCode.OK, response.StatusCode);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task ReadyEndpoint_Unhealthy_Returns503()
|
||||
{
|
||||
var (response, _, _) = await RunAsync("/health/ready", readyStatus: HealthStatus.Unhealthy);
|
||||
|
||||
Assert.Equal(HttpStatusCode.ServiceUnavailable, response.StatusCode);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task ActiveEndpoint_Unhealthy_Returns503()
|
||||
{
|
||||
var (response, _, _) = await RunAsync("/health/active", activeStatus: HealthStatus.Unhealthy);
|
||||
|
||||
Assert.Equal(HttpStatusCode.ServiceUnavailable, response.StatusCode);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task LivenessEndpoint_UnaffectedByUnhealthyChecks()
|
||||
{
|
||||
// Even though every registered check is Unhealthy, /healthz runs none of them
|
||||
// (predicate _ => false) and stays 200 as long as the process is up.
|
||||
var (response, ready, active) = await RunAsync(
|
||||
"/healthz", readyStatus: HealthStatus.Unhealthy, activeStatus: HealthStatus.Unhealthy);
|
||||
|
||||
Assert.Equal(HttpStatusCode.OK, response.StatusCode);
|
||||
Assert.Equal(0, ready.Invocations);
|
||||
Assert.Equal(0, active.Invocations);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task Options_OverrideRoutePaths()
|
||||
{
|
||||
var ready = new RecordingHealthCheck(HealthStatus.Healthy);
|
||||
var active = new RecordingHealthCheck(HealthStatus.Healthy);
|
||||
|
||||
var builder = WebApplication.CreateBuilder();
|
||||
builder.WebHost.UseTestServer();
|
||||
builder.Services.AddHealthChecks()
|
||||
.AddCheck("ready-check", ready, tags: new[] { ZbHealthTags.Ready })
|
||||
.AddCheck("active-check", active, tags: new[] { ZbHealthTags.Active });
|
||||
|
||||
await using var app = builder.Build();
|
||||
app.MapZbHealth(new ZbHealthEndpointOptions
|
||||
{
|
||||
ReadyPath = "/custom/ready",
|
||||
ActivePath = "/custom/active",
|
||||
LivePath = "/custom/live",
|
||||
});
|
||||
await app.StartAsync();
|
||||
|
||||
var client = app.GetTestClient();
|
||||
|
||||
var readyResponse = await client.GetAsync("/custom/ready");
|
||||
Assert.Equal(HttpStatusCode.OK, readyResponse.StatusCode);
|
||||
Assert.Equal(1, ready.Invocations);
|
||||
Assert.Equal(0, active.Invocations);
|
||||
|
||||
var liveResponse = await client.GetAsync("/custom/live");
|
||||
Assert.Equal(HttpStatusCode.OK, liveResponse.StatusCode);
|
||||
|
||||
// The default paths must no longer be mapped when overridden.
|
||||
var defaultReady = await client.GetAsync("/health/ready");
|
||||
Assert.Equal(HttpStatusCode.NotFound, defaultReady.StatusCode);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,28 @@
|
||||
<Project Sdk="Microsoft.NET.Sdk">
|
||||
|
||||
<PropertyGroup>
|
||||
<IsPackable>false</IsPackable>
|
||||
</PropertyGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<PackageReference Include="coverlet.collector" />
|
||||
<PackageReference Include="Microsoft.NET.Test.Sdk" />
|
||||
<PackageReference Include="xunit" />
|
||||
<PackageReference Include="xunit.runner.visualstudio" />
|
||||
<PackageReference Include="Microsoft.AspNetCore.Mvc.Testing" />
|
||||
</ItemGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<Using Include="Xunit" />
|
||||
</ItemGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<!-- WebApplicationFactory requires the full ASP.NET Core shared framework -->
|
||||
<FrameworkReference Include="Microsoft.AspNetCore.App" />
|
||||
</ItemGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<ProjectReference Include="..\..\src\ZB.MOM.WW.Health\ZB.MOM.WW.Health.csproj" />
|
||||
</ItemGroup>
|
||||
|
||||
</Project>
|
||||
Reference in New Issue
Block a user