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
@@ -18,7 +18,7 @@ using Microsoft.Extensions.DependencyInjection;
namespace ZB.MOM.WW.ScadaBridge.Communication.Tests.Grpc;
/// <summary>
/// Audit Log (#23) site→central ingest routing on <see cref="CentralControlGrpcService"/>.
/// Audit Log site→central ingest routing on <see cref="CentralControlGrpcService"/>.
/// <para>
/// The service Asks the <c>audit-log-ingest</c> singleton proxy DIRECTLY. It used to relay
/// through <see cref="CentralCommunicationActor"/>, which re-Asked the same proxy with the same
@@ -40,6 +40,8 @@ public class CentralControlGrpcServiceAuditIngestTests : TestKit
NullLogger<CentralControlGrpcService>.Instance,
Options.Create(new CommunicationOptions()));
/// <summary>Verifies that ingesting audit events asks the ingest proxy directly and never goes through the communication actor.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task IngestAuditEvents_AsksTheIngestProxy_AndNeverTheCommunicationActor()
{
@@ -66,6 +68,8 @@ public class CentralControlGrpcServiceAuditIngestTests : TestKit
control.ExpectNoMsg(TimeSpan.FromMilliseconds(200));
}
/// <summary>Verifies that ingesting cached telemetry asks the ingest proxy directly and never goes through the communication actor.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task IngestCachedTelemetry_AsksTheIngestProxy_AndNeverTheCommunicationActor()
{
@@ -94,6 +98,8 @@ public class CentralControlGrpcServiceAuditIngestTests : TestKit
control.ExpectNoMsg(TimeSpan.FromMilliseconds(200));
}
/// <summary>Verifies that ingesting audit events before the ingest proxy is wired returns an empty acknowledgement.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task IngestAuditEvents_BeforeTheIngestProxyIsWired_ReturnsAnEmptyAck()
{
@@ -111,6 +117,8 @@ public class CentralControlGrpcServiceAuditIngestTests : TestKit
Assert.Empty(ack.AcceptedEventIds);
}
/// <summary>Verifies that ingesting cached telemetry before the ingest proxy is wired returns an empty acknowledgement.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task IngestCachedTelemetry_BeforeTheIngestProxyIsWired_ReturnsAnEmptyAck()
{
@@ -129,6 +137,7 @@ public class CentralControlGrpcServiceAuditIngestTests : TestKit
Assert.Empty(ack.AcceptedEventIds);
}
/// <summary>Verifies that setting the audit ingest actor is independent of marking the service ready.</summary>
[Fact]
public void SetAuditIngestActor_IsIndependentOfSetReady()
{
@@ -141,6 +150,7 @@ public class CentralControlGrpcServiceAuditIngestTests : TestKit
Assert.False(service.IsReady);
}
/// <summary>Verifies that the central communication actor no longer relays ingest commands.</summary>
[Fact]
public void CentralCommunicationActor_NoLongerRelaysIngestCommands()
{