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 @@ namespace ZB.MOM.WW.ScadaBridge.Transport.Tests.Import;
/// <summary>
/// Register row 53: <c>MaxConcurrentImportSessions</c> had no observability — nothing
/// counted open sessions and nothing logged a rejection at the cap, so the register-row-43
/// counted open sessions and nothing logged a rejection at the cap, so the earlier
/// session leak could only be inferred from rotating test failures. These tests pin the
/// two signals that close that gap: the
/// <c>scadabridge.central.transport.import_sessions.open</c> gauge and the Warning-level
@@ -25,6 +25,7 @@ public sealed class BundleSessionObservabilityTests
// Warning log on cap rejection
// ------------------------------------------------------------------
/// <summary>Verifies that opening a session at the cap logs a warning with the session count and the cap.</summary>
[Fact]
public void Open_AtCap_LogsWarningWithCountAndCap()
{
@@ -50,6 +51,7 @@ public sealed class BundleSessionObservabilityTests
Assert.Contains("MaxConcurrentImportSessions", warning.Message, StringComparison.Ordinal);
}
/// <summary>Verifies that opening a session under the cap logs nothing.</summary>
[Fact]
public void Open_UnderCap_LogsNothing()
{
@@ -64,6 +66,7 @@ public sealed class BundleSessionObservabilityTests
Assert.Empty(logger.Entries);
}
/// <summary>Verifies that opening at a cap filled by expired sessions reclaims them and logs nothing.</summary>
[Fact]
public void Open_AtCapOfExpiredSessions_ReclaimsAndLogsNothing()
{
@@ -88,6 +91,7 @@ public sealed class BundleSessionObservabilityTests
// Rejection counter (register row 66)
// ------------------------------------------------------------------
/// <summary>Verifies that opening a session at the cap increments the rejection counter.</summary>
[Fact]
public void Open_AtCap_IncrementsTheRejectionCounter()
{
@@ -109,6 +113,7 @@ public sealed class BundleSessionObservabilityTests
Assert.Equal(1, delta);
}
/// <summary>Verifies that repeated cap hits accumulate on the rejection counter.</summary>
[Fact]
public void Open_RepeatedCapHits_AccumulateOnTheRejectionCounter()
{
@@ -131,6 +136,7 @@ public sealed class BundleSessionObservabilityTests
Assert.Equal(3, delta);
}
/// <summary>Verifies that opening a session under the cap does not increment the rejection counter.</summary>
[Fact]
public void Open_UnderCap_DoesNotIncrementTheRejectionCounter()
{
@@ -145,6 +151,7 @@ public sealed class BundleSessionObservabilityTests
Assert.Equal(0, delta);
}
/// <summary>Verifies that reclaiming expired sessions at the cap does not increment the rejection counter.</summary>
[Fact]
public void Open_AtCapOfExpiredSessions_ReclaimsWithoutIncrementingTheRejectionCounter()
{
@@ -166,6 +173,7 @@ public sealed class BundleSessionObservabilityTests
Assert.Equal(0, delta);
}
/// <summary>Verifies that reopening an existing session id at the cap does not increment the rejection counter.</summary>
[Fact]
public void Open_ReopeningAnExistingSessionIdAtCap_DoesNotIncrementTheRejectionCounter()
{
@@ -190,6 +198,7 @@ public sealed class BundleSessionObservabilityTests
// OpenSessionCount / gauge
// ------------------------------------------------------------------
/// <summary>Verifies that the open session count excludes sessions that expired but have not been swept.</summary>
[Fact]
public void OpenSessionCount_ExcludesExpiredButUnsweptSessions()
{
@@ -211,6 +220,8 @@ public sealed class BundleSessionObservabilityTests
Assert.Equal(1, sut.OpenSessionCount);
}
/// <summary>Verifies that the eviction service registers the gauge provider and clears it on stop.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task EvictionService_RegistersTheGaugeProvider_AndClearsItOnStop()
{
@@ -250,6 +261,8 @@ public sealed class BundleSessionObservabilityTests
Assert.Equal(0, afterClear);
}
/// <summary>Verifies that stopping an eviction service does not clobber a newer instance's gauge provider.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task EvictionService_StopDoesNotClobberANewerInstancesProvider()
{
@@ -418,8 +431,13 @@ public sealed class BundleSessionObservabilityTests
private sealed class TestClock : TimeProvider
{
private DateTimeOffset _now;
/// <summary>Initializes the clock at the given start time.</summary>
/// <param name="start">The initial time.</param>
public TestClock(DateTimeOffset start) { _now = start; }
/// <inheritdoc />
public override DateTimeOffset GetUtcNow() => _now;
/// <summary>Moves the clock forward.</summary>
/// <param name="by">The amount of time to advance.</param>
public void Advance(TimeSpan by) => _now = _now.Add(by);
}
@@ -434,22 +452,39 @@ public sealed class BundleSessionObservabilityTests
{
public static readonly InertUnlockWindow Instance = new();
/// <inheritdoc />
public Task<bool> TryRegisterAttemptAsync(
string clientKey, int maxAttemptsPerWindow, TimeSpan window, CancellationToken ct = default)
=> Task.FromResult(true);
/// <inheritdoc />
public Task PruneAsync(TimeSpan window, CancellationToken ct = default) => Task.CompletedTask;
}
/// <summary>Captures formatted log entries so the cap-rejection Warning can be asserted.</summary>
private sealed class CapturingLogger : ILogger<BundleSessionStore>
{
/// <summary>Gets the captured log entries in emission order.</summary>
public List<(LogLevel Level, string Message)> Entries { get; } = [];
/// <summary>Starts no scope; the fake does not track scopes.</summary>
/// <typeparam name="TState">The type of the scope state.</typeparam>
/// <param name="state">The scope state, ignored.</param>
/// <returns>No scope token; the fake does not track scopes.</returns>
public IDisposable? BeginScope<TState>(TState state) where TState : notnull => null;
/// <summary>Reports every log level as enabled.</summary>
/// <param name="logLevel">The log level being queried.</param>
/// <returns>Always <see langword="true"/>.</returns>
public bool IsEnabled(LogLevel logLevel) => true;
/// <summary>Records the log entry for later assertions.</summary>
/// <typeparam name="TState">The type of the log state.</typeparam>
/// <param name="logLevel">The severity of the entry.</param>
/// <param name="eventId">The event id of the entry.</param>
/// <param name="state">The state object being logged.</param>
/// <param name="exception">The exception associated with the entry, if any.</param>
/// <param name="formatter">Formats the state and exception into the message text.</param>
public void Log<TState>(
LogLevel logLevel,
EventId eventId,