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
@@ -7,7 +7,7 @@ using Xunit;
namespace ZB.MOM.WW.ScadaBridge.CentralUI.PlaywrightTests.Deployment;
/// <summary>
/// Real-browser coverage for the Flow Debugger page (follow-ups plan 2026-09-06, Task 9):
/// Real-browser coverage for the Flow Debugger page (follow-ups plan 2026-09-06):
/// a Live run of an inbound method completes and draws a graph, and the method choice survives
/// a reload through the page's <c>localStorage</c> restore path. Both go through the same
/// prediction path that used to deadlock the circuit (see <see cref="FlowDebuggerFixture"/>) —
@@ -15,7 +15,7 @@ namespace ZB.MOM.WW.ScadaBridge.CentralUI.PlaywrightTests.Deployment;
/// so these tests are the browser-level guard for that fix as well.
///
/// <para>
/// The script entry (design 2026-09-08, Task 11) adds two more: a Live direct call of the rig's
/// The script entry (design 2026-09-08) adds two more: a Live direct call of the rig's
/// <c>OutboundDemo</c> Call script on <c>DelmiaSim01</c>, and the write-kind Inputs card naming the
/// trigger's own attribute. Unlike the method tests those drive RIG-SEEDED objects the fixture does
/// not provision, so each picker step skips with a "run docker/seed-…" message when it is absent.
@@ -29,12 +29,17 @@ public class FlowDebuggerTests : IClassFixture<FlowDebuggerFixture>
private readonly PlaywrightFixture _pw;
private readonly FlowDebuggerFixture _flow;
/// <summary>Initializes a new instance of the <c>FlowDebuggerTests</c> class.</summary>
/// <param name="pw">The shared Playwright fixture.</param>
/// <param name="flow">The Flow Debugger fixture.</param>
public FlowDebuggerTests(PlaywrightFixture pw, FlowDebuggerFixture flow)
{
_pw = pw;
_flow = flow;
}
/// <summary>Verifies that a live run in the browser completes and draws the flow graph.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[SkippableFact]
public async Task LiveRun_InBrowser_CompletesAndDrawsTheGraph()
{
@@ -47,7 +52,7 @@ public class FlowDebuggerTests : IClassFixture<FlowDebuggerFixture>
await SelectMethodAsync(page);
// The prediction (a Roslyn walk + the route-target resolve) finished: the state chip flips
// to Predicted and the method's ParameterValueForm (#37: the same typed form the script
// to Predicted and the method's ParameterValueForm (the same typed form the script
// pane uses, inputs addressed by field id) appears.
await Assertions.Expect(page.Locator("[data-test='flow-state']")).ToHaveTextAsync("Predicted", new() { Timeout = 15_000 });
var input = page.Locator("#param-Text");
@@ -72,6 +77,8 @@ public class FlowDebuggerTests : IClassFixture<FlowDebuggerFixture>
Assert.DoesNotContain(consoleErrors, e => e.Contains("JSInterop", StringComparison.OrdinalIgnoreCase));
}
/// <summary>Verifies that the chosen inbound API method survives a page reload through local storage.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[SkippableFact]
public async Task MethodChoice_SurvivesReload_ViaLocalStorage()
{
@@ -100,6 +107,8 @@ public class FlowDebuggerTests : IClassFixture<FlowDebuggerFixture>
Assert.DoesNotContain(consoleErrors, e => e.Contains("JSInterop", StringComparison.OrdinalIgnoreCase));
}
/// <summary>Verifies that a live run of a call script from the script entry completes in the browser.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[SkippableFact]
public async Task ScriptEntry_LiveRunOfACallScript_InBrowser_Completes()
{
@@ -151,6 +160,8 @@ public class FlowDebuggerTests : IClassFixture<FlowDebuggerFixture>
Assert.DoesNotContain(consoleErrors, e => e.Contains("JSInterop", StringComparison.OrdinalIgnoreCase));
}
/// <summary>Verifies that selecting a write-kind script shows the value field for its trigger attribute.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[SkippableFact]
public async Task ScriptEntry_WriteKindScript_ShowsTheValueFieldForTheTriggerAttribute()
{