Joseph Doherty
8ebc712eff
Materialize each native alarm ONCE at the raw tag (ConditionId = RawPath, Raw realm); wire the single condition as an SDK event notifier of each referencing equipment's UNS folder so one ReportEvent fans to every root without re-reporting per root (which would break Server-object dedup + Part 9 ack correlation). - New sink method WireAlarmNotifiers(alarmNodeId, alarmRealm, notifierFolderNodeIds, notifierFolderRealm) on IOpcUaAddressSpaceSink, forwarded through DeferredAddressSpaceSink + SdkAddressSpaceSink + NullOpcUaAddressSpaceSink (the forwarding-trap guard); auto-covered by the DeferredSinkForwardingReflectionTests realm + forwarding guards + a hand-written forward test. - OtOpcUaNodeManager: the normative AddNotifier(isInverse) pair + idempotent EnsureFolderIsEventNotifier per equipment folder; tracked per condition in _alarmNotifierWiring. Teardown symmetry: RemoveNotifier(bidirectional:true) on RebuildAddressSpace, RemoveAlarmConditionNode, and RemoveEquipmentSubtree so no inverse-notifier entry leaks across redeploys. - AddressSpaceApplier.MaterialiseRawSubtree wires notifiers for each native alarm tag, resolving its ReferencingEquipmentPaths (Area/Line/Equipment) to the EquipmentId folder NodeIds via BuildEquipmentIdByFolderPath. - AlarmTransitionEvent gains ReferencingEquipmentPaths (empty default); /alerts renders the referencing-equipment list as display metadata. - Un-skipped + rewrote the native-alarm dark tests (DriverHostActorNativeAlarmTests x6, DriverHostActorNativeAlarmAckRoutingTests x1) for the v3 raw-condition model; new NodeManagerMultiNotifierAlarmTests proves multi-notifier wiring + teardown symmetry (no leaked duplicates after a re-trip) + applier wiring test. Claude-Session: https://claude.ai/code/session_01LVneM3eh1UtJxEisFXgmox
259 lines
12 KiB
C#
259 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, OpcUaQuality.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, OpcUaQuality.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, OpcUaQuality.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, OpcUaQuality quality, DateTime sourceTimestampUtc, AddressSpaceRealm realm = AddressSpaceRealm.Uns)
|
|
=> WriteValueCalled = true;
|
|
|
|
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, OpcUaQuality quality, DateTime sourceTimestampUtc, AddressSpaceRealm realm = AddressSpaceRealm.Uns) { }
|
|
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; }
|
|
}
|
|
}
|