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
@@ -11,7 +11,7 @@ using ZB.MOM.WW.ScadaBridge.Host.Health;
namespace ZB.MOM.WW.ScadaBridge.Host.Tests;
/// <summary>
/// WP-12: Tests for the three-tier health endpoints after adopting the shared
/// Tests for the three-tier health endpoints after adopting the shared
/// ZB.MOM.WW.Health probes. Verifies that /health/ready, /health/active and the new
/// /healthz tier are mapped, and that the readiness/active tier split is now carried by
/// the canonical <see cref="ZbHealthTags"/> (Ready for database + akka-cluster, Active for
@@ -23,12 +23,14 @@ public class HealthCheckTests : IDisposable
{
private readonly List<IDisposable> _disposables = new();
/// <summary>Initializes the test class and registers the central database test environment.</summary>
public HealthCheckTests()
{
// Host-003: connection strings are externalised; supply them via env vars.
// Connection strings are externalised; supply them via env vars.
_disposables.Add(new CentralDbTestEnvironment());
}
/// <summary>Releases the resources held by the test fixture.</summary>
public void Dispose()
{
foreach (var d in _disposables)
@@ -64,6 +66,8 @@ public class HealthCheckTests : IDisposable
private static IEnumerable<HealthCheckRegistration> Registrations(WebApplicationFactory<Program> factory) =>
factory.Services.GetRequiredService<IOptions<HealthCheckServiceOptions>>().Value.Registrations;
/// <summary>Verifies that the /health/ready endpoint is mapped.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task HealthReady_Endpoint_IsMapped()
{
@@ -92,6 +96,8 @@ public class HealthCheckTests : IDisposable
}
}
/// <summary>Verifies that the /health/active endpoint is mapped.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task HealthActive_Endpoint_IsMapped()
{
@@ -117,6 +123,8 @@ public class HealthCheckTests : IDisposable
}
}
/// <summary>Verifies that the /healthz liveness endpoint is mapped and returns 200.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Healthz_LivenessEndpoint_IsMappedAndReturns200()
{
@@ -140,10 +148,11 @@ public class HealthCheckTests : IDisposable
}
}
/// <summary>Verifies that the Ready tier carries the database and akka-cluster checks.</summary>
[Fact]
public void ReadyTier_Carries_Database_And_AkkaCluster()
{
// Host-001 regression guard: readiness reflects cluster membership + DB connectivity
// Regression guard: readiness reflects cluster membership + DB connectivity
// only (REQ-HOST-4a), NOT cluster leadership. The split is now carried by the Ready tag
// rather than a check-name predicate: database + akka-cluster are Ready-tagged, and the
// leader-only active-node check is NOT — so a fully operational standby central node
@@ -162,7 +171,7 @@ public class HealthCheckTests : IDisposable
Assert.Contains(ZbHealthTags.Ready, registrations["database"].Tags);
Assert.Contains(ZbHealthTags.Ready, registrations["akka-cluster"].Tags);
// M2.14 (#28): readiness ALSO reflects "required cluster singletons running"
// Readiness ALSO reflects "required cluster singletons running"
// (REQ-HOST-4a). The Central-only required-singletons check is Ready-tagged so
// it gates /health/ready alongside database + akka-cluster, but is leadership-
// agnostic (it does NOT carry the Active tag), so a ready standby stays ready.
@@ -180,6 +189,7 @@ public class HealthCheckTests : IDisposable
}
}
/// <summary>Verifies that the Active tier carries the active-node and database checks.</summary>
[Fact]
public void ActiveTier_Carries_ActiveNode_And_Database()
{
@@ -207,6 +217,7 @@ public class HealthCheckTests : IDisposable
}
}
/// <summary>Verifies that the active-node check is the shared oldest-Up-member check.</summary>
[Fact]
public void ActiveNodeCheck_IsTheSharedOldestUpMemberCheck()
{
@@ -233,6 +244,7 @@ public class HealthCheckTests : IDisposable
}
}
/// <summary>Verifies that the database check also gates the Active tier.</summary>
[Fact]
public void DatabaseCheck_AlsoGatesActive()
{