test(v3): migrate 6 driver IntegrationTests to RawTags API

Replace pre-declared options.Tags (typed <Driver>TagDefinition lists) with options.RawTags (IReadOnlyList<RawTagEntry>) across all 6 Docker-gated driver integration suites so they COMPILE against the v3 driver API. Each project gets a local <Driver>RawTags helper mirroring the unit-test project's helper: it serialises a typed def back to its TagConfig blob via the driver's <Driver>TagDefinitionFactory.ToTagConfig and packages it as a RawTagEntry (RawPath = def.Name; DeviceName = def.DeviceHostAddress for the multi-device drivers AbCip/AbLegacy/TwinCAT/FOCAS). Test intent (addresses, data types, device routing, assertions) is unchanged — only the tag-authoring/config-delivery shape was migrated. Docker-gated: these still skip at runtime without fixtures; COMPILE is the gate.
2026-07-15 20:59:42 -04:00
parent 604928b29d
commit a4c61989b2
28 changed files with 249 additions and 104 deletions
@@ -27,7 +27,7 @@ public sealed class AddressingGrammarTests
    {
        var opts = new ModbusDriverOptions
        {
-            Host = _sim.Host, Port = _sim.Port, Tags = tags,
+            Host = _sim.Host, Port = _sim.Port, RawTags = ModbusRawTags.Entries(tags),
            Probe = new ModbusProbeOptions { Enabled = false },
        };
        var drv = new ModbusDriver(opts, "addressing-e2e");
@@ -108,7 +108,7 @@ public sealed class AddressingGrammarTests
        var t3 = new ModbusTagDefinition("T3", ModbusRegion.HoldingRegisters, 204, ModbusDataType.Int16);
        var opts = new ModbusDriverOptions
        {
-            Host = _sim.Host, Port = _sim.Port, Tags = [t1, t2, t3], MaxReadGap = 5,
+            Host = _sim.Host, Port = _sim.Port, RawTags = ModbusRawTags.Entries([t1, t2, t3]), MaxReadGap = 5,
            Probe = new ModbusProbeOptions { Enabled = false },
        };
        var drv = new ModbusDriver(opts, "addressing-e2e");
@@ -31,15 +31,14 @@ public sealed class DL205BcdQuirkTests(ModbusSimulatorFixture sim)
            Port = sim.Port,
            UnitId = 1,
            Timeout = TimeSpan.FromSeconds(2),
-            Tags =
-            [
+            RawTags = ModbusRawTags.Entries([
                new ModbusTagDefinition("DL205_Count_Bcd",
                    ModbusRegion.HoldingRegisters, Address: 1072,
                    DataType: ModbusDataType.Bcd16, Writable: false),
                new ModbusTagDefinition("DL205_Count_Int16",
                    ModbusRegion.HoldingRegisters, Address: 1072,
                    DataType: ModbusDataType.Int16, Writable: false),
-            ],
+            ]),
            Probe = new ModbusProbeOptions { Enabled = false },
        };
        await using var driver = new ModbusDriver(options, driverInstanceId: "dl205-bcd");
@@ -106,7 +106,7 @@ public sealed class DL205CoilMappingTests(ModbusSimulatorFixture sim)
            Port = sim.Port,
            UnitId = 1,
            Timeout = TimeSpan.FromSeconds(2),
-            Tags = tags,
+            RawTags = ModbusRawTags.Entries(tags),
            Probe = new ModbusProbeOptions { Enabled = false },
        };
 }
@@ -36,12 +36,11 @@ public sealed class DL205ExceptionCodeTests(ModbusSimulatorFixture sim)
            Port = sim.Port,
            UnitId = 1,
            Timeout = TimeSpan.FromSeconds(2),
-            Tags =
-            [
+            RawTags = ModbusRawTags.Entries([
                new ModbusTagDefinition("Unmapped",
                    ModbusRegion.HoldingRegisters, Address: 16383,
                    DataType: ModbusDataType.UInt16, Writable: false),
-            ],
+            ]),
            Probe = new ModbusProbeOptions { Enabled = false },
        };
        await using var driver = new ModbusDriver(options, driverInstanceId: "dl205-exc");
