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
@@ -13,7 +13,7 @@ using ExternalSystemForm = ZB.MOM.WW.ScadaBridge.CentralUI.Components.Pages.Desi
namespace ZB.MOM.WW.ScadaBridge.CentralUI.Tests.Design;
/// <summary>
/// Bundle D drill-in test (#23 M7-T12) for the External Systems edit page.
/// Drill-in test for the External Systems edit page.
/// The page-header chip routes operators into the central Audit Log
/// pre-filtered by Target = external-system name. Create mode has nothing
/// to drill into yet, so the link is suppressed.
@@ -22,6 +22,7 @@ public class ExternalSystemFormAuditDrillinTests : BunitContext
{
private readonly IExternalSystemRepository _repo = Substitute.For<IExternalSystemRepository>();
/// <summary>Initializes the test context with a substitute repository and test authentication.</summary>
public ExternalSystemFormAuditDrillinTests()
{
Services.AddSingleton(_repo);
@@ -38,6 +39,7 @@ public class ExternalSystemFormAuditDrillinTests : BunitContext
AuthorizationPolicies.AddScadaBridgeAuthorization(Services);
}
/// <summary>Verifies that the edit page shows a recent audit activity link whose target equals the system name.</summary>
[Fact]
public void EditPage_HasRecentAuditActivityLink_WithTargetEqualToSystemName()
{
@@ -57,6 +59,7 @@ public class ExternalSystemFormAuditDrillinTests : BunitContext
});
}
/// <summary>Verifies that the create page shows no recent audit activity link.</summary>
[Fact]
public void CreatePage_HasNoRecentAuditActivityLink()
{
@@ -70,10 +73,11 @@ public class ExternalSystemFormAuditDrillinTests : BunitContext
});
}
/// <summary>Verifies that the form renders a timeout seconds input with the gateway default helper text.</summary>
[Fact]
public void Form_RendersTimeoutSecondsInput_WithGatewayDefaultHelperText()
{
// PLAN-06 Task 12: the per-system TimeoutSeconds column (Task 8) needs a
// The per-system TimeoutSeconds column needs a
// Central UI form field so Design users can actually set it.
var cut = Render<ExternalSystemForm>();
@@ -84,6 +88,7 @@ public class ExternalSystemFormAuditDrillinTests : BunitContext
});
}
/// <summary>Verifies that saving a new system passes its timeout seconds to the repository.</summary>
[Fact]
public void SavingNewSystem_WithTimeoutSeconds_PassesTimeoutSecondsToRepository()
{
@@ -105,6 +110,7 @@ public class ExternalSystemFormAuditDrillinTests : BunitContext
});
}
/// <summary>Verifies that saving an edited system updates the timeout seconds on the existing record.</summary>
[Fact]
public void SavingEditedSystem_UpdatesTimeoutSecondsOnExisting()
{