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
@@ -149,6 +149,8 @@ public class PendingUpdatesEvaluatorTests
// ── artifact state ───────────────────────────────────────────────────────
/// <summary>Verifies that a site with a null stored hash is reported as never deployed and not as a pending update.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task EvaluateAsync_NullStoredHash_IsNeverDeployedAndNotAPendingUpdate()
{
@@ -167,6 +169,8 @@ public class PendingUpdatesEvaluatorTests
Assert.False(snapshot.HasPendingUpdates);
}
/// <summary>Verifies that a stored hash that matches the current definitions is reported as current.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task EvaluateAsync_StoredHashMatchesCurrentDefinitions_IsCurrent()
{
@@ -186,6 +190,8 @@ public class PendingUpdatesEvaluatorTests
Assert.False(snapshot.HasPendingUpdates);
}
/// <summary>Verifies that a stored hash that differs from the current definitions is reported as out of date and counted.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task EvaluateAsync_StoredHashDiffersFromCurrentDefinitions_IsOutOfDateAndCounted()
{
@@ -203,6 +209,8 @@ public class PendingUpdatesEvaluatorTests
Assert.True(snapshot.HasPendingUpdates);
}
/// <summary>Verifies that the evaluation carries the site identity onto each result row.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task EvaluateAsync_CarriesSiteIdentityOntoTheRow()
{
@@ -220,6 +228,8 @@ public class PendingUpdatesEvaluatorTests
// ── instance counts ──────────────────────────────────────────────────────
/// <summary>Verifies that deployed, stale and unknown instances are counted per site.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task EvaluateAsync_CountsDeployedStaleAndUnknownInstancesPerSite()
{
@@ -248,6 +258,8 @@ public class PendingUpdatesEvaluatorTests
Assert.True(snapshot.HasPendingUpdates);
}
/// <summary>Verifies that not-deployed instances are never handed to the staleness batch.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task EvaluateAsync_NotDeployedInstancesAreNeverHandedToTheStalenessBatch()
{
@@ -278,6 +290,8 @@ public class PendingUpdatesEvaluatorTests
Assert.Equal(1, snapshot.Sites.Single().DeployedInstanceCount);
}
/// <summary>Verifies that instance counts are attributed to their own site.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task EvaluateAsync_AttributesInstanceCountsToTheirOwnSite()
{
@@ -302,6 +316,8 @@ public class PendingUpdatesEvaluatorTests
Assert.Equal(1, snapshot.StaleInstanceCount);
}
/// <summary>Verifies that a fleet with nothing stale has no pending updates.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task EvaluateAsync_NothingStale_HasNoPendingUpdates()
{
@@ -325,6 +341,8 @@ public class PendingUpdatesEvaluatorTests
// ── ordering, ComputedAt, ForSites ───────────────────────────────────────
/// <summary>Verifies that sites are ordered by name, ignoring case.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task EvaluateAsync_OrdersSitesByNameIgnoringCase()
{
@@ -339,6 +357,8 @@ public class PendingUpdatesEvaluatorTests
Assert.Equal(["Alpha", "bravo", "charlie"], snapshot.Sites.Select(s => s.SiteName));
}
/// <summary>Verifies that the evaluation stamps the computed-at time.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task EvaluateAsync_StampsComputedAt()
{
@@ -351,6 +371,8 @@ public class PendingUpdatesEvaluatorTests
Assert.InRange(snapshot.ComputedAt, before, DateTimeOffset.UtcNow);
}
/// <summary>Verifies that exceptions thrown during evaluation propagate to the caller.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task EvaluateAsync_ExceptionsPropagate()
{
@@ -364,6 +386,7 @@ public class PendingUpdatesEvaluatorTests
Assert.Equal("db down", ex.Message);
}
/// <summary>Verifies that scoping to sites keeps only the named sites and the same computed-at time.</summary>
[Fact]
public void ForSites_KeepsOnlyTheNamedSitesAndTheSameComputedAt()
{
@@ -387,6 +410,7 @@ public class PendingUpdatesEvaluatorTests
Assert.True(scoped.HasPendingUpdates);
}
/// <summary>Verifies that scoping to an empty site set yields no pending updates.</summary>
[Fact]
public void ForSites_EmptyScope_YieldsNoPendingUpdates()
{
@@ -401,6 +425,7 @@ public class PendingUpdatesEvaluatorTests
Assert.False(scoped.HasPendingUpdates);
}
/// <summary>Verifies that the snapshot totals sum across all sites.</summary>
[Fact]
public void Snapshot_Totals_SumAcrossSites()
{