docs(tests): fix CommentChecker findings across tests/ — 13,392 → 0 (repo-wide scan clean)

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.
This commit is contained in:
Joseph Doherty
2026-10-07 15:05:49 -04:00
parent 0ffd4bdbea
commit 513fa1aa16
998 changed files with 17896 additions and 2395 deletions
@@ -8,7 +8,7 @@ using ZB.MOM.WW.ScadaBridge.Commons.Types.Kpi;
namespace ZB.MOM.WW.ScadaBridge.AuditLog.Tests.Kpi;
/// <summary>
/// M6 "KPI History &amp; Trends" (K8) coverage for <see cref="AuditLogKpiSampleSource"/> —
/// "KPI History &amp; Trends" coverage for <see cref="AuditLogKpiSampleSource"/> —
/// the <see cref="ZB.MOM.WW.ScadaBridge.Commons.Interfaces.Kpi.IKpiSampleSource"/> the
/// central recorder enumerates to snapshot Audit Log KPIs. Asserts the source maps the
/// repository's <see cref="AuditLogKpiSnapshot"/> onto exactly three Global-scope samples
@@ -19,6 +19,7 @@ public class AuditLogKpiSampleSourceTests
{
private static readonly DateTime CapturedAt = new(2026, 6, 17, 12, 30, 0, DateTimeKind.Utc);
/// <summary>Verifies that the sample source reports the AuditLog source name.</summary>
[Fact]
public void Source_is_AuditLog()
{
@@ -28,6 +29,8 @@ public class AuditLogKpiSampleSourceTests
Assert.Equal(KpiSources.AuditLog, sut.Source);
}
/// <summary>Verifies that collecting emits three global samples mapped from the health snapshot.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task CollectAsync_emits_three_global_samples_mapped_from_snapshot()
{
@@ -64,6 +67,8 @@ public class AuditLogKpiSampleSourceTests
AssertMetric(samples, "backlogTotal", 305);
}
/// <summary>Verifies that the sample window is anchored on the snapshot's capture time.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task CollectAsync_anchors_the_window_on_capturedAtUtc()
{
@@ -83,6 +88,8 @@ public class AuditLogKpiSampleSourceTests
Arg.Any<CancellationToken>());
}
/// <summary>Verifies that collecting returns no samples when the snapshot is null.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task CollectAsync_returns_empty_when_snapshot_is_null()
{
@@ -98,6 +105,8 @@ public class AuditLogKpiSampleSourceTests
Assert.Empty(samples);
}
/// <summary>Verifies that the backlog provider's value is used when one is registered.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task CollectAsync_uses_backlog_provider_when_present()
{
@@ -127,11 +136,13 @@ public class AuditLogKpiSampleSourceTests
AssertMetric(samples, "backlogTotal", 42);
}
/// <summary>Verifies that the snapshot's own backlog total is used when no backlog provider is registered.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task CollectAsync_falls_back_to_snapshot_backlog_when_provider_absent()
{
// No provider (sites / unit tests): the sample source degrades to the
// snapshot's own BacklogTotal — unchanged pre-Task-10 behavior.
// snapshot's own BacklogTotal — unchanged behavior from before the provider existed.
var snapshot = new AuditLogKpiSnapshot(
TotalEventsLastHour: 10,
ErrorEventsLastHour: 1,