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
@@ -36,6 +36,7 @@ public class WireSerializationPinTests : TestKit
return (T)serialization.Deserialize(bytes, serializer.Identifier, message!.GetType());
}
/// <summary>Verifies that a heartbeat message round-trips on the wire.</summary>
[Fact]
public void HeartbeatMessage_RoundTripsOnTheWire()
{
@@ -44,6 +45,7 @@ public class WireSerializationPinTests : TestKit
Assert.Equal(original, back); // all-scalar record → structural equality holds
}
/// <summary>Verifies that a notification submit message round-trips on the wire.</summary>
[Fact]
public void NotificationSubmit_RoundTripsOnTheWire()
{
@@ -77,6 +79,7 @@ public class WireSerializationPinTests : TestKit
Assert.Equal(original.SourceNode, back.SourceNode);
}
/// <summary>Verifies that an ingest-audit-events command round-trips on the wire.</summary>
[Fact]
public void IngestAuditEventsCommand_RoundTripsOnTheWire()
{
@@ -130,6 +133,7 @@ public class WireSerializationPinTests : TestKit
Assert.Equal(o.ErrorMessage, rt.ErrorMessage);
}
/// <summary>Verifies that a site health report round-trips on the wire.</summary>
[Fact]
public void SiteHealthReport_RoundTripsOnTheWire()
{
@@ -181,6 +185,9 @@ public class WireSerializationPinTests : TestKit
// central↔site communication. If one of these assertions fails, you are making
// a wire-breaking change — coordinate a full-fleet upgrade or add an explicit
// serialization binding before renaming/moving the type.
/// <summary>Verifies that each cross-cluster contract type keeps its pinned full name.</summary>
/// <param name="type">The contract type under test.</param>
/// <param name="expectedFullName">The full type name that must stay stable on the wire.</param>
[Theory]
[InlineData(typeof(HeartbeatMessage), "ZB.MOM.WW.ScadaBridge.Commons.Messages.Health.HeartbeatMessage")]
[InlineData(typeof(NotificationSubmit), "ZB.MOM.WW.ScadaBridge.Commons.Messages.Notification.NotificationSubmit")]