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

feat(m9/T25): connection live-status indicators on the design page

Browse Source
This commit is contained in:
Joseph Doherty
2026-06-18 11:03:22 -04:00
parent e3bc19c673
commit efe3ada03d
6 changed files with 393 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tests/ZB.MOM.WW.ScadaBridge.CentralUI.Tests/DataConnectionsPageTests.cs
+47
View File
@@ -5,8 +5,10 @@ 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.Sites;
using ZB.MOM.WW.ScadaBridge.Commons.Interfaces.Repositories;
using ZB.MOM.WW.ScadaBridge.Commons.Types.Enums;
using DataConnectionsPage = ZB.MOM.WW.ScadaBridge.CentralUI.Components.Pages.Design.DataConnections;
namespace ZB.MOM.WW.ScadaBridge.CentralUI.Tests;
@@ -19,15 +21,26 @@ namespace ZB.MOM.WW.ScadaBridge.CentralUI.Tests;
public class DataConnectionsPageTests : BunitContext
{
private readonly ISiteRepository _siteRepo = Substitute.For<ISiteRepository>();
// M9-T25: the design page now injects IConnectionHealthQueryService to render
// per-connection live health badges. A substitute defaulting to an empty map
// keeps every existing test green (no badge / unknown state when no report).
private readonly IConnectionHealthQueryService _healthQuery =
Substitute.For<IConnectionHealthQueryService>();
public DataConnectionsPageTests()
{
Services.AddSingleton(_siteRepo);
Services.AddSingleton(_healthQuery);
// Satisfy the page's [Inject] IDialogService — the host that actually
// renders the dialog lives in MainLayout, not in bUnit's render scope.
Services.AddScoped<IDialogService, DialogService>();
AddTestAuth();
// Default: no health known. Tests that assert badge state override this.
_healthQuery.GetConnectionHealthAsync(Arg.Any<CancellationToken>())
.Returns(Task.FromResult<IReadOnlyDictionary<int, ConnectionHealth>>(
new Dictionary<int, ConnectionHealth>()));
JSInterop.Setup<string?>("treeviewStorage.load", _ => true).SetResult(null);
JSInterop.SetupVoid("treeviewStorage.save", _ => true);
}
@@ -162,4 +175,38 @@ public class DataConnectionsPageTests : BunitContext
Assert.Contains("/design/connections", routes);
Assert.Contains("/design/data-connections", routes);
}
[Fact]
public void ConnectionNode_RendersLiveHealthBadge_MatchingStatus()
{
// M9-T25: a connection whose live health is Connected gets the success
// health badge next to its node; a Disconnected one gets the danger badge.
SeedRepos(
sites: new[] { new Site("Plant-A", "plant-a") { Id = 1 } },
connections: new[]
{
new DataConnection("PLC-1", "OpcUa", 1) { Id = 100 },
new DataConnection("RTU-9", "Custom", 1) { Id = 200 }
});
_healthQuery.GetConnectionHealthAsync(Arg.Any<CancellationToken>())
.Returns(Task.FromResult<IReadOnlyDictionary<int, ConnectionHealth>>(
new Dictionary<int, ConnectionHealth>
{
[100] = ConnectionHealth.Connected,
[200] = ConnectionHealth.Disconnected,
}));
var cut = Render<DataConnectionsPage>();
FindToggleForLabel(cut, "Plant-A")!.Click();
// Each connection node carries a status badge keyed by connection id so the
// assertion targets the right node regardless of tree ordering.
var connectedBadge = cut.Find("[data-test='conn-health-100']");
Assert.Contains("bg-success", connectedBadge.GetAttribute("class"));
Assert.Contains("Connected", connectedBadge.TextContent);
var disconnectedBadge = cut.Find("[data-test='conn-health-200']");
Assert.Contains("bg-danger", disconnectedBadge.GetAttribute("class"));
Assert.Contains("Disconnected", disconnectedBadge.TextContent);
}
}
tests/ZB.MOM.WW.ScadaBridge.CentralUI.Tests/Services/ConnectionHealthQueryServiceTests.cs
+152
View File
@@ -0,0 +1,152 @@
using NSubstitute;
using ZB.MOM.WW.ScadaBridge.CentralUI.Services;
using ZB.MOM.WW.ScadaBridge.Commons.Entities.Sites;
using ZB.MOM.WW.ScadaBridge.Commons.Interfaces.Repositories;
using ZB.MOM.WW.ScadaBridge.Commons.Messages.Health;
using ZB.MOM.WW.ScadaBridge.Commons.Types;
using ZB.MOM.WW.ScadaBridge.Commons.Types.Enums;
using ZB.MOM.WW.ScadaBridge.HealthMonitoring;
namespace ZB.MOM.WW.ScadaBridge.CentralUI.Tests.Services;
/// <summary>
/// M9-T25: unit tests for <see cref="ConnectionHealthQueryService"/>, which projects
/// the site health reports' name-keyed <see cref="SiteHealthReport.DataConnectionStatuses"/>
/// onto a connection-id → <see cref="ConnectionHealth"/> map for the design
/// DataConnections page. The site repository + health aggregator are substituted so
/// the name→id resolution + missing-report / unknown-name tolerance are exercised
/// without any EF Core or cluster traffic.
/// </summary>
public sealed class ConnectionHealthQueryServiceTests
{
private readonly ISiteRepository _siteRepo = Substitute.For<ISiteRepository>();
private readonly ICentralHealthAggregator _aggregator = Substitute.For<ICentralHealthAggregator>();
private ConnectionHealthQueryService CreateService() => new(_siteRepo, _aggregator);
private void SeedRepos(IEnumerable<Site> sites, IEnumerable<DataConnection> connections)
{
_siteRepo.GetAllSitesAsync(Arg.Any<CancellationToken>())
.Returns(Task.FromResult<IReadOnlyList<Site>>(sites.ToList()));
_siteRepo.GetAllDataConnectionsAsync(Arg.Any<CancellationToken>())
.Returns(Task.FromResult<IReadOnlyList<DataConnection>>(connections.ToList()));
}
private static SiteHealthState StateWith(
string siteIdentifier,
params (string Name, ConnectionHealth Health)[] statuses)
{
var dict = statuses.ToDictionary(s => s.Name, s => s.Health);
return new SiteHealthState
{
SiteId = siteIdentifier,
IsOnline = true,
LatestReport = MakeReport(siteIdentifier, dict),
};
}
private static SiteHealthReport MakeReport(
string siteIdentifier,
IReadOnlyDictionary<string, ConnectionHealth> statuses) =>
new(
SiteId: siteIdentifier,
SequenceNumber: 1,
ReportTimestamp: DateTimeOffset.UtcNow,
DataConnectionStatuses: statuses,
TagResolutionCounts: new Dictionary<string, TagResolutionStatus>(),
ScriptErrorCount: 0,
AlarmEvaluationErrorCount: 0,
StoreAndForwardBufferDepths: new Dictionary<string, int>(),
DeadLetterCount: 0,
DeployedInstanceCount: 0,
EnabledInstanceCount: 0,
DisabledInstanceCount: 0);
[Fact]
public async Task Maps_ConnectionNameStatuses_ToConnectionIds()
{
var site = new Site("Plant-A", "plant-a") { Id = 1 };
var plc1 = new DataConnection("PLC-1", "OpcUa", 1) { Id = 100 };
var rtu9 = new DataConnection("RTU-9", "Custom", 1) { Id = 200 };
SeedRepos(new[] { site }, new[] { plc1, rtu9 });
_aggregator.GetSiteState("plant-a").Returns(
StateWith("plant-a",
("PLC-1", ConnectionHealth.Connected),
("RTU-9", ConnectionHealth.Disconnected)));
var map = await CreateService().GetConnectionHealthAsync();
Assert.Equal(ConnectionHealth.Connected, map[100]);
Assert.Equal(ConnectionHealth.Disconnected, map[200]);
Assert.Equal(2, map.Count);
}
[Fact]
public async Task MissingReport_YieldsNoEntriesForThatSite()
{
var site = new Site("Plant-A", "plant-a") { Id = 1 };
var plc1 = new DataConnection("PLC-1", "OpcUa", 1) { Id = 100 };
SeedRepos(new[] { site }, new[] { plc1 });
// No state tracked for the site yet (just-started central / no report).
_aggregator.GetSiteState("plant-a").Returns((SiteHealthState?)null);
var map = await CreateService().GetConnectionHealthAsync();
Assert.Empty(map);
}
[Fact]
public async Task StateWithoutLatestReport_YieldsNoEntries()
{
var site = new Site("Plant-A", "plant-a") { Id = 1 };
var plc1 = new DataConnection("PLC-1", "OpcUa", 1) { Id = 100 };
SeedRepos(new[] { site }, new[] { plc1 });
// Heartbeat-only state: site is tracked but has not sent a full report.
_aggregator.GetSiteState("plant-a").Returns(
new SiteHealthState { SiteId = "plant-a", IsOnline = true, LatestReport = null });
var map = await CreateService().GetConnectionHealthAsync();
Assert.Empty(map);
}
[Fact]
public async Task UnknownConnectionName_IsSkipped()
{
var site = new Site("Plant-A", "plant-a") { Id = 1 };
var plc1 = new DataConnection("PLC-1", "OpcUa", 1) { Id = 100 };
SeedRepos(new[] { site }, new[] { plc1 });
// Report references a connection name with no matching DataConnection row
// (e.g. a connection deleted centrally but still live at the site).
_aggregator.GetSiteState("plant-a").Returns(
StateWith("plant-a",
("PLC-1", ConnectionHealth.Connected),
("GHOST", ConnectionHealth.Error)));
var map = await CreateService().GetConnectionHealthAsync();
Assert.Equal(ConnectionHealth.Connected, map[100]);
Assert.Single(map);
}
[Fact]
public async Task ResolvesNamesPerSite_NotGloballyAmbiguous()
{
// Two sites each own a connection named "PLC-1". The name→id resolution
// must be scoped to the report's own site so the right id is stamped.
var siteA = new Site("Plant-A", "plant-a") { Id = 1 };
var siteB = new Site("Plant-B", "plant-b") { Id = 2 };
var aPlc = new DataConnection("PLC-1", "OpcUa", 1) { Id = 100 };
var bPlc = new DataConnection("PLC-1", "OpcUa", 2) { Id = 200 };
SeedRepos(new[] { siteA, siteB }, new[] { aPlc, bPlc });
_aggregator.GetSiteState("plant-a").Returns(
StateWith("plant-a", ("PLC-1", ConnectionHealth.Connected)));
_aggregator.GetSiteState("plant-b").Returns(
StateWith("plant-b", ("PLC-1", ConnectionHealth.Connecting)));
var map = await CreateService().GetConnectionHealthAsync();
Assert.Equal(ConnectionHealth.Connected, map[100]);
Assert.Equal(ConnectionHealth.Connecting, map[200]);
}
}