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
@@ -10,7 +10,7 @@ using ZB.MOM.WW.ScadaBridge.HealthMonitoring;
namespace ZB.MOM.WW.ScadaBridge.DataConnectionLayer.Tests;
/// <summary>
/// WP-34: Tests for DataConnectionManagerActor routing and lifecycle.
/// Tests for DataConnectionManagerActor routing and lifecycle.
/// </summary>
[Collection("DataConnectionManagerActor")]
public class DataConnectionManagerActorTests : TestKit
@@ -19,6 +19,7 @@ public class DataConnectionManagerActorTests : TestKit
private readonly DataConnectionOptions _options;
private readonly ISiteHealthCollector _mockHealthCollector;
/// <summary>Initializes the test class with mock collaborators and the actor-system configuration.</summary>
public DataConnectionManagerActorTests()
: base(@"akka.loglevel = DEBUG")
{
@@ -31,6 +32,7 @@ public class DataConnectionManagerActorTests : TestKit
};
}
/// <summary>Verifies that writing to an unknown connection returns an error.</summary>
[Fact]
public void WriteToUnknownConnection_ReturnsError()
{
@@ -45,6 +47,7 @@ public class DataConnectionManagerActorTests : TestKit
Assert.Contains("Unknown connection", response.ErrorMessage);
}
/// <summary>Verifies that subscribing to an unknown connection returns an error.</summary>
[Fact]
public void SubscribeToUnknownConnection_ReturnsError()
{
@@ -59,6 +62,7 @@ public class DataConnectionManagerActorTests : TestKit
Assert.Contains("Unknown connection", response.ErrorMessage);
}
/// <summary>Verifies that subscribing to alarms on an unknown connection returns an error.</summary>
[Fact]
public void SubscribeAlarmsToUnknownConnection_ReturnsError()
{
@@ -76,10 +80,11 @@ public class DataConnectionManagerActorTests : TestKit
Assert.Contains("Unknown connection", response.ErrorMessage);
}
/// <summary>Verifies that a connection actor crash preserves the subscription state.</summary>
[Fact]
public void DCL002_ConnectionActorCrash_PreservesSubscriptionState()
{
// Regression test for DataConnectionLayer-002. The supervisor used
// Regression test: the supervisor used
// Directive.Restart, which discards the connection actor's in-memory
// subscription registry — breaking the design doc's "transparent
// re-subscribe" guarantee (subscribers are never re-subscribed and sit at
@@ -133,6 +138,7 @@ public class DataConnectionManagerActorTests : TestKit
Assert.Equal(1, report.ResolvedTags);
}
/// <summary>Verifies that creating a connection uses the connection factory.</summary>
[Fact]
public void CreateConnection_UsesFactory()
{