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
@@ -3,7 +3,7 @@ using Microsoft.Extensions.Options;
namespace ZB.MOM.WW.ScadaBridge.NotificationOutbox.Tests;
/// <summary>
/// P5-5 (arch-review Low): <see cref="NotificationOutboxOptions"/> had no
/// Tests for the options validator: <see cref="NotificationOutboxOptions"/> had no
/// registered validator before this — the dispatch/purge/KPI cadences and the
/// delivered-throughput KPI window (<see cref="NotificationOutboxOptions.DeliveredKpiWindow"/>)
/// could be zero/negative with no boot-time signal, which would spin an Akka
@@ -19,6 +19,7 @@ public class NotificationOutboxOptionsValidatorTests
private static ValidateOptionsResult Validate(NotificationOutboxOptions options) =>
new NotificationOutboxOptionsValidator().Validate(Options.DefaultName, options);
/// <summary>Verifies that the default options are valid.</summary>
[Fact]
public void DefaultOptions_AreValid()
{
@@ -26,6 +27,7 @@ public class NotificationOutboxOptionsValidatorTests
Assert.True(result.Succeeded, result.FailureMessage);
}
/// <summary>Verifies that a zero dispatch interval is rejected.</summary>
[Fact]
public void ZeroDispatchInterval_IsRejected()
{
@@ -34,6 +36,7 @@ public class NotificationOutboxOptionsValidatorTests
Assert.Contains("DispatchInterval", result.FailureMessage);
}
/// <summary>Verifies that a zero dispatch batch size is rejected.</summary>
[Fact]
public void ZeroDispatchBatchSize_IsRejected()
{
@@ -42,6 +45,7 @@ public class NotificationOutboxOptionsValidatorTests
Assert.Contains("DispatchBatchSize", result.FailureMessage);
}
/// <summary>Verifies that a zero stuck-age threshold is rejected.</summary>
[Fact]
public void ZeroStuckAgeThreshold_IsRejected()
{
@@ -50,6 +54,7 @@ public class NotificationOutboxOptionsValidatorTests
Assert.Contains("StuckAgeThreshold", result.FailureMessage);
}
/// <summary>Verifies that a zero terminal-row retention is rejected.</summary>
[Fact]
public void ZeroTerminalRetention_IsRejected()
{
@@ -58,6 +63,7 @@ public class NotificationOutboxOptionsValidatorTests
Assert.Contains("TerminalRetention", result.FailureMessage);
}
/// <summary>Verifies that a zero purge interval is rejected.</summary>
[Fact]
public void ZeroPurgeInterval_IsRejected()
{
@@ -66,6 +72,7 @@ public class NotificationOutboxOptionsValidatorTests
Assert.Contains("PurgeInterval", result.FailureMessage);
}
/// <summary>Verifies that a zero delivered-KPI window is rejected.</summary>
[Fact]
public void ZeroDeliveredKpiWindow_IsRejected()
{
@@ -74,6 +81,7 @@ public class NotificationOutboxOptionsValidatorTests
Assert.Contains("DeliveredKpiWindow", result.FailureMessage);
}
/// <summary>Verifies that a negative delivered-KPI window is rejected.</summary>
[Fact]
public void NegativeDeliveredKpiWindow_IsRejected()
{
@@ -82,6 +90,7 @@ public class NotificationOutboxOptionsValidatorTests
Assert.Contains("DeliveredKpiWindow", result.FailureMessage);
}
/// <summary>Verifies that a zero maximum parallel deliveries value is rejected.</summary>
[Fact]
public void ZeroMaxParallelDeliveries_IsRejected()
{