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
@@ -15,7 +15,7 @@ using ZB.MOM.WW.ScadaBridge.SiteRuntime.Scripts;
namespace ZB.MOM.WW.ScadaBridge.SiteRuntime.Tests.Scripts;
/// <summary>
/// Audit Log #23 (M5.4 — ParentExecutionId tag-cascade): nested
/// ParentExecutionId tag-cascade: nested
/// <c>CallScript</c> / <c>CallShared</c> invocations and alarm on-trigger runs
/// must form a true execution tree, where each spawned run records its
/// immediate spawner's <c>ExecutionId</c> as its <c>ParentExecutionId</c>.
@@ -52,8 +52,10 @@ public class ParentExecutionTreeTests : TestKit
/// </summary>
private sealed class CapturingAuditWriter : IAuditWriter
{
/// <summary>Gets the audit rows captured so far.</summary>
public List<AuditRowProjection.AuditRowValues> Events { get; } = new();
/// <inheritdoc />
public Task WriteAsync(AuditEvent evt, CancellationToken ct = default)
{
Events.Add(evt.AsRow());
@@ -101,6 +103,8 @@ public class ParentExecutionTreeTests : TestKit
// Nested CallScript (actor-routed) — A → CallScript(B)
// -------------------------------------------------------------------------
/// <summary>Verifies that <c>CallScript</c> stamps the calling run's own execution id as the child's parent.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task CallScript_StampsCallingRunsOwnExecutionId_AsChildParent()
{
@@ -122,6 +126,8 @@ public class ParentExecutionTreeTests : TestKit
await call;
}
/// <summary>Verifies that <c>CallScript</c> from a routed run uses the run's own execution id rather than an inherited parent.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task CallScript_FromRoutedRun_UsesOwnExecutionId_NotInheritedParent()
{
@@ -151,6 +157,8 @@ public class ParentExecutionTreeTests : TestKit
// Nested CallShared (inline) — B → CallShared(C)
// -------------------------------------------------------------------------
/// <summary>Verifies that a <c>CallShared</c> child run has the caller's execution id as parent and a fresh execution id of its own.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task CallShared_ChildRun_ParentIsCallersExecutionId_FreshOwnExecutionId()
{
@@ -186,6 +194,8 @@ public class ParentExecutionTreeTests : TestKit
Assert.NotEqual(bExecutionId, evt.ExecutionId!.Value);
}
/// <summary>Verifies that a <c>CallShared</c> from a routed run has the caller as parent rather than an inherited grandparent.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task CallShared_FromRoutedRun_ChildParentIsCaller_NotInheritedGrandparent()
{
@@ -222,6 +232,7 @@ public class ParentExecutionTreeTests : TestKit
// Alarm on-trigger plumbing
// -------------------------------------------------------------------------
/// <summary>Verifies that creating a child context for a shared script makes the caller's execution the parent and mints a fresh id.</summary>
[Fact]
public void CreateChildContextForSharedScript_ParentIsCallerExecution_FreshOwnId()
{
@@ -237,6 +248,7 @@ public class ParentExecutionTreeTests : TestKit
Assert.NotEqual(bExecutionId, child.ExecutionId);
}
/// <summary>Verifies that a nested <c>CallScript</c> from an alarm on-trigger script carries the alarm run's own execution id as parent.</summary>
[Fact]
public void AlarmOnTrigger_NestedCallScript_CarriesAlarmRunsOwnExecutionId_AsParent()
{