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
@@ -14,7 +14,7 @@ using ZB.MOM.WW.ScadaBridge.SiteRuntime.Tests.TestSupport;
namespace ZB.MOM.WW.ScadaBridge.SiteRuntime.Tests.Actors;
/// <summary>
/// arch-review 2026-08-19 P1-3 — alarm on-trigger runs used to bypass the stuck-script
/// Alarm on-trigger runs used to bypass the stuck-script
/// watchdog, the script-error health counter, and <see cref="ScriptRunSummaryRecorder"/>
/// entirely: <c>ScriptRunLauncher.RunAlarmScriptAsync</c> carried none of the machinery its
/// sibling <c>RunScriptAsync</c> (the instance-script path) carries, on the SAME bounded
@@ -32,6 +32,7 @@ public class AlarmScriptWatchdogTests : TestKit, IDisposable
{
private readonly SharedScriptLibrary _sharedLibrary;
/// <summary>Initializes the test class with a shared script library and a closed watchdog gate.</summary>
public AlarmScriptWatchdogTests()
{
var compilationService = new ScriptCompilationService(
@@ -41,6 +42,7 @@ public class AlarmScriptWatchdogTests : TestKit, IDisposable
AlarmWatchdogHooks.Gate = new SemaphoreSlim(0);
}
/// <inheritdoc />
void IDisposable.Dispose()
{
// Free any still-wedged worker before tearing down, so no test leaves a blocked thread.
@@ -99,6 +101,7 @@ public class AlarmScriptWatchdogTests : TestKit, IDisposable
MaxScriptCallDepth = 10
};
/// <summary>Verifies that a wedged alarm script has its worker detached, a replacement started, and the queue drains once it is freed.</summary>
[Fact]
public void WedgedAlarmScript_DetachesItsWorker_StartsAReplacement_AndDrainsWhenFreed()
{
@@ -142,6 +145,7 @@ public class AlarmScriptWatchdogTests : TestKit, IDisposable
Assert.Equal(1, scheduler.MaximumConcurrencyLevel);
}
/// <summary>Verifies that an alarm run that timed out at dequeue increments the health collector's script error count.</summary>
[Fact]
public void AlarmRunTimedOutAtDequeue_IncrementsHealthCollectorScriptErrorCount()
{
@@ -196,6 +200,8 @@ public class AlarmScriptWatchdogTests : TestKit, IDisposable
TimeSpan.FromSeconds(20), TimeSpan.FromMilliseconds(25));
}
/// <summary>Verifies that an alarm run completion is recorded by the script run summary recorder.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task AlarmRunCompletion_IsRecordedByScriptRunSummaryRecorder()
{