544a6ddb77
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.
111 lines
4.5 KiB
C#
111 lines
4.5 KiB
C#
using System.Net;
|
|
using System.Net.Http.Json;
|
|
using System.Text.Json;
|
|
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 canonical JSON response writer (<see cref="ZbHealthWriter.WriteJsonAsync"/>):
|
|
/// the JSON body shape, the <c>application/json</c> content type, and that the framework's
|
|
/// status-to-HTTP mapping (Healthy/Degraded → 200, Unhealthy → 503) is preserved when the
|
|
/// writer is wired onto the ready/active tiers by <see cref="ZbHealthEndpointExtensions.MapZbHealth"/>.
|
|
/// </summary>
|
|
public sealed class ResponseWriterTests
|
|
{
|
|
private sealed class StubHealthCheck : IHealthCheck
|
|
{
|
|
private readonly HealthCheckResult _result;
|
|
|
|
public StubHealthCheck(HealthStatus status, string? description = null) =>
|
|
_result = new HealthCheckResult(status, description);
|
|
|
|
public Task<HealthCheckResult> CheckHealthAsync(
|
|
HealthCheckContext context,
|
|
CancellationToken cancellationToken = default) => Task.FromResult(_result);
|
|
}
|
|
|
|
private static async Task<HttpResponseMessage> GetReadyAsync(
|
|
HealthStatus status, string? description = "db reachable")
|
|
{
|
|
var builder = WebApplication.CreateBuilder();
|
|
builder.WebHost.UseTestServer();
|
|
builder.Services.AddHealthChecks()
|
|
.AddCheck("db", new StubHealthCheck(status, description), tags: new[] { ZbHealthTags.Ready });
|
|
|
|
await using var app = builder.Build();
|
|
app.MapZbHealth();
|
|
await app.StartAsync();
|
|
|
|
var client = app.GetTestClient();
|
|
return await client.GetAsync("/health/ready");
|
|
}
|
|
|
|
[Fact]
|
|
public async Task ReadyEndpoint_Healthy_WritesJsonBody_With200()
|
|
{
|
|
var response = await GetReadyAsync(HealthStatus.Healthy);
|
|
|
|
Assert.Equal(HttpStatusCode.OK, response.StatusCode);
|
|
Assert.Equal("application/json", response.Content.Headers.ContentType?.MediaType);
|
|
|
|
using var doc = JsonDocument.Parse(await response.Content.ReadAsStringAsync());
|
|
var root = doc.RootElement;
|
|
|
|
Assert.Equal("Healthy", root.GetProperty("status").GetString());
|
|
Assert.Equal(JsonValueKind.Number, root.GetProperty("totalDurationMs").ValueKind);
|
|
|
|
var entries = root.GetProperty("entries");
|
|
var db = entries.GetProperty("db");
|
|
Assert.Equal("Healthy", db.GetProperty("status").GetString());
|
|
Assert.Equal("db reachable", db.GetProperty("description").GetString());
|
|
}
|
|
|
|
[Fact]
|
|
public async Task ReadyEndpoint_NullDescription_EmitsDescriptionKeyAsNull()
|
|
{
|
|
// A check that produces no description must still emit the "description" key with a JSON null
|
|
// value (matching the spec §3 example and the HealthChecks.UI.Client shape) rather than
|
|
// dropping the key — so consumers can read entries.<name>.description without handling a
|
|
// missing property.
|
|
var response = await GetReadyAsync(HealthStatus.Healthy, description: null);
|
|
|
|
Assert.Equal(HttpStatusCode.OK, response.StatusCode);
|
|
|
|
using var doc = JsonDocument.Parse(await response.Content.ReadAsStringAsync());
|
|
var db = doc.RootElement.GetProperty("entries").GetProperty("db");
|
|
|
|
Assert.True(db.TryGetProperty("description", out var description), "description key must be present");
|
|
Assert.Equal(JsonValueKind.Null, description.ValueKind);
|
|
}
|
|
|
|
[Fact]
|
|
public async Task ReadyEndpoint_Degraded_Returns200_WithDegradedStatus()
|
|
{
|
|
var response = await GetReadyAsync(HealthStatus.Degraded);
|
|
|
|
Assert.Equal(HttpStatusCode.OK, response.StatusCode);
|
|
Assert.Equal("application/json", response.Content.Headers.ContentType?.MediaType);
|
|
|
|
using var doc = JsonDocument.Parse(await response.Content.ReadAsStringAsync());
|
|
Assert.Equal("Degraded", doc.RootElement.GetProperty("status").GetString());
|
|
}
|
|
|
|
[Fact]
|
|
public async Task ReadyEndpoint_Unhealthy_Returns503_WithUnhealthyStatus()
|
|
{
|
|
var response = await GetReadyAsync(HealthStatus.Unhealthy);
|
|
|
|
Assert.Equal(HttpStatusCode.ServiceUnavailable, response.StatusCode);
|
|
Assert.Equal("application/json", response.Content.Headers.ContentType?.MediaType);
|
|
|
|
using var doc = JsonDocument.Parse(await response.Content.ReadAsStringAsync());
|
|
Assert.Equal("Unhealthy", doc.RootElement.GetProperty("status").GetString());
|
|
}
|
|
}
|