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
@@ -32,6 +32,8 @@ public class CentralControlGrpcServiceTests : TestKit
NullLogger<CentralControlGrpcService>.Instance,
Options.Create(options ?? new CommunicationOptions()));
/// <summary>Verifies that a unary call made before the service is set ready fails as unavailable.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task BeforeSetReady_AUnaryCall_IsUnavailable()
{
@@ -45,6 +47,8 @@ public class CentralControlGrpcServiceTests : TestKit
Assert.Equal(StatusCode.Unavailable, ex.StatusCode);
}
/// <summary>Verifies that a non-empty ingest batch sent before the service is set ready fails as unavailable.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task BeforeSetReady_ANonEmptyIngestBatch_IsUnavailable()
{
@@ -58,6 +62,8 @@ public class CentralControlGrpcServiceTests : TestKit
Assert.Equal(StatusCode.Unavailable, ex.StatusCode);
}
/// <summary>Verifies that a unary call made after the service is set ready reaches the actor.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task AfterSetReady_AUnaryCall_ReachesTheActor()
{
@@ -70,6 +76,8 @@ public class CentralControlGrpcServiceTests : TestKit
Assert.True(ack.Accepted);
}
/// <summary>Verifies that a heartbeat before the service is set ready succeeds and is dropped.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Heartbeat_BeforeSetReady_SucceedsAndIsDropped()
{
@@ -82,6 +90,8 @@ public class CentralControlGrpcServiceTests : TestKit
Assert.NotNull(reply);
}
/// <summary>Verifies that a heartbeat after the service is set ready is told to the actor and never asked.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Heartbeat_AfterSetReady_TellsTheActor_AndNeverAsks()
{
@@ -96,6 +106,8 @@ public class CentralControlGrpcServiceTests : TestKit
Assert.NotNull(reply);
}
/// <summary>Verifies that a call to an actor that never replies fails with deadline exceeded rather than unavailable.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task WhenTheActorNeverReplies_TheCall_IsDeadlineExceeded_NotUnavailable()
{
@@ -114,6 +126,8 @@ public class CentralControlGrpcServiceTests : TestKit
Assert.Equal(StatusCode.DeadlineExceeded, ex.StatusCode);
}
/// <summary>Verifies that an empty ingest batch short-circuits even before the service is set ready.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task EmptyIngestBatch_ShortCircuits_EvenBeforeSetReady()
{
@@ -125,6 +139,7 @@ public class CentralControlGrpcServiceTests : TestKit
Assert.Empty(ack.AcceptedEventIds);
}
/// <summary>Verifies that the audit ingest timeout is the single shared constant.</summary>
[Fact]
public void TheAuditIngestTimeout_IsTheOneSharedConstant()
{
@@ -166,6 +181,7 @@ public class CentralControlGrpcServiceTests : TestKit
private sealed class StubActor : ReceiveActor
{
/// <summary>Creates the actor, which acknowledges every notification submit as accepted.</summary>
public StubActor()
{
Receive<NotificationSubmit>(msg =>
@@ -176,6 +192,7 @@ public class CentralControlGrpcServiceTests : TestKit
/// <summary>Swallows every message and never replies, so an Ask against it times out.</summary>
private sealed class NeverRepliesActor : ReceiveActor
{
/// <summary>Creates the actor, which ignores every message.</summary>
public NeverRepliesActor() => ReceiveAny(_ => { });
}
}