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
@@ -7,7 +7,7 @@ using ZB.MOM.WW.ScadaBridge.Commons.Types.Enums;
namespace ZB.MOM.WW.ScadaBridge.Commons.Tests.Messages.Integration;
/// <summary>
/// Audit Log #23 (M3 Bundle A — Task A4) — tests for the combined
/// Tests for the combined
/// audit + operational telemetry packet emitted per cached-call lifecycle event
/// (<c>Submit</c> → per-attempt <c>ApiCallCached</c> / <c>DbWriteCached</c> →
/// terminal <c>Resolve</c>). The site emits one packet per event; central writes
@@ -29,7 +29,7 @@ public class CachedCallTelemetryTests
string? errorMessage = null,
int? httpStatus = null)
{
// C3 (Task 2.5): build the canonical ZB.MOM.WW.Audit.AuditEvent via the
// Build the canonical ZB.MOM.WW.Audit.AuditEvent via the
// shared factory; the ScadaBridge domain fields ride in DetailsJson and
// are read back as typed properties via AsRow() in the assertions.
// ForwardState is no longer a packet field — it is a site-storage-only
@@ -61,7 +61,7 @@ public class CachedCallTelemetryTests
Channel: nameof(AuditChannel.ApiOutbound),
Target: "ERP.GetOrder",
SourceSite: SiteId,
// SourceNode: actual stamping arrives with Task 14; for now the
// SourceNode: actual stamping is not done here; the
// packet builder leaves the column null so existing assertions on
// the packet's other fields stay intact.
SourceNode: null,
@@ -74,6 +74,7 @@ public class CachedCallTelemetryTests
TerminalAtUtc: terminalAtUtc);
}
/// <summary>Verifies that a submit packet carries a CachedSubmit audit row and an operational retry count of zero.</summary>
[Fact]
public void SubmitPacket_AuditCarriesCachedSubmit_AndOperationalRetryCountZero()
{
@@ -91,6 +92,7 @@ public class CachedCallTelemetryTests
Assert.Equal(trackedId, packet.Operational.TrackedOperationId);
}
/// <summary>Verifies that an attempted packet carries an ApiCallCached audit row whose retry count matches the operational record.</summary>
[Fact]
public void AttemptedPacket_AuditCarriesApiCallCached_RetryCountAlignsBetweenAuditAndOperational()
{
@@ -121,6 +123,7 @@ public class CachedCallTelemetryTests
Assert.Null(packet.Operational.TerminalAtUtc);
}
/// <summary>Verifies that an attempted database-write packet carries the DbWriteCached kind.</summary>
[Fact]
public void AttemptedPacket_DbWriteCached_CarriesDbWriteCachedKind()
{
@@ -144,6 +147,8 @@ public class CachedCallTelemetryTests
Assert.Equal(1, packet.Operational.RetryCount);
}
/// <summary>Verifies that a resolve packet carries a CachedResolve audit row and sets the operational terminal timestamp.</summary>
/// <param name="terminalStatus">The terminal audit status being resolved.</param>
[Theory]
[InlineData(AuditStatus.Delivered)]
[InlineData(AuditStatus.Failed)]
@@ -169,6 +174,7 @@ public class CachedCallTelemetryTests
Assert.Equal(terminalAt, packet.Operational.TerminalAtUtc);
}
/// <summary>Verifies that a cached-call telemetry packet is equal to a copy built from the same values.</summary>
[Fact]
public void CachedCallTelemetry_RoundTripEquality()
{
@@ -190,6 +196,7 @@ public class CachedCallTelemetryTests
Assert.Equal(1, c.Operational.RetryCount);
}
/// <summary>Verifies that a site-call operational record supports value equality and non-destructive copying with a with-expression.</summary>
[Fact]
public void SiteCallOperational_RoundTripEquality_AndWithExpression()
{