Files
ScadaBridge/tests/ZB.MOM.WW.ScadaBridge.CentralUI.Tests/Design/SchemaLibraryPageTests.cs
T
Joseph Doherty 40944a0d04 feat(centralui): row 75 — Approve is caution amber, not destructive red
The Secured Writes page rendered Approve and Reject as IDENTICAL red buttons.
Row 28 fixed the labels but left the styling, and the styling was the worse
half: at the moment of a two-person-control decision the colour carried no
discriminating information at all, and the affirmative half of the control wore
the delete affordance.

Root cause is that `danger` was a two-state flag for a three-state concept, so a
consequential-but-not-destructive action had to choose between looking like a
delete and looking like the safe default. Adds the missing middle rung:

    DialogSeverity { Normal -> btn-primary, Caution -> btn-warning,
                     Destructive -> btn-danger }

DECISION. Approve -> Caution (amber): approving executes a real write to live
plant equipment, so it is not a benign primary action, but it is not destroying
anything either. Reject KEEPS Destructive (red): it is terminal and irreversible
for the request — the Operator must resubmit — and holding it red is what keeps
the two opposite decisions visually distinct now that Approve is amber. Dropping
Reject to neutral was considered and rejected: it would invert the bias, making
declining look like the safe default. Colour is never the only signal — both
buttons carry their verb.

Only Destructive inherits the row-28 "Delete" label fallback; an unlabelled
Caution reads "Confirm", since a caution action is by definition not a delete —
otherwise row 28 would come back through the new door.

ADDITIVE OVERLOAD, deliberately. The boolean form stays the signature for all
~34 existing call sites, which are genuinely two-state, so nothing in src/
outside SecuredWrites.razor changed. Adding a fifth optional parameter to the
boolean form instead would have silently un-matched every existing four-argument
NSubstitute stub — the exact row-28 gotcha (null Task, caller NREs, no compile
error). The overload cannot: the only breakage was six hand-written IDialogService
fakes failing to compile, which is the loud failure mode. That gotcha did land
once, in SecuredWritesTests' own stub, and is now stubbed on both overloads with
a comment saying why.

DialogState's `bool Danger` became `DialogSeverity Severity` rather than gaining
a second field — it is read only by DialogHost, and one field cannot disagree
with itself.

Fail-before, both halves:
  - Approve call site reverted to `danger: true` -> both new Approve pins fail.
  - Caution remapped to btn-danger in DialogHost -> the amber styling pin fails.

