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
@@ -28,6 +28,7 @@ public class AlarmsAccessorTests : TestKit, IDisposable
instanceName: "CvdReactor01",
logger: NullLogger<ScriptRuntimeContext>.Instance);
/// <inheritdoc />
void IDisposable.Dispose() => Shutdown();
private static readonly DateTimeOffset RaisedAt = new(2026, 8, 1, 10, 0, 0, TimeSpan.Zero);
@@ -63,6 +64,8 @@ public class AlarmsAccessorTests : TestKit, IDisposable
request.CorrelationId, request.InstanceUniqueName, alarms, DateTimeOffset.UtcNow));
}
/// <summary>Verifies that the current-alarms call asks the instance actor for its own instance.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task CurrentAsync_AsksTheInstanceActor_ForItsOwnInstance()
{
@@ -84,6 +87,8 @@ public class AlarmsAccessorTests : TestKit, IDisposable
Assert.Empty(await pending);
}
/// <summary>Verifies that the current-alarms call projects every native alarm field, including the acknowledgement time.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task CurrentAsync_ProjectsEveryNativeField_IncludingAckTime()
{
@@ -118,6 +123,8 @@ public class AlarmsAccessorTests : TestKit, IDisposable
Assert.False(alarm.IsConfiguredPlaceholder);
}
/// <summary>Verifies that an unacknowledged native alarm reports no acknowledgement time.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task CurrentAsync_UnackedNativeAlarm_ReportsNoAckTime()
{
@@ -138,6 +145,8 @@ public class AlarmsAccessorTests : TestKit, IDisposable
Assert.False(alarm.Shelved);
}
/// <summary>Verifies that a computed alarm reads its state from the derived condition.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task CurrentAsync_ComputedAlarm_ReadsFromTheDerivedCondition()
{
@@ -161,6 +170,8 @@ public class AlarmsAccessorTests : TestKit, IDisposable
Assert.Equal(string.Empty, alarm.NativeSourceCanonicalName);
}
/// <summary>Verifies that placeholder rows are surfaced so that quiet bindings can be told apart.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task CurrentAsync_SurfacesPlaceholderRows_SoQuietBindingsAreDistinguishable()
{
@@ -187,6 +198,8 @@ public class AlarmsAccessorTests : TestKit, IDisposable
Assert.Equal("Z28061.HeartbeatTimeoutAlarm", real.Name);
}
/// <summary>Verifies that the current-alarms call projects the MES-reportable flag.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task CurrentAsync_ProjectsIsMesReportable()
{
@@ -206,6 +219,8 @@ public class AlarmsAccessorTests : TestKit, IDisposable
Assert.False(Assert.Single(alarms, a => a.Name == "HighTemp").IsMesReportable);
}
/// <summary>Verifies that the MES-reportable call returns only the flagged rows.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task MesReportableAsync_FiltersToFlaggedRows()
{
@@ -224,6 +239,8 @@ public class AlarmsAccessorTests : TestKit, IDisposable
Assert.True(alarm.IsMesReportable);
}
/// <summary>Verifies that the current-alarms call is not scope-prefixed, so every scope sees the same list.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task CurrentAsync_IsNotScopePrefixed_EveryScopeSeesTheSameList()
{