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,18 +7,22 @@ using ZB.MOM.WW.ScadaBridge.Security;
namespace ZB.MOM.WW.ScadaBridge.IntegrationTests;
/// <summary>
/// WP-22: Auth flow integration tests.
/// Auth flow integration tests.
/// Tests that require a running LDAP server are marked with Integration trait.
/// </summary>
public class AuthFlowTests : IClassFixture<ScadaBridgeWebApplicationFactory>
{
private readonly ScadaBridgeWebApplicationFactory _factory;
/// <summary>Initializes the test with the shared web application factory.</summary>
/// <param name="factory">The web application factory hosting the app under test.</param>
public AuthFlowTests(ScadaBridgeWebApplicationFactory factory)
{
_factory = factory;
}
/// <summary>Verifies that the login endpoint with empty credentials redirects to the login page with an error.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task LoginEndpoint_WithEmptyCredentials_RedirectsToLoginWithError()
{
@@ -37,6 +41,8 @@ public class AuthFlowTests : IClassFixture<ScadaBridgeWebApplicationFactory>
Assert.Contains("error", location, StringComparison.OrdinalIgnoreCase);
}
/// <summary>Verifies that the logout endpoint clears the cookie and redirects.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task LogoutEndpoint_ClearsCookieAndRedirects()
{
@@ -52,6 +58,7 @@ public class AuthFlowTests : IClassFixture<ScadaBridgeWebApplicationFactory>
Assert.Contains("/login", location);
}
/// <summary>Verifies that the JWT token service round-trips a generated token through validation.</summary>
[Fact]
public void JwtTokenService_GenerateAndValidate_RoundTrips()
{
@@ -79,6 +86,7 @@ public class AuthFlowTests : IClassFixture<ScadaBridgeWebApplicationFactory>
Assert.Contains("Designer", roles);
}
/// <summary>Verifies that tokens generated with site scopes include site id claims.</summary>
[Fact]
public void JwtTokenService_WithSiteScopes_IncludesSiteIdClaims()
{
@@ -99,6 +107,8 @@ public class AuthFlowTests : IClassFixture<ScadaBridgeWebApplicationFactory>
Assert.Contains("3", siteIds);
}
/// <summary>Verifies that the login endpoint with valid LDAP credentials sets the cookie and redirects.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Trait("Category", "Integration")]
[Fact]
public async Task LoginEndpoint_WithValidLdapCredentials_SetsCookieAndRedirects()
@@ -132,6 +142,8 @@ public class AuthFlowTests : IClassFixture<ScadaBridgeWebApplicationFactory>
Assert.Contains("ZB.MOM.WW.ScadaBridge.Auth", setCookieHeader);
}
/// <summary>Verifies that the login endpoint without an antiforgery token is rejected without an auth cookie.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task LoginEndpoint_WithoutAntiforgeryToken_RejectsWithoutAuthCookie()
{