dohertj2/ScadaBridge
1
0
Fork 0
Code Issues 2 Pull Requests Actions Packages Projects Releases Wiki Activity

docs(tests): fix CommentChecker findings across tests/ — 13,392 → 0 (repo-wide scan clean)

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files
tests/ZB.MOM.WW.ScadaBridge.CentralUI.PlaywrightTests/NavigationTests.cs
+24
View File
@@ -7,11 +7,15 @@ public class NavigationTests
{
private readonly PlaywrightFixture _fixture;
/// <summary>Initializes the test class with the shared Playwright fixture.</summary>
/// <param name="fixture">The shared Playwright fixture that provides the browser and login helpers.</param>
public NavigationTests(PlaywrightFixture fixture)
{
_fixture = fixture;
}
/// <summary>Verifies that the dashboard is visible after logging in.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Dashboard_IsVisibleAfterLogin()
{
@@ -24,6 +28,10 @@ public class NavigationTests
await Expect(page.GetByRole(AriaRole.Link, new() { Name = "Dashboard", Exact = true })).ToBeVisibleAsync();
}
/// <summary>Verifies that each Admin navigation link leads to its expected page.</summary>
/// <param name="linkText">The visible text of the navigation link to click.</param>
/// <param name="expectedPath">The URL path expected after navigation.</param>
/// <returns>A task that represents the asynchronous operation.</returns>
[Theory]
[InlineData("Sites", "/admin/sites")]
[InlineData("API Keys", "/admin/api-keys")]
@@ -34,6 +42,10 @@ public class NavigationTests
await ClickNavAndWait(page, linkText, expectedPath);
}
/// <summary>Verifies that each Notifications navigation link leads to its expected page.</summary>
/// <param name="linkText">The visible text of the navigation link to click.</param>
/// <param name="expectedPath">The URL path expected after navigation.</param>
/// <returns>A task that represents the asynchronous operation.</returns>
[Theory]
[InlineData("SMTP Configuration", "/notifications/smtp")]
[InlineData("Notification Lists", "/notifications/lists")]
@@ -45,6 +57,10 @@ public class NavigationTests
await ClickNavAndWait(page, linkText, expectedPath);
}
/// <summary>Verifies that each Design navigation link leads to its expected page.</summary>
/// <param name="linkText">The visible text of the navigation link to click.</param>
/// <param name="expectedPath">The URL path expected after navigation.</param>
/// <returns>A task that represents the asynchronous operation.</returns>
[Theory]
[InlineData("Templates", "/design/templates")]
[InlineData("Shared Scripts", "/design/shared-scripts")]
@@ -56,6 +72,10 @@ public class NavigationTests
await ClickNavAndWait(page, linkText, expectedPath);
}
/// <summary>Verifies that each Deployment navigation link leads to its expected page.</summary>
/// <param name="linkText">The visible text of the navigation link to click.</param>
/// <param name="expectedPath">The URL path expected after navigation.</param>
/// <returns>A task that represents the asynchronous operation.</returns>
[Theory]
[InlineData("Topology", "/deployment/topology")]
[InlineData("Deployments", "/deployment/deployments")]
@@ -65,6 +85,10 @@ public class NavigationTests
await ClickNavAndWait(page, linkText, expectedPath);
}
/// <summary>Verifies that each Monitoring navigation link leads to its expected page.</summary>
/// <param name="linkText">The visible text of the navigation link to click.</param>
/// <param name="expectedPath">The URL path expected after navigation.</param>
/// <returns>A task that represents the asynchronous operation.</returns>
[Theory]
[InlineData("Health Dashboard", "/monitoring/health")]
[InlineData("Event Logs", "/monitoring/event-logs")]