Joseph Doherty
406 lines
20 KiB
C#
406 lines
20 KiB
C#
using System.Collections.Concurrent;
|
|
using Akka.Actor;
|
|
using Shouldly;
|
|
using Xunit;
|
|
using ZB.MOM.WW.OtOpcUa.Commons.Messages.Redundancy;
|
|
using ZB.MOM.WW.OtOpcUa.Commons.OpcUa;
|
|
using ZB.MOM.WW.OtOpcUa.Commons.Types;
|
|
using ZB.MOM.WW.OtOpcUa.Runtime.Health;
|
|
using ZB.MOM.WW.OtOpcUa.Runtime.OpcUa;
|
|
using ZB.MOM.WW.OtOpcUa.Runtime.Tests.Harness;
|
|
|
|
namespace ZB.MOM.WW.OtOpcUa.Runtime.Tests.OpcUa;
|
|
|
|
public sealed class OpcUaPublishActorTests : RuntimeActorTestBase
|
|
{
|
|
/// <summary>Verifies that message contracts are accepted without a pinned dispatcher in tests.</summary>
|
|
[Fact]
|
|
public void Accepts_message_contracts_without_pinned_dispatcher_in_tests()
|
|
{
|
|
var actor = Sys.ActorOf(OpcUaPublishActor.PropsForTests());
|
|
actor.Tell(new OpcUaPublishActor.AttributeValueUpdate("ns=2;s=Tag1", 42.0, OpcUaQuality.Good, DateTime.UtcNow));
|
|
actor.Tell(new OpcUaPublishActor.AlarmStateUpdate("ns=2;s=Alarm1", Snapshot(active: true), DateTime.UtcNow));
|
|
actor.Tell(new OpcUaPublishActor.RebuildAddressSpace(CorrelationId.NewId()));
|
|
actor.Tell(new OpcUaPublishActor.ServiceLevelChanged(240));
|
|
|
|
ExpectNoMsg(TimeSpan.FromMilliseconds(200));
|
|
}
|
|
|
|
/// <summary>Verifies that production props target the OPC UA synchronized dispatcher.</summary>
|
|
[Fact]
|
|
public void Production_Props_targets_opcua_synchronized_dispatcher()
|
|
{
|
|
var props = OpcUaPublishActor.Props();
|
|
props.Dispatcher.ShouldBe(OpcUaPublishActor.DispatcherId);
|
|
}
|
|
|
|
/// <summary>Verifies that AttributeValueUpdate routes to sink WriteValue.</summary>
|
|
[Fact]
|
|
public void AttributeValueUpdate_routes_to_sink_WriteValue()
|
|
{
|
|
var sink = new RecordingSink();
|
|
var actor = Sys.ActorOf(OpcUaPublishActor.PropsForTests(sink: sink));
|
|
|
|
actor.Tell(new OpcUaPublishActor.AttributeValueUpdate("ns=2;s=T1", 3.14, OpcUaQuality.Good, DateTime.UtcNow));
|
|
actor.Tell(new OpcUaPublishActor.AttributeValueUpdate("ns=2;s=T2", "abc", OpcUaQuality.Uncertain, DateTime.UtcNow));
|
|
|
|
AwaitAssert(() =>
|
|
{
|
|
sink.Values.Count.ShouldBe(2);
|
|
sink.Values[0].NodeId.ShouldBe("ns=2;s=T1");
|
|
sink.Values[0].Value.ShouldBe(3.14);
|
|
sink.Values[0].Quality.ShouldBe(OpcUaQuality.Good);
|
|
sink.Values[1].Quality.ShouldBe(OpcUaQuality.Uncertain);
|
|
}, duration: TimeSpan.FromMilliseconds(500));
|
|
}
|
|
|
|
/// <summary>Verifies that AlarmStateUpdate routes to sink WriteAlarmCondition with the full snapshot.</summary>
|
|
[Fact]
|
|
public void AlarmStateUpdate_routes_to_sink_WriteAlarmCondition()
|
|
{
|
|
var sink = new RecordingSink();
|
|
var actor = Sys.ActorOf(OpcUaPublishActor.PropsForTests(sink: sink));
|
|
|
|
actor.Tell(new OpcUaPublishActor.AlarmStateUpdate(
|
|
"ns=2;s=A1", Snapshot(active: true, acknowledged: false, severity: 700), DateTime.UtcNow));
|
|
|
|
AwaitAssert(() =>
|
|
{
|
|
sink.Alarms.Count.ShouldBe(1);
|
|
sink.Alarms[0].AlarmNodeId.ShouldBe("ns=2;s=A1");
|
|
sink.Alarms[0].State.Active.ShouldBeTrue();
|
|
sink.Alarms[0].State.Acknowledged.ShouldBeFalse();
|
|
sink.Alarms[0].State.Severity.ShouldBe((ushort)700);
|
|
}, duration: TimeSpan.FromMilliseconds(500));
|
|
}
|
|
|
|
/// <summary>Builds a test <see cref="AlarmConditionSnapshot"/> with sensible defaults so each test
|
|
/// only specifies the fields it cares about.</summary>
|
|
private static AlarmConditionSnapshot Snapshot(
|
|
bool active = false,
|
|
bool acknowledged = true,
|
|
bool confirmed = true,
|
|
bool enabled = true,
|
|
AlarmShelvingKind shelving = AlarmShelvingKind.Unshelved,
|
|
ushort severity = 500,
|
|
string message = "test") =>
|
|
new(active, acknowledged, confirmed, enabled, shelving, severity, message);
|
|
|
|
/// <summary>Verifies that RebuildAddressSpace calls sink Rebuild.</summary>
|
|
[Fact]
|
|
public void RebuildAddressSpace_calls_sink_Rebuild()
|
|
{
|
|
var sink = new RecordingSink();
|
|
var actor = Sys.ActorOf(OpcUaPublishActor.PropsForTests(sink: sink));
|
|
|
|
actor.Tell(new OpcUaPublishActor.RebuildAddressSpace(CorrelationId.NewId()));
|
|
|
|
AwaitAssert(() => sink.RebuildCalls.ShouldBe(1), duration: TimeSpan.FromMilliseconds(500));
|
|
}
|
|
|
|
/// <summary>Verifies that ServiceLevelChanged publishes to IServiceLevelPublisher once per unique level.</summary>
|
|
[Fact]
|
|
public void ServiceLevelChanged_publishes_to_IServiceLevelPublisher_once_per_unique_level()
|
|
{
|
|
var publisher = new RecordingPublisher();
|
|
var actor = Sys.ActorOf(OpcUaPublishActor.PropsForTests(serviceLevel: publisher));
|
|
|
|
actor.Tell(new OpcUaPublishActor.ServiceLevelChanged(240));
|
|
actor.Tell(new OpcUaPublishActor.ServiceLevelChanged(240)); // dedup
|
|
actor.Tell(new OpcUaPublishActor.ServiceLevelChanged(100));
|
|
|
|
AwaitAssert(() => publisher.Levels.ShouldBe(new byte[] { 240, 100 }),
|
|
duration: TimeSpan.FromMilliseconds(500));
|
|
}
|
|
|
|
/// <summary>Verifies that RedundancyStateChanged drives local ServiceLevel publish for primary leader.</summary>
|
|
[Fact]
|
|
public void RedundancyStateChanged_drives_local_ServiceLevel_publish_for_primary_leader()
|
|
{
|
|
var publisher = new RecordingPublisher();
|
|
var local = NodeId.Parse("primary-node");
|
|
var actor = Sys.ActorOf(OpcUaPublishActor.PropsForTests(
|
|
serviceLevel: publisher, localNode: local));
|
|
|
|
var snapshot = new RedundancyStateChanged(
|
|
Nodes: new[]
|
|
{
|
|
new NodeRedundancyState(local, RedundancyRole.Primary,
|
|
IsClusterLeader: true, IsRoleLeaderForDriver: true, DateTime.UtcNow),
|
|
new NodeRedundancyState(NodeId.Parse("other-node"), RedundancyRole.Secondary,
|
|
IsClusterLeader: false, IsRoleLeaderForDriver: false, DateTime.UtcNow),
|
|
},
|
|
CorrelationId.NewId());
|
|
actor.Tell(snapshot);
|
|
|
|
AwaitAssert(() => publisher.Levels.ShouldBe(new byte[] { 240 }),
|
|
duration: TimeSpan.FromMilliseconds(500));
|
|
}
|
|
|
|
/// <summary>Verifies that RedundancyStateChanged for secondary publishes 100.</summary>
|
|
[Fact]
|
|
public void RedundancyStateChanged_for_secondary_publishes_100()
|
|
{
|
|
var publisher = new RecordingPublisher();
|
|
var local = NodeId.Parse("secondary-node");
|
|
var actor = Sys.ActorOf(OpcUaPublishActor.PropsForTests(serviceLevel: publisher, localNode: local));
|
|
|
|
var snapshot = new RedundancyStateChanged(
|
|
Nodes: new[]
|
|
{
|
|
new NodeRedundancyState(local, RedundancyRole.Secondary,
|
|
IsClusterLeader: false, IsRoleLeaderForDriver: false, DateTime.UtcNow),
|
|
},
|
|
CorrelationId.NewId());
|
|
actor.Tell(snapshot);
|
|
|
|
AwaitAssert(() => publisher.Levels.ShouldBe(new byte[] { 100 }),
|
|
duration: TimeSpan.FromMilliseconds(500));
|
|
}
|
|
|
|
/// <summary>Verifies that the calculator path computes 250 for a healthy primary role-leader
|
|
/// (basis 240 from DB-reachable + probe-ok + fresh, +10 driver-role-leader bonus).</summary>
|
|
[Fact]
|
|
public void Calculator_path_healthy_primary_leader_publishes_250()
|
|
{
|
|
var publisher = new RecordingPublisher();
|
|
var local = NodeId.Parse("primary-node");
|
|
var probe = Sys.ActorOf(Akka.Actor.Props.Create(() =>
|
|
new StubDbHealth(new DbHealthProbeActor.DbHealthStatus(true, DateTime.UtcNow, null))));
|
|
var actor = Sys.ActorOf(OpcUaPublishActor.PropsForTests(
|
|
serviceLevel: publisher, localNode: local, dbHealthProbe: probe));
|
|
|
|
actor.Tell(new DbHealthProbeActor.DbHealthStatus(true, DateTime.UtcNow, null));
|
|
actor.Tell(new RedundancyStateChanged(
|
|
Nodes: new[]
|
|
{
|
|
new NodeRedundancyState(local, RedundancyRole.Primary,
|
|
IsClusterLeader: true, IsRoleLeaderForDriver: true, DateTime.UtcNow),
|
|
},
|
|
CorrelationId.NewId()));
|
|
|
|
AwaitAssert(() => publisher.Levels.ShouldContain((byte)250),
|
|
duration: TimeSpan.FromMilliseconds(500));
|
|
}
|
|
|
|
/// <summary>Verifies that the calculator path computes 240 for a healthy non-leader secondary
|
|
/// (basis 240 from DB-reachable + probe-ok + fresh, no leader bonus). Documented change from the
|
|
/// legacy role-only path, which mapped Secondary → 100.</summary>
|
|
[Fact]
|
|
public void Calculator_path_healthy_secondary_publishes_240()
|
|
{
|
|
var publisher = new RecordingPublisher();
|
|
var local = NodeId.Parse("secondary-node");
|
|
var probe = Sys.ActorOf(Akka.Actor.Props.Create(() =>
|
|
new StubDbHealth(new DbHealthProbeActor.DbHealthStatus(true, DateTime.UtcNow, null))));
|
|
var actor = Sys.ActorOf(OpcUaPublishActor.PropsForTests(
|
|
serviceLevel: publisher, localNode: local, dbHealthProbe: probe));
|
|
|
|
actor.Tell(new DbHealthProbeActor.DbHealthStatus(true, DateTime.UtcNow, null));
|
|
actor.Tell(new RedundancyStateChanged(
|
|
Nodes: new[]
|
|
{
|
|
new NodeRedundancyState(local, RedundancyRole.Secondary,
|
|
IsClusterLeader: false, IsRoleLeaderForDriver: false, DateTime.UtcNow),
|
|
},
|
|
CorrelationId.NewId()));
|
|
|
|
AwaitAssert(() => publisher.Levels.ShouldContain((byte)240),
|
|
duration: TimeSpan.FromMilliseconds(500));
|
|
}
|
|
|
|
/// <summary>Verifies that the calculator path computes 100 when the DB is unreachable
|
|
/// ((false,_,true) basis, stale via !DbReachable) for a non-leader secondary (no bonus).</summary>
|
|
[Fact]
|
|
public void Calculator_path_db_unreachable_publishes_100()
|
|
{
|
|
var publisher = new RecordingPublisher();
|
|
var local = NodeId.Parse("secondary-node");
|
|
var probe = Sys.ActorOf(Akka.Actor.Props.Create(() =>
|
|
new StubDbHealth(new DbHealthProbeActor.DbHealthStatus(false, DateTime.UtcNow, "down"))));
|
|
var actor = Sys.ActorOf(OpcUaPublishActor.PropsForTests(
|
|
serviceLevel: publisher, localNode: local, dbHealthProbe: probe));
|
|
|
|
actor.Tell(new DbHealthProbeActor.DbHealthStatus(false, DateTime.UtcNow, "down"));
|
|
actor.Tell(new RedundancyStateChanged(
|
|
Nodes: new[]
|
|
{
|
|
new NodeRedundancyState(local, RedundancyRole.Secondary,
|
|
IsClusterLeader: false, IsRoleLeaderForDriver: false, DateTime.UtcNow),
|
|
},
|
|
CorrelationId.NewId()));
|
|
|
|
AwaitAssert(() => publisher.Levels.ShouldContain((byte)100),
|
|
duration: TimeSpan.FromMilliseconds(500));
|
|
}
|
|
|
|
/// <summary>Verifies that the calculator path computes 200 for a stale snapshot when the DB is
|
|
/// reachable + fresh but the redundancy entry's AsOfUtc is older than the stale window
|
|
/// ((true,_,true) basis) for a non-leader secondary (no bonus).</summary>
|
|
[Fact]
|
|
public void Calculator_path_stale_snapshot_publishes_200()
|
|
{
|
|
var publisher = new RecordingPublisher();
|
|
var local = NodeId.Parse("secondary-node");
|
|
var probe = Sys.ActorOf(Akka.Actor.Props.Create(() =>
|
|
new StubDbHealth(new DbHealthProbeActor.DbHealthStatus(true, DateTime.UtcNow, null))));
|
|
var actor = Sys.ActorOf(OpcUaPublishActor.PropsForTests(
|
|
serviceLevel: publisher, localNode: local, dbHealthProbe: probe,
|
|
staleWindow: TimeSpan.FromSeconds(2)));
|
|
|
|
actor.Tell(new DbHealthProbeActor.DbHealthStatus(true, DateTime.UtcNow, null));
|
|
actor.Tell(new RedundancyStateChanged(
|
|
Nodes: new[]
|
|
{
|
|
new NodeRedundancyState(local, RedundancyRole.Secondary,
|
|
IsClusterLeader: false, IsRoleLeaderForDriver: false,
|
|
DateTime.UtcNow - TimeSpan.FromMinutes(1)),
|
|
},
|
|
CorrelationId.NewId()));
|
|
|
|
AwaitAssert(() => publisher.Levels.ShouldContain((byte)200),
|
|
duration: TimeSpan.FromMilliseconds(500));
|
|
}
|
|
|
|
/// <summary>Verifies that a detached local node publishes 0 (the calculator does not model
|
|
/// Detached, so the handler guards it before the calculator path). The node first goes healthy
|
|
/// (250) so the dedup'd transition down to 0 is observable.</summary>
|
|
[Fact]
|
|
public void Calculator_path_detached_publishes_0()
|
|
{
|
|
var publisher = new RecordingPublisher();
|
|
var local = NodeId.Parse("detached-node");
|
|
var probe = Sys.ActorOf(Akka.Actor.Props.Create(() =>
|
|
new StubDbHealth(new DbHealthProbeActor.DbHealthStatus(true, DateTime.UtcNow, null))));
|
|
var actor = Sys.ActorOf(OpcUaPublishActor.PropsForTests(
|
|
serviceLevel: publisher, localNode: local, dbHealthProbe: probe));
|
|
|
|
actor.Tell(new DbHealthProbeActor.DbHealthStatus(true, DateTime.UtcNow, null));
|
|
// First go healthy primary-leader (250) so the transition down to 0 is not dedup'd against
|
|
// the initial 0.
|
|
actor.Tell(new RedundancyStateChanged(
|
|
Nodes: new[]
|
|
{
|
|
new NodeRedundancyState(local, RedundancyRole.Primary,
|
|
IsClusterLeader: true, IsRoleLeaderForDriver: true, DateTime.UtcNow),
|
|
},
|
|
CorrelationId.NewId()));
|
|
AwaitAssert(() => publisher.Levels.ShouldContain((byte)250),
|
|
duration: TimeSpan.FromMilliseconds(500));
|
|
|
|
// Now detach — expect the guard to drive ServiceLevel down to 0.
|
|
actor.Tell(new RedundancyStateChanged(
|
|
Nodes: new[]
|
|
{
|
|
new NodeRedundancyState(local, RedundancyRole.Detached,
|
|
IsClusterLeader: false, IsRoleLeaderForDriver: false, DateTime.UtcNow),
|
|
},
|
|
CorrelationId.NewId()));
|
|
|
|
AwaitAssert(() => publisher.Levels.ShouldContain((byte)0),
|
|
duration: TimeSpan.FromMilliseconds(500));
|
|
}
|
|
|
|
/// <summary>Verifies the legacy back-compat seam: with no DB-health probe wired, the handler
|
|
/// falls back to the old role-only switch (Primary + leader → 240).</summary>
|
|
[Fact]
|
|
public void Legacy_path_no_db_probe_keeps_role_only()
|
|
{
|
|
var publisher = new RecordingPublisher();
|
|
var local = NodeId.Parse("primary-node");
|
|
var actor = Sys.ActorOf(OpcUaPublishActor.PropsForTests(
|
|
serviceLevel: publisher, localNode: local));
|
|
|
|
actor.Tell(new RedundancyStateChanged(
|
|
Nodes: new[]
|
|
{
|
|
new NodeRedundancyState(local, RedundancyRole.Primary,
|
|
IsClusterLeader: true, IsRoleLeaderForDriver: true, DateTime.UtcNow),
|
|
},
|
|
CorrelationId.NewId()));
|
|
|
|
AwaitAssert(() => publisher.Levels.ShouldContain((byte)240),
|
|
duration: TimeSpan.FromMilliseconds(500));
|
|
}
|
|
|
|
/// <summary>Stub DB-health probe actor that answers <see cref="DbHealthProbeActor.GetStatus"/>
|
|
/// with a fixed status, so the calculator path is deterministic without a real timer.</summary>
|
|
private sealed class StubDbHealth : Akka.Actor.ReceiveActor
|
|
{
|
|
/// <summary>Initializes a new instance of the <see cref="StubDbHealth"/> class.</summary>
|
|
/// <param name="status">The fixed DB-health status to reply with.</param>
|
|
public StubDbHealth(DbHealthProbeActor.DbHealthStatus status) =>
|
|
Receive<DbHealthProbeActor.GetStatus>(_ => Sender.Tell(status));
|
|
}
|
|
|
|
/// <summary>Test implementation of IOpcUaAddressSpaceSink that records calls.</summary>
|
|
private sealed class RecordingSink : IOpcUaAddressSpaceSink
|
|
{
|
|
/// <summary>Gets the queue of recorded value updates.</summary>
|
|
public ConcurrentQueue<(string NodeId, object? Value, OpcUaQuality Quality, DateTime Ts)> ValueQueue { get; } = new();
|
|
/// <summary>Gets the queue of recorded alarm condition updates.</summary>
|
|
public ConcurrentQueue<(string AlarmNodeId, AlarmConditionSnapshot State, DateTime Ts)> AlarmQueue { get; } = new();
|
|
/// <summary>Count of rebuild calls.</summary>
|
|
public int RebuildCalls;
|
|
|
|
/// <summary>Gets the list of recorded value updates.</summary>
|
|
public List<(string NodeId, object? Value, OpcUaQuality Quality, DateTime Ts)> Values =>
|
|
ValueQueue.ToList();
|
|
/// <summary>Gets the list of recorded alarm condition updates.</summary>
|
|
public List<(string AlarmNodeId, AlarmConditionSnapshot State, DateTime Ts)> Alarms =>
|
|
AlarmQueue.ToList();
|
|
|
|
/// <summary>Records a value update.</summary>
|
|
/// <param name="nodeId">The OPC UA node identifier.</param>
|
|
/// <param name="value">The attribute value.</param>
|
|
/// <param name="quality">The OPC UA quality code.</param>
|
|
/// <param name="ts">The timestamp of the update.</param>
|
|
public void WriteValue(string nodeId, object? value, OpcUaQuality quality, DateTime ts) =>
|
|
ValueQueue.Enqueue((nodeId, value, quality, ts));
|
|
|
|
/// <summary>Records an alarm condition update.</summary>
|
|
/// <param name="alarmNodeId">The OPC UA alarm node identifier.</param>
|
|
/// <param name="state">The full condition state snapshot.</param>
|
|
/// <param name="ts">The timestamp of the update.</param>
|
|
public void WriteAlarmCondition(string alarmNodeId, AlarmConditionSnapshot state, DateTime ts) =>
|
|
AlarmQueue.Enqueue((alarmNodeId, state, ts));
|
|
|
|
/// <summary>Materialises an alarm condition (no-op in test).</summary>
|
|
/// <param name="alarmNodeId">The alarm node ID.</param>
|
|
/// <param name="equipmentNodeId">The equipment folder node ID.</param>
|
|
/// <param name="displayName">The condition display name.</param>
|
|
/// <param name="alarmType">The domain alarm type.</param>
|
|
/// <param name="severity">The domain severity.</param>
|
|
public void MaterialiseAlarmCondition(string alarmNodeId, string equipmentNodeId, string displayName, string alarmType, int severity) { }
|
|
|
|
/// <summary>Ensures a folder exists (no-op in test).</summary>
|
|
/// <param name="folderNodeId">The OPC UA folder node identifier.</param>
|
|
/// <param name="parentNodeId">The parent folder node identifier, or null for root.</param>
|
|
/// <param name="displayName">The display name of the folder.</param>
|
|
public void EnsureFolder(string folderNodeId, string? parentNodeId, string displayName) { }
|
|
|
|
/// <summary>Ensures a variable exists (no-op in test).</summary>
|
|
/// <param name="variableNodeId">The OPC UA variable node identifier.</param>
|
|
/// <param name="parentFolderNodeId">The parent folder node identifier, or null for root.</param>
|
|
/// <param name="displayName">The display name of the variable.</param>
|
|
/// <param name="dataType">The OPC UA built-in type name.</param>
|
|
/// <param name="writable">Whether the node is created read/write.</param>
|
|
/// <param name="historianTagname">The resolved historian tagname (null ⇒ not historized).</param>
|
|
public void EnsureVariable(string variableNodeId, string? parentFolderNodeId, string displayName, string dataType, bool writable, string? historianTagname = null) { }
|
|
|
|
/// <summary>Records a rebuild call.</summary>
|
|
public void RebuildAddressSpace() => Interlocked.Increment(ref RebuildCalls);
|
|
}
|
|
|
|
/// <summary>Test implementation of IServiceLevelPublisher that records publishes.</summary>
|
|
private sealed class RecordingPublisher : IServiceLevelPublisher
|
|
{
|
|
private readonly ConcurrentQueue<byte> _q = new();
|
|
/// <summary>Gets the recorded service levels.</summary>
|
|
public byte[] Levels => _q.ToArray();
|
|
/// <summary>Records a service level publish.</summary>
|
|
/// <param name="serviceLevel">The service level value to publish.</param>
|
|
public void Publish(byte serviceLevel) => _q.Enqueue(serviceLevel);
|
|
}
|
|
}
|