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
@@ -16,7 +16,7 @@ using ZB.MOM.WW.ScadaBridge.SiteRuntime.Streaming;
namespace ZB.MOM.WW.ScadaBridge.IntegrationTests.Grpc;
/// <summary>
/// End-to-end trace for the aggregated live alarm stream (plan #10 deferred item, Task 7).
/// End-to-end trace for the aggregated live alarm stream.
///
/// Every per-task unit test (T1–T6) exercises exactly one layer with its neighbour mocked:
/// T1 the site broadcast filter (subscriber = TestKit probe, domain events), T2/the existing
@@ -41,7 +41,7 @@ namespace ZB.MOM.WW.ScadaBridge.IntegrationTests.Grpc;
/// for MULTIPLE instances (no per-instance filter); and a snapshot-seed row and a live delta
/// for the same native alarm — both mapped through the real pipe — collapse onto ONE cache row.
///
/// Full gRPC-over-HTTP/2 remains a manual docker-cluster smoke (plan §4 Task 7).
/// Full gRPC-over-HTTP/2 remains a manual docker-cluster smoke (plan §4).
/// </summary>
public class SiteAlarmStreamEndToEndTests : TestKit
{
@@ -50,6 +50,8 @@ public class SiteAlarmStreamEndToEndTests : TestKit
// ── The full site→proto→client trace ────────────────────────────────────────
/// <summary>Verifies that a site-wide alarm traverses the manager, relay and client, preserving identity and enrichment while dropping attributes and placeholders.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task SiteWideAlarm_TraversesManagerToRelayToClient_PreservingIdentityAndEnrichment_DroppingAttributesAndPlaceholders()
{
@@ -173,6 +175,8 @@ public class SiteAlarmStreamEndToEndTests : TestKit
// ── Snapshot-seed vs live-delta identity parity, through the real pipe ────────
/// <summary>Verifies that a seed row and a live delta for the same native alarm collapse onto one cache row.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task RealPipeMapped_SeedRow_And_LiveDelta_ForSameNativeAlarm_CollapseOntoOneCacheRow()
{
@@ -226,7 +230,7 @@ public class SiteAlarmStreamEndToEndTests : TestKit
sink.Publish, factory, "http://a:5100", "http://b:5100", TimeSpan.FromMinutes(10),
TimeSpan.Zero, TimeSpan.FromSeconds(5), TimeSpan.FromSeconds(60),
// Props.Create is an expression tree, which may not omit optional arguments
// (CS0854) — jitter and the P3-4 open-attempt deadline are passed explicitly.
// (CS0854) — jitter and the open-attempt deadline are passed explicitly.
0.0, SiteAlarmAggregatorActor.DefaultOpenAttemptTimeout)));
await WaitForConditionAsync(() => sink.Latest is { Count: 1 }); // seed applied
@@ -268,10 +272,14 @@ public class SiteAlarmStreamEndToEndTests : TestKit
{
private readonly object _lock = new();
private IReadOnlyList<AlarmStateChanged>? _latest;
/// <summary>Records the latest published snapshot.</summary>
/// <param name="snapshot">The alarm snapshot published to the sink.</param>
/// <param name="streamLive">Whether the live stream is connected (ignored).</param>
public void Publish(IReadOnlyList<AlarmStateChanged> snapshot, bool streamLive)
{
lock (_lock) { _latest = snapshot; }
}
/// <summary>Gets the most recently published snapshot, or null if none has been published.</summary>
public IReadOnlyList<AlarmStateChanged>? Latest
{
get { lock (_lock) { return _latest; } }
@@ -281,6 +289,7 @@ public class SiteAlarmStreamEndToEndTests : TestKit
/// <summary>Aggregator transport double: its live stream simply stays open until cancelled.</summary>
private sealed class NoopSiteStreamClient : SiteStreamGrpcClient
{
/// <inheritdoc />
public override Task SubscribeSiteAsync(
string correlationId, Action<AlarmStateChanged> onAlarmEvent, Action<Exception> onError,
Action onCompleted, CancellationToken ct, Action? onConnected = null)
@@ -291,14 +300,18 @@ public class SiteAlarmStreamEndToEndTests : TestKit
return tcs.Task;
}
/// <inheritdoc />
public override void Unsubscribe(string correlationId) { }
}
private sealed class NoopSiteStreamClientFactory : SiteStreamGrpcClientFactory
{
private readonly NoopSiteStreamClient _client = new();
/// <summary>Initializes the factory with a null logger factory.</summary>
public NoopSiteStreamClientFactory() : base(NullLoggerFactory.Instance) { }
/// <inheritdoc />
public override SiteStreamGrpcClient GetOrCreate(string siteIdentifier, string grpcEndpoint) => _client;
/// <inheritdoc />
public override SiteStreamGrpcClient? TryGet(string siteIdentifier, string grpcEndpoint) => _client;
}
}