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
@@ -9,12 +9,14 @@ using ZB.MOM.WW.ScadaBridge.TestSupport;
namespace ZB.MOM.WW.ScadaBridge.IntegrationTests;
/// <summary>
/// WP-2 (Phase 8): Full-system failover testing — Site.
/// Full-system failover testing — Site.
/// Verifies S&amp;F buffer takeover, DCL reconnection structure, alarm re-evaluation,
/// and script trigger resumption after site failover.
/// </summary>
public class SiteFailoverTests
{
/// <summary>Verifies that buffered store-and-forward messages are retained across a restart.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Trait("Category", "Integration")]
[Fact]
public async Task StoreAndForward_BufferSurvivesRestart_MessagesRetained()
@@ -72,6 +74,8 @@ public class SiteFailoverTests
}
}
/// <summary>Verifies that parked store-and-forward messages survive a failover.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Trait("Category", "Integration")]
[Fact]
public async Task StoreAndForward_ParkedMessages_SurviveFailover()
@@ -123,6 +127,7 @@ public class SiteFailoverTests
}
}
/// <summary>Verifies that an incoming value triggers alarm re-evaluation and a new alarm state.</summary>
[Fact]
public void AlarmReEvaluation_IncomingValue_TriggersNewState()
{
@@ -151,6 +156,7 @@ public class SiteFailoverTests
Assert.True(clearedEvent.Timestamp > alarmEvent.Timestamp);
}
/// <summary>Verifies that a value change triggers its script after failover.</summary>
[Fact]
public void ScriptTriggerResumption_ValueChangeTriggersScript()
{
@@ -171,6 +177,8 @@ public class SiteFailoverTests
Assert.Equal("Good", valueChange.Quality);
}
/// <summary>Verifies that the store-and-forward buffer depth is reported after a failover.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Trait("Category", "Integration")]
[Fact]
public async Task StoreAndForward_BufferDepth_ReportedAfterFailover()