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
@@ -8,11 +8,12 @@ using ZB.MOM.WW.ScadaBridge.TestSupport;
namespace ZB.MOM.WW.ScadaBridge.IntegrationTests;
/// <summary>
/// WP-7 (Phase 8): Recovery drill test scaffolds.
/// Recovery drill test scaffolds.
/// Mid-deploy failover, communication drops, and site restart with persisted configs.
/// </summary>
public class RecoveryDrillTests
{
/// <summary>Verifies that a site state query after a mid-deploy failover is followed by a successful redeploy.</summary>
[Trait("Category", "Integration")]
[Fact]
public void MidDeployFailover_SiteStateQuery_ThenRedeploy()
@@ -53,6 +54,8 @@ public class RecoveryDrillTests
Assert.Equal(DeploymentStatus.Success, completedStatus.Status);
}
/// <summary>Verifies that a communication drop during artifact deployment buffers the work for retry.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Trait("Category", "Integration")]
[Fact]
public async Task CommunicationDrop_DuringArtifactDeployment_BuffersForRetry()
@@ -113,6 +116,8 @@ public class RecoveryDrillTests
}
}
/// <summary>Verifies that a site restart with persisted configurations rebuilds its state from SQLite.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Trait("Category", "Integration")]
[Fact]
public async Task SiteRestart_WithPersistedConfigs_RebuildFromSQLite()
@@ -172,6 +177,7 @@ public class RecoveryDrillTests
}
}
/// <summary>Verifies that redeploying the same revision hash is a no-op.</summary>
[Fact]
public void DeploymentIdempotency_SameRevisionHash_NoOp()
{
@@ -191,6 +197,7 @@ public class RecoveryDrillTests
Assert.Equal(cmd1.InstanceUniqueName, cmd2.InstanceUniqueName);
}
/// <summary>Verifies that the flattened configuration snapshot contains the revision hash.</summary>
[Fact]
public void FlattenedConfigSnapshot_ContainsRevisionHash()
{