using Shouldly; using Xunit; using ZB.MOM.WW.OtOpcUa.Core.Abstractions; namespace ZB.MOM.WW.OtOpcUa.Driver.Modbus.Tests; /// /// Round-trip coverage for #137 array support — read N consecutive registers (or coils) /// and surface them as a typed OPC UA array. Builds on the FakeTransport in /// ; tests are co-located with the rest of the in-memory /// driver coverage so they all share the same harness. /// [Trait("Category", "Unit")] public sealed class ModbusArrayTests { private static (ModbusDriver driver, ModbusDriverTests.FakeTransport fake) NewDriver(params ModbusTagDefinition[] tags) { var fake = new ModbusDriverTests.FakeTransport(); var opts = new ModbusDriverOptions { Host = "fake", Tags = tags }; var drv = new ModbusDriver(opts, "modbus-array", _ => fake); return (drv, fake); } /// Verifies reading an Int16 array returns a typed array. [Fact] public async Task Read_Int16_Array_Returns_Typed_Array() { var tag = new ModbusTagDefinition("Levels", ModbusRegion.HoldingRegisters, 0, ModbusDataType.Int16, ArrayCount: 5); var (drv, fake) = NewDriver(tag); for (var i = 0; i < 5; i++) fake.HoldingRegisters[i] = (ushort)(100 + i); await drv.InitializeAsync("{}", CancellationToken.None); var values = await drv.ReadAsync(["Levels"], CancellationToken.None); var arr = values[0].Value.ShouldBeOfType(); arr.ShouldBe(new short[] { 100, 101, 102, 103, 104 }); } /// Verifies reading a Float32 array with word swap returns a typed array. [Fact] public async Task Read_Float32_Array_Returns_Typed_Array_With_WordSwap() { var tag = new ModbusTagDefinition("Temps", ModbusRegion.HoldingRegisters, 10, ModbusDataType.Float32, ArrayCount: 3, ByteOrder: ModbusByteOrder.WordSwap); var (drv, fake) = NewDriver(tag); // Pre-encode 3 floats into the fake bank using the matching CDAB layout. // Float 1.5f = 0x3FC00000; word-swap → low word in high reg pair: reg0=0x0000, reg1=0x3FC0. // Loop encodes 1.5, 2.5, 3.5. var src = new[] { 1.5f, 2.5f, 3.5f }; for (var i = 0; i < src.Length; i++) { var bytes = BitConverter.GetBytes(src[i]); // BitConverter is little-endian on x86; rearrange to big-endian register pair. // CDAB means: reg(addr+0) holds bytes[1..0] (low word), reg(addr+1) holds bytes[3..2] (high word). fake.HoldingRegisters[10 + i * 2 + 0] = (ushort)((bytes[1] << 8) | bytes[0]); fake.HoldingRegisters[10 + i * 2 + 1] = (ushort)((bytes[3] << 8) | bytes[2]); } await drv.InitializeAsync("{}", CancellationToken.None); var values = await drv.ReadAsync(["Temps"], CancellationToken.None); var arr = values[0].Value.ShouldBeOfType(); arr.ShouldBe(src); } /// Verifies reading a coil array returns a bool array. [Fact] public async Task Read_Coil_Array_Returns_Bool_Array() { var tag = new ModbusTagDefinition("Flags", ModbusRegion.Coils, 0, ModbusDataType.Bool, ArrayCount: 10); var (drv, fake) = NewDriver(tag); // alternating pattern: T F T F T F T F T F for (var i = 0; i < 10; i++) fake.Coils[i] = i % 2 == 0; await drv.InitializeAsync("{}", CancellationToken.None); var values = await drv.ReadAsync(["Flags"], CancellationToken.None); var arr = values[0].Value.ShouldBeOfType(); arr.ShouldBe(new[] { true, false, true, false, true, false, true, false, true, false }); } /// Verifies writing an Int16 array lands contiguously in the register bank. [Fact] public async Task Write_Int16_Array_Lands_Contiguous_In_Bank() { var tag = new ModbusTagDefinition("Setpoints", ModbusRegion.HoldingRegisters, 50, ModbusDataType.Int16, ArrayCount: 4); var (drv, fake) = NewDriver(tag); await drv.InitializeAsync("{}", CancellationToken.None); var write = new[] { (short)10, (short)20, (short)30, (short)40 }; var results = await drv.WriteAsync( new[] { new WriteRequest("Setpoints", write) }, CancellationToken.None); results[0].StatusCode.ShouldBe(0u); for (var i = 0; i < 4; i++) fake.HoldingRegisters[50 + i].ShouldBe((ushort)write[i]); } /// Verifies writing a coil array packs bits in LSB-first order. [Fact] public async Task Write_Coil_Array_Packs_LSB_First() { var tag = new ModbusTagDefinition("Outputs", ModbusRegion.Coils, 0, ModbusDataType.Bool, ArrayCount: 10); var (drv, fake) = NewDriver(tag); await drv.InitializeAsync("{}", CancellationToken.None); var pattern = new[] { true, true, false, true, false, false, true, false, true, true }; var results = await drv.WriteAsync( new[] { new WriteRequest("Outputs", pattern) }, CancellationToken.None); results[0].StatusCode.ShouldBe(0u); for (var i = 0; i < pattern.Length; i++) fake.Coils[i].ShouldBe(pattern[i]); } /// Verifies writing an array with mismatched length surfaces an error. [Fact] public async Task Write_Array_Mismatch_Length_Surfaces_Error() { var tag = new ModbusTagDefinition("Setpoints", ModbusRegion.HoldingRegisters, 0, ModbusDataType.Int16, ArrayCount: 4); var (drv, _) = NewDriver(tag); await drv.InitializeAsync("{}", CancellationToken.None); var results = await drv.WriteAsync( new[] { new WriteRequest("Setpoints", new short[] { 1, 2, 3 }) }, // 3 != 4 CancellationToken.None); results[0].StatusCode.ShouldNotBe(0u); } /// Verifies discovery surfaces IsArray and ArrayDim correctly. [Fact] public async Task Discovery_Surfaces_IsArray_And_ArrayDim() { var tag = new ModbusTagDefinition("Vector", ModbusRegion.HoldingRegisters, 0, ModbusDataType.Float32, ArrayCount: 8); var (drv, _) = NewDriver(tag); await drv.InitializeAsync("{}", CancellationToken.None); var captured = new List(); await drv.DiscoverAsync(new RecordingBuilder(captured), CancellationToken.None); captured.Count.ShouldBe(1); captured[0].IsArray.ShouldBeTrue(); captured[0].ArrayDim.ShouldBe(8u); } /// Verifies scalar tag discovery keeps IsArray false. [Fact] public async Task Scalar_Tag_Discovery_Stays_NonArray() { // Regression guard: scalar tags must keep IsArray=false / ArrayDim=null. var tag = new ModbusTagDefinition("Single", ModbusRegion.HoldingRegisters, 0, ModbusDataType.Int16); var (drv, _) = NewDriver(tag); await drv.InitializeAsync("{}", CancellationToken.None); var captured = new List(); await drv.DiscoverAsync(new RecordingBuilder(captured), CancellationToken.None); captured[0].IsArray.ShouldBeFalse(); captured[0].ArrayDim.ShouldBeNull(); } // ---- Gap: String array + BitInRegister array decode ---- /// /// Verifies that a String array (N string elements backed by contiguous register blocks) /// decodes to a string[]. Each element occupies (StringLength+1)/2 /// registers packed high-byte-first (standard HighByteFirst order). /// [Fact] public async Task Read_String_Array_Returns_String_Array() { // 3-element array of 4-char strings → each element = 2 registers = 4 bytes. // "AB" → reg0_hi='A'(0x41), reg0_lo='B'(0x42), reg1_hi=0x00, reg1_lo=0x00 // "CD" → reg2_hi='C'(0x43), reg2_lo='D'(0x44), reg3_hi=0x00, reg3_lo=0x00 // "EF" → reg4_hi='E'(0x45), reg4_lo='F'(0x46), reg5_hi=0x00, reg5_lo=0x00 // StringLength=4 means 4 chars max; "AB" uses 2 then nul-terminates at index 2. var tag = new ModbusTagDefinition("Names", ModbusRegion.HoldingRegisters, 0, ModbusDataType.String, StringLength: 4, ArrayCount: 3); var (drv, fake) = NewDriver(tag); // Element 0: "AB\0\0" → reg0=(0x41<<8|0x42)=0x4142, reg1=0x0000 fake.HoldingRegisters[0] = 0x4142; // 'A','B' fake.HoldingRegisters[1] = 0x0000; // nul nul // Element 1: "CD\0\0" → reg2=0x4344, reg3=0x0000 fake.HoldingRegisters[2] = 0x4344; // 'C','D' fake.HoldingRegisters[3] = 0x0000; // Element 2: "EF\0\0" → reg4=0x4546, reg5=0x0000 fake.HoldingRegisters[4] = 0x4546; // 'E','F' fake.HoldingRegisters[5] = 0x0000; await drv.InitializeAsync("{}", CancellationToken.None); var values = await drv.ReadAsync(["Names"], CancellationToken.None); var arr = values[0].Value.ShouldBeOfType(); arr.Length.ShouldBe(3); arr[0].ShouldBe("AB"); arr[1].ShouldBe("CD"); arr[2].ShouldBe("EF"); } /// /// Verifies that a String array with full-length strings (no nul terminator within the /// element block) decodes correctly. /// [Fact] public async Task Read_String_Array_Full_Length_Elements() { // 2-element array of 2-char strings → each element = 1 register = 2 bytes. // "AB" → reg0=(0x41<<8|0x42), "CD" → reg1=(0x43<<8|0x44) var tag = new ModbusTagDefinition("Codes", ModbusRegion.HoldingRegisters, 10, ModbusDataType.String, StringLength: 2, ArrayCount: 2); var (drv, fake) = NewDriver(tag); fake.HoldingRegisters[10] = 0x4142; // "AB" fake.HoldingRegisters[11] = 0x4344; // "CD" await drv.InitializeAsync("{}", CancellationToken.None); var values = await drv.ReadAsync(["Codes"], CancellationToken.None); var arr = values[0].Value.ShouldBeOfType(); arr.ShouldBe(new[] { "AB", "CD" }); } /// /// Verifies that a BitInRegister array (N register-backed bits at the same bit position) /// decodes to a bool[]. Each element is 1 register; the same BitIndex is applied /// to each. /// [Fact] public async Task Read_BitInRegister_Array_Returns_Bool_Array() { // 4-element BitInRegister array at bit 3 (0-based). // reg0 = 0x0008 → bit3=1, reg1 = 0x0000 → bit3=0, // reg2 = 0x000F → bit3=1, reg3 = 0x0001 → bit3=0 var tag = new ModbusTagDefinition("Bits", ModbusRegion.HoldingRegisters, 5, ModbusDataType.BitInRegister, BitIndex: 3, ArrayCount: 4); var (drv, fake) = NewDriver(tag); fake.HoldingRegisters[5] = 0x0008; // bit3 = 1 fake.HoldingRegisters[6] = 0x0000; // bit3 = 0 fake.HoldingRegisters[7] = 0x000F; // bit3 = 1 fake.HoldingRegisters[8] = 0x0001; // bit3 = 0 await drv.InitializeAsync("{}", CancellationToken.None); var values = await drv.ReadAsync(["Bits"], CancellationToken.None); var arr = values[0].Value.ShouldBeOfType(); arr.ShouldBe(new[] { true, false, true, false }); } /// /// Verifies that a BitInRegister array at bit 0 correctly distinguishes set / clear. /// [Fact] public async Task Read_BitInRegister_Array_Bit0_Returns_Bool_Array() { var tag = new ModbusTagDefinition("Lsb", ModbusRegion.HoldingRegisters, 0, ModbusDataType.BitInRegister, BitIndex: 0, ArrayCount: 3); var (drv, fake) = NewDriver(tag); fake.HoldingRegisters[0] = 0x0001; // bit0 = 1 fake.HoldingRegisters[1] = 0x0002; // bit0 = 0 fake.HoldingRegisters[2] = 0xFFFF; // bit0 = 1 await drv.InitializeAsync("{}", CancellationToken.None); var values = await drv.ReadAsync(["Lsb"], CancellationToken.None); var arr = values[0].Value.ShouldBeOfType(); arr.ShouldBe(new[] { true, false, true }); } // ---- Gap: equipment-tag resolver threads arrayLength → ArrayCount ---- /// /// Verifies that the equipment-tag parser threads arrayLength from the TagConfig /// JSON blob into ModbusTagDefinition.ArrayCount so that an isArray /// equipment tag reads the correct number of elements as an array. /// [Fact] public async Task Equipment_Tag_With_ArrayLength_Reads_As_Array() { var json = """{"region":"HoldingRegisters","address":20,"dataType":"Int16","byteOrder":"BigEndian","bitIndex":0,"stringLength":0,"isArray":true,"arrayLength":3}"""; var fake = new ModbusDriverTests.FakeTransport(); var opts = new ModbusDriverOptions { Host = "fake", Tags = [] }; var drv = new ModbusDriver(opts, "modbus-eq-arr", _ => fake); await drv.InitializeAsync("{}", CancellationToken.None); fake.HoldingRegisters[20] = 100; fake.HoldingRegisters[21] = 200; fake.HoldingRegisters[22] = 300; var r = await drv.ReadAsync([json], CancellationToken.None); r[0].StatusCode.ShouldBe(0u); var arr = r[0].Value.ShouldBeOfType(); arr.ShouldBe(new short[] { 100, 200, 300 }); } /// /// Verifies that an equipment-tag without arrayLength (or arrayLength=0) /// still reads as a scalar (regression guard). /// [Fact] public async Task Equipment_Tag_Without_ArrayLength_Reads_As_Scalar() { var json = """{"region":"HoldingRegisters","address":30,"dataType":"UInt16","byteOrder":"BigEndian","bitIndex":0,"stringLength":0}"""; var fake = new ModbusDriverTests.FakeTransport(); var opts = new ModbusDriverOptions { Host = "fake", Tags = [] }; var drv = new ModbusDriver(opts, "modbus-eq-scalar", _ => fake); await drv.InitializeAsync("{}", CancellationToken.None); fake.HoldingRegisters[30] = 1234; var r = await drv.ReadAsync([json], CancellationToken.None); r[0].StatusCode.ShouldBe(0u); r[0].Value.ShouldBe((ushort)1234); } /// /// Verifies that the equipment-tag parser correctly reads the parsed ArrayCount /// value when arrayLength is present in the JSON blob. /// [Fact] public void Equipment_Tag_Parser_Threads_ArrayLength_Into_ArrayCount() { var json = """{"region":"HoldingRegisters","address":0,"dataType":"Int16","byteOrder":"BigEndian","bitIndex":0,"stringLength":0,"isArray":true,"arrayLength":5}"""; ModbusEquipmentTagParser.TryParse(json, out var def).ShouldBeTrue(); def!.ArrayCount.ShouldBe(5); } /// /// Verifies that the equipment-tag parser leaves ArrayCount null when /// arrayLength is absent or zero. /// [Fact] public void Equipment_Tag_Parser_No_ArrayLength_Leaves_ArrayCount_Null() { var json = """{"region":"HoldingRegisters","address":0,"dataType":"Int16","byteOrder":"BigEndian","bitIndex":0,"stringLength":0}"""; ModbusEquipmentTagParser.TryParse(json, out var def).ShouldBeTrue(); def!.ArrayCount.ShouldBeNull(); } /// Recording address space builder for capturing discovered attributes. /// List to capture discovered attributes into. private sealed class RecordingBuilder(List captured) : IAddressSpaceBuilder { /// Creates a folder in the address space. /// The browse name of the folder. /// The display name of the folder. /// This builder instance. public IAddressSpaceBuilder Folder(string browseName, string displayName) => this; /// Creates a variable in the address space. /// The browse name of the variable. /// The display name of the variable. /// The attribute information. /// A variable handle. public IVariableHandle Variable(string browseName, string displayName, DriverAttributeInfo attributeInfo) { captured.Add(attributeInfo); return new StubHandle(browseName); } /// Adds a property to the current node. /// The browse name of the property. /// The data type of the property. /// The property value. public void AddProperty(string browseName, DriverDataType dataType, object? value) { } /// Stub variable handle for testing. /// The full reference of the handle. private sealed class StubHandle(string fullRef) : IVariableHandle { /// Gets the full reference. public string FullReference => fullRef; /// Marks this variable as an alarm condition. /// The alarm condition information. /// An alarm condition sink. public IAlarmConditionSink MarkAsAlarmCondition(AlarmConditionInfo info) => throw new NotSupportedException("RecordingBuilder doesn't model alarms"); } } }