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
@@ -3,7 +3,7 @@ using Microsoft.Extensions.Options;
namespace ZB.MOM.WW.ScadaBridge.HealthMonitoring.Tests;
/// <summary>
/// HealthMonitoring-014 regression: <see cref="HealthMonitoringOptions"/> intervals
/// Regression tests: <see cref="HealthMonitoringOptions"/> intervals
/// are fed straight into <c>new PeriodicTimer(...)</c>, which throws
/// <see cref="ArgumentOutOfRangeException"/> for a zero/negative period. A
/// misconfigured <c>appsettings.json</c> must be rejected by an
@@ -15,6 +15,7 @@ public class HealthMonitoringOptionsValidatorTests
private static ValidateOptionsResult Validate(HealthMonitoringOptions options) =>
new HealthMonitoringOptionsValidator().Validate(Options.DefaultName, options);
/// <summary>Verifies that the default options pass validation.</summary>
[Fact]
public void DefaultOptions_AreValid()
{
@@ -22,6 +23,7 @@ public class HealthMonitoringOptionsValidatorTests
Assert.True(result.Succeeded, result.FailureMessage);
}
/// <summary>Verifies that a zero report interval is rejected.</summary>
[Fact]
public void ZeroReportInterval_IsRejected()
{
@@ -31,6 +33,7 @@ public class HealthMonitoringOptionsValidatorTests
Assert.Contains("ReportInterval", result.FailureMessage);
}
/// <summary>Verifies that a negative report interval is rejected.</summary>
[Fact]
public void NegativeReportInterval_IsRejected()
{
@@ -40,6 +43,7 @@ public class HealthMonitoringOptionsValidatorTests
Assert.Contains("ReportInterval", result.FailureMessage);
}
/// <summary>Verifies that a zero offline timeout is rejected.</summary>
[Fact]
public void ZeroOfflineTimeout_IsRejected()
{
@@ -49,6 +53,7 @@ public class HealthMonitoringOptionsValidatorTests
Assert.Contains("OfflineTimeout", result.FailureMessage);
}
/// <summary>Verifies that a zero central offline timeout is rejected.</summary>
[Fact]
public void ZeroCentralOfflineTimeout_IsRejected()
{
@@ -58,6 +63,7 @@ public class HealthMonitoringOptionsValidatorTests
Assert.Contains("CentralOfflineTimeout", result.FailureMessage);
}
/// <summary>Verifies that a central offline timeout shorter than the offline timeout is rejected.</summary>
[Fact]
public void CentralOfflineTimeout_ShorterThanOfflineTimeout_IsRejected()
{
@@ -71,6 +77,7 @@ public class HealthMonitoringOptionsValidatorTests
Assert.Contains("CentralOfflineTimeout", result.FailureMessage);
}
/// <summary>Verifies that a zero metrics stale timeout is rejected.</summary>
[Fact]
public void ZeroMetricsStaleTimeout_IsRejected()
{
@@ -80,6 +87,7 @@ public class HealthMonitoringOptionsValidatorTests
Assert.Contains("MetricsStaleTimeout", result.FailureMessage);
}
/// <summary>Verifies that a metrics stale timeout shorter than the report interval is rejected.</summary>
[Fact]
public void MetricsStaleTimeout_ShorterThanReportInterval_IsRejected()
{
@@ -98,6 +106,8 @@ public class HealthMonitoringOptionsValidatorTests
// LocalDb sustained-backlog badge (register row 33)
// ------------------------------------------------------------------
/// <summary>Verifies that a non-positive LocalDb backlog threshold is rejected.</summary>
/// <param name="threshold">The invalid backlog threshold under test.</param>
[Theory]
[InlineData(0)]
[InlineData(-1)]
@@ -111,6 +121,7 @@ public class HealthMonitoringOptionsValidatorTests
Assert.Contains("LocalDbBacklogThreshold", result.FailureMessage);
}
/// <summary>Verifies that a zero LocalDb backlog sustained-for window is rejected.</summary>
[Fact]
public void ZeroLocalDbBacklogSustainedFor_IsRejected()
{
@@ -123,6 +134,7 @@ public class HealthMonitoringOptionsValidatorTests
Assert.Contains("LocalDbBacklogSustainedFor", result.FailureMessage);
}
/// <summary>Verifies that a LocalDb backlog sustained-for window shorter than the report interval is rejected.</summary>
[Fact]
public void LocalDbBacklogSustainedFor_ShorterThanReportInterval_IsRejected()
{
@@ -139,6 +151,7 @@ public class HealthMonitoringOptionsValidatorTests
Assert.Contains("LocalDbBacklogSustainedFor", result.FailureMessage);
}
/// <summary>Verifies that the default sustained window comfortably outlasts a purge drain.</summary>
[Fact]
public void DefaultSustainedWindow_ComfortablyOutlastsAPurgeDrain()
{