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
@@ -4,7 +4,7 @@ using ZB.MOM.WW.ScadaBridge.DataConnectionLayer.Adapters;
namespace ZB.MOM.WW.ScadaBridge.DataConnectionLayer.Tests.Adapters;
/// <summary>
/// WP2.1b — the primitives the batch seam is built from, tested in isolation because the
/// The primitives the batch seam is built from, tested in isolation because the
/// OPC Foundation Session/Subscription types they drive cannot be faked without a live
/// server: monitored-item shard placement, the apply-serialization gate, the bounded
/// pipeline behind the MxGateway supervisory advise, the alarm-stream union prefix, and
@@ -14,6 +14,7 @@ public class BatchSeamPrimitiveTests
{
// ── Shard placement ──
/// <summary>Verifies that sharding, splits items at the budget.</summary>
[Fact]
public void Sharding_SplitsItemsAtTheBudget()
{
@@ -31,6 +32,7 @@ public class BatchSeamPrimitiveTests
Assert.Equal(2, placement[12_000]);
}
/// <summary>Verifies that sharding, fills the first shard with free capacity before creating one.</summary>
[Fact]
public void Sharding_FillsTheFirstShardWithFreeCapacityBeforeCreatingOne()
{
@@ -41,6 +43,7 @@ public class BatchSeamPrimitiveTests
Assert.Equal([1, 2], placement);
}
/// <summary>Verifies that sharding, non positive budget degrades to one item per shard.</summary>
[Fact]
public void Sharding_NonPositiveBudgetDegradesToOneItemPerShard()
{
@@ -49,6 +52,8 @@ public class BatchSeamPrimitiveTests
// ── Apply serialization ──
/// <summary>Verifies that apply gate, never runs two sections concurrently.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ApplyGate_NeverRunsTwoSectionsConcurrently()
{
@@ -69,6 +74,8 @@ public class BatchSeamPrimitiveTests
Assert.Equal(1, maxObserved);
}
/// <summary>Verifies that apply gate, releases when a section throws.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ApplyGate_ReleasesWhenASectionThrows()
{
@@ -90,6 +97,8 @@ public class BatchSeamPrimitiveTests
// ── Bounded pipeline (MxGateway supervisory advise) ──
/// <summary>Verifies that bulk pipeline, keeps in flight count within the window.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task BulkPipeline_KeepsInFlightCountWithinTheWindow()
{
@@ -116,6 +125,8 @@ public class BatchSeamPrimitiveTests
Assert.InRange(maxObserved, 1, parallelism);
}
/// <summary>Verifies that bulk pipeline, captures per item faults without aborting the batch.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task BulkPipeline_CapturesPerItemFaultsWithoutAbortingTheBatch()
{
@@ -132,6 +143,9 @@ public class BatchSeamPrimitiveTests
// ── Alarm-stream union prefix ──
/// <summary>Verifies that alarm prefix, is the longest common prefix.</summary>
/// <param name="sources">Test case input.</param>
/// <param name="expected">Test case input.</param>
[Theory]
[InlineData(new[] { "Area1.Tank1", "Area1.Tank2" }, "Area1.Tank")]
[InlineData(new[] { "Area1.Tank1" }, "Area1.Tank1")]
@@ -144,6 +158,7 @@ public class BatchSeamPrimitiveTests
Assert.Equal(expected, AlarmFilterPrefix.LongestCommonPrefix(sources));
}
/// <summary>Verifies that alarm prefix, covers only sources under the live prefix.</summary>
[Fact]
public void AlarmPrefix_CoversOnlySourcesUnderTheLivePrefix()
{
@@ -155,6 +170,7 @@ public class BatchSeamPrimitiveTests
// ── Tag-resolution backoff ──
/// <summary>Verifies that backoff, doubles per failed round and caps at the maximum.</summary>
[Fact]
public void Backoff_DoublesPerFailedRoundAndCapsAtTheMaximum()
{
@@ -182,6 +198,7 @@ public class BatchSeamPrimitiveTests
], sequence);
}
/// <summary>Verifies that backoff, misconfigured ceiling below floor degrades to a fixed interval.</summary>
[Fact]
public void Backoff_MisconfiguredCeilingBelowFloorDegradesToAFixedInterval()
{