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
@@ -7,20 +7,23 @@ public class DesignTimeDbContextFactoryTests : IDisposable
private const string EnvVar = "SCADABRIDGE_DESIGNTIME_CONNECTIONSTRING";
private readonly string? _originalEnv;
/// <summary>Initializes the test and captures the original connection string environment variable.</summary>
public DesignTimeDbContextFactoryTests()
{
_originalEnv = Environment.GetEnvironmentVariable(EnvVar);
}
/// <summary>Releases the resources held by the test fixture.</summary>
public void Dispose()
{
Environment.SetEnvironmentVariable(EnvVar, _originalEnv);
}
/// <summary>Verifies that creating a context with no connection string configured throws a clear exception.</summary>
[Fact]
public void CreateDbContext_NoConnectionStringConfigured_ThrowsClearException()
{
// Regression guard for ConfigurationDatabase-002: the factory must not fall back
// Regression guard: the factory must not fall back
// to a hardcoded `sa`/password literal. With nothing configured it must fail loudly
// with an actionable message instead of silently pointing tooling at a guessed DB.
Environment.SetEnvironmentVariable(EnvVar, null);
@@ -33,6 +36,7 @@ public class DesignTimeDbContextFactoryTests : IDisposable
Assert.DoesNotContain("sa", ex.Message.Split(' '), StringComparer.OrdinalIgnoreCase);
}
/// <summary>Verifies that a connection string from the environment variable is used.</summary>
[Fact]
public void CreateDbContext_ConnectionStringFromEnvironmentVariable_IsUsed()
{
@@ -47,6 +51,7 @@ public class DesignTimeDbContextFactoryTests : IDisposable
Assert.NotNull(context);
}
/// <summary>Verifies that the factory source contains no hardcoded SA credential.</summary>
[Fact]
public void DesignTimeDbContextFactory_SourceContainsNoHardcodedSaCredential()
{