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
@@ -6,7 +6,7 @@ using ZB.MOM.WW.ScadaBridge.Security;
namespace ZB.MOM.WW.ScadaBridge.CentralUI.Tests.Auth;
/// <summary>
/// Regression tests for CentralUI-024. Ten components each copy-pasted a
/// Regression tests for the shared claim lookups. Ten components each copy-pasted a
/// <c>GetCurrentUserAsync</c> helper using the magic string
/// <c>FindFirst("Username")</c>, and <c>NavMenu</c>/<c>Dashboard</c> used
/// <c>FindFirst("DisplayName")</c>. A rename of the claim type in
@@ -20,6 +20,7 @@ public class ClaimsPrincipalExtensionsTests
private static ClaimsPrincipal Principal(params Claim[] claims)
=> new(new ClaimsIdentity(claims, authenticationType: "TestCookie"));
/// <summary>Verifies that the username lookup resolves the claim the JWT token service issues.</summary>
[Fact]
public void GetUsername_ResolvesTheJwtTokenServiceUsernameClaim()
{
@@ -29,6 +30,7 @@ public class ClaimsPrincipalExtensionsTests
Assert.Equal("alice", principal.GetUsername());
}
/// <summary>Verifies that the username lookup falls back to unknown when the claim is absent.</summary>
[Fact]
public void GetUsername_FallsBackToUnknown_WhenClaimAbsent()
{
@@ -37,6 +39,7 @@ public class ClaimsPrincipalExtensionsTests
Assert.Equal(ClaimsPrincipalExtensions.UnknownUser, principal.GetUsername());
}
/// <summary>Verifies that the display-name lookup resolves the claim the JWT token service issues.</summary>
[Fact]
public void GetDisplayName_ResolvesTheJwtTokenServiceDisplayNameClaim()
{
@@ -46,12 +49,15 @@ public class ClaimsPrincipalExtensionsTests
Assert.Equal("Alice Anderson", principal.GetDisplayName());
}
/// <summary>Verifies that the display-name lookup returns null when the claim is absent.</summary>
[Fact]
public void GetDisplayName_IsNull_WhenClaimAbsent()
{
Assert.Null(Principal().GetDisplayName());
}
/// <summary>Verifies that the current-username lookup reads the username from the authentication state.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task GetCurrentUsernameAsync_ReadsUsernameFromAuthState()
{
@@ -63,6 +69,7 @@ public class ClaimsPrincipalExtensionsTests
Assert.Equal("bob", await provider.GetCurrentUsernameAsync());
}
/// <summary>Verifies that the username lookup follows a rename of the claim type in the JWT token service.</summary>
[Fact]
public void Username_LookupTracksAJwtTokenServiceRename()
{
@@ -81,7 +88,10 @@ public class ClaimsPrincipalExtensionsTests
private sealed class StubAuthStateProvider : AuthenticationStateProvider
{
private readonly AuthenticationState _state;
/// <summary>Initializes the provider with a fixed authentication state.</summary>
/// <param name="state">The authentication state to return.</param>
public StubAuthStateProvider(AuthenticationState state) => _state = state;
/// <inheritdoc />
public override Task<AuthenticationState> GetAuthenticationStateAsync()
=> Task.FromResult(_state);
}