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
@@ -34,6 +34,7 @@ public class SiteStreamPullTraceEventsTests : TestKit
AuditChannel.ScriptTrace, AuditKind.ScriptRun, AuditStatus.Delivered,
occurredAtUtc: new DateTime(2026, 9, 5, 12, 0, 0, DateTimeKind.Utc), executionId: executionId, sourceSiteId: "site-a");
/// <summary>Verifies that the pull-trace-events RPC sits under the preshared-key-gated service prefix.</summary>
[Fact]
public void PullTraceEvents_IsUnderThePskGatedServicePrefix()
{
@@ -42,6 +43,8 @@ public class SiteStreamPullTraceEventsTests : TestKit
Assert.Equal("sitestream.SiteStreamService", SiteStreamService.Descriptor.FullName);
}
/// <summary>Verifies that the RPC returns an empty result when no queue is wired.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task NoQueueWired_ReturnsEmpty()
{
@@ -52,6 +55,8 @@ public class SiteStreamPullTraceEventsTests : TestKit
Assert.Empty(response.Events);
}
/// <summary>Verifies that the RPC reads events by id, projects them to DTOs and never changes their state.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ReadsByIds_ProjectsDtos_AndNeverFlipsState()
{
@@ -83,6 +88,10 @@ public class SiteStreamPullTraceEventsTests : TestKit
await queue.DidNotReceiveWithAnyArgs().MarkReconciledAsync(default!, default);
}
/// <summary>Verifies that invalid arguments are rejected.</summary>
/// <param name="maxEvents">The requested maximum number of events.</param>
/// <param name="idCount">The number of ids supplied in the request.</param>
/// <returns>A task that represents the asynchronous operation.</returns>
[Theory]
[InlineData(0, 1)]
[InlineData(2001, 1)]
@@ -99,6 +108,8 @@ public class SiteStreamPullTraceEventsTests : TestKit
Assert.Equal(StatusCode.InvalidArgument, ex.StatusCode);
}
/// <summary>Verifies that an id that is not a GUID is rejected.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task NonGuidId_IsRejected()
{
@@ -109,6 +120,8 @@ public class SiteStreamPullTraceEventsTests : TestKit
Assert.Equal(StatusCode.InvalidArgument, ex.StatusCode);
}
/// <summary>Verifies that a queue fault collapses to an empty result.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task QueueFault_CollapsesToEmpty()
{