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.LocalDb;
namespace ZB.MOM.WW.ScadaBridge.Host.Tests;
/// <summary>
/// Deferred-work register row 105 (arch-review 2026-08-19 P4-7 → LocalDb 0.3.3): a replicated
/// Guards the LocalDb 0.3.3 restriction: a replicated
/// table must never be the parent of a foreign key with a row-mutating <c>ON DELETE</c> action
/// (<c>CASCADE</c> / <c>SET NULL</c> / <c>SET DEFAULT</c>). LocalDb's LWW applier upserts with
/// <c>INSERT OR REPLACE</c> under <c>foreign_keys=ON</c>, so the implicit delete would fire the
@@ -16,8 +16,8 @@ namespace ZB.MOM.WW.ScadaBridge.Host.Tests;
/// pair. This test moves that discovery from the first replicated boot to the build: it walks
/// the real site schema (every table <c>SiteLocalDbSetup.OnReady</c> creates) and asserts none
/// of the twelve <see cref="SiteLocalDbSetup.ReplicatedTables"/> (incl. <c>deployed_secrets</c>,
/// added for site-secrets artifact deploy, and <c>secret_mirror_status</c>, added by review
/// finding M1) has such an inbound FK.
/// added for site-secrets artifact deploy, and <c>secret_mirror_status</c>, added by a
/// review finding) has such an inbound FK.
/// </summary>
/// <remarks>
/// The schema is built with an UNREPLICATED config on purpose: a replicated one would make
@@ -27,6 +27,7 @@ namespace ZB.MOM.WW.ScadaBridge.Host.Tests;
/// </remarks>
public class SiteLocalDbReplicatedTableFkGuardTests
{
/// <summary>Verifies that no replicated table is the parent of a foreign key with a row-mutating <c>ON DELETE</c> action.</summary>
[Fact]
public void NoReplicatedTable_IsAParentOfARowMutatingOnDeleteForeignKey()
{
@@ -64,6 +65,7 @@ public class SiteLocalDbReplicatedTableFkGuardTests
}
}
/// <summary>Verifies, as a negative control, that the checker detects a child table with a cascading foreign key.</summary>
[Fact]
public void NegativeControl_CheckerFindsACascadingChild()
{