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
@@ -23,10 +23,12 @@ namespace ZB.MOM.WW.ScadaBridge.Communication.Tests;
[Collection("DebugStreamStatics")]
public class DebugStreamServiceTests : TestKit
{
/// <summary>Verifies that a stream that terminates before the snapshot arrives throws a meaningful exception.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task StartStreamAsync_StreamTerminatesBeforeSnapshot_ThrowsMeaningfulException()
{
// Regression test for Communication-001. When the debug stream terminates before
// Regression test: when the debug stream terminates before
// the initial snapshot arrives, StartStreamAsync used to let the raw
// InvalidOperationException from onTerminatedWrapper escape its
// OperationCanceledException-only catch — the caller saw an untranslated exception
@@ -80,6 +82,8 @@ public class DebugStreamServiceTests : TestKit
Assert.NotNull(ex.InnerException);
}
/// <summary>Verifies that an attached session is kept alive by the service keepalive and dies once detached.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task AttachedSession_IsKeptAliveByTheServiceKeepalive_AndDiesOnceDetached()
{
@@ -165,8 +169,12 @@ public class DebugStreamServiceTests : TestKit
}
}
// --- arch-review 2026-08-19 P3-3: single-endpoint sites ---
// --- single-endpoint sites ---
/// <summary>Verifies that a single-endpoint site uses its sole address for both node slots.</summary>
/// <param name="nodeA">The gRPC address of node A, or null.</param>
/// <param name="nodeB">The gRPC address of node B, or null.</param>
/// <returns>A task that represents the asynchronous operation.</returns>
[Theory]
[InlineData("http://localhost:5100", null)]
[InlineData(null, "http://localhost:5200")]
@@ -222,6 +230,8 @@ public class DebugStreamServiceTests : TestKit
await Assert.ThrowsAsync<InvalidOperationException>(() => startTask);
}
/// <summary>Verifies that a site with no gRPC addresses still throws.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task StartStreamAsync_SiteWithNoGrpcAddresses_StillThrows()
{