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
@@ -4,7 +4,7 @@ namespace ZB.MOM.WW.ScadaBridge.CentralUI.Tests.Services;
/// <summary>
/// Unit tests for <see cref="SingleFlightMemo{T}"/> — the primitive behind the process-level
/// KPI snapshot cache and the shared Alarm Summary fan-out (arch-review WP2.4). The two
/// KPI snapshot cache and the shared Alarm Summary fan-out. The two
/// properties the whole optimisation rests on are tested here: <b>single-flight</b> (N
/// concurrent circuits asking the same question produce ONE query) and <b>TTL</b> (a query
/// answered inside the freshness window is served from memory, and one outside it is not).
@@ -13,6 +13,8 @@ public class SingleFlightMemoTests
{
private static readonly DateTimeOffset T0 = new(2026, 8, 14, 9, 0, 0, TimeSpan.Zero);
/// <summary>Verifies that concurrent callers share a single in-flight query.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ConcurrentCallers_ShareOneFlight()
{
@@ -37,6 +39,8 @@ public class SingleFlightMemoTests
Assert.All(results, r => Assert.Equal(42, r));
}
/// <summary>Verifies that a call within the TTL serves the memoized value without querying again.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task WithinTtl_ServesTheMemoizedValue_WithoutRequerying()
{
@@ -54,6 +58,8 @@ public class SingleFlightMemoTests
Assert.Equal(1, memo.FlightCount);
}
/// <summary>Verifies that a call after the TTL expires queries exactly once more.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task AfterTtl_RequeriesOnce()
{
@@ -70,6 +76,8 @@ public class SingleFlightMemoTests
Assert.Equal(2, memo.FlightCount);
}
/// <summary>Verifies that a forced refresh bypasses a value that is still fresh.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ForceRefresh_BypassesAFreshValue()
{
@@ -84,6 +92,8 @@ public class SingleFlightMemoTests
Assert.Equal(2, memo.FlightCount);
}
/// <summary>Verifies that a forced refresh still joins a query that is already in flight.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ForceRefresh_StillJoinsAnInFlightRound()
{
@@ -107,6 +117,8 @@ public class SingleFlightMemoTests
Assert.Equal(1, invocations);
}
/// <summary>Verifies that a failure is not memoized and the next caller retries.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Failure_IsNotMemoized_AndTheNextCallerRetries()
{
@@ -129,6 +141,8 @@ public class SingleFlightMemoTests
Assert.Equal(2, memo.FlightCount);
}
/// <summary>Verifies that a TTL override applies to the flight it was supplied for.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task TtlOverride_AppliesToThatFlight()
{
@@ -146,6 +160,8 @@ public class SingleFlightMemoTests
Assert.Equal(1, memo.FlightCount);
}
/// <summary>Verifies that cancelling one caller does not cancel the shared flight.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task CallerCancellation_DoesNotCancelTheSharedFlight()
{