@@ -33,8 +33,7 @@ public sealed class DL205FloatCdabQuirkTests(ModbusSimulatorFixture sim)
            Port = sim.Port,
            UnitId = 1,
            Timeout = TimeSpan.FromSeconds(2),
-            Tags =
-            [
+            RawTags = ModbusRawTags.Entries([
                new ModbusTagDefinition("DL205_Float_CDAB",
                    ModbusRegion.HoldingRegisters, Address: 1056,
                    DataType: ModbusDataType.Float32, Writable: false,
@@ -44,7 +43,7 @@ public sealed class DL205FloatCdabQuirkTests(ModbusSimulatorFixture sim)
                    ModbusRegion.HoldingRegisters, Address: 1056,
                    DataType: ModbusDataType.Float32, Writable: false,
                    ByteOrder: ModbusByteOrder.BigEndian),
-            ],
+            ]),
            Probe = new ModbusProbeOptions { Enabled = false },
        };
        await using var driver = new ModbusDriver(options, driverInstanceId: "dl205-cdab");
@@ -37,15 +37,14 @@ public static class DL205Profile
        Port = port,
        UnitId = 1,
        Timeout = TimeSpan.FromSeconds(2),
-        Tags =
-        [
+        RawTags = ModbusRawTags.Entries([
            new ModbusTagDefinition(
                Name: "Smoke_HReg200",
                Region: ModbusRegion.HoldingRegisters,
                Address: SmokeHoldingRegister,
                DataType: ModbusDataType.Int16,
                Writable: true),
-        ],
+        ]),
        // Disable the background probe loop — integration tests drive reads explicitly and
        // the probe would race with assertions.
        Probe = new ModbusProbeOptions { Enabled = false },
@@ -40,8 +40,7 @@ public sealed class DL205StringQuirkTests(ModbusSimulatorFixture sim)
            Port = sim.Port,
            UnitId = 1,
            Timeout = TimeSpan.FromSeconds(2),
-            Tags =
-            [
+            RawTags = ModbusRawTags.Entries([
                new ModbusTagDefinition(
                    Name: "DL205_Hello_Low",
                    Region: ModbusRegion.HoldingRegisters,
@@ -60,7 +59,7 @@ public sealed class DL205StringQuirkTests(ModbusSimulatorFixture sim)
                    Writable: false,
                    StringLength: 5,
                    StringByteOrder: ModbusStringByteOrder.HighByteFirst),
-            ],
+            ]),
            Probe = new ModbusProbeOptions { Enabled = false },
        };
        await using var driver = new ModbusDriver(options, driverInstanceId: "dl205-string");
@@ -36,12 +36,11 @@ public sealed class DL205VMemoryQuirkTests(ModbusSimulatorFixture sim)
            Port = sim.Port,
            UnitId = 1,
            Timeout = TimeSpan.FromSeconds(2),
-            Tags =
-            [
+            RawTags = ModbusRawTags.Entries([
                new ModbusTagDefinition("DL205_V2000",
                    ModbusRegion.HoldingRegisters, Address: pdu,
                    DataType: ModbusDataType.UInt16, Writable: false),
-            ],
+            ]),
            Probe = new ModbusProbeOptions { Enabled = false },
        };
        await using var driver = new ModbusDriver(options, driverInstanceId: "dl205-vmem");
@@ -75,12 +74,11 @@ public sealed class DL205VMemoryQuirkTests(ModbusSimulatorFixture sim)
            Port = sim.Port,
            UnitId = 1,
            Timeout = TimeSpan.FromSeconds(2),
-            Tags =
-            [
+            RawTags = ModbusRawTags.Entries([
                new ModbusTagDefinition("DL205_V40400",
                    ModbusRegion.HoldingRegisters, Address: pdu,
                    DataType: ModbusDataType.UInt16, Writable: false),
-            ],
+            ]),
            Probe = new ModbusProbeOptions { Enabled = false },
        };
        await using var driver = new ModbusDriver(options, driverInstanceId: "dl205-sysv");
