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
@@ -12,13 +12,14 @@ using ZB.MOM.WW.ScadaBridge.Communication.Actors;
namespace ZB.MOM.WW.ScadaBridge.Communication.Tests;
/// <summary>
/// T1B.3 seam tests: <see cref="CentralCommunicationActor"/> routing a <see cref="SiteEnvelope"/>
/// Seam tests: <see cref="CentralCommunicationActor"/> routing a <see cref="SiteEnvelope"/>
/// through an injected <see cref="ISiteCommandTransport"/> (transport-agnostic), proving the
/// envelope reaches the transport, the reply routes back to the waiting Ask, and the DB refresh
/// tick reconciles per-site transport resources.
/// </summary>
public class CentralCommunicationActorTransportTests : TestKit
{
/// <summary>Initializes the test kit with a quieter Akka log level.</summary>
public CentralCommunicationActorTransportTests() : base(@"akka.loglevel = WARNING") { }
private static Site GrpcSite(string id, string? grpcA = "http://a:8083", string? grpcB = "http://b:8083") =>
@@ -44,6 +45,7 @@ public class CentralCommunicationActorTransportTests : TestKit
return (actor, transport, repo);
}
/// <summary>Verifies that a site envelope is routed to the transport with the sender as the reply-to actor.</summary>
[Fact]
public void SiteEnvelope_IsRoutedToTheTransport_WithTheSenderAsReplyTo()
{
@@ -58,6 +60,8 @@ public class CentralCommunicationActorTransportTests : TestKit
probe.Ref));
}
/// <summary>Verifies that a reply from the transport is routed back to the waiting Ask.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task AskReply_FromTransport_RoutesBackToTheWaitingAsk()
{
@@ -80,6 +84,7 @@ public class CentralCommunicationActorTransportTests : TestKit
Assert.Equal(DeploymentStatus.Success, result.Status);
}
/// <summary>Verifies that a database refresh reconciles the transport with the loaded gRPC endpoints.</summary>
[Fact]
public void DbRefresh_ReconcilesTheTransport_WithTheLoadedGrpcEndpoints()
{
@@ -95,6 +100,7 @@ public class CentralCommunicationActorTransportTests : TestKit
TimeSpan.FromSeconds(3));
}
/// <summary>Verifies that a site added or removed across refreshes flows through to the transport.</summary>
[Fact]
public void SiteAddedAndRemoved_AcrossRefreshes_FlowsThroughToTheTransport()
{
@@ -117,6 +123,7 @@ public class CentralCommunicationActorTransportTests : TestKit
TimeSpan.FromSeconds(3));
}
/// <summary>Verifies that a site without gRPC addresses is absent from the gRPC contacts but still known.</summary>
[Fact]
public void SiteWithoutGrpcAddresses_IsAbsentFromGrpcContacts_ButStillKnown()
{