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
@@ -13,10 +13,10 @@ using ZB.MOM.WW.ScadaBridge.SiteRuntime.Tests.TestSupport;
namespace ZB.MOM.WW.ScadaBridge.SiteRuntime.Tests.Actors;
/// <summary>
/// WP3.1 test group 4 — the stuck-script watchdog now REPLACES the thread a wedged script is
/// The stuck-script watchdog now REPLACES the thread a wedged script is
/// holding, not just names it.
///
/// <para>Before WP3.1 the watchdog was observability only: a script blocked in synchronous,
/// <para>Previously the watchdog was observability only: a script blocked in synchronous,
/// uninterruptible I/O never observes the cooperative cancellation the timeout requests, so
/// the pool simply lost that dedicated thread — permanently, and silently apart from one log
/// line. Eight such scripts left the site with no script execution at all. The watchdog now
@@ -29,6 +29,7 @@ public class StuckScriptWatchdogTests : TestKit, IDisposable
{
private readonly SharedScriptLibrary _sharedLibrary;
/// <summary>Initializes a new instance of <c>StuckScriptWatchdogTests</c>.</summary>
public StuckScriptWatchdogTests()
{
var compilationService = new ScriptCompilationService(
@@ -38,6 +39,7 @@ public class StuckScriptWatchdogTests : TestKit, IDisposable
WatchdogHooks.Gate = new SemaphoreSlim(0);
}
/// <inheritdoc />
void IDisposable.Dispose()
{
// Free any still-wedged worker before tearing down, so no test leaves a blocked thread.
@@ -81,6 +83,7 @@ public class StuckScriptWatchdogTests : TestKit, IDisposable
MaxScriptCallDepth = 10
};
/// <summary>Verifies that wedged script detaches its worker starts a replacement and drains when freed.</summary>
[Fact]
public void WedgedScript_DetachesItsWorker_StartsAReplacement_AndDrainsWhenFreed()
{
@@ -107,7 +110,7 @@ public class StuckScriptWatchdogTests : TestKit, IDisposable
TimeSpan.FromSeconds(5));
// The replacement worker is live: a fresh script runs even though the pool's only
// original thread is still blocked. Before WP3.1 this reply never came.
// original thread is still blocked. Previously this reply never came.
var healthy = BuildScriptActor("Healthy", CompileRaw("return 7;"), options, scheduler, null);
var caller = CreateTestProbe();
healthy.Tell(new ScriptCallRequest("Healthy", null, 0, "corr-healthy"), caller.Ref);
@@ -124,6 +127,7 @@ public class StuckScriptWatchdogTests : TestKit, IDisposable
Assert.Equal(1, scheduler.MaximumConcurrencyLevel);
}
/// <summary>Verifies that at the detach cap no further replacement is started and an error event is emitted.</summary>
[Fact]
public void AtTheDetachCap_NoFurtherReplacementIsStarted_AndAnErrorEventIsEmitted()
{
@@ -155,6 +159,8 @@ public class StuckScriptWatchdogTests : TestKit, IDisposable
WatchdogHooks.Gate.Release(2);
}
/// <summary>Verifies that detached thread count is surfaced on the site health report.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task DetachedThreadCount_IsSurfacedOnTheSiteHealthReport()
{