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,13 +7,14 @@ using ZB.MOM.WW.ScadaBridge.HealthMonitoring;
namespace ZB.MOM.WW.ScadaBridge.PerformanceTests;
/// <summary>
/// WP-4 (Phase 8): Performance test framework for health reporting aggregation.
/// Performance test framework for health reporting aggregation.
/// Verifies health reporting from 10 sites can be aggregated correctly.
/// </summary>
public class HealthAggregationTests
{
private readonly CentralHealthAggregator _aggregator;
/// <summary>Initializes the test class with a central health aggregator configured for 30-second reports and a 60-second offline timeout.</summary>
public HealthAggregationTests()
{
var options = Options.Create(new HealthMonitoringOptions
@@ -26,6 +27,7 @@ public class HealthAggregationTests
NullLogger<CentralHealthAggregator>.Instance);
}
/// <summary>Verifies that health reports from ten sites are all tracked by the aggregator.</summary>
[Trait("Category", "Performance")]
[Fact]
public void AggregateHealthReports_10Sites_AllTracked()
@@ -66,6 +68,7 @@ public class HealthAggregationTests
Assert.All(states.Values, s => Assert.True(s.IsOnline));
}
/// <summary>Verifies that the aggregator handles a high volume of rapid report updates.</summary>
[Trait("Category", "Performance")]
[Fact]
public void AggregateHealthReports_RapidUpdates_HandlesVolume()
@@ -106,6 +109,7 @@ public class HealthAggregationTests
});
}
/// <summary>Verifies that stale health reports are rejected.</summary>
[Trait("Category", "Performance")]
[Fact]
public void AggregateHealthReports_StaleReportsRejected()
@@ -133,6 +137,7 @@ public class HealthAggregationTests
Assert.Equal(5, state.LatestReport!.ScriptErrorCount);
}
/// <summary>Verifies that collecting a report resets the interval counters.</summary>
[Trait("Category", "Performance")]
[Fact]
public void HealthCollector_CollectReport_ResetsIntervalCounters()