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
@@ -3,11 +3,12 @@ using System.Reflection;
namespace ZB.MOM.WW.ScadaBridge.Host.Tests;
/// <summary>
/// WP-16: Tests for CoordinatedShutdown configuration.
/// Tests for CoordinatedShutdown configuration.
/// Verifies no Environment.Exit calls exist in source and HOCON config is correct.
/// </summary>
public class CoordinatedShutdownTests
{
/// <summary>Verifies that host source does not contain environment exit.</summary>
[Fact]
public void HostSource_DoesNotContainEnvironmentExit()
{
@@ -48,6 +49,7 @@ public class CoordinatedShutdownTests
}
}
/// <summary>Verifies that akka hosted service hocon config includes coordinated shutdown settings.</summary>
[Fact]
public void AkkaHostedService_HoconConfig_IncludesCoordinatedShutdownSettings()
{
@@ -65,6 +67,7 @@ public class CoordinatedShutdownTests
Assert.Contains("run-coordinated-shutdown-when-down = on", content);
}
/// <summary>Verifies that all central singletons register through registrar with drain.</summary>
[Fact]
public void AllCentralSingletons_RegisterThroughRegistrarWithDrain()
{
@@ -91,6 +94,7 @@ public class CoordinatedShutdownTests
Assert.Equal(0, CountOccurrences(content, "ClusterSingletonManager.Props("));
}
/// <summary>Verifies that site singletons register through registrar with drain.</summary>
[Fact]
public void SiteSingletons_RegisterThroughRegistrarWithDrain()
{
@@ -98,7 +102,7 @@ public class CoordinatedShutdownTests
Assert.NotNull(hostProjectDir);
var content = File.ReadAllText(Path.Combine(hostProjectDir!, "Actors", "AkkaHostedService.cs"));
// Round-2 N5: the two role-scoped SITE singletons previously stayed
// The two role-scoped SITE singletons previously stayed
// hand-rolled (bare PoisonPill, no PhaseClusterLeave drain). They now
// go through SingletonRegistrar.Start(..., role: siteRole), which
// always adds the GracefulStop drain — in-flight SQLite writes