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:
@@ -24,7 +24,9 @@ public class PlaywrightFixture : IAsyncLifetime
|
||||
public const string TestUsername = "multi-role";
|
||||
public const string TestPassword = "password";
|
||||
|
||||
/// <summary>The Playwright driver instance created during initialization.</summary>
|
||||
public IPlaywright Playwright { get; private set; } = null!;
|
||||
/// <summary>The browser connected to the Playwright server.</summary>
|
||||
public IBrowser Browser { get; private set; } = null!;
|
||||
|
||||
/// <summary>
|
||||
@@ -44,12 +46,16 @@ public class PlaywrightFixture : IAsyncLifetime
|
||||
/// </summary>
|
||||
private const int MaxRetainedContexts = 4;
|
||||
|
||||
/// <summary>Creates the Playwright driver and connects to the remote Chromium endpoint.</summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
public async Task InitializeAsync()
|
||||
{
|
||||
Playwright = await Microsoft.Playwright.Playwright.CreateAsync();
|
||||
Browser = await Playwright.Chromium.ConnectAsync(PlaywrightWsEndpoint);
|
||||
}
|
||||
|
||||
/// <summary>Closes the browser connection and disposes the Playwright driver.</summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
public async Task DisposeAsync()
|
||||
{
|
||||
await Browser.CloseAsync();
|
||||
@@ -62,6 +68,7 @@ public class PlaywrightFixture : IAsyncLifetime
|
||||
/// <see cref="MaxRetainedContexts"/> are open, to bound the number of concurrent Blazor
|
||||
/// Server circuits the run holds on the Central UI.
|
||||
/// </summary>
|
||||
/// <returns>The new page, which belongs to its own isolated browser context.</returns>
|
||||
public async Task<IPage> NewPageAsync()
|
||||
{
|
||||
var context = await Browser.NewContextAsync();
|
||||
@@ -92,6 +99,7 @@ public class PlaywrightFixture : IAsyncLifetime
|
||||
/// <summary>
|
||||
/// Create a new page and log in with the default multi-role test user.
|
||||
/// </summary>
|
||||
/// <returns>A page that is authenticated as the default test user.</returns>
|
||||
public Task<IPage> NewAuthenticatedPageAsync() =>
|
||||
NewAuthenticatedPageAsync(TestUsername, TestPassword);
|
||||
|
||||
@@ -100,6 +108,9 @@ public class PlaywrightFixture : IAsyncLifetime
|
||||
/// Uses JavaScript fetch() to POST to /auth/login from within the browser,
|
||||
/// which sets the auth cookie in the browser context. Then navigates to the dashboard.
|
||||
/// </summary>
|
||||
/// <param name="username">The LDAP user name to log in with.</param>
|
||||
/// <param name="password">The password for <paramref name="username"/>.</param>
|
||||
/// <returns>A page that is authenticated as the given user.</returns>
|
||||
public async Task<IPage> NewAuthenticatedPageAsync(string username, string password)
|
||||
{
|
||||
var page = await NewPageAsync();
|
||||
@@ -144,6 +155,11 @@ public class PlaywrightFixture : IAsyncLifetime
|
||||
/// Blazor Server uses SignalR for client-side navigation (no full page reload),
|
||||
/// so standard WaitForURLAsync times out. This polls window.location instead.
|
||||
/// </summary>
|
||||
/// <param name="page">The page whose location is polled.</param>
|
||||
/// <param name="path">A path fragment the location must contain.</param>
|
||||
/// <param name="excludePath">An optional path fragment the location must not contain.</param>
|
||||
/// <param name="timeoutMs">The maximum time to wait, in milliseconds.</param>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
public static async Task WaitForPathAsync(IPage page, string path, string? excludePath = null, int timeoutMs = 10000)
|
||||
{
|
||||
var js = excludePath != null
|
||||
@@ -163,6 +179,8 @@ public class PlaywrightFixture : IAsyncLifetime
|
||||
/// in the DOM but are hidden until the section is expanded. Call this after
|
||||
/// authenticating, before interacting with sectioned nav links.
|
||||
/// </summary>
|
||||
/// <param name="page">The authenticated page whose navigation sections are expanded.</param>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
public static async Task ExpandAllNavSectionsAsync(IPage page)
|
||||
{
|
||||
var toggles = page.Locator("summary.rail-eyebrow-toggle");
|
||||
|
||||
Reference in New Issue
Block a user