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
@@ -32,10 +32,11 @@ public class LocalDbReplicationStatusReporterTests
logger: NullLogger<LocalDbReplicationStatusReporter>.Instance,
refreshInterval: TimeSpan.FromHours(1));
/// <summary>Verifies that probing an unconfigured replication node publishes null for both fields.</summary>
[Fact]
public void Probe_ReplicationUnconfigured_PublishesNullForBothFields()
{
// The row-80 regression. The inert engine's false/0 must NOT reach the report.
// The inert-engine regression. The inert engine's false/0 must NOT reach the report.
var collector = new SiteHealthCollector();
using var reporter = Build(collector, replicationConfigured: false);
@@ -46,6 +47,7 @@ public class LocalDbReplicationStatusReporterTests
Assert.Null(report.LocalDbOplogBacklog);
}
/// <summary>Verifies that probing an unconfigured replication node does not read the sync status providers.</summary>
[Fact]
public void Probe_ReplicationUnconfigured_DoesNotReadTheSyncStatusProviders()
{
@@ -69,6 +71,7 @@ public class LocalDbReplicationStatusReporterTests
Assert.Equal(0, backlogReads);
}
/// <summary>Verifies that a configured but disconnected node publishes false rather than null.</summary>
[Fact]
public void Probe_ReplicationConfiguredButDisconnected_PublishesFalse_NotNull()
{
@@ -86,6 +89,7 @@ public class LocalDbReplicationStatusReporterTests
Assert.Equal(4200L, report.LocalDbOplogBacklog);
}
/// <summary>Verifies that a configured and connected node publishes true.</summary>
[Fact]
public void Probe_ReplicationConfiguredAndConnected_PublishesTrue()
{
@@ -100,6 +104,7 @@ public class LocalDbReplicationStatusReporterTests
Assert.Equal(0L, report.LocalDbOplogBacklog);
}
/// <summary>Verifies that a configured node preserves a null backlog as unknown.</summary>
[Fact]
public void Probe_ReplicationConfigured_PreservesANullBacklogAsUnknown()
{
@@ -117,6 +122,7 @@ public class LocalDbReplicationStatusReporterTests
Assert.Null(report.LocalDbOplogBacklog);
}
/// <summary>Verifies that a throwing provider leaves the previous snapshot intact.</summary>
[Fact]
public void Probe_ProviderThrows_LeavesThePreviousSnapshotIntact()
{
@@ -143,6 +149,7 @@ public class LocalDbReplicationStatusReporterTests
Assert.Equal(7L, report.LocalDbOplogBacklog);
}
/// <summary>Verifies that flipping the replication gate on stops the null reporting.</summary>
[Fact]
public void Probe_GateFlippedOn_StopsReportingNull()
{
@@ -169,6 +176,7 @@ public class LocalDbReplicationStatusReporterTests
Assert.Equal(12L, report.LocalDbOplogBacklog);
}
/// <summary>Verifies that a null replication-configured provider causes the constructor to throw.</summary>
[Fact]
public void Constructor_NullReplicationConfiguredProvider_Throws()
{