Files
lmxopcua/tests/Server/ZB.MOM.WW.OtOpcUa.Runtime.Tests/Drivers/ActorNodeWriteGatewayTests.cs
T
Joseph Doherty 2e0743ad25 fix(v3-batch4-wp3): realm-qualified write routing + dormant discovery guard + self-correction/byte-parity tests (Wave B review H1/M1/M2/L1/L3)
H1 (HIGH): write-routing key now (AddressSpaceRealm, bareId), not bare-only.
A raw s=<RawPath> and a UNS s=<Area/Line/Equip/Eff> can collide as bare
strings; the bare-only key let a colliding raw+UNS pair route to the WRONG
driver ref (last-writer-wins). The realm the node manager resolves (RealmOf)
is now threaded through IOpcUaNodeWriteGateway.WriteAsync -> RouteNodeWrite ->
_driverRefByNodeId keyed by (realm, bareId). New regression test:
Colliding_raw_and_uns_bare_ids_route_to_their_own_driver_by_realm.

M1 (MEDIUM): discovered-node injection made coherently DORMANT. HandleDiscoveredNodes
hard-short-circuits (single enforcement point; _discoveredByDriver never
populates so the re-inject tail is inert too), with a clear log pointing at the
/raw browse-commit flow. New pin: Discovered_nodes_are_ignored_dormant_in_v3;
the 16+2 v2 injection scenarios re-pointed to an accurate skip reason
(DiscoveryInjectionDormantV3).

M2 (MEDIUM): realm-qualified dual-node self-correction tests —
Failed_uns_write_reverts_uns_node_and_leaves_raw_node_untouched +
Raw_realm_revert_reverts_raw_node_only (the second fails if the realm is dropped).

L1: removed the = AddressSpaceRealm.Uns defaults from the consequential
node-manager mutation methods (WriteValue/WriteAlarmCondition/MaterialiseAlarmCondition/
EnsureFolder/EnsureVariable/UpdateFolderDisplayName/UpdateTagAttributes/
RaiseNodesAddedModelChange/Remove*/RevertOptimisticWriteIfNeeded) + the
AttributeValueUpdate/AlarmStateUpdate records, so the compiler forces explicit
realm; read-only accessors + internal builders retain their defaults.

L3: fixed the stale VirtualTagHostActor class comment (V3NodeIds.Uns, not the
retired EquipmentNodeIds.Variable).

Also: DeploymentArtifactRawUnsParityTests — Raw/UNS node-set byte-parity
round-trip between AddressSpaceComposer.Compose and DeploymentArtifact.ParseComposition.

Claude-Session: https://claude.ai/code/session_01LVneM3eh1UtJxEisFXgmox
2026-07-16 11:30:13 -04:00

87 lines
3.8 KiB
C#

using Akka.Actor;
using Microsoft.Extensions.Logging.Abstractions;
using Shouldly;
using ZB.MOM.WW.OtOpcUa.Commons.OpcUa;
using Xunit;
using ZB.MOM.WW.OtOpcUa.Runtime.Drivers;
using ZB.MOM.WW.OtOpcUa.Runtime.Tests.Harness;
namespace ZB.MOM.WW.OtOpcUa.Runtime.Tests.Drivers;
/// <summary>
/// Verifies the <see cref="ActorNodeWriteGateway"/> adapter: it implements the Commons
/// <c>IOpcUaNodeWriteGateway</c> by lazily resolving the <see cref="DriverHostActor"/> and Asking it a
/// <see cref="DriverHostActor.RouteNodeWrite"/>, translating the actor's
/// <see cref="DriverHostActor.NodeWriteResult"/> reply into a Commons <c>NodeWriteOutcome</c>. A
/// <c>TestProbe</c> stands in for the DriverHostActor (passed via <c>resolveDriverHost</c>) so the
/// gateway can be driven without the full driver harness.
/// </summary>
public sealed class ActorNodeWriteGatewayTests : RuntimeActorTestBase
{
/// <summary>Probe receives the RouteNodeWrite and replies success → the outcome is (true, null).</summary>
[Fact]
public async Task Success_reply_maps_to_successful_outcome()
{
var probe = CreateTestProbe();
var gateway = new ActorNodeWriteGateway(resolveDriverHost: () => probe.Ref, NullLogger.Instance);
var writeTask = gateway.WriteAsync("eq-1/speed", 123.0, AddressSpaceRealm.Uns, CancellationToken.None);
var routed = probe.ExpectMsg<DriverHostActor.RouteNodeWrite>(TimeSpan.FromSeconds(5));
routed.NodeId.ShouldBe("eq-1/speed");
routed.Value.ShouldBe(123.0);
probe.Reply(new DriverHostActor.NodeWriteResult(true, null));
var outcome = await writeTask;
outcome.Success.ShouldBeTrue();
outcome.Reason.ShouldBeNull();
}
/// <summary>Probe replies failure → the outcome carries the same (false, reason) verbatim.</summary>
[Fact]
public async Task Failure_reply_maps_to_failure_outcome_with_reason()
{
var probe = CreateTestProbe();
var gateway = new ActorNodeWriteGateway(resolveDriverHost: () => probe.Ref, NullLogger.Instance);
var writeTask = gateway.WriteAsync("eq-1/speed", 123.0, AddressSpaceRealm.Uns, CancellationToken.None);
probe.ExpectMsg<DriverHostActor.RouteNodeWrite>(TimeSpan.FromSeconds(5));
probe.Reply(new DriverHostActor.NodeWriteResult(false, "not primary"));
var outcome = await writeTask;
outcome.Success.ShouldBeFalse();
outcome.Reason.ShouldBe("not primary");
}
/// <summary>The probe never replies; a short Ask timeout makes the gateway fast-fail with a negative,
/// non-null-reason outcome rather than hanging.</summary>
[Fact]
public async Task No_reply_within_timeout_maps_to_negative_outcome()
{
var probe = CreateTestProbe();
var gateway = new ActorNodeWriteGateway(
resolveDriverHost: () => probe.Ref, NullLogger.Instance,
askTimeout: TimeSpan.FromMilliseconds(200));
var outcome = await gateway.WriteAsync("eq-1/speed", 123.0, AddressSpaceRealm.Uns, CancellationToken.None);
outcome.Success.ShouldBeFalse();
outcome.Reason.ShouldNotBeNull();
outcome.Reason.ShouldBe("write timeout");
}
/// <summary>When no DriverHostActor is registered (resolver returns null), the gateway short-circuits
/// to (false, "writes unavailable") and never messages any actor.</summary>
[Fact]
public async Task No_actor_registered_maps_to_writes_unavailable()
{
var gateway = new ActorNodeWriteGateway(resolveDriverHost: () => null, NullLogger.Instance);
var outcome = await gateway.WriteAsync("eq-1/speed", 123.0, AddressSpaceRealm.Uns, CancellationToken.None);
outcome.Success.ShouldBeFalse();
outcome.Reason.ShouldBe("writes unavailable");
}
}