Tests: DialogSeverityStylingTests renders the REAL DialogService behind a real
DialogHost (FailoverConfirmLabelTests' harness), so it pins what the user sees,
not what an argument was — all three severities, both label fallbacks, and the
boolean adapter. SecuredWritesTests pins that the page asks for Caution, with a
negative control that it did NOT also go through the boolean form (without which
the assertion would pass on a call site left at danger:true). Reject's red is
pinned too, so a later "make this page less alarming" pass cannot flatten both
to one colour.

No Playwright selectors needed updating — the suite has no Secured Writes
coverage, and no `.btn-danger` selector elsewhere targets this page.

Docs: Component-CentralUI.md gains the severity contract under Technology (next
to the row-28 label contract) plus the decision on the Secured Writes section.

CentralUI.Tests: 1055/1055 green.
2026-08-15 21:33:08 -04:00

233 lines
9.9 KiB
C#

using System.Security.Claims;
using Bunit;
using Microsoft.AspNetCore.Components.Authorization;
using Microsoft.Extensions.DependencyInjection;
using NSubstitute;
using ZB.MOM.WW.ScadaBridge.CentralUI.Components.Shared;
using ZB.MOM.WW.ScadaBridge.CentralUI.Services;
using ZB.MOM.WW.ScadaBridge.Commons.Entities.Schemas;
using ZB.MOM.WW.ScadaBridge.Security;
using SchemaLibraryPage = ZB.MOM.WW.ScadaBridge.CentralUI.Components.Pages.Design.SchemaLibrary;
namespace ZB.MOM.WW.ScadaBridge.CentralUI.Tests.Design;
/// <summary>
/// bUnit tests for the Schema Library page (M9-T32c). The page lists the reusable named
/// JSON-Schema library entries, authors create/edit via the shared <c>SchemaBuilder</c>
/// component, and deletes with a confirm — every mutation dispatched through
/// <see cref="ISchemaLibraryService"/> (the guard-running ManagementActor path), never a
/// direct repo write. The service is substituted so the tests capture the dispatched
/// commands and simulate success / guard-error responses without a real ManagementActor.
/// </summary>
public class SchemaLibraryPageTests : BunitContext
{
private readonly ISchemaLibraryService _service = Substitute.For<ISchemaLibraryService>();
public SchemaLibraryPageTests()
{
Services.AddSingleton(_service);
Services.AddSingleton<IDialogService>(new AlwaysConfirmDialogService());
AddTestAuth();
// Default: empty library. Tests that need rows override this.
_service.ListAsync(Arg.Any<CancellationToken>())
.Returns(Task.FromResult<IReadOnlyList<SharedSchema>>(new List<SharedSchema>()));
}
private void AddTestAuth()
{
var claims = new[]
{
new Claim(JwtTokenService.UsernameClaimType, "tester"),
new Claim(JwtTokenService.RoleClaimType, "Designer"),
};
var user = new ClaimsPrincipal(new ClaimsIdentity(claims, "TestAuth"));
Services.AddSingleton<AuthenticationStateProvider>(new TestAuthStateProvider(user));
Services.AddAuthorizationCore();
}
private void SeedSchemas(params SharedSchema[] schemas) =>
_service.ListAsync(Arg.Any<CancellationToken>())
.Returns(Task.FromResult<IReadOnlyList<SharedSchema>>(schemas.ToList()));
[Fact]
public void Renders_EmptyState_WhenNoSchemas()
{
var cut = Render<SchemaLibraryPage>();
cut.WaitForAssertion(() =>
Assert.Contains("No library schemas defined", cut.Markup));
}
[Fact]
public void Lists_ExistingSchemas_WithLibReference()
{
SeedSchemas(
new SharedSchema { Id = 1, Name = "Address", Scope = "global", SchemaJson = "{\"type\":\"object\"}" },
new SharedSchema { Id = 2, Name = "GeoPoint", SchemaJson = "{\"type\":\"object\"}" });
var cut = Render<SchemaLibraryPage>();
cut.WaitForAssertion(() =>
{
Assert.Contains("Address", cut.Markup);
Assert.Contains("GeoPoint", cut.Markup);
// The list surfaces the lib:Name reference designers paste into a $ref.
Assert.Contains("lib:Address", cut.Markup);
});
}
[Fact]
public void NewSchema_OpensEditor_WithSchemaBuilder()
{
var cut = Render<SchemaLibraryPage>();
cut.WaitForState(() => cut.Markup.Contains("No library schemas defined"));
cut.FindAll("button").First(b => b.TextContent.Contains("New Schema")).Click();
// The editor card mounts with a name field and the SchemaBuilder component.
Assert.Contains("New Schema", cut.Markup);
Assert.NotEmpty(cut.FindAll("input")); // name / scope inputs
Assert.NotNull(cut.FindComponent<SchemaBuilder>());
}
[Fact]
public void Create_DispatchesCreateCommand_WithNameAndSchema()
{
_service.CreateAsync(Arg.Any<string>(), Arg.Any<string?>(), Arg.Any<string>(), Arg.Any<CancellationToken>())
.Returns(Task.FromResult(SchemaLibraryActionResult.Ok()));
var cut = Render<SchemaLibraryPage>();
cut.WaitForState(() => cut.Markup.Contains("No library schemas defined"));
cut.FindAll("button").First(b => b.TextContent.Contains("New Schema")).Click();
// Type a name and save (the SchemaBuilder seeds a default object schema).
cut.FindAll("input").First().Change("Address");
cut.FindAll("button").First(b => b.TextContent.Trim() == "Save").Click();
cut.WaitForAssertion(() =>
_service.Received(1).CreateAsync(
"Address", Arg.Any<string?>(), Arg.Any<string>(), Arg.Any<CancellationToken>()));
}
[Fact]
public void Create_GuardError_IsShownInline_AndEditorStaysOpen()
{
_service.CreateAsync(Arg.Any<string>(), Arg.Any<string?>(), Arg.Any<string>(), Arg.Any<CancellationToken>())
.Returns(Task.FromResult(SchemaLibraryActionResult.Fail("A schema named 'Address' already exists.")));
var cut = Render<SchemaLibraryPage>();
cut.WaitForState(() => cut.Markup.Contains("No library schemas defined"));
cut.FindAll("button").First(b => b.TextContent.Contains("New Schema")).Click();
cut.FindAll("input").First().Change("Address");
cut.FindAll("button").First(b => b.TextContent.Trim() == "Save").Click();
cut.WaitForAssertion(() =>
{
Assert.Contains("already exists", cut.Markup);
// Editor stays open (Save button still present) on a guard error.
Assert.Contains(cut.FindAll("button"), b => b.TextContent.Trim() == "Save");
});
}
[Fact]
public void EmptyName_DoesNotDispatch()
{
var cut = Render<SchemaLibraryPage>();
cut.WaitForState(() => cut.Markup.Contains("No library schemas defined"));
cut.FindAll("button").First(b => b.TextContent.Contains("New Schema")).Click();
// Leave name blank and save.
cut.FindAll("button").First(b => b.TextContent.Trim() == "Save").Click();
cut.WaitForAssertion(() => Assert.Contains("name is required", cut.Markup));
_service.DidNotReceive().CreateAsync(
Arg.Any<string>(), Arg.Any<string?>(), Arg.Any<string>(), Arg.Any<CancellationToken>());
}
[Fact]
public void Delete_ConfirmsThenDispatchesDeleteCommand_AndReloads()
{
SeedSchemas(new SharedSchema { Id = 7, Name = "Address", SchemaJson = "{\"type\":\"object\"}" });
_service.DeleteAsync(Arg.Any<int>(), Arg.Any<CancellationToken>())
.Returns(Task.FromResult(SchemaLibraryActionResult.Ok()));
var cut = Render<SchemaLibraryPage>();
cut.WaitForState(() => cut.Markup.Contains("Address"));
cut.FindAll("tbody tr button").First(b => b.TextContent.Contains("Delete")).Click();
cut.WaitForAssertion(() =>
{
_service.Received(1).DeleteAsync(7, Arg.Any<CancellationToken>());
// Reload re-invokes the list query (once on init, once after delete).
_service.Received(2).ListAsync(Arg.Any<CancellationToken>());
});
}
[Fact]
public void Edit_OpensEditor_AndDispatchesUpdateCommand()
{
SeedSchemas(new SharedSchema { Id = 9, Name = "Address", Scope = "us", SchemaJson = "{\"type\":\"object\"}" });
_service.UpdateAsync(Arg.Any<int>(), Arg.Any<string>(), Arg.Any<string?>(), Arg.Any<string>(), Arg.Any<CancellationToken>())
.Returns(Task.FromResult(SchemaLibraryActionResult.Ok()));
var cut = Render<SchemaLibraryPage>();
cut.WaitForState(() => cut.Markup.Contains("Address"));
cut.FindAll("tbody tr button").First(b => b.TextContent.Contains("Edit")).Click();
Assert.Contains("Edit Schema: Address", cut.Markup);
cut.FindAll("button").First(b => b.TextContent.Trim() == "Save").Click();
cut.WaitForAssertion(() =>
_service.Received(1).UpdateAsync(
9, "Address", Arg.Any<string?>(), Arg.Any<string>(), Arg.Any<CancellationToken>()));
}
[Fact]
public void Editing_DisablesRowActions_SoTheRowUnderEditCannotBeDeleted()
{
// #260: while the edit form is open the list still shows the row, but its
// Edit/Delete actions must be disabled so the row under edit (or a sibling)
// can't be deleted out from under the form.
SeedSchemas(new SharedSchema { Id = 9, Name = "Address", Scope = "us", SchemaJson = "{\"type\":\"object\"}" });
var cut = Render<SchemaLibraryPage>();
cut.WaitForState(() => cut.Markup.Contains("Address"));
cut.FindAll("tbody tr button").First(b => b.TextContent.Contains("Edit")).Click();
Assert.Contains("Edit Schema: Address", cut.Markup);
// Every row action button is now disabled while the editor is open.
var rowButtons = cut.FindAll("tbody tr button");
Assert.NotEmpty(rowButtons);
Assert.All(rowButtons, b => Assert.True(b.HasAttribute("disabled")));
}
/// <summary>A dialog service that auto-confirms, so the delete path runs end-to-end.</summary>
private sealed class AlwaysConfirmDialogService : IDialogService
{
public Task<bool> ConfirmAsync(string title, string message, bool danger = false, string? confirmLabel = null)
=> Task.FromResult(true);
// Register row 75 added a DialogSeverity overload. This stub auto-confirms
// regardless of severity — it exists to let action paths run end to end, not to
// assert anything about styling.
public Task<bool> ConfirmAsync(string title, string message, DialogSeverity severity, string? confirmLabel = null)
=> Task.FromResult(true);
public Task<string?> PromptAsync(
string title, string label, string initialValue = "", string? placeholder = null)
=> Task.FromResult<string?>(null);
public Task<TResult?> ShowAsync<TResult>(
string title,
Microsoft.AspNetCore.Components.RenderFragment<DialogContext<TResult>> body,
string? size = null)
=> Task.FromResult<TResult?>(default);
}
}