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
@@ -61,6 +61,8 @@ public class SiteCommunicationAuditClientTests : TestKit
UpdatedAtUtc = Timestamp.FromDateTime(new DateTime(2026, 5, 20, 10, 0, 0, DateTimeKind.Utc)),
};
/// <summary>Verifies that a full acknowledgement maps all accepted event ids onto the returned ack.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task IngestAuditEventsAsync_FullAck_MapsAllAcceptedIdsOntoAck()
{
@@ -88,6 +90,8 @@ public class SiteCommunicationAuditClientTests : TestKit
ack.AcceptedEventIds.ToHashSet());
}
/// <summary>Verifies that a partial acknowledgement lists only the accepted event ids on the returned ack.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task IngestAuditEventsAsync_PartialAck_OnlyAcceptedIdsAppearOnAck()
{
@@ -110,6 +114,8 @@ public class SiteCommunicationAuditClientTests : TestKit
ack.AcceptedEventIds.ToHashSet());
}
/// <summary>Verifies that an Ask timeout throws so the drain loop keeps its rows pending.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task IngestAuditEventsAsync_AskTimeout_Throws_SoDrainLoopKeepsRowsPending()
{
@@ -127,6 +133,8 @@ public class SiteCommunicationAuditClientTests : TestKit
await Assert.ThrowsAnyAsync<Exception>(() => task);
}
/// <summary>Verifies that a faulted reply causes the ingest call to throw.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task IngestAuditEventsAsync_FaultedReply_Throws()
{
@@ -136,13 +144,15 @@ public class SiteCommunicationAuditClientTests : TestKit
var task = sut.IngestAuditEventsAsync(BatchOf(new[] { NewEvent() }), CancellationToken.None);
probe.ExpectMsg<IngestAuditEventsCommand>(TimeSpan.FromSeconds(3));
// A Status.Failure from central (Task 1: central does not swallow an
// A Status.Failure from central (central does not swallow an
// ingest fault into an empty ack) must propagate as a thrown exception.
probe.Reply(new Status.Failure(new InvalidOperationException("central ingest faulted")));
await Assert.ThrowsAnyAsync<Exception>(() => task);
}
/// <summary>Verifies that cached telemetry is routed as a command and the reply is mapped back.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task IngestCachedTelemetryAsync_RoutesCommand_AndMapsReply()
{
@@ -178,6 +188,8 @@ public class SiteCommunicationAuditClientTests : TestKit
ack.AcceptedEventIds.ToHashSet());
}
/// <summary>Verifies that an Ask timeout during cached telemetry ingestion throws.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task IngestCachedTelemetryAsync_AskTimeout_Throws()
{