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
@@ -111,6 +111,8 @@ public class CachedCallTelemetryForwarderTests
UpdatedAtUtc: _now,
TerminalAtUtc: _now));
/// <summary>Verifies that forwarding a submit packet writes an audit event and records the enqueue.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ForwardAsync_Submit_WritesAuditEvent_AndRecordsEnqueue()
{
@@ -130,7 +132,7 @@ public class CachedCallTelemetryForwarderTests
// Tracking row: insert-if-not-exists with kind discriminator.
// Default CreateSut() does NOT supply an INodeIdentityProvider, so the
// forwarder passes null sourceNode to RecordEnqueueAsync (legacy / test
// host behaviour). The Task 14 stamping path is covered by the
// host behaviour). The stamping path is covered by the
// ForwardAsync_Submit_StampsSourceNode_FromNodeIdentityProvider test
// below.
await _tracking.Received(1).RecordEnqueueAsync(
@@ -147,6 +149,8 @@ public class CachedCallTelemetryForwarderTests
default, default!, default, default, default);
}
/// <summary>Verifies that forwarding an attempted packet writes an audit event and records the attempt.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ForwardAsync_Attempted_WritesAuditEvent_AndRecordsAttempt()
{
@@ -170,6 +174,8 @@ public class CachedCallTelemetryForwarderTests
default, default!, default, default, default);
}
/// <summary>Verifies that forwarding a resolve packet writes an audit event and records the terminal state.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ForwardAsync_Resolve_WritesAuditEvent_AndRecordsTerminal()
{
@@ -196,6 +202,8 @@ public class CachedCallTelemetryForwarderTests
// ── 2026-09-06: the audit row is enqueued, never awaited to commit ─────
// Design: docs/plans/2026-09-06-tracking-store-async-writes-design.md
/// <summary>Verifies that forwarding returns while the audit commit is still pending.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ForwardAsync_ReturnsWhileTheAuditCommitIsStillPending()
{
@@ -216,6 +224,8 @@ public class CachedCallTelemetryForwarderTests
_id, "Delivered", Arg.Any<string?>(), Arg.Any<int?>(), Arg.Any<CancellationToken>());
}
/// <summary>Verifies that a later audit commit fault is swallowed rather than surfaced to the caller.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ForwardAsync_AuditCommitFaultsLater_IsSwallowed()
{
@@ -234,6 +244,8 @@ public class CachedCallTelemetryForwarderTests
Arg.Any<string?>(), Arg.Any<string?>(), Arg.Any<string?>(), Arg.Any<CancellationToken>());
}
/// <summary>Verifies that a throwing audit writer is logged and the exception does not propagate.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ForwardAsync_WriterThrows_Logs_DoesNotPropagate()
{
@@ -257,6 +269,8 @@ public class CachedCallTelemetryForwarderTests
Arg.Any<CancellationToken>());
}
/// <summary>Verifies that a throwing tracking store is logged and the exception does not propagate.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ForwardAsync_TrackingStoreThrows_Logs_DoesNotPropagate()
{
@@ -279,6 +293,8 @@ public class CachedCallTelemetryForwarderTests
Arg.Any<AuditEvent>(), Arg.Any<CancellationToken>());
}
/// <summary>Verifies that forwarding a null packet throws.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ForwardAsync_NullPacket_Throws()
{
@@ -288,12 +304,14 @@ public class CachedCallTelemetryForwarderTests
() => sut.ForwardAsync(null!, CancellationToken.None));
}
// ── SourceNode-stamping (Task 14) ──
// ── SourceNode stamping ──
/// <summary>Verifies that a submit packet is stamped with the source node from the node identity provider.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ForwardAsync_Submit_StampsSourceNode_FromNodeIdentityProvider()
{
// SourceNode-stamping (Task 14): when an INodeIdentityProvider is
// SourceNode stamping: when an INodeIdentityProvider is
// wired the forwarder must stamp its NodeName onto the
// RecordEnqueueAsync sourceNode parameter so the tracking row
// captures the originating node (node-a/node-b).
@@ -315,6 +333,8 @@ public class CachedCallTelemetryForwarderTests
Arg.Any<CancellationToken>());
}
/// <summary>Verifies that a node identity with a null node name results in a null source node.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ForwardAsync_Submit_NodeIdentityNullNodeName_PassesNullSourceNode()
{