using System.Collections.Concurrent; using Shouldly; using Xunit; using ZB.MOM.WW.OtOpcUa.Core.Abstractions; using ZB.MOM.WW.OtOpcUa.Driver.TwinCAT; namespace ZB.MOM.WW.OtOpcUa.Driver.TwinCAT.Tests; [Trait("Category", "Unit")] public sealed class TwinCATCapabilityTests { // ---- ITagDiscovery ---- [Fact] public async Task DiscoverAsync_emits_pre_declared_tags() { var builder = new RecordingBuilder(); var drv = new TwinCATDriver(new TwinCATDriverOptions { Devices = [new TwinCATDeviceOptions("ads://5.23.91.23.1.1:851", DeviceName: "Mach1")], Tags = [ new TwinCATTagDefinition("Speed", "ads://5.23.91.23.1.1:851", "MAIN.Speed", TwinCATDataType.DInt), new TwinCATTagDefinition("Status", "ads://5.23.91.23.1.1:851", "GVL.Status", TwinCATDataType.Bool, Writable: false), ], Probe = new TwinCATProbeOptions { Enabled = false }, }, "drv-1"); await drv.InitializeAsync("{}", CancellationToken.None); await drv.DiscoverAsync(builder, CancellationToken.None); builder.Folders.ShouldContain(f => f.BrowseName == "TwinCAT"); builder.Folders.ShouldContain(f => f.BrowseName == "ads://5.23.91.23.1.1:851" && f.DisplayName == "Mach1"); builder.Variables.Single(v => v.BrowseName == "Speed").Info.SecurityClass.ShouldBe(SecurityClassification.Operate); builder.Variables.Single(v => v.BrowseName == "Status").Info.SecurityClass.ShouldBe(SecurityClassification.ViewOnly); } // ---- ISubscribable ---- [Fact] public async Task Subscribe_initial_poll_raises_OnDataChange() { var factory = new FakeTwinCATClientFactory { Customise = () => new FakeTwinCATClient { Values = { ["MAIN.X"] = 42 } }, }; var drv = new TwinCATDriver(new TwinCATDriverOptions { Devices = [new TwinCATDeviceOptions("ads://5.23.91.23.1.1:851")], Tags = [new TwinCATTagDefinition("X", "ads://5.23.91.23.1.1:851", "MAIN.X", TwinCATDataType.DInt)], Probe = new TwinCATProbeOptions { Enabled = false }, UseNativeNotifications = false, // poll-mode test }, "drv-1", factory); await drv.InitializeAsync("{}", CancellationToken.None); var events = new ConcurrentQueue(); drv.OnDataChange += (_, e) => events.Enqueue(e); var handle = await drv.SubscribeAsync(["X"], TimeSpan.FromMilliseconds(200), CancellationToken.None); await WaitForAsync(() => events.Count >= 1, TimeSpan.FromSeconds(2)); events.First().Snapshot.Value.ShouldBe(42); await drv.UnsubscribeAsync(handle, CancellationToken.None); } [Fact] public async Task ShutdownAsync_cancels_active_subscriptions() { var factory = new FakeTwinCATClientFactory { Customise = () => new FakeTwinCATClient { Values = { ["MAIN.X"] = 1 } }, }; var drv = new TwinCATDriver(new TwinCATDriverOptions { Devices = [new TwinCATDeviceOptions("ads://5.23.91.23.1.1:851")], Tags = [new TwinCATTagDefinition("X", "ads://5.23.91.23.1.1:851", "MAIN.X", TwinCATDataType.DInt)], Probe = new TwinCATProbeOptions { Enabled = false }, UseNativeNotifications = false, // poll-mode test }, "drv-1", factory); await drv.InitializeAsync("{}", CancellationToken.None); var events = new ConcurrentQueue(); drv.OnDataChange += (_, e) => events.Enqueue(e); _ = await drv.SubscribeAsync(["X"], TimeSpan.FromMilliseconds(100), CancellationToken.None); await WaitForAsync(() => events.Count >= 1, TimeSpan.FromSeconds(1)); await drv.ShutdownAsync(CancellationToken.None); var afterShutdown = events.Count; await Task.Delay(200); events.Count.ShouldBe(afterShutdown); } // ---- IHostConnectivityProbe ---- [Fact] public async Task GetHostStatuses_returns_entry_per_device() { var drv = new TwinCATDriver(new TwinCATDriverOptions { Devices = [ new TwinCATDeviceOptions("ads://5.23.91.23.1.1:851"), new TwinCATDeviceOptions("ads://5.23.91.24.1.1:851"), ], Probe = new TwinCATProbeOptions { Enabled = false }, }, "drv-1"); await drv.InitializeAsync("{}", CancellationToken.None); drv.GetHostStatuses().Count.ShouldBe(2); } [Fact] public async Task Probe_transitions_to_Running_on_successful_probe() { var factory = new FakeTwinCATClientFactory { Customise = () => new FakeTwinCATClient { ProbeResult = true }, }; var transitions = new ConcurrentQueue(); var drv = new TwinCATDriver(new TwinCATDriverOptions { Devices = [new TwinCATDeviceOptions("ads://5.23.91.23.1.1:851")], Probe = new TwinCATProbeOptions { Enabled = true, Interval = TimeSpan.FromMilliseconds(100), Timeout = TimeSpan.FromMilliseconds(50), }, }, "drv-1", factory); drv.OnHostStatusChanged += (_, e) => transitions.Enqueue(e); await drv.InitializeAsync("{}", CancellationToken.None); await WaitForAsync(() => transitions.Any(t => t.NewState == HostState.Running), TimeSpan.FromSeconds(2)); drv.GetHostStatuses().Single().State.ShouldBe(HostState.Running); await drv.ShutdownAsync(CancellationToken.None); } [Fact] public async Task Probe_transitions_to_Stopped_on_probe_failure() { var factory = new FakeTwinCATClientFactory { Customise = () => new FakeTwinCATClient { ProbeResult = false }, }; var transitions = new ConcurrentQueue(); var drv = new TwinCATDriver(new TwinCATDriverOptions { Devices = [new TwinCATDeviceOptions("ads://5.23.91.23.1.1:851")], Probe = new TwinCATProbeOptions { Enabled = true, Interval = TimeSpan.FromMilliseconds(100), Timeout = TimeSpan.FromMilliseconds(50), }, }, "drv-1", factory); drv.OnHostStatusChanged += (_, e) => transitions.Enqueue(e); await drv.InitializeAsync("{}", CancellationToken.None); await WaitForAsync(() => transitions.Any(t => t.NewState == HostState.Stopped), TimeSpan.FromSeconds(2)); drv.GetHostStatuses().Single().State.ShouldBe(HostState.Stopped); await drv.ShutdownAsync(CancellationToken.None); } [Fact] public async Task Probe_disabled_when_Enabled_is_false() { var factory = new FakeTwinCATClientFactory(); var drv = new TwinCATDriver(new TwinCATDriverOptions { Devices = [new TwinCATDeviceOptions("ads://5.23.91.23.1.1:851")], Probe = new TwinCATProbeOptions { Enabled = false }, }, "drv-1", factory); await drv.InitializeAsync("{}", CancellationToken.None); await Task.Delay(200); drv.GetHostStatuses().Single().State.ShouldBe(HostState.Unknown); await drv.ShutdownAsync(CancellationToken.None); } // ---- IPerCallHostResolver ---- [Fact] public async Task ResolveHost_returns_declared_device_for_known_tag() { var drv = new TwinCATDriver(new TwinCATDriverOptions { Devices = [ new TwinCATDeviceOptions("ads://5.23.91.23.1.1:851"), new TwinCATDeviceOptions("ads://5.23.91.24.1.1:851"), ], Tags = [ new TwinCATTagDefinition("A", "ads://5.23.91.23.1.1:851", "MAIN.A", TwinCATDataType.DInt), new TwinCATTagDefinition("B", "ads://5.23.91.24.1.1:851", "MAIN.B", TwinCATDataType.DInt), ], Probe = new TwinCATProbeOptions { Enabled = false }, }, "drv-1"); await drv.InitializeAsync("{}", CancellationToken.None); drv.ResolveHost("A").ShouldBe("ads://5.23.91.23.1.1:851"); drv.ResolveHost("B").ShouldBe("ads://5.23.91.24.1.1:851"); } [Fact] public async Task ResolveHost_falls_back_to_first_device_for_unknown_ref() { var drv = new TwinCATDriver(new TwinCATDriverOptions { Devices = [new TwinCATDeviceOptions("ads://5.23.91.23.1.1:851")], Probe = new TwinCATProbeOptions { Enabled = false }, }, "drv-1"); await drv.InitializeAsync("{}", CancellationToken.None); drv.ResolveHost("missing").ShouldBe("ads://5.23.91.23.1.1:851"); } [Fact] public async Task ResolveHost_falls_back_to_DriverInstanceId_when_no_devices() { var drv = new TwinCATDriver(new TwinCATDriverOptions(), "drv-1"); await drv.InitializeAsync("{}", CancellationToken.None); drv.ResolveHost("anything").ShouldBe("drv-1"); } // ---- helpers ---- private static async Task WaitForAsync(Func condition, TimeSpan timeout) { var deadline = DateTime.UtcNow + timeout; while (!condition() && DateTime.UtcNow < deadline) await Task.Delay(20); } private sealed class RecordingBuilder : IAddressSpaceBuilder { public List<(string BrowseName, string DisplayName)> Folders { get; } = new(); public List<(string BrowseName, DriverAttributeInfo Info)> Variables { get; } = new(); public IAddressSpaceBuilder Folder(string browseName, string displayName) { Folders.Add((browseName, displayName)); return this; } public IVariableHandle Variable(string browseName, string displayName, DriverAttributeInfo info) { Variables.Add((browseName, info)); return new Handle(info.FullName); } public void AddProperty(string _, DriverDataType __, object? ___) { } private sealed class Handle(string fullRef) : IVariableHandle { public string FullReference => fullRef; public IAlarmConditionSink MarkAsAlarmCondition(AlarmConditionInfo info) => new NullSink(); } private sealed class NullSink : IAlarmConditionSink { public void OnTransition(AlarmEventArgs args) { } } } }