Files
ScadaBridge/tests/ZB.MOM.WW.ScadaBridge.CentralUI.PlaywrightTests/NavigationTests.cs
T
Joseph Doherty 513fa1aa16 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.
2026-10-07 15:05:49 -04:00

143 lines
7.2 KiB
C#

using Microsoft.Playwright;
namespace ZB.MOM.WW.ScadaBridge.CentralUI.PlaywrightTests;
[Collection("Playwright")]
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()
{
var page = await _fixture.NewAuthenticatedPageAsync();
// The nav sidebar should be visible with the brand. ToContainText, not
// ToHaveText: the brand also carries the accent mark glyph (▮).
await Expect(page.Locator(".brand")).ToContainTextAsync("ScadaBridge");
// The nav should contain "Dashboard" link (exact match to avoid "Health Dashboard")
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")]
[InlineData("LDAP Mappings", "/admin/ldap-mappings")]
public async Task AdminNavLinks_NavigateCorrectly(string linkText, string expectedPath)
{
var page = await _fixture.NewAuthenticatedPageAsync();
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")]
[InlineData("Notification Report", "/notifications/report")]
[InlineData("Notification KPIs", "/notifications/kpis")]
public async Task NotificationsNavLinks_NavigateCorrectly(string linkText, string expectedPath)
{
var page = await _fixture.NewAuthenticatedPageAsync();
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")]
[InlineData("Connections", "/design/connections")]
[InlineData("External Systems", "/design/external-systems")]
public async Task DesignNavLinks_NavigateCorrectly(string linkText, string expectedPath)
{
var page = await _fixture.NewAuthenticatedPageAsync();
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")]
public async Task DeploymentNavLinks_NavigateCorrectly(string linkText, string expectedPath)
{
var page = await _fixture.NewAuthenticatedPageAsync();
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")]
[InlineData("Parked Messages", "/monitoring/parked-messages")]
public async Task MonitoringNavLinks_NavigateCorrectly(string linkText, string expectedPath)
{
var page = await _fixture.NewAuthenticatedPageAsync();
await ClickNavAndWait(page, linkText, expectedPath);
}
// Maps each navigable route to the exact heading text rendered by that page.
private static readonly Dictionary<string, string> RouteHeadings = new()
{
["/admin/sites"] = "Site Management",
["/admin/api-keys"] = "API Key Management",
["/admin/ldap-mappings"] = "LDAP Group Mappings",
["/notifications/smtp"] = "SMTP Configuration",
["/notifications/lists"] = "Notification Lists",
["/notifications/report"] = "Notification Report",
["/notifications/kpis"] = "Notification KPIs",
["/design/templates"] = "Templates",
["/design/shared-scripts"] = "Shared Scripts",
["/design/connections"] = "Connections",
["/design/external-systems"] = "Integration Definitions",
["/deployment/topology"] = "Topology",
["/deployment/deployments"] = "Deployment Status",
["/monitoring/health"] = "Health Dashboard",
["/monitoring/event-logs"] = "Site Event Logs",
["/monitoring/parked-messages"] = "Parked Messages",
};
private static async Task ClickNavAndWait(IPage page, string linkText, string expectedPath)
{
// Sections are collapsed by default — open them so the link is in the DOM.
await PlaywrightFixture.ExpandAllNavSectionsAsync(page);
await page.Locator($"nav a:has-text('{linkText}')").ClickAsync();
await PlaywrightFixture.WaitForPathAsync(page, expectedPath);
Assert.Contains(expectedPath, page.Url);
// Verify the destination page actually rendered its heading (catches 500s
// and blank renders that a URL-only check would miss).
// Every mapped route renders its heading as an <h4> — tightened from the
// broader "h1, h4, h5" to prevent strict-mode violations if multiple
// heading elements match.
var expectedHeading = RouteHeadings[expectedPath];
await Assertions.Expect(page.Locator("h4", new() { HasText = expectedHeading })).ToBeVisibleAsync();
}
private static ILocatorAssertions Expect(ILocator locator) =>
Assertions.Expect(locator);
}