Files
scadaproj/ZB.MOM.WW.Health/tests/ZB.MOM.WW.Health.Tests/TierMappingTests.cs
T
Joseph Doherty 544a6ddb77 Fix all baseline code-review findings across the six shared libraries
Resolves the 35 findings from the 2026-06-01 baseline (commit 26ba1c7),
test-first for every behavioral change. +51 tests (331 -> 382 passing, 0 failed).

- Telemetry-001 (HIGH): RedactionEnricher now honours property removal, so a
  redactor that drops a key actually scrubs the secret from the event.
- Auth: LDAP validator ValidateOnStart; API-key verify no longer fails on a
  best-effort MarkUsed write or a corrupt scopes column (fail-closed); LDAP cert
  validation hook; KeyPrefix persistence aligned; README algorithm corrected.
- Health: Akka checks return Degraded (not throw) when the cluster isn't up yet;
  GrpcDependencyHealthCheck catch-all; null 'description' rendered; composite
  endpoint builder; XML docs shipped.
- Audit: CompositeAuditWriter no longer re-throws OperationCanceledException;
  TruncatingAuditRedactor over-redact scrubs Target + safe negative max; options
  record; XML docs shipped.
- Configuration: TryAddEnumerable idempotent registration; consistent port
  quoting; strict invariant port parsing; XML docs + README packaged.
- Theme: mobile toggle is now CSS-only (no Bootstrap JS); token/CSS hygiene;
  XML docs on the public parameter surface.

Shared-contract/spec docs updated where the code was the source of truth
(observability service.instance.id, MapZbMetrics, redactor reach). All changes
additive/back-compatible at v0.1.0. code-reviews bookkeeping follows separately.
2026-06-01 11:22:14 -04:00

191 lines
7.3 KiB
C#

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 ChainedConvention_AppliesToAllThreeEndpoints()
{
// MapZbHealth returns a composite builder, so a convention chained onto its result
// (.RequireHost) must gate all three endpoints — not just readiness. With a host filter
// that does not match the default test-client host, every tier returns 404.
var builder = WebApplication.CreateBuilder();
builder.WebHost.UseTestServer();
builder.Services.AddHealthChecks()
.AddCheck("ready-check", new RecordingHealthCheck(HealthStatus.Healthy), tags: new[] { ZbHealthTags.Ready })
.AddCheck("active-check", new RecordingHealthCheck(HealthStatus.Healthy), tags: new[] { ZbHealthTags.Active });
await using var app = builder.Build();
app.MapZbHealth().RequireHost("health.internal");
await app.StartAsync();
var client = app.GetTestClient();
// The default test host does not match "health.internal", so the convention removed every
// endpoint from this host — confirming it fanned out to all three, not just readiness.
Assert.Equal(HttpStatusCode.NotFound, (await client.GetAsync("/health/ready")).StatusCode);
Assert.Equal(HttpStatusCode.NotFound, (await client.GetAsync("/health/active")).StatusCode);
Assert.Equal(HttpStatusCode.NotFound, (await client.GetAsync("/healthz")).StatusCode);
}
[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);
}
}