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
@@ -13,11 +13,14 @@ public class SiteServiceTests
private readonly Mock<IAuditService> _auditMock = new();
private readonly SiteService _sut;
/// <summary>Initializes the test class with a mocked repository and the service under test.</summary>
public SiteServiceTests()
{
_sut = new SiteService(_repoMock.Object, _auditMock.Object);
}
/// <summary>Verifies that creating a site with valid input succeeds.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task CreateSite_ValidInput_ReturnsSuccess()
{
@@ -33,6 +36,8 @@ public class SiteServiceTests
Assert.Equal("SITE-001", result.Value.SiteIdentifier);
}
/// <summary>Verifies that creating a site with a duplicate identifier fails.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task CreateSite_DuplicateIdentifier_ReturnsFailure()
{
@@ -45,6 +50,8 @@ public class SiteServiceTests
Assert.Contains("already exists", result.Error);
}
/// <summary>Verifies that creating a site with an empty name fails.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task CreateSite_EmptyName_ReturnsFailure()
{
@@ -54,6 +61,8 @@ public class SiteServiceTests
Assert.Contains("required", result.Error);
}
/// <summary>Verifies that deleting a site that has instances fails.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task DeleteSite_WithInstances_ReturnsFailure()
{
@@ -72,6 +81,8 @@ public class SiteServiceTests
Assert.Contains("2 instance(s)", result.Error);
}
/// <summary>Verifies that deleting a site without instances succeeds.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task DeleteSite_NoInstances_Success()
{
@@ -87,6 +98,8 @@ public class SiteServiceTests
Assert.True(result.IsSuccess);
}
/// <summary>Verifies that creating a data connection with valid input succeeds.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task CreateDataConnection_ValidInput_Success()
{
@@ -101,6 +114,8 @@ public class SiteServiceTests
Assert.Equal(1, result.Value.SiteId);
}
/// <summary>Verifies that updating a site with valid input succeeds.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task UpdateSite_ValidInput_Success()
{