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
@@ -59,6 +59,8 @@ public sealed class LocalDbConfigConvergenceTests : LocalDbSitePairHarness
// ---- scenarios --------------------------------------------------------------------
/// <summary>Verifies that a node with newer local rows keeps them when a peer snapshot arrives.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ANodeWithNewerLocalRows_KeepsThem_WhenAPeerSnapshotArrives()
{
@@ -110,13 +112,15 @@ public sealed class LocalDbConfigConvergenceTests : LocalDbSitePairHarness
"both nodes to converge on the newer config for the contended instance");
}
/// <summary>Verifies that a config deployed on node A converges to node B through replication alone, without any fetch.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ConfigDeployedOnA_ConvergesToB_WithoutAnyFetch()
{
// Was: SiteReplicationActorTests #1-#5 (notify-and-fetch — the standby is told a
// Was: the SiteReplicationActor tests (notify-and-fetch — the standby is told a
// deploy happened, then HTTP-fetches the config itself, with retries and a
// superseded-404 path). Under CDC the config row simply replicates, so that whole
// exchange is deleted at Task 15.
// superseded-config 404 path). Under CDC the config row simply replicates, so that whole
// exchange is deleted.
//
// The plan called for asserting a fetcher test double records zero invocations. That
// would be THEATRE here and is deliberately not done: this harness has no actor
@@ -126,7 +130,7 @@ public sealed class LocalDbConfigConvergenceTests : LocalDbSitePairHarness
//
// What this test honestly proves is the positive half: the config reaches node B
// through replication ALONE, in a process where fetching is not merely unused but
// absent. The negative half — that no fetch path survives — is proved by Task 15
// absent. The negative half — that no fetch path survives — is proved by
// deleting the code and the build still passing, which is a stronger check than any
// runtime counter.
//
@@ -140,6 +144,8 @@ public sealed class LocalDbConfigConvergenceTests : LocalDbSitePairHarness
"the deployed config to reach node B over replication alone");
}
/// <summary>Verifies that redeploying an instance converges both nodes to the new revision.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task RedeployingAnInstance_ConvergesToTheNewRevision_OnBothNodes()
{
@@ -160,6 +166,8 @@ public sealed class LocalDbConfigConvergenceTests : LocalDbSitePairHarness
"both nodes to converge on the redeployed revision");
}
/// <summary>Verifies that a config deployed on node B converges to node A.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ConfigDeployedOnB_ConvergesToA()
{