dohertj2/ScadaBridge
1
0
Fork 0
Code Issues 2 Pull Requests Actions Packages Projects Releases Wiki Activity

docs(tests): fix CommentChecker findings across tests/ — 13,392 → 0 (repo-wide scan clean)

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files
tests/ZB.MOM.WW.ScadaBridge.SiteRuntime.Tests/Actors/ScriptRecursionVsRunCapTests.cs
+6 -5
View File
@@ -26,7 +26,7 @@ namespace ZB.MOM.WW.ScadaBridge.SiteRuntime.Tests.Actors;
/// <c>ScriptRuntimeContext.CallScript</c> — unreachable.</para>
///
/// <para>The cap now applies to <c>callDepth == 0</c> launches only: trigger-driven runs and
/// depth-0 Ask calls, i.e. genuinely NEW work. Both halves are pinned below.</para>
/// depth 0 Ask calls, i.e. genuinely NEW work. Both halves are pinned below.</para>
/// </summary>
public class ScriptRecursionVsRunCapTests : TestKit, IDisposable
{
@@ -43,6 +43,7 @@ public class ScriptRecursionVsRunCapTests : TestKit, IDisposable
RecursionHooks.Reset();
}
/// <inheritdoc />
void IDisposable.Dispose()
{
RecursionHooks.Gate.Release(64);
@@ -142,8 +143,8 @@ public class ScriptRecursionVsRunCapTests : TestKit, IDisposable
}
/// <summary>
/// The exemption is scoped to nesting: with the cap already full of depth-0 runs, another
/// depth-0 request is still shed, while a nested (<c>callDepth &gt; 0</c>) request is
/// The exemption is scoped to nesting: with the cap already full of depth 0 runs, another
/// depth 0 request is still shed, while a nested (<c>callDepth &gt; 0</c>) request is
/// launched. This is the discriminating pin — a blanket "skip the cap" would fail the first
/// half, and the pre-fix behaviour fails the second.
/// </summary>
@@ -164,7 +165,7 @@ public class ScriptRecursionVsRunCapTests : TestKit, IDisposable
null, null, health, new SingleServiceProvider(siteLog), _scheduler, null)),
"cap-" + Guid.NewGuid().ToString("N"));
// Fill the cap with four depth-0 runs, all blocked in their bodies.
// Fill the cap with four depth 0 runs, all blocked in their bodies.
for (var i = 0; i < 4; i++)
actor.Tell(new ScriptCallRequest("Hot", null, 0, $"corr-{i}"), ActorRefs.NoSender);
@@ -195,7 +196,7 @@ public class ScriptRecursionVsRunCapTests : TestKit, IDisposable
// It is running, not answered: no shed reply reached the nested caller.
nested.ExpectNoMsg(TimeSpan.FromMilliseconds(500));
// Exactly the one depth-0 refusal was counted.
// Exactly the one depth 0 refusal was counted.
Assert.Equal(1, health.CollectReport("site-1").ScriptRunShedCount);
}