Joseph Doherty
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.
60 lines
2.4 KiB
C#
60 lines
2.4 KiB
C#
namespace ZB.MOM.WW.ScadaBridge.HealthMonitoring.Tests;
|
|
|
|
/// <summary>
|
|
/// Regression coverage: the canonical audit redactor
|
|
/// (<see cref="ZB.MOM.WW.ScadaBridge.AuditLog.Redaction.ScadaBridgeAuditRedactor"/>) increments
|
|
/// <see cref="ZB.MOM.WW.ScadaBridge.AuditLog.Payload.IAuditRedactionFailureCounter"/> every time
|
|
/// a header/body/SQL-param redactor stage throws and the redactor has to
|
|
/// over-redact the field with the <c><redacted: redactor error></c> marker.
|
|
/// Bundle C bridges that counter into the Site Health Monitoring report payload
|
|
/// as <c>AuditRedactionFailure</c> so a misconfigured / catastrophic regex
|
|
/// surfaces on /monitoring/health rather than disappearing into a NoOp sink.
|
|
/// Mirrors the Bundle G <c>SiteAuditWriteFailures</c> metric shape — same
|
|
/// per-interval increment-and-reset semantics, same defaults-to-zero
|
|
/// contract.
|
|
/// </summary>
|
|
public class AuditRedactionFailureMetricTests
|
|
{
|
|
private readonly SiteHealthCollector _collector = new();
|
|
|
|
/// <summary>Verifies that incrementing the counter three times makes it report three.</summary>
|
|
[Fact]
|
|
public void Increment_Three_Times_Counter_Reports_3()
|
|
{
|
|
_collector.IncrementAuditRedactionFailure();
|
|
_collector.IncrementAuditRedactionFailure();
|
|
_collector.IncrementAuditRedactionFailure();
|
|
|
|
var report = _collector.CollectReport("site-1");
|
|
|
|
Assert.Equal(3, report.AuditRedactionFailure);
|
|
}
|
|
|
|
/// <summary>Verifies that the report payload includes the audit redaction failure count as zero by default.</summary>
|
|
[Fact]
|
|
public void Report_Payload_Includes_AuditRedactionFailure_AsZeroByDefault()
|
|
{
|
|
var report = _collector.CollectReport("site-1");
|
|
|
|
Assert.Equal(0, report.AuditRedactionFailure);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Mirrors the existing per-interval reset semantics for ScriptErrorCount /
|
|
/// AlarmEvaluationErrorCount / DeadLetterCount / SiteAuditWriteFailures —
|
|
/// AuditRedactionFailure is an interval count, not a running total.
|
|
/// </summary>
|
|
[Fact]
|
|
public void CollectReport_Resets_AuditRedactionFailure()
|
|
{
|
|
_collector.IncrementAuditRedactionFailure();
|
|
_collector.IncrementAuditRedactionFailure();
|
|
|
|
var first = _collector.CollectReport("site-1");
|
|
Assert.Equal(2, first.AuditRedactionFailure);
|
|
|
|
var second = _collector.CollectReport("site-1");
|
|
Assert.Equal(0, second.AuditRedactionFailure);
|
|
}
|
|
}
|