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.
2026-10-07 15:05:49 -04:00
parent 0ffd4bdbea
commit 513fa1aa16
998 changed files with 17896 additions and 2395 deletions
@@ -5,12 +5,13 @@ using ZB.MOM.WW.ScadaBridge.Communication.Grpc;
 namespace ZB.MOM.WW.ScadaBridge.Communication.Tests.Protos;

 /// <summary>
-/// Wire-format round-trip tests for the Audit Log (#23) telemetry proto messages
+/// Wire-format round-trip tests for the Audit Log telemetry proto messages
 /// (<see cref="AuditEventDto"/>, <see cref="AuditEventBatch"/>, <see cref="IngestAck"/>).
 /// Locks the additive contract the site → central audit pipeline depends on.
 /// </summary>
 public class AuditEventProtoTests
 {
+    /// <summary>Verifies that an <c>AuditEventDto</c> round trip preserves all fields.</summary>
    [Fact]
    public void AuditEventDto_RoundTrip_PreservesAllFields()
    {
@@ -66,6 +67,7 @@ public class AuditEventProtoTests
        Assert.Equal(original.Extra, deserialized.Extra);
    }

+    /// <summary>Verifies that an unset nullable integer is absent from the wire encoding.</summary>
    [Fact]
    public void AuditEventDto_NullableInt_AbsentByDefault_NotIncludedInWire()
    {
@@ -90,6 +92,7 @@ public class AuditEventProtoTests
        Assert.Null(deserialized.DurationMs);
    }

+    /// <summary>Verifies that an empty <c>AuditEventBatch</c> round-trips to an empty event list.</summary>
    [Fact]
    public void AuditEventBatch_Empty_RoundTrip_Yields_EmptyEvents()
    {
@@ -102,6 +105,7 @@ public class AuditEventProtoTests
        Assert.Empty(deserialized.Events);
    }

+    /// <summary>Verifies that an <c>IngestAck</c> preserves its accepted event ids.</summary>
    [Fact]
    public void IngestAck_PreservesAcceptedEventIds()
    {
@@ -5,7 +5,7 @@ using ZB.MOM.WW.ScadaBridge.Communication.Grpc;
 namespace ZB.MOM.WW.ScadaBridge.Communication.Tests.Protos;

 /// <summary>
-/// Wire-format round-trip tests for the Audit Log (#23) M3 cached-telemetry
+/// Wire-format round-trip tests for the Audit Log cached-telemetry
 /// proto messages (<see cref="SiteCallOperationalDto"/>,
 /// <see cref="CachedTelemetryPacket"/>, <see cref="CachedTelemetryBatch"/>).
 /// Locks the additive contract the central dual-write transaction depends on.
@@ -23,6 +23,7 @@ public class CachedTelemetryProtoTests
        SourceSiteId = "site-1",
    };

+    /// <summary>Verifies that a <c>SiteCallOperationalDto</c> round trip preserves all fields.</summary>
    [Fact]
    public void SiteCallOperationalDto_RoundTrip_PreservesAllFields()
    {
@@ -66,6 +67,7 @@ public class CachedTelemetryProtoTests
        Assert.Equal(original.TerminalAtUtc, deserialized.TerminalAtUtc);
    }

+    /// <summary>Verifies that the terminal timestamp is absent when the call is not terminal.</summary>
    [Fact]
    public void SiteCallOperationalDto_TerminalAt_AbsentWhenNotTerminal()
    {
@@ -91,6 +93,7 @@ public class CachedTelemetryProtoTests
        Assert.Null(deserialized.TerminalAtUtc);
    }

+    /// <summary>Verifies that the nullable HTTP status is absent by default.</summary>
    [Fact]
    public void SiteCallOperationalDto_NullableHttpStatus_AbsentByDefault()
    {
@@ -116,6 +119,7 @@ public class CachedTelemetryProtoTests
        Assert.Null(deserialized.HttpStatus);
    }

+    /// <summary>Verifies that a <c>CachedTelemetryPacket</c> round trip preserves its nested entities.</summary>
    [Fact]
    public void CachedTelemetryPacket_RoundTrip_PreservesNestedEntities()
    {
@@ -161,6 +165,7 @@ public class CachedTelemetryProtoTests
        Assert.Equal(operationalDto.LastError, deserialized.Operational.LastError);
    }

+    /// <summary>Verifies that an empty <c>CachedTelemetryBatch</c> round trip yields no packets.</summary>
    [Fact]
    public void CachedTelemetryBatch_Empty_RoundTrip_Yields_EmptyPackets()
    {
@@ -5,7 +5,7 @@ using ZB.MOM.WW.ScadaBridge.Communication.Grpc;
 namespace ZB.MOM.WW.ScadaBridge.Communication.Tests.Protos;

 /// <summary>
-/// Wire-format round-trip tests for the Audit Log (#23) M6 reconciliation
+/// Wire-format round-trip tests for the Audit Log reconciliation
 /// pull proto messages (<see cref="PullAuditEventsRequest"/>,
 /// <see cref="PullAuditEventsResponse"/>). Locks the additive contract the
 /// central→site reconciliation puller depends on.
@@ -23,6 +23,7 @@ public class PullAuditEventsProtoTests
        SourceSiteId = "site-1",
    };

+    /// <summary>Verifies that a <c>PullAuditEventsRequest</c> survives a serialize and parse round trip unchanged.</summary>
    [Fact]
    public void PullAuditEventsRequest_RoundTrip()
    {
@@ -42,6 +43,7 @@ public class PullAuditEventsProtoTests
        Assert.Equal(250, deserialized.BatchSize);
    }

+    /// <summary>Verifies that a <c>PullAuditEventsResponse</c> with events and the more-available flag survives a round trip.</summary>
    [Fact]
    public void PullAuditEventsResponse_RoundTrip_WithEvents_And_MoreAvailable()
    {
@@ -67,6 +69,7 @@ public class PullAuditEventsProtoTests
        }
    }

+    /// <summary>Verifies that an empty <c>PullAuditEventsResponse</c> parses back with no events.</summary>
    [Fact]
    public void PullAuditEventsResponse_Empty_Yields_EmptyEvents()
    {