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
@@ -11,9 +11,9 @@ using ZB.MOM.WW.ScadaBridge.Commons.Types.Templates;
namespace ZB.MOM.WW.ScadaBridge.DeploymentManager.Tests;
/// <summary>
/// WP-8: Tests for deployed vs template-derived state comparison.
/// Tests for deployed vs template-derived state comparison.
///
/// PLAN-05 Task 16: adds behavioral coverage proving the read-only
/// Adds behavioral coverage proving the read-only
/// staleness/comparison path can flatten (and thus hash) an instance whose
/// script does NOT compile — because <c>validateScripts: false</c> skips the
/// expensive Roslyn <see cref="ValidationService.ValidateScriptCompilation"/>
@@ -22,6 +22,7 @@ namespace ZB.MOM.WW.ScadaBridge.DeploymentManager.Tests;
/// </summary>
public class DeploymentComparisonTests
{
/// <summary>Verifies that a comparison with matching hashes is not stale.</summary>
[Fact]
public void DeploymentComparisonResult_MatchingHashes_NotStale()
{
@@ -33,6 +34,7 @@ public class DeploymentComparisonTests
Assert.Equal("sha256:abc", result.CurrentRevisionHash);
}
/// <summary>Verifies that a comparison with different hashes is stale.</summary>
[Fact]
public void DeploymentComparisonResult_DifferentHashes_IsStale()
{
@@ -43,6 +45,7 @@ public class DeploymentComparisonTests
Assert.NotEqual(result.DeployedRevisionHash, result.CurrentRevisionHash);
}
/// <summary>Verifies that a comparison result carries the deployed timestamp.</summary>
[Fact]
public void DeploymentComparisonResult_ContainsDeployedTimestamp()
{
@@ -52,7 +55,7 @@ public class DeploymentComparisonTests
Assert.Equal(deployedAt, result.DeployedAt);
}
// ── PLAN-05 Task 16: read-only paths skip Roslyn script compilation ──
// ── read-only paths skip Roslyn script compilation ──
private const int InstanceId = 1;
private const int TemplateId = 10;
@@ -100,6 +103,8 @@ public class DeploymentComparisonTests
return (templateRepo, siteRepo, sharedSchemaRepo);
}
/// <summary>Verifies that flattening with script validation off succeeds with a hash and no compilation error for a non-compiling script.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task FlattenAndValidate_ValidateScriptsFalse_NonCompilingScript_SucceedsWithHashAndNoCompilationError()
{
@@ -116,6 +121,8 @@ public class DeploymentComparisonTests
e => e.Category == ValidationCategory.ScriptCompilation);
}
/// <summary>Verifies that flattening with the default script validation reports a compilation error for a non-compiling script.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task FlattenAndValidate_DefaultValidateScripts_NonCompilingScript_ReportsCompilationError()
{