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,6 +22,7 @@ public class ScadaBridgeWebApplicationFactory : WebApplicationFactory<Program>
/// </summary>
private readonly Dictionary<string, string?> _previousEnvVars = new();
/// <summary>Initializes the factory and sets the environment variables that configure a Central node for tests.</summary>
public ScadaBridgeWebApplicationFactory()
{
// The initial ConfigurationBuilder in Program.cs reads env vars with AddEnvironmentVariables().
@@ -30,7 +31,7 @@ public class ScadaBridgeWebApplicationFactory : WebApplicationFactory<Program>
{
["DOTNET_ENVIRONMENT"] = "Development",
["ScadaBridge__Node__Role"] = "Central",
// NodeName is eagerly validated at boot (arch-review 08 round 2 NF4 / plan R2-08 T7):
// NodeName is eagerly validated at boot:
// an empty node name stamps the SourceNode audit column NULL, so the validator now
// fails host boot without it. The integration harness must supply one.
["ScadaBridge__Node__NodeName"] = "central-a",
@@ -46,7 +47,7 @@ public class ScadaBridgeWebApplicationFactory : WebApplicationFactory<Program>
// enforces a >=16-char floor; it backs the peppered-HMAC verifier). Supply a fixed
// test pepper so host boot passes validation in the test environment.
["ScadaBridge__InboundApi__ApiKeyPepper"] = "integration-test-api-key-pepper-0123456789",
// Task 1.4: LDAP settings nest under Security:Ldap (shared LdapOptions) and use
// LDAP settings nest under Security:Ldap (shared LdapOptions) and use
// the renamed keys (Transport replaces LdapUseTls; None == plaintext for the
// GLAuth dev directory, paired with AllowInsecure=true).
["ScadaBridge__Security__Ldap__Server"] = "localhost",
@@ -59,7 +60,7 @@ public class ScadaBridgeWebApplicationFactory : WebApplicationFactory<Program>
// succeeds but its searches return `50 Insufficient access`, i.e. auth reads as
// "service unavailable"). Matches the local redundant pair
// (scadaproj/infra/glauth-redundant), whose serviceaccount password is the
// well-known dev value — the shared 10.100.0.35 instance's is rotated (SEC-36).
// well-known dev value — the shared 10.100.0.35 instance's has been rotated.
["ScadaBridge__Security__Ldap__ServiceAccountDn"] = "cn=serviceaccount,dc=zb,dc=local",
["ScadaBridge__Security__Ldap__ServiceAccountPassword"] = "serviceaccount123",
};
@@ -71,6 +72,7 @@ public class ScadaBridgeWebApplicationFactory : WebApplicationFactory<Program>
}
}
/// <inheritdoc />
protected override void ConfigureWebHost(IWebHostBuilder builder)
{
builder.UseEnvironment("Development");
@@ -105,6 +107,7 @@ public class ScadaBridgeWebApplicationFactory : WebApplicationFactory<Program>
});
}
/// <inheritdoc />
protected override void Dispose(bool disposing)
{
base.Dispose(disposing);