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
@@ -22,12 +22,14 @@ public class ReconcileRepositoryTests : IDisposable
private readonly ScadaBridgeDbContext _context;
private readonly DeploymentManagerRepository _repository;
/// <summary>Initializes the test with an in-memory database context and repository.</summary>
public ReconcileRepositoryTests()
{
_context = SqliteTestHelper.CreateInMemoryContext();
_repository = new DeploymentManagerRepository(_context);
}
/// <summary>Releases the resources held by this test class.</summary>
public void Dispose()
{
_context.Database.CloseConnection();
@@ -69,6 +71,8 @@ public class ReconcileRepositoryTests : IDisposable
// --- GetExpectedDeploymentsForSiteAsync ---
/// <summary>Verifies that only deployed instances belonging to the site are returned as expected deployments.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task GetExpectedDeployments_ReturnsOnlyDeployedInstancesForSite()
{
@@ -115,6 +119,8 @@ public class ReconcileRepositoryTests : IDisposable
Assert.False(a2.IsEnabled);
}
/// <summary>Verifies that no expected deployments are returned when the site has no deployed instances.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task GetExpectedDeployments_NoDeployedInstances_ReturnsEmpty()
{
@@ -129,6 +135,8 @@ public class ReconcileRepositoryTests : IDisposable
// --- StagePendingIfAbsentAsync ---
/// <summary>Verifies that staging a pending deployment with no prior row stages it and returns true.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task StagePendingIfAbsent_NoPriorRow_StagesAndReturnsTrue()
{
@@ -157,6 +165,8 @@ public class ReconcileRepositoryTests : IDisposable
Assert.Equal("rev-new", row.RevisionHash);
}
/// <summary>Verifies that staging a pending deployment when a row already exists returns false and does not overwrite it.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task StagePendingIfAbsent_PriorRowExists_ReturnsFalseAndDoesNotOverwrite()
{