@@ -66,7 +66,7 @@ public sealed class DL205XInputTests(ModbusSimulatorFixture sim)
            Port = sim.Port,
            UnitId = 1,
            Timeout = TimeSpan.FromSeconds(2),
-            Tags = tags,
+            RawTags = ModbusRawTags.Entries(tags),
            Probe = new ModbusProbeOptions { Enabled = false },
        };
 }
@@ -47,12 +47,11 @@ public sealed class ExceptionInjectionTests(ModbusSimulatorFixture sim)
            Port = sim.Port,
            UnitId = 1,
            Timeout = TimeSpan.FromSeconds(2),
-            Tags =
-            [
+            RawTags = ModbusRawTags.Entries([
                new ModbusTagDefinition(tagName,
                    ModbusRegion.HoldingRegisters, Address: (ushort)address,
                    DataType: ModbusDataType.UInt16, Writable: false),
-            ],
+            ]),
            Probe = new ModbusProbeOptions { Enabled = false },
        };
        await using var driver = new ModbusDriver(opts, driverInstanceId: "modbus-exc");
@@ -112,12 +111,11 @@ public sealed class ExceptionInjectionTests(ModbusSimulatorFixture sim)
            Port = sim.Port,
            UnitId = 1,
            Timeout = TimeSpan.FromSeconds(2),
-            Tags =
-            [
+            RawTags = ModbusRawTags.Entries([
                new ModbusTagDefinition(tag,
                    ModbusRegion.HoldingRegisters, Address: (ushort)address,
                    DataType: ModbusDataType.UInt16, Writable: true),
-            ],
+            ]),
            Probe = new ModbusProbeOptions { Enabled = false },
        };
        await using var driver = new ModbusDriver(opts, driverInstanceId: "modbus-exc-write");
@@ -32,15 +32,14 @@ public static class MitsubishiProfile
        Port = port,
        UnitId = 1,
        Timeout = TimeSpan.FromSeconds(2),
-        Tags =
-        [
+        RawTags = ModbusRawTags.Entries([
            new ModbusTagDefinition(
                Name: "Smoke_HReg200",
                Region: ModbusRegion.HoldingRegisters,
                Address: SmokeHoldingRegister,
                DataType: ModbusDataType.Int16,
                Writable: true),
-        ],
+        ]),
        Probe = new ModbusProbeOptions { Enabled = false },
    };
 }
@@ -176,7 +176,7 @@ public sealed class MitsubishiQuirkTests(ModbusSimulatorFixture sim)
                Port = sim.Port,
                UnitId = 1,
                Timeout = TimeSpan.FromSeconds(2),
-                Tags = tags,
+                RawTags = ModbusRawTags.Entries(tags),
                Probe = new ModbusProbeOptions { Enabled = false },
            },
            driverInstanceId: "melsec-quirk");
@@ -0,0 +1,29 @@
+using ZB.MOM.WW.OtOpcUa.Core.Abstractions;
+
+namespace ZB.MOM.WW.OtOpcUa.Driver.Modbus.IntegrationTests;
+
+/// <summary>
+///     Test helper bridging the v2 authoring shape (a typed <see cref="ModbusTagDefinition"/>) to the v3
+///     delivery shape (<see cref="RawTagEntry"/>). Under v3 the driver no longer takes pre-declared
+///     definitions — the deploy artifact hands it authored raw tags (RawPath + TagConfig blob), and the
+///     driver rebuilds the typed definitions via <see cref="ModbusTagDefinitionFactory"/>. These integration
+///     profiles + quirk tests keep expressing their intent as typed definitions; this helper serialises each
+///     back to its TagConfig blob (via <see cref="ModbusTagDefinitionFactory.ToTagConfig"/>) and packages it
+///     as a <see cref="RawTagEntry"/> whose RawPath is the def's <c>Name</c> — so the round-trip through the
+///     real mapper reproduces the same definition the test authored, keyed by the same name the
+///     read/write/subscribe call sites use. Mirrors the unit-test project's helper of the same name.
+/// </summary>
+internal static class ModbusRawTags
+{
+    /// <summary>Serialises one typed definition into its <see cref="RawTagEntry"/> (RawPath = def.Name).</summary>
+    /// <param name="def">The typed definition to convert.</param>
+    /// <returns>The equivalent <see cref="RawTagEntry"/>.</returns>
+    public static RawTagEntry Entry(ModbusTagDefinition def)
+        => new(def.Name, ModbusTagDefinitionFactory.ToTagConfig(def), def.WriteIdempotent);
+
+    /// <summary>Serialises a sequence of typed definitions into <see cref="RawTagEntry"/> records.</summary>
+    /// <param name="defs">The typed definitions to convert.</param>
+    /// <returns>The equivalent raw-tag entries.</returns>
+    public static IReadOnlyList<RawTagEntry> Entries(IEnumerable<ModbusTagDefinition> defs)
+        => [.. defs.Select(Entry)];
+}
@@ -32,15 +32,14 @@ public static class S7_1500Profile
        Port = port,
        UnitId = 1,
        Timeout = TimeSpan.FromSeconds(2),
