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
@@ -1,10 +1,11 @@
namespace ZB.MOM.WW.ScadaBridge.Communication.Tests;
/// <summary>
/// WP-2: Tests for per-pattern timeout configuration.
/// Tests for per-pattern timeout configuration.
/// </summary>
public class CommunicationOptionsTests
{
/// <summary>Verifies that the default timeouts are reasonable.</summary>
[Fact]
public void DefaultTimeouts_AreReasonable()
{
@@ -19,16 +20,18 @@ public class CommunicationOptionsTests
Assert.Equal(TimeSpan.FromSeconds(10), options.HealthReportTimeout);
}
/// <summary>Verifies that the transport heartbeat has explicit defaults.</summary>
[Fact]
public void TransportHeartbeat_HasExplicitDefaults()
{
var options = new CommunicationOptions();
// WP-3: Transport heartbeat is explicitly configured, not framework defaults
// Transport heartbeat is explicitly configured, not framework defaults
Assert.Equal(TimeSpan.FromSeconds(5), options.TransportHeartbeatInterval);
Assert.Equal(TimeSpan.FromSeconds(15), options.TransportFailureThreshold);
}
/// <summary>Verifies that the deployment timeout is the longest of the timeout patterns.</summary>
[Fact]
public void DeploymentTimeout_IsLongestPattern()
{
@@ -39,6 +42,7 @@ public class CommunicationOptionsTests
Assert.True(options.DeploymentTimeout > options.IntegrationTimeout);
}
/// <summary>Verifies that all timeouts are configurable.</summary>
[Fact]
public void AllTimeouts_AreConfigurable()
{
@@ -59,6 +63,7 @@ public class CommunicationOptionsTests
Assert.Equal(TimeSpan.FromSeconds(2), options.TransportHeartbeatInterval);
}
/// <summary>Verifies that the application heartbeat interval defaults to 5 seconds, independent of the transport heartbeat.</summary>
[Fact]
public void ApplicationHeartbeatInterval_DefaultsTo5s_IndependentOfTransport()
{