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
@@ -8,7 +8,7 @@ using ZB.MOM.WW.ScadaBridge.ConfigurationDatabase;
namespace ZB.MOM.WW.ScadaBridge.ConfigurationDatabase.Tests;
/// <summary>
/// Regression guard for ConfigurationDatabase-004: secret-bearing columns
/// Regression guard: secret-bearing columns
/// (SMTP credentials, external-system auth config, database connection strings)
/// must be encrypted at rest, not persisted verbatim.
/// </summary>
@@ -17,6 +17,7 @@ public class SecretEncryptionTests : IDisposable
private readonly ScadaBridgeDbContext _context;
private readonly IDataProtectionProvider _protectionProvider;
/// <summary>Initializes a new instance of <c>SecretEncryptionTests</c>.</summary>
public SecretEncryptionTests()
{
_protectionProvider = new EphemeralDataProtectionProvider();
@@ -31,12 +32,15 @@ public class SecretEncryptionTests : IDisposable
_context.Database.EnsureCreated();
}
/// <summary>Releases the resources held by this test class.</summary>
public void Dispose()
{
_context.Database.CloseConnection();
_context.Dispose();
}
/// <summary>Verifies that database connection definition connection string stored encrypted round trips.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task DatabaseConnectionDefinition_ConnectionString_StoredEncrypted_RoundTrips()
{
@@ -57,6 +61,8 @@ public class SecretEncryptionTests : IDisposable
Assert.Equal(secret, loaded.ConnectionString);
}
/// <summary>Verifies that smtp configuration credentials stored encrypted round trips.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task SmtpConfiguration_Credentials_StoredEncrypted_RoundTrips()
{
@@ -78,6 +84,8 @@ public class SecretEncryptionTests : IDisposable
Assert.Equal(secret, loaded.Credentials);
}
/// <summary>Verifies that external system definition auth configuration stored encrypted round trips.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ExternalSystemDefinition_AuthConfiguration_StoredEncrypted_RoundTrips()
{
@@ -99,6 +107,8 @@ public class SecretEncryptionTests : IDisposable
Assert.Equal(secret, loaded.AuthConfiguration);
}
/// <summary>Verifies that smtp configuration null credentials round trips as null.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task SmtpConfiguration_NullCredentials_RoundTripsAsNull()
{
@@ -114,6 +124,8 @@ public class SecretEncryptionTests : IDisposable
Assert.Null(loaded.Credentials);
}
/// <summary>Verifies that sms configuration auth token stored encrypted round trips.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task SmsConfiguration_AuthToken_StoredEncrypted_RoundTrips()
{
@@ -141,6 +153,8 @@ public class SecretEncryptionTests : IDisposable
Assert.Equal("AC0123456789", rawSid);
}
/// <summary>Verifies that sms configuration null auth token round trips as null.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task SmsConfiguration_NullAuthToken_RoundTripsAsNull()
{