Joseph Doherty
2d20aeb779
#519 — a driver's OPC UA status code now reaches a client with its sub-code intact. DriverInstanceActor projected the driver's uint onto a 3-state Good/Uncertain/Bad enum and OtOpcUaNodeManager re-expanded Bad to a bare 0x80000000, so BadNoCommunication, BadTypeMismatch and BadNotSupported were indistinguishable on the wire and every driver's status constants (incl. the 16 #497 had just corrected) were diagnostic in logs only. Resolved by option (b): the raw uint rides AttributeValuePublished -> AttributeValueUpdate -> IOpcUaAddressSpaceSink.WriteValue, OpcUaQuality is deleted, and severity classification is a helper (OpcUaStatus.IsGood/IsUncertain/IsBad). The surface was wider than the issue costed (41 files, not "the sink and 3 implementations"): OpcUaQuality had non-driver producers with no uint to carry. Each got its natural code — BadInternalError for a failed virtual-tag script, BadNoCommunication for driver comms loss — and ScriptedAlarmHostActor's pair of mutually-inverse uint<->enum mappers is deleted, having round-tripped a code the engine already held. AddressSpaceApplier's removal writes deliberately keep the generic Bad: not losing a code the driver had is this issue; inventing one for the deploy path is a separate call. Behaviour change: WriteAlarmQuality fires its Part 9 event on a status-code change rather than a severity-bucket change. While the annotation was 3-state those were the same predicate; now a move between two Bad reasons changes what a subscriber reads. New SDK-free named constants live on Commons.OpcUa.OpcUaStatus, and StatusCodeParityTests is widened to cover them — that guard is reflection-driven, so it can only see a named constant, never an inline literal. #517 — the symptom is real but the issue named the wrong path and its fix was unsafe. ShutdownAsync cannot race: DriverInstanceActor calls it from PostStop, after the mailbox drains. (Core/Hosting/DriverHost, the one class with a concurrent GetHealth, has no production call site.) InitializeAsync can: it runs on a fire-and-forget Task.Run, and MTConnectDriver writes Healthy then starts loops that can throw into a catch which disposes the client before writing Faulted. Moving the write earlier, as suggested, inverts the terminal state — teardown drains in-flight loops that write health as they unwind, so a late loop could leave Healthy at rest with every connection closed. The fix is a bracket (conservative before, terminal after), applied to MTConnect's init-failure path only; shutdown keeps its single trailing write, and the rule plus the reachability table are documented on IDriver.ShutdownAsync. CalculationDriver.GetHealth returned a hard-coded Healthy that consulted nothing — Healthy before initialize, after shutdown and after dispose. Now derived from _running. Its test, named Health_is_always_Connected, asserted the defect and is replaced. Every new guard was falsified by breaking the production code and watching it go red. The two sub-code tests each assert two different Bad codes, since a single-code assertion could pass against a hard-coded constant under the old projection. Pre-existing failures, verified unchanged on a stashed tree and not chased: 4 in Driver.AbLegacy.IntegrationTests (slc500/micrologix/plc5 fixtures not up) and 3 in Host.IntegrationTests. Closes #517 Closes #519 Claude-Session: https://claude.ai/code/session_015p7wGqy3YpZNCpDzTpGMKo
262 lines
12 KiB
C#
262 lines
12 KiB
C#
using Shouldly;
|
|
using Xunit;
|
|
using ZB.MOM.WW.OtOpcUa.Commons.OpcUa;
|
|
|
|
namespace ZB.MOM.WW.OtOpcUa.Commons.Tests.OpcUa;
|
|
|
|
/// <summary>
|
|
/// Covers the deferred-sink forwarding invariants documented in Commons-003.
|
|
/// The DeferredAddressSpaceSink is a production-critical seam: a new optional capability
|
|
/// interface MUST be forwarded through it or the optimization is inert on every driver-role
|
|
/// host (DeferredAddressSpaceSink is what actors inject, not the inner sink directly).
|
|
/// </summary>
|
|
public class DeferredAddressSpaceSinkTests
|
|
{
|
|
// ---------- before SetSink — all calls are safe no-ops ----------
|
|
|
|
[Fact]
|
|
public void Before_SetSink_WriteValue_is_a_noop()
|
|
{
|
|
var sink = new DeferredAddressSpaceSink();
|
|
// Must not throw.
|
|
sink.WriteValue("ns=2;s=x", 42, OpcUaStatus.Good, DateTime.UtcNow, AddressSpaceRealm.Uns);
|
|
}
|
|
|
|
[Fact]
|
|
public void Before_SetSink_RebuildAddressSpace_is_a_noop()
|
|
{
|
|
var sink = new DeferredAddressSpaceSink();
|
|
sink.RebuildAddressSpace(); // Must not throw.
|
|
}
|
|
|
|
[Fact]
|
|
public void Before_SetSink_UpdateTagAttributes_returns_false()
|
|
{
|
|
var sink = new DeferredAddressSpaceSink();
|
|
sink.UpdateTagAttributes("ns=2;s=x", writable: true, historianTagname: null,
|
|
dataType: "Boolean", isArray: false, arrayLength: null, AddressSpaceRealm.Uns).ShouldBeFalse();
|
|
}
|
|
|
|
// ---------- after SetSink — operations are forwarded ----------
|
|
|
|
[Fact]
|
|
public void After_SetSink_WriteValue_is_forwarded()
|
|
{
|
|
var inner = new SpySink();
|
|
var sink = new DeferredAddressSpaceSink();
|
|
sink.SetSink(inner);
|
|
|
|
sink.WriteValue("ns=2;s=x", 99, OpcUaStatus.Good, DateTime.UtcNow, AddressSpaceRealm.Uns);
|
|
|
|
inner.WriteValueCalled.ShouldBeTrue();
|
|
}
|
|
|
|
[Fact]
|
|
public void After_SetSink_RebuildAddressSpace_is_forwarded()
|
|
{
|
|
var inner = new SpySink();
|
|
var sink = new DeferredAddressSpaceSink();
|
|
sink.SetSink(inner);
|
|
|
|
sink.RebuildAddressSpace();
|
|
|
|
inner.RebuildCalled.ShouldBeTrue();
|
|
}
|
|
|
|
[Fact]
|
|
public void After_SetSink_WireAlarmNotifiers_is_forwarded_with_all_args()
|
|
{
|
|
// v3 Batch 4 WP4: without this forward the native-alarm multi-notifier fan-out ships INERT on every
|
|
// driver-role host (actors inject THIS wrapper, not the inner sink) — the F10b / PR#423 trap class.
|
|
var inner = new SpySink();
|
|
var sink = new DeferredAddressSpaceSink();
|
|
sink.SetSink(inner);
|
|
|
|
sink.WireAlarmNotifiers("Plant/Modbus/dev1/temp_hi", AddressSpaceRealm.Raw,
|
|
new[] { "EQ-1", "EQ-2" }, AddressSpaceRealm.Uns);
|
|
|
|
inner.WireAlarmNotifiersArgs.ShouldNotBeNull();
|
|
inner.WireAlarmNotifiersArgs!.Value.AlarmNodeId.ShouldBe("Plant/Modbus/dev1/temp_hi");
|
|
inner.WireAlarmNotifiersArgs.Value.AlarmRealm.ShouldBe(AddressSpaceRealm.Raw);
|
|
inner.WireAlarmNotifiersArgs.Value.Folders.ShouldBe(new[] { "EQ-1", "EQ-2" });
|
|
inner.WireAlarmNotifiersArgs.Value.FolderRealm.ShouldBe(AddressSpaceRealm.Uns);
|
|
}
|
|
|
|
// ---------- ISurgicalAddressSpaceSink forwarding ----------
|
|
|
|
[Fact]
|
|
public void UpdateTagAttributes_returns_false_for_non_surgical_inner()
|
|
{
|
|
// SpySink does NOT implement ISurgicalAddressSpaceSink.
|
|
var sink = new DeferredAddressSpaceSink();
|
|
sink.SetSink(new SpySink());
|
|
|
|
sink.UpdateTagAttributes("ns=2;s=x", writable: true, historianTagname: null,
|
|
dataType: "Int32", isArray: false, arrayLength: null, AddressSpaceRealm.Uns).ShouldBeFalse();
|
|
}
|
|
|
|
[Fact]
|
|
public void UpdateTagAttributes_returns_true_for_surgical_inner()
|
|
{
|
|
var surgical = new SpySurgicalSink();
|
|
var sink = new DeferredAddressSpaceSink();
|
|
sink.SetSink(surgical);
|
|
|
|
var result = sink.UpdateTagAttributes("ns=2;s=x", writable: true, historianTagname: null,
|
|
dataType: "Float", isArray: false, arrayLength: null, AddressSpaceRealm.Uns);
|
|
|
|
result.ShouldBeTrue();
|
|
surgical.UpdateCalled.ShouldBeTrue();
|
|
}
|
|
|
|
[Fact]
|
|
public void UpdateFolderDisplayName_returns_false_for_non_surgical_inner()
|
|
{
|
|
// SpySink does NOT implement ISurgicalAddressSpaceSink.
|
|
var sink = new DeferredAddressSpaceSink();
|
|
sink.SetSink(new SpySink());
|
|
|
|
sink.UpdateFolderDisplayName("area-1", "Plant South", AddressSpaceRealm.Uns).ShouldBeFalse();
|
|
}
|
|
|
|
[Fact]
|
|
public void UpdateFolderDisplayName_returns_true_for_surgical_inner()
|
|
{
|
|
// OpcUaServer-001: the deferred wrapper must forward the folder-rename capability to a surgical inner.
|
|
var surgical = new SpySurgicalSink();
|
|
var sink = new DeferredAddressSpaceSink();
|
|
sink.SetSink(surgical);
|
|
|
|
var result = sink.UpdateFolderDisplayName("area-1", "Plant South", AddressSpaceRealm.Uns);
|
|
|
|
result.ShouldBeTrue();
|
|
surgical.FolderRenameCalled.ShouldBeTrue();
|
|
}
|
|
|
|
// ---------- R2-07 Phase 2: surgical remove forwarding ----------
|
|
|
|
[Fact]
|
|
public void Remove_members_return_false_for_non_surgical_inner()
|
|
{
|
|
var sink = new DeferredAddressSpaceSink();
|
|
sink.SetSink(new SpySink());
|
|
|
|
sink.RemoveVariableNode("v-1", AddressSpaceRealm.Uns).ShouldBeFalse();
|
|
sink.RemoveAlarmConditionNode("a-1", AddressSpaceRealm.Uns).ShouldBeFalse();
|
|
sink.RemoveEquipmentSubtree("eq-1", AddressSpaceRealm.Uns).ShouldBeFalse();
|
|
}
|
|
|
|
[Fact]
|
|
public void Remove_members_forward_to_surgical_inner()
|
|
{
|
|
var surgical = new SpySurgicalSink();
|
|
var sink = new DeferredAddressSpaceSink();
|
|
sink.SetSink(surgical);
|
|
|
|
sink.RemoveVariableNode("v-1", AddressSpaceRealm.Uns).ShouldBeTrue();
|
|
sink.RemoveAlarmConditionNode("a-1", AddressSpaceRealm.Uns).ShouldBeTrue();
|
|
sink.RemoveEquipmentSubtree("eq-1", AddressSpaceRealm.Uns).ShouldBeTrue();
|
|
|
|
surgical.RemoveVariableCalled.ShouldBeTrue();
|
|
surgical.RemoveAlarmCalled.ShouldBeTrue();
|
|
surgical.RemoveSubtreeCalled.ShouldBeTrue();
|
|
}
|
|
|
|
[Fact]
|
|
public void Before_SetSink_remove_members_return_false()
|
|
{
|
|
var sink = new DeferredAddressSpaceSink();
|
|
sink.RemoveVariableNode("v-1", AddressSpaceRealm.Uns).ShouldBeFalse();
|
|
sink.RemoveAlarmConditionNode("a-1", AddressSpaceRealm.Uns).ShouldBeFalse();
|
|
sink.RemoveEquipmentSubtree("eq-1", AddressSpaceRealm.Uns).ShouldBeFalse();
|
|
}
|
|
|
|
// ---------- SetSink(null) reverts to null sink ----------
|
|
|
|
[Fact]
|
|
public void SetSink_null_reverts_to_null_sink_and_UpdateTagAttributes_returns_false()
|
|
{
|
|
var surgical = new SpySurgicalSink();
|
|
var sink = new DeferredAddressSpaceSink();
|
|
sink.SetSink(surgical);
|
|
sink.SetSink(null); // revert
|
|
|
|
sink.UpdateTagAttributes("ns=2;s=x", writable: false, historianTagname: null,
|
|
dataType: "Boolean", isArray: false, arrayLength: null, AddressSpaceRealm.Uns).ShouldBeFalse();
|
|
}
|
|
|
|
[Fact]
|
|
public void SetSink_null_reverts_to_null_sink_and_WriteValue_is_noop()
|
|
{
|
|
var inner = new SpySink();
|
|
var sink = new DeferredAddressSpaceSink();
|
|
sink.SetSink(inner);
|
|
sink.SetSink(null); // revert
|
|
|
|
sink.WriteValue("ns=2;s=x", 1, OpcUaStatus.Good, DateTime.UtcNow, AddressSpaceRealm.Uns);
|
|
|
|
inner.WriteValueCalled.ShouldBeFalse("write should be no-op after reverting to null sink");
|
|
}
|
|
|
|
// ---- test doubles ----
|
|
|
|
private sealed class SpySink : IOpcUaAddressSpaceSink
|
|
{
|
|
public bool WriteValueCalled { get; private set; }
|
|
public bool RebuildCalled { get; private set; }
|
|
public (string AlarmNodeId, AddressSpaceRealm AlarmRealm, IReadOnlyList<string> Folders, AddressSpaceRealm FolderRealm)? WireAlarmNotifiersArgs { get; private set; }
|
|
|
|
public void WriteValue(string nodeId, object? value, uint statusCode, DateTime sourceTimestampUtc, AddressSpaceRealm realm = AddressSpaceRealm.Uns)
|
|
=> WriteValueCalled = true;
|
|
|
|
public void WriteAlarmQuality(string alarmNodeId, uint statusCode, DateTime sourceTimestampUtc, AddressSpaceRealm realm) { }
|
|
|
|
public void WriteAlarmCondition(string alarmNodeId, AlarmConditionSnapshot state, DateTime sourceTimestampUtc, AddressSpaceRealm realm = AddressSpaceRealm.Uns) { }
|
|
public void MaterialiseAlarmCondition(string alarmNodeId, string equipmentNodeId, string displayName, string alarmType, int severity, AddressSpaceRealm realm, bool isNative = false) { }
|
|
public void EnsureFolder(string folderNodeId, string? parentNodeId, string displayName, AddressSpaceRealm realm = AddressSpaceRealm.Uns) { }
|
|
public void EnsureVariable(string variableNodeId, string? parentFolderNodeId, string displayName, string dataType, bool writable, AddressSpaceRealm realm, string? historianTagname = null, bool isArray = false, uint? arrayLength = null) { }
|
|
public void RebuildAddressSpace() => RebuildCalled = true;
|
|
public void RaiseNodesAddedModelChange(string affectedNodeId, AddressSpaceRealm realm = AddressSpaceRealm.Uns) { }
|
|
public void WireAlarmNotifiers(string alarmNodeId, AddressSpaceRealm alarmRealm, IReadOnlyList<string> notifierFolderNodeIds, AddressSpaceRealm notifierFolderRealm)
|
|
=> WireAlarmNotifiersArgs = (alarmNodeId, alarmRealm, notifierFolderNodeIds, notifierFolderRealm);
|
|
public void AddReference(string sourceNodeId, AddressSpaceRealm sourceRealm, string targetNodeId, AddressSpaceRealm targetRealm, string referenceType = "Organizes") { }
|
|
}
|
|
|
|
private sealed class SpySurgicalSink : IOpcUaAddressSpaceSink, ISurgicalAddressSpaceSink
|
|
{
|
|
public bool UpdateCalled { get; private set; }
|
|
public bool FolderRenameCalled { get; private set; }
|
|
|
|
public void WriteValue(string nodeId, object? value, uint statusCode, DateTime sourceTimestampUtc, AddressSpaceRealm realm = AddressSpaceRealm.Uns) { }
|
|
public void WriteAlarmQuality(string alarmNodeId, uint statusCode, DateTime sourceTimestampUtc, AddressSpaceRealm realm) { }
|
|
public void WriteAlarmCondition(string alarmNodeId, AlarmConditionSnapshot state, DateTime sourceTimestampUtc, AddressSpaceRealm realm = AddressSpaceRealm.Uns) { }
|
|
public void MaterialiseAlarmCondition(string alarmNodeId, string equipmentNodeId, string displayName, string alarmType, int severity, AddressSpaceRealm realm, bool isNative = false) { }
|
|
public void EnsureFolder(string folderNodeId, string? parentNodeId, string displayName, AddressSpaceRealm realm = AddressSpaceRealm.Uns) { }
|
|
public void EnsureVariable(string variableNodeId, string? parentFolderNodeId, string displayName, string dataType, bool writable, AddressSpaceRealm realm, string? historianTagname = null, bool isArray = false, uint? arrayLength = null) { }
|
|
public void RebuildAddressSpace() { }
|
|
public void RaiseNodesAddedModelChange(string affectedNodeId, AddressSpaceRealm realm = AddressSpaceRealm.Uns) { }
|
|
public void WireAlarmNotifiers(string alarmNodeId, AddressSpaceRealm alarmRealm, IReadOnlyList<string> notifierFolderNodeIds, AddressSpaceRealm notifierFolderRealm) { }
|
|
public void AddReference(string sourceNodeId, AddressSpaceRealm sourceRealm, string targetNodeId, AddressSpaceRealm targetRealm, string referenceType = "Organizes") { }
|
|
|
|
public bool UpdateTagAttributes(string variableNodeId, bool writable, string? historianTagname, string dataType, bool isArray, uint? arrayLength, AddressSpaceRealm realm = AddressSpaceRealm.Uns)
|
|
{
|
|
UpdateCalled = true;
|
|
return true;
|
|
}
|
|
|
|
public bool UpdateFolderDisplayName(string folderNodeId, string displayName, AddressSpaceRealm realm = AddressSpaceRealm.Uns)
|
|
{
|
|
FolderRenameCalled = true;
|
|
return true;
|
|
}
|
|
|
|
public bool RemoveVariableCalled { get; private set; }
|
|
public bool RemoveAlarmCalled { get; private set; }
|
|
public bool RemoveSubtreeCalled { get; private set; }
|
|
|
|
public bool RemoveVariableNode(string variableNodeId, AddressSpaceRealm realm = AddressSpaceRealm.Uns) { RemoveVariableCalled = true; return true; }
|
|
public bool RemoveAlarmConditionNode(string alarmNodeId, AddressSpaceRealm realm = AddressSpaceRealm.Uns) { RemoveAlarmCalled = true; return true; }
|
|
public bool RemoveEquipmentSubtree(string equipmentNodeId, AddressSpaceRealm realm = AddressSpaceRealm.Uns) { RemoveSubtreeCalled = true; return true; }
|
|
}
|
|
}
|