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
@@ -23,6 +23,7 @@ public class SecretProjectionTests : TestKit, IDisposable
private readonly IAuditService _auditService;
private readonly ServiceCollection _services;
/// <summary>Initializes the test class with stubbed repositories and audit service.</summary>
public SecretProjectionTests()
{
_auditService = Substitute.For<IAuditService>();
@@ -41,10 +42,11 @@ public class SecretProjectionTests : TestKit, IDisposable
new(new AuthenticatedUser("testuser", "Test User", roles, Array.Empty<string>()),
command, Guid.NewGuid().ToString("N"));
/// <inheritdoc />
void IDisposable.Dispose() => Shutdown();
// ========================================================================
// Task 7 — DataConnection config secret elision
// DataConnection config secret elision
// ========================================================================
private ISiteRepository AddSiteRepoWithConnection(DataConnection conn)
@@ -57,6 +59,7 @@ public class SecretProjectionTests : TestKit, IDisposable
return siteRepo;
}
/// <summary>Verifies that the get-data-connection response omits passwords.</summary>
[Fact]
public void GetDataConnection_ResponseOmitsPasswords()
{
@@ -74,6 +77,7 @@ public class SecretProjectionTests : TestKit, IDisposable
Assert.Contains("hasSecrets", resp.JsonData); // camelCase serializer
}
/// <summary>Verifies that the list-data-connections response omits passwords.</summary>
[Fact]
public void ListDataConnections_ResponseOmitsPasswords()
{
@@ -91,6 +95,8 @@ public class SecretProjectionTests : TestKit, IDisposable
Assert.Contains("hasSecrets", resp.JsonData);
}
/// <summary>Verifies that updating a data connection with the sentinel config preserves the stored secret.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task UpdateDataConnection_SentinelConfig_PreservesStoredSecret()
{
@@ -112,6 +118,7 @@ public class SecretProjectionTests : TestKit, IDisposable
Arg.Any<CancellationToken>());
}
/// <summary>Verifies that the audit after-state of a data connection update omits passwords.</summary>
[Fact]
public void UpdateDataConnection_AuditAfterState_OmitsPasswords()
{
@@ -133,7 +140,7 @@ public class SecretProjectionTests : TestKit, IDisposable
}
// ========================================================================
// Task 8 — ExternalSystem AuthConfiguration elision
// ExternalSystem AuthConfiguration elision
// ========================================================================
private IExternalSystemRepository AddExternalSystemRepo(ExternalSystemDefinition def)
@@ -146,6 +153,7 @@ public class SecretProjectionTests : TestKit, IDisposable
return repo;
}
/// <summary>Verifies that the get-external-system response omits the auth configuration.</summary>
[Fact]
public void GetExternalSystem_ResponseOmitsAuthConfiguration()
{
@@ -163,6 +171,7 @@ public class SecretProjectionTests : TestKit, IDisposable
Assert.Contains("hasAuthConfiguration", resp.JsonData);
}
/// <summary>Verifies that the list-external-systems response omits the auth configuration.</summary>
[Fact]
public void ListExternalSystems_ResponseOmitsAuthConfiguration()
{
@@ -180,6 +189,8 @@ public class SecretProjectionTests : TestKit, IDisposable
Assert.Contains("hasAuthConfiguration", resp.JsonData);
}
/// <summary>Verifies that updating an external system with a null auth configuration preserves the stored secret.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task UpdateExternalSystem_NullAuthConfiguration_PreservesStoredSecret()
{
@@ -199,6 +210,7 @@ public class SecretProjectionTests : TestKit, IDisposable
Arg.Any<CancellationToken>());
}
/// <summary>Verifies that the audit after-state of an external system update omits the auth configuration.</summary>
[Fact]
public void UpdateExternalSystem_AuditAfterState_OmitsAuthConfiguration()
{
@@ -220,7 +232,7 @@ public class SecretProjectionTests : TestKit, IDisposable
}
// ========================================================================
// Task 9 — DatabaseConnection ConnectionString elision
// DatabaseConnection ConnectionString elision
// ========================================================================
private IExternalSystemRepository AddDatabaseConnectionRepo(DatabaseConnectionDefinition def)
@@ -233,6 +245,7 @@ public class SecretProjectionTests : TestKit, IDisposable
return repo;
}
/// <summary>Verifies that the get-database-connection response omits the connection string.</summary>
[Fact]
public void GetDatabaseConnection_ResponseOmitsConnectionString()
{
@@ -246,6 +259,7 @@ public class SecretProjectionTests : TestKit, IDisposable
Assert.Contains("hasConnectionString", resp.JsonData);
}
/// <summary>Verifies that the list-database-connections response omits the connection string.</summary>
[Fact]
public void ListDatabaseConnections_ResponseOmitsConnectionString()
{
@@ -259,6 +273,8 @@ public class SecretProjectionTests : TestKit, IDisposable
Assert.Contains("hasConnectionString", resp.JsonData);
}
/// <summary>Verifies that updating a database connection with a null connection string preserves the stored secret.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task UpdateDatabaseConnection_NullConnectionString_PreservesStoredSecret()
{