513fa1aa16
Comment/XML-doc changes only: - add summaries to ~10k test methods, fixtures, fakes and helpers (+ <param> on theories, <returns> on async Task methods, <inheritdoc/> on interface implementations the checker can resolve) - strip ~2.6k project-tracking references (WP*, P*-*, row-NN, Task N, #NN, Component-0NN) from comments, keeping the explanatory text; reword false positives in comments only - real docs on fakes implementing BCL/library interfaces (IDisposable, ILogger, IOptionsMonitor, IAsyncLifetime) - reword the last 5 src/ false positives (CWE-1236, failures-1, year-0001, M365) Only non-comment edits: four one-line nested classes split across lines so members can carry docs. Build 0 errors / 0 warnings.
103 lines
4.3 KiB
C#
103 lines
4.3 KiB
C#
using Akka.Actor;
|
|
using Akka.TestKit.Xunit2;
|
|
using Microsoft.Extensions.Configuration;
|
|
using Microsoft.Extensions.DependencyInjection;
|
|
using Microsoft.Extensions.Logging;
|
|
using Microsoft.Extensions.Logging.Abstractions;
|
|
using ZB.MOM.WW.ScadaBridge.AuditLog;
|
|
using ZB.MOM.WW.ScadaBridge.AuditLog.Central;
|
|
using ZB.MOM.WW.ScadaBridge.AuditLog.Payload;
|
|
|
|
namespace ZB.MOM.WW.ScadaBridge.AuditLog.Tests.Central;
|
|
|
|
/// <summary>
|
|
/// Coverage for the central-side payload-filter redactor
|
|
/// failure bridge. The SITE bridge
|
|
/// (<c>HealthMetricsAuditRedactionFailureCounter</c>) that pushes increments
|
|
/// into the site health report; the central bridge mirrors that with
|
|
/// <see cref="CentralAuditRedactionFailureCounter"/> so the same payload
|
|
/// filter — when it runs on the central writer paths — surfaces failures on
|
|
/// the central <see cref="AuditCentralHealthSnapshot"/>.
|
|
/// </summary>
|
|
public class CentralAuditRedactionFailureCounterTests : TestKit
|
|
{
|
|
/// <summary>Verifies that incrementing the counter routes the failure to the central health snapshot.</summary>
|
|
[Fact]
|
|
public void Increment_Routes_To_Snapshot()
|
|
{
|
|
var snapshot = new AuditCentralHealthSnapshot();
|
|
var counter = new CentralAuditRedactionFailureCounter(snapshot);
|
|
|
|
counter.Increment();
|
|
counter.Increment();
|
|
counter.Increment();
|
|
|
|
Assert.Equal(3, snapshot.AuditRedactionFailure);
|
|
}
|
|
|
|
/// <summary>Verifies that constructing the counter with a null snapshot throws.</summary>
|
|
[Fact]
|
|
public void Construction_With_Null_Snapshot_Throws()
|
|
{
|
|
Assert.Throws<ArgumentNullException>(
|
|
() => new CentralAuditRedactionFailureCounter(null!));
|
|
}
|
|
|
|
/// <summary>Verifies that registering central maintenance replaces the redaction failure counter with the central implementation.</summary>
|
|
[Fact]
|
|
public void AddAuditLogCentralMaintenance_Replaces_IAuditRedactionFailureCounter_With_CentralImpl()
|
|
{
|
|
// AddAuditLog registers NoOp; AddAuditLogCentralMaintenance is the
|
|
// override path. The replaced binding MUST resolve to the central
|
|
// bridge — a site host that wires AddAuditLogHealthMetricsBridge
|
|
// instead would resolve to the site bridge (covered in
|
|
// AddAuditLogTests).
|
|
var config = new ConfigurationBuilder()
|
|
.AddInMemoryCollection(new Dictionary<string, string?>
|
|
{
|
|
["AuditLog:SiteWriter:DatabasePath"] = ":memory:",
|
|
})
|
|
.Build();
|
|
|
|
var services = new ServiceCollection();
|
|
services.AddSingleton<ILoggerFactory, NullLoggerFactory>();
|
|
services.AddSingleton(typeof(ILogger<>), typeof(NullLogger<>));
|
|
// AuditCentralHealthSnapshot no longer takes a tracker dependency —
|
|
// the tracker is constructed later by the Akka bootstrap because its
|
|
// ctor needs an ActorSystem (not a DI-resolvable singleton). The
|
|
// snapshot itself composes purely from primitives.
|
|
services.AddAuditLog(config);
|
|
services.AddAuditLogCentralMaintenance(config);
|
|
using var provider = services.BuildServiceProvider();
|
|
|
|
var counter = provider.GetRequiredService<IAuditRedactionFailureCounter>();
|
|
|
|
Assert.IsType<CentralAuditRedactionFailureCounter>(counter);
|
|
}
|
|
|
|
/// <summary>Verifies that the default redaction failure counter registered by the audit log is a no-op.</summary>
|
|
[Fact]
|
|
public void AddAuditLog_Default_IAuditRedactionFailureCounter_Is_NoOp()
|
|
{
|
|
// Sanity check: without AddAuditLogCentralMaintenance the default
|
|
// remains the NoOp — the central bridge only takes effect
|
|
// when the central-only registration runs.
|
|
var config = new ConfigurationBuilder()
|
|
.AddInMemoryCollection(new Dictionary<string, string?>
|
|
{
|
|
["AuditLog:SiteWriter:DatabasePath"] = ":memory:",
|
|
})
|
|
.Build();
|
|
|
|
var services = new ServiceCollection();
|
|
services.AddSingleton<ILoggerFactory, NullLoggerFactory>();
|
|
services.AddSingleton(typeof(ILogger<>), typeof(NullLogger<>));
|
|
services.AddAuditLog(config);
|
|
using var provider = services.BuildServiceProvider();
|
|
|
|
var counter = provider.GetRequiredService<IAuditRedactionFailureCounter>();
|
|
|
|
Assert.IsType<NoOpAuditRedactionFailureCounter>(counter);
|
|
}
|
|
}
|