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
@@ -10,7 +10,7 @@ using ZB.MOM.WW.ScadaBridge.HealthMonitoring;
namespace ZB.MOM.WW.ScadaBridge.CentralUI.Tests.Services;
/// <summary>
/// M9-T25: unit tests for <see cref="ConnectionHealthQueryService"/>, which projects
/// Unit tests for <see cref="ConnectionHealthQueryService"/>, which projects
/// the site health reports' name-keyed <see cref="SiteHealthReport.DataConnectionStatuses"/>
/// onto a connection-id → <see cref="ConnectionHealth"/> map for the design
/// DataConnections page. The site repository + health aggregator are substituted so
@@ -62,6 +62,8 @@ public sealed class ConnectionHealthQueryServiceTests
EnabledInstanceCount: 0,
DisabledInstanceCount: 0);
/// <summary>Verifies that connection names in a health report are mapped to connection ids.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Maps_ConnectionNameStatuses_ToConnectionIds()
{
@@ -81,6 +83,8 @@ public sealed class ConnectionHealthQueryServiceTests
Assert.Equal(2, map.Count);
}
/// <summary>Verifies that a site without a health report yields no entries.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task MissingReport_YieldsNoEntriesForThatSite()
{
@@ -95,6 +99,8 @@ public sealed class ConnectionHealthQueryServiceTests
Assert.Empty(map);
}
/// <summary>Verifies that a site state without a latest report yields no entries.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task StateWithoutLatestReport_YieldsNoEntries()
{
@@ -110,6 +116,8 @@ public sealed class ConnectionHealthQueryServiceTests
Assert.Empty(map);
}
/// <summary>Verifies that a connection name that cannot be resolved is skipped.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task UnknownConnectionName_IsSkipped()
{
@@ -129,10 +137,12 @@ public sealed class ConnectionHealthQueryServiceTests
Assert.Single(map);
}
/// <summary>Verifies that connection names are resolved per site rather than globally.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ResolvesNamesPerSite_NotGloballyAmbiguous()
{
// Two sites each own a connection named "PLC-1". The name→id resolution
// Two sites each own a connection with the same name. The name→id resolution
// must be scoped to the report's own site so the right id is stamped.
var siteA = new Site("Plant-A", "plant-a") { Id = 1 };
var siteB = new Site("Plant-B", "plant-b") { Id = 2 };