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
@@ -16,7 +16,7 @@ using ZB.MOM.WW.ScadaBridge.TestSupport;
namespace ZB.MOM.WW.ScadaBridge.SiteRuntime.Tests.Actors;
/// <summary>
/// Regression tests for arch-review 2026-08-19 P1-2 — <b>"static overrides are reset on
/// Regression tests for arch-review 2026-08-19 — <b>"static overrides are reset on
/// redeployment" was racy in both directions</b>.
///
/// <para>
@@ -45,6 +45,7 @@ public class RedeployStaticOverrideResetTests : TestKit, IDisposable
private readonly SharedScriptLibrary _sharedScriptLibrary;
private readonly TestLocalDb _localDb;
/// <summary>Creates a temporary LocalDb-backed site storage, compilation service and shared script library for each test.</summary>
public RedeployStaticOverrideResetTests()
{
_localDb = TestLocalDb.CreateTemp("redeploy-override-test");
@@ -57,6 +58,7 @@ public class RedeployStaticOverrideResetTests : TestKit, IDisposable
_compilationService, NullLogger<SharedScriptLibrary>.Instance);
}
/// <inheritdoc />
void IDisposable.Dispose()
{
// Shut the actors down BEFORE the ILocalDb they write through is disposed.
@@ -135,6 +137,7 @@ public class RedeployStaticOverrideResetTests : TestKit, IDisposable
/// <see cref="RedeployResetGate_HoldsTheOverrideLoadUntilTheResetHasCommitted"/>.
/// </para>
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Redeploy_DoesNotApplyPreRedeployOverridesToTheNewActor()
{
@@ -179,6 +182,7 @@ public class RedeployStaticOverrideResetTests : TestKit, IDisposable
/// after it is released proves the read is ordered behind the reset rather than merely
/// losing a race to it.
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task RedeployResetGate_HoldsTheOverrideLoadUntilTheResetHasCommitted()
{
@@ -223,6 +227,8 @@ public class RedeployStaticOverrideResetTests : TestKit, IDisposable
// Leg 2: final persistence is acknowledged independently of termination.
// The manager waits for both before resetting state; a standalone actor still
// persists its final dirty batch asynchronously after stopping.
/// <summary>Verifies that stopping an Instance Actor completes its final override flush asynchronously.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task InstanceActorStop_CompletesFinalOverrideFlushAsynchronously()
{
@@ -264,6 +270,7 @@ public class RedeployStaticOverrideResetTests : TestKit, IDisposable
/// the clear and durably resurrect the predecessor's values — invisible until the next
/// restart loaded them.
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Redeploy_LateFlushFromTheStoppedActor_CannotResurrectClearedOverrides()
{
@@ -297,6 +304,7 @@ public class RedeployStaticOverrideResetTests : TestKit, IDisposable
/// up on its config defaults, and an override written after it must persist normally. Pins
/// that the reset gate did not turn the ordinary deploy path into a no-op.
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task FirstDeploy_StillLoadsAndPersistsStaticOverridesNormally()
{
@@ -318,6 +326,7 @@ public class RedeployStaticOverrideResetTests : TestKit, IDisposable
"corr-get", instanceName, "Temperature", DateTimeOffset.UtcNow));
Assert.Equal("123.4", ExpectMsg<GetAttributeResponse>(TimeSpan.FromSeconds(5)).Value?.ToString());
}
/// <summary>Verifies that stopping an actor does not block the dispatcher while the SQLite writer is busy.</summary>
[Fact]
public void SR5_StopDoesNotBlockDispatcherWhileSqliteWriterIsBusy()
{
@@ -337,6 +346,8 @@ public class RedeployStaticOverrideResetTests : TestKit, IDisposable
ExpectTerminated(actor, TimeSpan.FromMilliseconds(500));
}
/// <summary>Verifies that a redeploy waits for the flush acknowledgement after the predecessor terminates.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task SR5_RedeployWaitsForFlushAcknowledgementAfterTermination()
{
@@ -360,6 +371,9 @@ public class RedeployStaticOverrideResetTests : TestKit, IDisposable
Assert.Empty(await _storage.GetStaticOverridesAsync(name));
}
/// <summary>Verifies that cancelling a queued redeploy stops its predecessor.</summary>
/// <param name="delete">Whether the queued operations are deletes rather than redeploys.</param>
/// <returns>A task that represents the asynchronous operation.</returns>
[Theory]
[InlineData(false)]
[InlineData(true)]
@@ -392,6 +406,8 @@ public class RedeployStaticOverrideResetTests : TestKit, IDisposable
transaction.Commit();
}
/// <summary>Verifies that a delete waits for the final flush and rejects an overlapping start.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task SR5_DeleteWaitsForFinalFlushAndRejectsAnOverlappingStart()
{