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
@@ -6,7 +6,7 @@ using ZB.MOM.WW.ScadaBridge.DataConnectionLayer.Adapters;
namespace ZB.MOM.WW.ScadaBridge.DataConnectionLayer.Tests.Adapters;
/// <summary>
/// WP2.1b — the MxGateway adapter's batch subscribe seam and the alarm-stream union
/// The MxGateway adapter's batch subscribe seam and the alarm-stream union
/// filter. The plain-vs-supervisory advise choice itself lives inside
/// <c>RealMxGatewayClient</c> (it needs a live MXAccess session); its bounded-pipeline
/// mechanism is pinned separately by <see cref="BatchSeamPrimitiveTests"/>.
@@ -26,6 +26,9 @@ public class MxGatewayBatchSeamTests
["ReadTimeoutMs"] = "2000",
};
/// <summary>Verifies that unsubscribing an old handle preserves routing for the new handle.</summary>
/// <param name="batch">Whether the batch subscribe path is used instead of the single-tag path.</param>
/// <returns>A task that represents the asynchronous operation.</returns>
[Theory]
[InlineData(false)]
[InlineData(true)]
@@ -50,6 +53,8 @@ public class MxGatewayBatchSeamTests
while (!condition()) await Task.Delay(10, timeout.Token);
}
/// <summary>Verifies that a batch subscribe issues exactly one bulk call per batch.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task SubscribeBatch_IssuesExactlyOneBulkCallPerBatch()
{
@@ -69,6 +74,8 @@ public class MxGatewayBatchSeamTests
Assert.All(results, r => Assert.NotNull(r.SubscriptionId));
}
/// <summary>Verifies that a batch subscribe reports per-tag failures without failing the batch.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task SubscribeBatch_ReportsPerTagFailuresWithoutFailingTheBatch()
{
@@ -86,6 +93,8 @@ public class MxGatewayBatchSeamTests
Assert.NotNull(failed.ErrorMessage);
}
/// <summary>Verifies that a batch unsubscribe releases every id in one bulk call.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task UnsubscribeBatch_ReleasesEveryIdInOneBulkCall()
{
@@ -100,6 +109,8 @@ public class MxGatewayBatchSeamTests
Assert.Equal(2, fake.BulkUnsubscribeCalls[0].Count);
}
/// <summary>Verifies that the alarm stream uses the longest common prefix and refreshes for every new source.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task AlarmStream_UsesLongestCommonPrefix_AndRefreshesEveryNewSource()
{
@@ -130,6 +141,8 @@ public class MxGatewayBatchSeamTests
Assert.Null(fake.AlarmStreamPrefixes[3]); // "" → gateway-wide
}
/// <summary>Verifies that unsubscribing never restarts the alarm stream.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task AlarmStream_UnsubscribeNeverRestartsTheStream()
{