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
@@ -2,6 +2,7 @@ namespace ZB.MOM.WW.ScadaBridge.ManagementService.Tests;
public class ConfigSecretScrubberTests
{
/// <summary>Verifies that password fields are redacted at any nesting depth.</summary>
[Fact]
public void Scrub_RedactsPasswordFields_AtAnyDepth()
{
@@ -14,6 +15,7 @@ public class ConfigSecretScrubberTests
Assert.Contains("opc.tcp://x", scrubbed); // non-secrets untouched
}
/// <summary>Verifies that scrubbing a document with no secrets reports that nothing was redacted.</summary>
[Fact]
public void Scrub_NoSecrets_ReturnsFalseFlag()
{
@@ -21,6 +23,8 @@ public class ConfigSecretScrubberTests
Assert.False(had);
}
/// <summary>Verifies that null, empty or malformed input passes through unchanged.</summary>
/// <param name="input">The raw configuration JSON to scrub.</param>
[Theory]
[InlineData(null)]
[InlineData("")]
@@ -32,6 +36,7 @@ public class ConfigSecretScrubberTests
Assert.False(had);
}
/// <summary>Verifies that merging sentinels restores stored secrets while keeping the operator's other edits.</summary>
[Fact]
public void MergeSentinels_RestoresStoredSecrets_KeepsEdits()
{
@@ -60,6 +65,7 @@ public class ConfigSecretScrubberTests
[typeof(ZB.MOM.WW.ScadaBridge.Commons.Types.DataConnections.OpcUaDeadbandConfig)] = [],
};
/// <summary>Verifies that every string property on the config types is either scrubbed or deliberately classified as non-secret.</summary>
[Fact]
public void EveryConfigStringProperty_IsScrubbedOrDeliberatelyNonSecret()
{
@@ -79,6 +85,8 @@ public class ConfigSecretScrubberTests
}
}
/// <summary>Verifies that each known secret property name matches the scrubber's fragment list.</summary>
/// <param name="name">The secret property name.</param>
[Theory]
[InlineData("Password")]
[InlineData("CertificatePassword")]