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
@@ -61,6 +61,7 @@ public class HealthFailoverButtonTests : BunitContext
return host.FindComponent<CentralFailoverControl>();
}
/// <summary>Verifies that the failover button is hidden for a non-admin user.</summary>
[Fact]
public void Button_is_hidden_for_a_non_admin()
{
@@ -71,6 +72,7 @@ public class HealthFailoverButtonTests : BunitContext
Assert.Empty(cut.FindAll("button"));
}
/// <summary>Verifies that the failover button is rendered and enabled for an admin when a standby node exists.</summary>
[Fact]
public void Button_is_rendered_and_enabled_for_an_admin_with_a_standby()
{
@@ -83,6 +85,7 @@ public class HealthFailoverButtonTests : BunitContext
Assert.Contains("failover", button.TextContent, StringComparison.OrdinalIgnoreCase);
}
/// <summary>Verifies that the failover button is disabled with an explanatory title when there is no standby.</summary>
[Fact]
public void Button_is_disabled_with_an_explanatory_title_when_there_is_no_standby()
{
@@ -96,6 +99,8 @@ public class HealthFailoverButtonTests : BunitContext
Assert.Contains("outage", button.GetAttribute("title"), StringComparison.OrdinalIgnoreCase);
}
/// <summary>Verifies that confirming the dialog triggers the failover exactly once.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Confirming_triggers_the_failover_exactly_once()
{
@@ -110,6 +115,8 @@ public class HealthFailoverButtonTests : BunitContext
await _failover.Received(1).FailOverCentralAsync("tester");
}
/// <summary>Verifies that cancelling the confirmation does not trigger a failover.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Cancelling_the_confirmation_does_not_trigger_a_failover()
{
@@ -122,6 +129,8 @@ public class HealthFailoverButtonTests : BunitContext
await _failover.DidNotReceive().FailOverCentralAsync(Arg.Any<string>());
}
/// <summary>Verifies that the confirmation warns that this page will disconnect.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Confirmation_warns_that_this_page_will_disconnect()
{
@@ -141,6 +150,8 @@ public class HealthFailoverButtonTests : BunitContext
Arg.Any<string?>());
}
/// <summary>Verifies that a refused failover surfaces the refusal instead of claiming success.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task A_refused_failover_surfaces_the_refusal_instead_of_claiming_success()
{
@@ -156,7 +167,7 @@ public class HealthFailoverButtonTests : BunitContext
Assert.Contains("no standby", cut.Markup, StringComparison.OrdinalIgnoreCase);
}
// ---- Site-pair failover (Task 10) ------------------------------------------
// ---- Site-pair failover ------------------------------------------
// Same control, SiteId set. The differences that matter: it calls the site path,
// and its confirmation must NOT claim the admin's own page will drop (it won't —
// the site is a different cluster).
@@ -175,6 +186,8 @@ public class HealthFailoverButtonTests : BunitContext
return host.FindComponent<CentralFailoverControl>();
}
/// <summary>Verifies that confirming on the site card triggers the site failover path.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Site_card_confirming_triggers_the_site_failover_path()
{
@@ -190,6 +203,8 @@ public class HealthFailoverButtonTests : BunitContext
await _failover.DidNotReceive().FailOverCentralAsync(Arg.Any<string>());
}
/// <summary>Verifies that the site card confirmation does not claim that this page will disconnect.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Site_card_confirmation_does_not_claim_this_page_disconnects()
{
@@ -210,6 +225,8 @@ public class HealthFailoverButtonTests : BunitContext
Arg.Any<string?>());
}
/// <summary>Verifies that the site card surfaces a refusal from the site.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Site_card_surfaces_a_refusal_from_the_site()
{
@@ -225,6 +242,8 @@ public class HealthFailoverButtonTests : BunitContext
Assert.Contains("No standby available", cut.Markup);
}
/// <summary>Verifies that the site card reports an unreachable site distinctly from a refusal.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Site_card_surfaces_an_unreachable_site_distinctly_from_a_refusal()
{