Files
ScadaBridge/tests/ZB.MOM.WW.ScadaBridge.CentralUI.PlaywrightTests/RoleNavigationTests.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

269 lines
12 KiB
C#

using Microsoft.Playwright;
namespace ZB.MOM.WW.ScadaBridge.CentralUI.PlaywrightTests;
/// <summary>
/// Verifies that navigation sections and links are shown/hidden based on the user's role.
///
/// LDAP test users (all passwords: "password"):
/// admin → Admin only
/// designer → Design only
/// deployer → Deployment only
/// multi-role → Admin + Design + Deployment
///
/// Nav structure (from NavMenu.razor):
/// All authenticated: Dashboard, Health Dashboard
/// Admin: LDAP Mappings, Sites, API Keys, SMTP Configuration, Audit Log
/// Design: Templates, Shared Scripts, Connections, External Systems
/// Deployment: Topology, Deployments, Debug View, Event Logs, Parked Messages
/// </summary>
[Collection("Playwright")]
public class RoleNavigationTests
{
private readonly PlaywrightFixture _fixture;
/// <summary>Initializes the test class with the shared Playwright fixture.</summary>
/// <param name="fixture">The shared Playwright fixture.</param>
public RoleNavigationTests(PlaywrightFixture fixture)
{
_fixture = fixture;
}
// ── Admin-only user ─────────────────────────────────────────────
/// <summary>Verifies that the admin user sees the Admin navigation section.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task AdminUser_SeesAdminSection()
{
var page = await _fixture.NewAuthenticatedPageAsync("admin", "password");
await AssertNavLinkVisible(page, "LDAP Mappings");
await AssertNavLinkVisible(page, "Sites");
await AssertNavLinkVisible(page, "API Keys");
await AssertNavLinkVisible(page, "SMTP Configuration");
await AssertNavLinkVisible(page, "Audit Log");
}
/// <summary>Verifies that the admin user does not see the Design navigation section.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task AdminUser_DoesNotSeeDesignSection()
{
var page = await _fixture.NewAuthenticatedPageAsync("admin", "password");
await AssertNavLinkHidden(page, "Templates");
await AssertNavLinkHidden(page, "Shared Scripts");
await AssertNavLinkHidden(page, "Connections");
await AssertNavLinkHidden(page, "External Systems");
}
/// <summary>Verifies that the admin user does not see the Deployment navigation section.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task AdminUser_DoesNotSeeDeploymentSection()
{
var page = await _fixture.NewAuthenticatedPageAsync("admin", "password");
await AssertNavLinkHidden(page, "Topology");
await AssertNavLinkHidden(page, "Deployments");
await AssertNavLinkHidden(page, "Debug View");
}
/// <summary>Verifies that the admin user sees the Health Dashboard but not Deployment monitoring.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task AdminUser_SeesHealthDashboard_NotDeploymentMonitoring()
{
var page = await _fixture.NewAuthenticatedPageAsync("admin", "password");
// Health Dashboard is all-roles; Event Logs and Parked Messages are
// Deployment-role only (NavMenu.razor / Component-CentralUI).
await AssertNavLinkVisible(page, "Health Dashboard");
await AssertNavLinkHidden(page, "Event Logs");
await AssertNavLinkHidden(page, "Parked Messages");
}
// ── Design-only user ────────────────────────────────────────────
/// <summary>Verifies that the design user sees the Design navigation section.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task DesignUser_SeesDesignSection()
{
var page = await _fixture.NewAuthenticatedPageAsync("designer", "password");
await AssertNavLinkVisible(page, "Templates");
await AssertNavLinkVisible(page, "Shared Scripts");
await AssertNavLinkVisible(page, "Connections");
await AssertNavLinkVisible(page, "External Systems");
}
/// <summary>Verifies that the design user does not see the Admin navigation section.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task DesignUser_DoesNotSeeAdminSection()
{
var page = await _fixture.NewAuthenticatedPageAsync("designer", "password");
await AssertNavLinkHidden(page, "LDAP Mappings");
await AssertNavLinkHidden(page, "Sites");
await AssertNavLinkHidden(page, "API Keys");
await AssertNavLinkHidden(page, "SMTP Configuration");
await AssertNavLinkHidden(page, "Audit Log");
}
/// <summary>Verifies that the design user does not see the Deployment navigation section.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task DesignUser_DoesNotSeeDeploymentSection()
{
var page = await _fixture.NewAuthenticatedPageAsync("designer", "password");
await AssertNavLinkHidden(page, "Topology");
await AssertNavLinkHidden(page, "Deployments");
await AssertNavLinkHidden(page, "Debug View");
}
/// <summary>Verifies that the design user sees the Health Dashboard but not Deployment monitoring or audit links.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task DesignUser_SeesHealthDashboard_NotDeploymentMonitoringOrAudit()
{
var page = await _fixture.NewAuthenticatedPageAsync("designer", "password");
// A Design-only user sees the all-roles Health Dashboard but not the
// Deployment-gated Event Logs / Parked Messages, nor the Admin Audit Log.
await AssertNavLinkVisible(page, "Health Dashboard");
await AssertNavLinkHidden(page, "Event Logs");
await AssertNavLinkHidden(page, "Parked Messages");
await AssertNavLinkHidden(page, "Audit Log");
}
// ── Deployment-only user ────────────────────────────────────────
/// <summary>Verifies that the deployment user sees the Deployment navigation section.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task DeploymentUser_SeesDeploymentSection()
{
var page = await _fixture.NewAuthenticatedPageAsync("deployer", "password");
await AssertNavLinkVisible(page, "Topology");
await AssertNavLinkVisible(page, "Deployments");
await AssertNavLinkVisible(page, "Debug View");
}
/// <summary>Verifies that the deployment user does not see the Admin navigation section.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task DeploymentUser_DoesNotSeeAdminSection()
{
var page = await _fixture.NewAuthenticatedPageAsync("deployer", "password");
await AssertNavLinkHidden(page, "LDAP Mappings");
await AssertNavLinkHidden(page, "Sites");
await AssertNavLinkHidden(page, "API Keys");
await AssertNavLinkHidden(page, "SMTP Configuration");
await AssertNavLinkHidden(page, "Audit Log");
}
/// <summary>Verifies that the deployment user does not see the Design navigation section.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task DeploymentUser_DoesNotSeeDesignSection()
{
var page = await _fixture.NewAuthenticatedPageAsync("deployer", "password");
await AssertNavLinkHidden(page, "Templates");
await AssertNavLinkHidden(page, "Shared Scripts");
await AssertNavLinkHidden(page, "Connections");
await AssertNavLinkHidden(page, "External Systems");
}
/// <summary>Verifies that the deployment user sees monitoring links but not the configuration audit log.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task DeploymentUser_SeesMonitoringButNotConfigurationAuditLog()
{
var page = await _fixture.NewAuthenticatedPageAsync("deployer", "password");
// Event Logs and Parked Messages are Deployment-role gated, so a
// Deployment user sees them; Configuration Audit Log is Admin-only.
await AssertNavLinkVisible(page, "Health Dashboard");
await AssertNavLinkVisible(page, "Event Logs");
await AssertNavLinkVisible(page, "Parked Messages");
await AssertNavLinkHidden(page, "Configuration Audit Log");
}
// ── Multi-role user (Admin + Design + Deployment) ───────────────
/// <summary>Verifies that the multi-role user sees every navigation section.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task MultiRoleUser_SeesAllSections()
{
var page = await _fixture.NewAuthenticatedPageAsync("multi-role", "password");
// Admin
await AssertNavLinkVisible(page, "LDAP Mappings");
await AssertNavLinkVisible(page, "Sites");
await AssertNavLinkVisible(page, "API Keys");
await AssertNavLinkVisible(page, "SMTP Configuration");
await AssertNavLinkVisible(page, "Audit Log");
// Design
await AssertNavLinkVisible(page, "Templates");
await AssertNavLinkVisible(page, "Shared Scripts");
await AssertNavLinkVisible(page, "Connections");
await AssertNavLinkVisible(page, "External Systems");
// Deployment
await AssertNavLinkVisible(page, "Topology");
await AssertNavLinkVisible(page, "Deployments");
await AssertNavLinkVisible(page, "Debug View");
// Monitoring
await AssertNavLinkVisible(page, "Health Dashboard");
await AssertNavLinkVisible(page, "Event Logs");
await AssertNavLinkVisible(page, "Parked Messages");
}
// ── All users see Dashboard ─────────────────────────────────────
/// <summary>Verifies that every user sees the Dashboard link.</summary>
/// <param name="username">The username to sign in with.</param>
/// <returns>A task that represents the asynchronous operation.</returns>
[Theory]
[InlineData("admin")]
[InlineData("designer")]
[InlineData("deployer")]
[InlineData("multi-role")]
public async Task AllUsers_SeeDashboardLink(string username)
{
var page = await _fixture.NewAuthenticatedPageAsync(username, "password");
var dashboardLink = page.GetByRole(AriaRole.Link, new() { Name = "Dashboard", Exact = true });
await Assertions.Expect(dashboardLink).ToBeVisibleAsync();
}
// ── Helpers ─────────────────────────────────────────────────────
private static async Task AssertNavLinkVisible(IPage page, string linkText)
{
// Sections are collapsed by default — expand them so a present link is
// in the DOM. Idempotent: already-expanded sections are skipped.
await PlaywrightFixture.ExpandAllNavSectionsAsync(page);
var locator = page.Locator($"nav a:has-text('{linkText}')");
var count = await locator.CountAsync();
Assert.True(count > 0, $"Expected nav link '{linkText}' to be visible, but it was not found");
}
private static async Task AssertNavLinkHidden(IPage page, string linkText)
{
var locator = page.Locator($"nav a:has-text('{linkText}')");
var count = await locator.CountAsync();
Assert.True(count == 0, $"Expected nav link '{linkText}' to be hidden, but it was found");
}
}