feat(dcl+ui): rename BrowseOpcUaNode -> ConnectionName-keyed; implement site handler + dialog failure mapping
- BrowseOpcUaNodeCommand: int DataConnectionId -> string ConnectionName (site DataConnectionManagerActor indexes children by name; CentralUI already has the connection name in scope via the dropdown — no extra plumbing across the trust boundary). - IOpcUaBrowseService / OpcUaBrowseService: parameter renamed accordingly. - OpcUaBrowserDialog: collapse the duplicate ConnectionName parameters (display label and routing key are the same string). - Task 10: DataConnectionManagerActor forwards BrowseOpcUaNodeCommand to its child by name (owns ConnectionNotFound); DataConnectionActor adds the receive across all three lifecycle states (Connecting / Connected / Reconnecting) and maps adapter outcomes to BrowseFailureKind (NotBrowsable / ConnectionNotConnected / Timeout / ServerError). - Task 17: SetFailure in OpcUaBrowserDialog implements the full BrowseFailureKind switch with friendly UI messages. - Tests: DataConnectionManagerBrowseHandlerTests covers ConnectionNotFound, NotBrowsable, success, and ConnectionNotConnectedException paths.
This commit is contained in:
Joseph Doherty
+165
@@ -0,0 +1,165 @@
|
||||
using Akka.Actor;
|
||||
using Akka.TestKit.Xunit2;
|
||||
using NSubstitute;
|
||||
using ZB.MOM.WW.ScadaBridge.Commons.Interfaces.Protocol;
|
||||
using ZB.MOM.WW.ScadaBridge.Commons.Messages.DataConnection;
|
||||
using ZB.MOM.WW.ScadaBridge.Commons.Messages.Management;
|
||||
using ZB.MOM.WW.ScadaBridge.Commons.Types.Enums;
|
||||
using ZB.MOM.WW.ScadaBridge.DataConnectionLayer.Actors;
|
||||
using ZB.MOM.WW.ScadaBridge.HealthMonitoring;
|
||||
|
||||
namespace ZB.MOM.WW.ScadaBridge.DataConnectionLayer.Tests.Actors;
|
||||
|
||||
/// <summary>
|
||||
/// Task 10 (opcua-tag-browser): the site-side
|
||||
/// <see cref="DataConnectionManagerActor"/> + child
|
||||
/// <see cref="DataConnectionActor"/> together resolve
|
||||
/// <see cref="BrowseOpcUaNodeCommand"/> against the live adapter and surface
|
||||
/// every browse outcome as a typed <see cref="BrowseFailure"/>. The split is:
|
||||
/// the manager owns <see cref="BrowseFailureKind.ConnectionNotFound"/> (only it
|
||||
/// knows the per-site connection set); everything else lives in the child where
|
||||
/// the adapter is held — <see cref="BrowseFailureKind.NotBrowsable"/> from the
|
||||
/// capability check, <see cref="BrowseFailureKind.ConnectionNotConnected"/> /
|
||||
/// <see cref="BrowseFailureKind.Timeout"/> / <see cref="BrowseFailureKind.ServerError"/>
|
||||
/// from the adapter call. These tests guard that split.
|
||||
/// </summary>
|
||||
public class DataConnectionManagerBrowseHandlerTests : TestKit
|
||||
{
|
||||
private readonly IDataConnectionFactory _factory;
|
||||
private readonly ISiteHealthCollector _healthCollector;
|
||||
private readonly DataConnectionOptions _options;
|
||||
|
||||
public DataConnectionManagerBrowseHandlerTests()
|
||||
: base(@"akka.loglevel = WARNING")
|
||||
{
|
||||
_factory = Substitute.For<IDataConnectionFactory>();
|
||||
_healthCollector = Substitute.For<ISiteHealthCollector>();
|
||||
_options = new DataConnectionOptions
|
||||
{
|
||||
ReconnectInterval = TimeSpan.FromSeconds(30),
|
||||
TagResolutionRetryInterval = TimeSpan.FromSeconds(30),
|
||||
};
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Unknown_connection_name_returns_ConnectionNotFound()
|
||||
{
|
||||
var manager = Sys.ActorOf(Props.Create(() =>
|
||||
new DataConnectionManagerActor(_factory, _options, _healthCollector, null)));
|
||||
|
||||
// No CreateConnectionCommand sent — the manager has zero children, so a
|
||||
// browse against any name must be rejected with ConnectionNotFound
|
||||
// (the manager is the only actor with site-level visibility).
|
||||
manager.Tell(new BrowseOpcUaNodeCommand("unknown-connection", ParentNodeId: null));
|
||||
|
||||
var reply = ExpectMsg<BrowseOpcUaNodeResult>();
|
||||
Assert.NotNull(reply.Failure);
|
||||
Assert.Equal(BrowseFailureKind.ConnectionNotFound, reply.Failure!.Kind);
|
||||
Assert.Empty(reply.Children);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Non_browsable_adapter_returns_NotBrowsable()
|
||||
{
|
||||
// Bare IDataConnection — no IBrowsableDataConnection. The child actor's
|
||||
// capability check must surface this as NotBrowsable.
|
||||
var adapter = Substitute.For<IDataConnection>();
|
||||
adapter.ConnectAsync(Arg.Any<IDictionary<string, string>>(), Arg.Any<CancellationToken>())
|
||||
.Returns(Task.CompletedTask);
|
||||
adapter.Status.Returns(ConnectionHealth.Connected);
|
||||
_factory.Create("OpcUa", Arg.Any<IDictionary<string, string>>()).Returns(adapter);
|
||||
|
||||
var manager = Sys.ActorOf(Props.Create(() =>
|
||||
new DataConnectionManagerActor(_factory, _options, _healthCollector, null)));
|
||||
manager.Tell(new CreateConnectionCommand(
|
||||
"conn-bare", "OpcUa", new Dictionary<string, string>(), null, 3));
|
||||
|
||||
// Give the manager a moment to spawn the child actor. We do not need to
|
||||
// wait for Connected — the browse handler runs in all states.
|
||||
AwaitCondition(
|
||||
() => _factory.ReceivedCalls().Any(c => c.GetMethodInfo().Name == "Create"),
|
||||
TimeSpan.FromSeconds(2));
|
||||
|
||||
manager.Tell(new BrowseOpcUaNodeCommand("conn-bare", ParentNodeId: null));
|
||||
|
||||
var reply = ExpectMsg<BrowseOpcUaNodeResult>(TimeSpan.FromSeconds(3));
|
||||
Assert.NotNull(reply.Failure);
|
||||
Assert.Equal(BrowseFailureKind.NotBrowsable, reply.Failure!.Kind);
|
||||
Assert.Empty(reply.Children);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Success_path_returns_mapped_children()
|
||||
{
|
||||
// Adapter implementing both IDataConnection (so DataConnectionActor can
|
||||
// run its lifecycle) AND IBrowsableDataConnection (so the browse handler
|
||||
// takes the success path).
|
||||
var adapter = Substitute.For<IDataConnection, IBrowsableDataConnection>();
|
||||
((IDataConnection)adapter).ConnectAsync(Arg.Any<IDictionary<string, string>>(), Arg.Any<CancellationToken>())
|
||||
.Returns(Task.CompletedTask);
|
||||
((IDataConnection)adapter).Status.Returns(ConnectionHealth.Connected);
|
||||
|
||||
var children = new[]
|
||||
{
|
||||
new BrowseNode("ns=2;s=A", "A", BrowseNodeClass.Variable, HasChildren: false),
|
||||
new BrowseNode("ns=2;s=B", "B", BrowseNodeClass.Object, HasChildren: true),
|
||||
};
|
||||
((IBrowsableDataConnection)adapter)
|
||||
.BrowseChildrenAsync(null, Arg.Any<CancellationToken>())
|
||||
.Returns(new BrowseChildrenResult(children, Truncated: false));
|
||||
|
||||
_factory.Create("OpcUa", Arg.Any<IDictionary<string, string>>())
|
||||
.Returns((IDataConnection)adapter);
|
||||
|
||||
var manager = Sys.ActorOf(Props.Create(() =>
|
||||
new DataConnectionManagerActor(_factory, _options, _healthCollector, null)));
|
||||
manager.Tell(new CreateConnectionCommand(
|
||||
"conn-ok", "OpcUa", new Dictionary<string, string>(), null, 3));
|
||||
|
||||
AwaitCondition(
|
||||
() => _factory.ReceivedCalls().Any(c => c.GetMethodInfo().Name == "Create"),
|
||||
TimeSpan.FromSeconds(2));
|
||||
|
||||
manager.Tell(new BrowseOpcUaNodeCommand("conn-ok", ParentNodeId: null));
|
||||
|
||||
var reply = ExpectMsg<BrowseOpcUaNodeResult>(TimeSpan.FromSeconds(3));
|
||||
Assert.Null(reply.Failure);
|
||||
Assert.Equal(2, reply.Children.Count);
|
||||
Assert.Equal("ns=2;s=A", reply.Children[0].NodeId);
|
||||
Assert.Equal("ns=2;s=B", reply.Children[1].NodeId);
|
||||
Assert.False(reply.Truncated);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void ConnectionNotConnectedException_maps_to_ConnectionNotConnected()
|
||||
{
|
||||
var adapter = Substitute.For<IDataConnection, IBrowsableDataConnection>();
|
||||
((IDataConnection)adapter).ConnectAsync(Arg.Any<IDictionary<string, string>>(), Arg.Any<CancellationToken>())
|
||||
.Returns(Task.CompletedTask);
|
||||
((IDataConnection)adapter).Status.Returns(ConnectionHealth.Connected);
|
||||
|
||||
((IBrowsableDataConnection)adapter)
|
||||
.BrowseChildrenAsync(Arg.Any<string?>(), Arg.Any<CancellationToken>())
|
||||
.Returns(Task.FromException<BrowseChildrenResult>(
|
||||
new ConnectionNotConnectedException("OPC UA session is not connected.")));
|
||||
|
||||
_factory.Create("OpcUa", Arg.Any<IDictionary<string, string>>())
|
||||
.Returns((IDataConnection)adapter);
|
||||
|
||||
var manager = Sys.ActorOf(Props.Create(() =>
|
||||
new DataConnectionManagerActor(_factory, _options, _healthCollector, null)));
|
||||
manager.Tell(new CreateConnectionCommand(
|
||||
"conn-down", "OpcUa", new Dictionary<string, string>(), null, 3));
|
||||
|
||||
AwaitCondition(
|
||||
() => _factory.ReceivedCalls().Any(c => c.GetMethodInfo().Name == "Create"),
|
||||
TimeSpan.FromSeconds(2));
|
||||
|
||||
manager.Tell(new BrowseOpcUaNodeCommand("conn-down", ParentNodeId: null));
|
||||
|
||||
var reply = ExpectMsg<BrowseOpcUaNodeResult>(TimeSpan.FromSeconds(3));
|
||||
Assert.NotNull(reply.Failure);
|
||||
Assert.Equal(BrowseFailureKind.ConnectionNotConnected, reply.Failure!.Kind);
|
||||
Assert.Empty(reply.Children);
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user