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.Commons.Types.Enums;
namespace ZB.MOM.WW.ScadaBridge.CentralUI.Tests.Components;
/// <summary>
/// M7-T16: the Instance Configure page accepts a CSV of attribute overrides via
/// The Instance Configure page accepts a CSV of attribute overrides via
/// an <c>&lt;InputFile&gt;</c>, parses it with the shared
/// <see cref="OverrideCsvParser"/>, validates each row against the instance's
/// overridable attributes (name must exist + not be template-locked, value must be
@@ -19,7 +19,7 @@ namespace ZB.MOM.WW.ScadaBridge.CentralUI.Tests.Components;
/// <para>
/// <c>InstanceConfigure</c> is a heavyweight page (≈7 injected services incl.
/// <c>InstanceService</c> + the flattening pipeline), so — consistent with the
/// MV-14 List-override and native-alarm coverage — the parse→validate→build-dict
/// list-override and native-alarm coverage — the parse→validate→build-dict
/// core is extracted to an <c>internal static</c> helper exercised directly here,
/// plus structural assertions over the component source that pin the InputFile +
/// reuse-the-existing-submit-path wiring.
@@ -49,6 +49,7 @@ public class InstanceConfigureCsvImportTests
// ── Core: valid CSV → override dict, no errors ──────────────────────────
/// <summary>Verifies that a valid CSV builds the override dictionary with no errors.</summary>
[Fact]
public void ValidCsv_BuildsOverrideDict_WithNoErrors()
{
@@ -64,6 +65,7 @@ public class InstanceConfigureCsvImportTests
Assert.Equal("Pump-A", outcome.Overrides["Name"]);
}
/// <summary>Verifies that a valid list-valued CSV row builds canonical JSON that round-trips through the value codec.</summary>
[Fact]
public void ValidListCsv_BuildsCanonicalJson_PerCodecRoundTrip()
{
@@ -81,6 +83,7 @@ public class InstanceConfigureCsvImportTests
// ── Core: bad rows → errors, NO dict (all-or-nothing) ───────────────────
/// <summary>Verifies that a row naming an unknown attribute produces an error and applies nothing.</summary>
[Fact]
public void UnknownAttribute_ProducesError_AndAppliesNothing()
{
@@ -94,6 +97,7 @@ public class InstanceConfigureCsvImportTests
Assert.Contains(outcome.Errors, e => e.Contains("DoesNotExist") && e.Contains("Line 2"));
}
/// <summary>Verifies that a template-locked attribute is rejected, matching the manual editor.</summary>
[Fact]
public void TemplateLockedAttribute_IsRejected_LikeTheEditor()
{
@@ -109,6 +113,7 @@ public class InstanceConfigureCsvImportTests
Assert.Contains(outcome.Errors, e => e.Contains("SerialNumber"));
}
/// <summary>Verifies that a type-incompatible value produces an error and applies nothing.</summary>
[Fact]
public void TypeIncompatibleValue_ProducesError_AndAppliesNothing()
{
@@ -123,6 +128,7 @@ public class InstanceConfigureCsvImportTests
Assert.Contains(outcome.Errors, e => e.Contains("Setpoint") && e.Contains("Line 2"));
}
/// <summary>Verifies that malformed list JSON produces an error and applies nothing.</summary>
[Fact]
public void MalformedListJson_ProducesError_AndAppliesNothing()
{
@@ -136,6 +142,7 @@ public class InstanceConfigureCsvImportTests
Assert.Contains(outcome.Errors, e => e.Contains("Counts"));
}
/// <summary>Verifies that parser errors propagate through the helper and nothing is applied.</summary>
[Fact]
public void ParserErrors_PropagateThrough_AndApplyNothing()
{
@@ -153,6 +160,7 @@ public class InstanceConfigureCsvImportTests
// ── Structural: InputFile + reuse-the-existing-submit-path wiring ───────
/// <summary>Verifies that the page source wires up the CSV input file control with its test hooks.</summary>
[Fact]
public void Page_WiresCsvInputFile_WithTestHooks()
{
@@ -165,6 +173,7 @@ public class InstanceConfigureCsvImportTests
Assert.Contains("OverrideCsvParser.Parse", markup);
}
/// <summary>Verifies that the page applies the imported overrides through the existing set-attribute-override path.</summary>
[Fact]
public void Page_AppliesViaExistingSetAttributeOverridePath()
{