-        Tags =
-        [
+        RawTags = ModbusRawTags.Entries([
            new ModbusTagDefinition(
                Name: "Smoke_HReg200",
                Region: ModbusRegion.HoldingRegisters,
                Address: SmokeHoldingRegister,
                DataType: ModbusDataType.Int16,
                Writable: true),
-        ],
+        ]),
        // Disable the background probe loop — integration tests drive reads explicitly and
        // the probe would race with assertions.
        Probe = new ModbusProbeOptions { Enabled = false },
@@ -33,8 +33,7 @@ public sealed class S7_ByteOrderTests(ModbusSimulatorFixture sim)
            Port = sim.Port,
            UnitId = 1,
            Timeout = TimeSpan.FromSeconds(2),
-            Tags =
-            [
+            RawTags = ModbusRawTags.Entries([
                new ModbusTagDefinition("S7_Float_ABCD",
                    ModbusRegion.HoldingRegisters, Address: 100,
                    DataType: ModbusDataType.Float32, Writable: false,
@@ -45,7 +44,7 @@ public sealed class S7_ByteOrderTests(ModbusSimulatorFixture sim)
                    ModbusRegion.HoldingRegisters, Address: 100,
                    DataType: ModbusDataType.Float32, Writable: false,
                    ByteOrder: ModbusByteOrder.WordSwap),
-            ],
+            ]),
            Probe = new ModbusProbeOptions { Enabled = false },
        };
        await using var driver = new ModbusDriver(options, driverInstanceId: "s7-float-abcd");
@@ -79,13 +78,12 @@ public sealed class S7_ByteOrderTests(ModbusSimulatorFixture sim)
            Port = sim.Port,
            UnitId = 1,
            Timeout = TimeSpan.FromSeconds(2),
-            Tags =
-            [
+            RawTags = ModbusRawTags.Entries([
                new ModbusTagDefinition("S7_Int32_ABCD",
                    ModbusRegion.HoldingRegisters, Address: 300,
                    DataType: ModbusDataType.Int32, Writable: false,
                    ByteOrder: ModbusByteOrder.BigEndian),
-            ],
+            ]),
            Probe = new ModbusProbeOptions { Enabled = false },
        };
        await using var driver = new ModbusDriver(options, driverInstanceId: "s7-int-abcd");
@@ -117,12 +115,11 @@ public sealed class S7_ByteOrderTests(ModbusSimulatorFixture sim)
            Port = sim.Port,
            UnitId = 1,
            Timeout = TimeSpan.FromSeconds(2),
-            Tags =
-            [
+            RawTags = ModbusRawTags.Entries([
                new ModbusTagDefinition("S7_Fingerprint",
                    ModbusRegion.HoldingRegisters, Address: 0,
                    DataType: ModbusDataType.UInt16, Writable: false),
-            ],
+            ]),
            Probe = new ModbusProbeOptions { Enabled = false },
        };
        await using var driver = new ModbusDriver(options, driverInstanceId: "s7-fingerprint");