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.
78 lines
3.1 KiB
C#
78 lines
3.1 KiB
C#
using ZB.MOM.WW.ScadaBridge.Commons.Types;
|
|
|
|
namespace ZB.MOM.WW.ScadaBridge.HealthMonitoring.Tests;
|
|
|
|
/// <summary>
|
|
/// Regression coverage. The site-side audit-log SQLite writer
|
|
/// exposes a backlog snapshot (<c>SiteAuditBacklogSnapshot</c>) via the
|
|
/// <c>ISiteAuditQueue.GetBacklogStatsAsync</c> surface. A periodic
|
|
/// <c>SiteAuditBacklogReporter</c> hosted service polls that snapshot and
|
|
/// pushes it into the collector via <see cref="ISiteHealthCollector.UpdateSiteAuditBacklog"/>
|
|
/// so the next <see cref="ISiteHealthCollector.CollectReport"/> includes it in
|
|
/// the report payload as <c>SiteAuditBacklog</c>. Unlike the
|
|
/// SiteAuditWriteFailures / AuditRedactionFailure interval counters, the
|
|
/// backlog snapshot is not reset on collect — the field carries forward
|
|
/// whatever the most recent refresh pushed in.
|
|
/// </summary>
|
|
public class SiteAuditBacklogMetricTests
|
|
{
|
|
private readonly SiteHealthCollector _collector = new();
|
|
|
|
/// <summary>Verifies that a report collected after an update includes the backlog.</summary>
|
|
[Fact]
|
|
public void Update_Then_CollectReport_IncludesBacklog()
|
|
{
|
|
var snapshot = new SiteAuditBacklogSnapshot(
|
|
PendingCount: 42,
|
|
OldestPendingUtc: new DateTime(2026, 5, 20, 10, 0, 0, DateTimeKind.Utc),
|
|
OnDiskBytes: 1234567);
|
|
|
|
_collector.UpdateSiteAuditBacklog(snapshot);
|
|
|
|
var report = _collector.CollectReport("site-1");
|
|
|
|
Assert.Equal(snapshot, report.SiteAuditBacklog);
|
|
}
|
|
|
|
/// <summary>Verifies that the report payload includes the site audit backlog as null by default.</summary>
|
|
[Fact]
|
|
public void Report_Payload_Includes_SiteAuditBacklog_AsNullByDefault()
|
|
{
|
|
// No refresh has been pushed yet — the report carries null so the
|
|
// central UI can distinguish "no data yet" from "queue empty".
|
|
var report = _collector.CollectReport("site-1");
|
|
|
|
Assert.Null(report.SiteAuditBacklog);
|
|
}
|
|
|
|
/// <summary>Verifies that collecting a report does not reset the site audit backlog.</summary>
|
|
[Fact]
|
|
public void CollectReport_DoesNotReset_SiteAuditBacklog()
|
|
{
|
|
// Backlog snapshot is a point-in-time reading, not a per-interval
|
|
// counter — successive CollectReport calls before the next
|
|
// SiteAuditBacklogReporter tick MUST keep returning the same snapshot
|
|
// so a slow refresh cadence doesn't blank the central dashboard.
|
|
var snapshot = new SiteAuditBacklogSnapshot(
|
|
PendingCount: 7,
|
|
OldestPendingUtc: null,
|
|
OnDiskBytes: 8192);
|
|
|
|
_collector.UpdateSiteAuditBacklog(snapshot);
|
|
|
|
var first = _collector.CollectReport("site-1");
|
|
var second = _collector.CollectReport("site-1");
|
|
|
|
Assert.Equal(snapshot, first.SiteAuditBacklog);
|
|
Assert.Equal(snapshot, second.SiteAuditBacklog);
|
|
}
|
|
|
|
/// <summary>Verifies that updating with a null snapshot throws an argument-null exception.</summary>
|
|
[Fact]
|
|
public void Update_With_Null_Throws_ArgumentNullException()
|
|
{
|
|
Assert.Throws<ArgumentNullException>(
|
|
() => _collector.UpdateSiteAuditBacklog(null!));
|
|
}
|
|
}
|