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
@@ -17,7 +17,7 @@ using System.Text.Json;
namespace ZB.MOM.WW.ScadaBridge.SiteRuntime.Tests.Actors;
/// <summary>
/// Audit Log #23 (M5.4 T4 — <c>ParentExecutionId</c> tag-cascade, alarm leg):
/// <c>ParentExecutionId</c> tag-cascade, alarm leg:
/// an alarm on-trigger script run must chain under the execution whose attribute
/// write fired the alarm, and must stay a tree ROOT when the firing value had no
/// audited origin.
@@ -52,6 +52,7 @@ public class AlarmCascadeParentExecutionTests : TestKit, IDisposable
private readonly TestLocalDb _localDb;
private readonly SiteStorageService _storage;
/// <summary>Initializes the test class with a compilation service, shared script library and a temporary LocalDb-backed site storage.</summary>
public AlarmCascadeParentExecutionTests()
{
_compilationService = new ScriptCompilationService(
@@ -64,6 +65,7 @@ public class AlarmCascadeParentExecutionTests : TestKit, IDisposable
_storage.InitializeAsync().GetAwaiter().GetResult();
}
/// <inheritdoc />
void IDisposable.Dispose()
{
// TestKit teardown first, so no in-flight actor can reach a disposed ILocalDb;
@@ -127,6 +129,8 @@ public class AlarmCascadeParentExecutionTests : TestKit, IDisposable
// Hop 3 — Alarm Actor → AlarmExecutionActor
// -------------------------------------------------------------------------
/// <summary>Verifies that a script-written value firing an alarm parents the on-trigger run only for observed (not inferred) writes.</summary>
/// <param name="inferred">Whether the writer was inferred rather than observed.</param>
[Theory]
[InlineData(false)]
[InlineData(true)]
@@ -143,6 +147,7 @@ public class AlarmCascadeParentExecutionTests : TestKit, IDisposable
Assert.Equal(inferred ? (Guid?)null : writerExecutionId, alarm.UnderlyingActor.LastOnTriggerParentExecutionId);
}
/// <summary>Verifies that a value originating from the data connection layer leaves the on-trigger run as a tree root.</summary>
[Fact]
public void DclOriginatedValue_FiringAlarm_LeavesOnTriggerRunAsATreeRoot()
{
@@ -159,6 +164,7 @@ public class AlarmCascadeParentExecutionTests : TestKit, IDisposable
Assert.Null(alarm.UnderlyingActor.LastOnTriggerParentExecutionId);
}
/// <summary>Verifies that a hi/lo alarm entering a band parents its on-trigger run to the writing execution.</summary>
[Fact]
public void HiLoAlarm_EnteringABand_ParentsOnTriggerRunToTheWritingExecution()
{
@@ -181,6 +187,7 @@ public class AlarmCascadeParentExecutionTests : TestKit, IDisposable
Assert.Equal(writerExecutionId, alarm.UnderlyingActor.LastOnTriggerParentExecutionId);
}
/// <summary>Verifies that an expression alarm carries the writer captured with the evaluated snapshot.</summary>
[Fact]
public void ExpressionAlarm_CarriesTheWriterCapturedWithTheEvaluatedSnapshot()
{
@@ -212,6 +219,8 @@ public class AlarmCascadeParentExecutionTests : TestKit, IDisposable
// Hop 1 — ScriptRuntimeContext.SetAttribute stamps the running execution
// -------------------------------------------------------------------------
/// <summary>Verifies that <c>SetAttribute</c> stamps the running execution id on the write command.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task SetAttribute_StampsTheRunningExecutionIdOnTheWriteCommand()
{
@@ -241,6 +250,7 @@ public class AlarmCascadeParentExecutionTests : TestKit, IDisposable
// Hop 2 — Instance Actor carries the writer onto the published change
// -------------------------------------------------------------------------
/// <summary>Verifies that a static write publishes the writing execution id on the resulting change.</summary>
[Fact]
public void InstanceActor_StaticWrite_PublishesTheWritingExecutionOnTheChange()
{
@@ -281,6 +291,7 @@ public class AlarmCascadeParentExecutionTests : TestKit, IDisposable
Assert.Equal(writerExecutionId, published.SourceExecutionId);
}
/// <summary>Verifies that a write with no audited origin publishes no execution id.</summary>
[Fact]
public void InstanceActor_WriteWithNoAuditedOrigin_PublishesNoExecutionId()
{