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
+8
-4
@@ -4,7 +4,7 @@ using ZB.MOM.WW.ScadaBridge.CentralUI.PlaywrightTests.Cluster;
|
||||
namespace ZB.MOM.WW.ScadaBridge.CentralUI.PlaywrightTests.Transport;
|
||||
|
||||
/// <summary>
|
||||
/// Happy-path end-to-end for the Transport Export wizard (Component #24, Task T21).
|
||||
/// Happy-path end-to-end for the Transport Export wizard.
|
||||
///
|
||||
/// <para>
|
||||
/// Drives the full four-step wizard at <c>/design/transport/export</c> against the
|
||||
@@ -40,11 +40,15 @@ public sealed class TransportExportTests
|
||||
{
|
||||
private readonly PlaywrightFixture _fixture;
|
||||
|
||||
/// <summary>Initializes the test class with the shared Playwright fixture.</summary>
|
||||
/// <param name="fixture">The shared Playwright fixture.</param>
|
||||
public TransportExportTests(PlaywrightFixture fixture)
|
||||
{
|
||||
_fixture = fixture;
|
||||
}
|
||||
|
||||
/// <summary>Verifies that exporting a throwaway template through the wizard reaches the download summary.</summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
[SkippableFact]
|
||||
public async Task ExportTemplate_ReachesDownloadSummary()
|
||||
{
|
||||
@@ -57,7 +61,7 @@ public sealed class TransportExportTests
|
||||
{
|
||||
var page = await _fixture.NewAuthenticatedPageAsync("multi-role", "password");
|
||||
await page.GotoAsync($"{PlaywrightFixture.BaseUrl}/design/transport/export");
|
||||
// Wait for Step-1 to render (OnInitializedAsync makes 8 repo calls over SignalR
|
||||
// Wait for step 1 to render (OnInitializedAsync makes 8 repo calls over SignalR
|
||||
// before the template tree appears — NetworkIdle is an unreliable proxy for this).
|
||||
await Assertions.Expect(page.Locator("[data-testid='group-templates']"))
|
||||
.ToBeVisibleAsync(new() { Timeout = 15_000 });
|
||||
@@ -85,8 +89,8 @@ public sealed class TransportExportTests
|
||||
|
||||
// ── STEP 2: Review ────────────────────────────────────────────────────────
|
||||
// The seed group lists the picked template; Next is always enabled here.
|
||||
// Scope the Next click to the Step-2 panel — identified by its unique
|
||||
// #include-deps toggle — so it cannot accidentally match a Step-1 button.
|
||||
// Scope the Next click to the step 2 panel — identified by its unique
|
||||
// #include-deps toggle — so it cannot accidentally match a step 1 button.
|
||||
await Assertions.Expect(page.Locator("[data-testid='seed-group']"))
|
||||
.ToBeVisibleAsync(new() { Timeout = 15_000 });
|
||||
await page.Locator("div:has(#include-deps) button.btn.btn-primary:has-text('Next')")
|
||||
|
||||
+13
-6
@@ -4,7 +4,7 @@ using ZB.MOM.WW.ScadaBridge.CentralUI.PlaywrightTests.Cluster;
|
||||
namespace ZB.MOM.WW.ScadaBridge.CentralUI.PlaywrightTests.Transport;
|
||||
|
||||
/// <summary>
|
||||
/// End-to-end round-trip for the Transport Import wizard (Component #24, Task T22).
|
||||
/// End-to-end round-trip for the Transport Import wizard (Transport component).
|
||||
///
|
||||
/// <para>
|
||||
/// The test exercises the full five-step Apply path at
|
||||
@@ -39,17 +39,21 @@ public sealed class TransportImportTests
|
||||
{
|
||||
private readonly PlaywrightFixture _fixture;
|
||||
|
||||
/// <summary>Initializes the test class with the shared Playwright fixture.</summary>
|
||||
/// <param name="fixture">The shared Playwright fixture providing browser and cluster access.</param>
|
||||
public TransportImportTests(PlaywrightFixture fixture)
|
||||
{
|
||||
_fixture = fixture;
|
||||
}
|
||||
|
||||
/// <summary>Verifies that importing a synthetic bundle applies it and shows the audit drill-in.</summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
[SkippableFact]
|
||||
public async Task ImportSyntheticBundle_AppliesAndShowsAuditDrillIn()
|
||||
{
|
||||
Skip.IfNot(await ClusterAvailability.IsAvailableAsync(), ClusterAvailability.SkipReason);
|
||||
|
||||
// The source-environment name doubles as the Step-4 confirm phrase, so it
|
||||
// The source-environment name doubles as the final-step confirm phrase, so it
|
||||
// must round-trip verbatim through the bundle manifest and back into the UI.
|
||||
var env = CliRunner.UniqueName("env");
|
||||
var tmplName = CliRunner.UniqueName("imp");
|
||||
@@ -84,7 +88,7 @@ public sealed class TransportImportTests
|
||||
// The bundle is encrypted (we exported with a passphrase), so the page
|
||||
// peeks the manifest with no passphrase, fails to decrypt, and shows the
|
||||
// encrypted-bundle notice instead of the (unencrypted-only) manifest
|
||||
// summary. Either way, the Step-1 Next button only renders once the file
|
||||
// summary. Either way, the first-step Next button only renders once the file
|
||||
// was read successfully — its appearance proves SetInputFiles worked.
|
||||
await Assertions.Expect(page.Locator("[data-testid='encrypted-bundle-notice']"))
|
||||
.ToBeVisibleAsync(new() { Timeout = 15_000 });
|
||||
@@ -175,6 +179,7 @@ public sealed class TransportImportTests
|
||||
/// deleted before import; teardown drops it by name prefix.
|
||||
/// </para>
|
||||
/// </summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
[SkippableFact]
|
||||
public async Task ImportWithWrongPassphrase_ShowsErrorAndStaysOnPassphraseStep()
|
||||
{
|
||||
@@ -242,8 +247,8 @@ public sealed class TransportImportTests
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// M8 Map step (#230): drive an import whose bundle carries a <c>Site</c>, so the
|
||||
/// preview surfaces a <see cref="RequiredSiteMapping"/> and the wizard's Step-3
|
||||
/// Map step: drive an import whose bundle carries a <c>Site</c>, so the
|
||||
/// preview surfaces a <see cref="RequiredSiteMapping"/> and the wizard's third-step
|
||||
/// <strong>Map</strong> sub-section (<c>[data-testid='map-section']</c>) renders.
|
||||
///
|
||||
/// <para>
|
||||
@@ -265,6 +270,7 @@ public sealed class TransportImportTests
|
||||
/// wizard.
|
||||
/// </para>
|
||||
/// </summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
[SkippableFact]
|
||||
public async Task ImportSiteBundle_RendersMapStep_AndMappingEnablesNext()
|
||||
{
|
||||
@@ -365,7 +371,7 @@ public sealed class TransportImportTests
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// M8 per-line diff (#230): drive an import where a bundled shared script's
|
||||
/// Per-line diff: drive an import where a bundled shared script's
|
||||
/// <c>Code</c> diverges from the destination's, so the preview classifies it
|
||||
/// <see cref="ConflictKind.Modified"/> and the row's "Field diff" carries a
|
||||
/// structured <c>lineDiff</c> — rendered by the <c>LineDiffView</c> component as a
|
||||
@@ -386,6 +392,7 @@ public sealed class TransportImportTests
|
||||
/// required because the line-diff block is not laid out until the disclosure opens.
|
||||
/// </para>
|
||||
/// </summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
[SkippableFact]
|
||||
public async Task ImportModifiedSharedScript_RendersPerLineDiff()
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user