dohertj2/lmxopcua
1
0
Fork 0
Code Issues 2 Pull Requests Actions Packages Projects Releases Wiki Activity

v3(b1-modbus): RawPath identity seam — RawTagEntry-driven Modbus driver

Browse Source 
Wave-B EXEMPLAR. Retire the pre-declared/blob-parse tag model; the driver now
builds its RawPath -> definition table from the artifact's RawTagEntry set via a
pure mapper.

- Contracts: rename ModbusEquipmentTagParser -> ModbusTagDefinitionFactory;
  TryParse(reference) -> FromTagConfig(tagConfig, rawPath) (def.Name = rawPath,
  no leading-brace heuristic); add inverse ToTagConfig(def) serializer; keep all
  strict-enum reads + guards; also read stringByteOrder/deadband/coalesceProhibited
  so a RawTagEntry round-trips the full authored def. Inspect() unchanged.
- Options: Tags(IReadOnlyList<ModbusTagDefinition>) -> RawTags(IReadOnlyList<RawTagEntry>).
- Driver: _tagsByName -> _tagsByRawPath (Ordinal); resolver byRawPath-only; build
  the table from RawTags at Initialize threading entry.WriteIdempotent onto each def;
  Discover/Teardown updated.
- Factory: remove ModbusTagDto/BuildTag/ValidateStringLength + ConfigDto.Tags; bind
  RawTags from driver-config JSON.
- CLI ModbusCommandBase.BuildOptions: serialise typed defs -> RawTagEntry via ToTagConfig.
- Tests: migrate Tags= -> RawTags via ModbusRawTags.Entries helper; parser tests ->
  FromTagConfig(rawPath); factory String-length/enum tests re-seated on the mapper seam.
- Propagated rename to ControlPlane EquipmentTagConfigInspector (outside Modbus projects).

Modbus.Tests 315/315, Addressing.Tests 161/161, Cli.Tests 72/72 green.
Docker-gated Driver.Modbus.IntegrationTests left untouched (won't compile against
the new API; expected).
This commit is contained in:
Joseph Doherty
2026-07-15 19:50:10 -04:00
parent 906800abc0
commit aafb9d4929
27 changed files with 362 additions and 362 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tests/Drivers/Cli/ZB.MOM.WW.OtOpcUa.Driver.Modbus.Cli.Tests/ModbusCommandBaseTests.cs
+8 -4
View File
@@ -92,9 +92,9 @@ public sealed class ModbusCommandBaseTests
options.UnitId.ShouldBe((byte)17);
}
/// <summary>Verifies that BuildOptions forwards the tag list verbatim.</summary>
/// <summary>Verifies that BuildOptions serialises each typed tag into a RawTagEntry (RawPath = name).</summary>
[Fact]
public void BuildOptions_forwards_tag_list_verbatim()
public void BuildOptions_serialises_tags_into_raw_tag_entries()
{
var sut = new ProbeOnly { Host = "h" };
var tag = new ModbusTagDefinition(
@@ -102,8 +102,12 @@ public sealed class ModbusCommandBaseTests
var options = sut.Invoke([tag]);
options.Tags.Count.ShouldBe(1);
options.Tags[0].ShouldBeSameAs(tag);
options.RawTags.Count.ShouldBe(1);
options.RawTags[0].RawPath.ShouldBe("T");
// The blob the driver's factory reads round-trips back to the same definition.
ModbusTagDefinitionFactory.FromTagConfig(options.RawTags[0].TagConfig, "T", out var def).ShouldBeTrue();
def.Region.ShouldBe(ModbusRegion.HoldingRegisters);
def.DataType.ShouldBe(ModbusDataType.UInt16);
}
// --- Driver.Modbus.Cli-003: parse-time endpoint validation -------------------------------
tests/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Modbus.Tests/ModbusArrayTests.cs
+13 -13
View File
@@ -16,7 +16,7 @@ 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 opts = new ModbusDriverOptions { Host = "fake", RawTags = ModbusRawTags.Entries(tags)};
var drv = new ModbusDriver(opts, "modbus-array", _ => fake);
return (drv, fake);
}
@@ -274,14 +274,14 @@ public sealed class ModbusArrayTests
{
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 opts = new ModbusDriverOptions { Host = "fake", RawTags = [new RawTagEntry("cell/modbus/arr20", json, false)] };
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);
var r = await drv.ReadAsync(["cell/modbus/arr20"], CancellationToken.None);
r[0].StatusCode.ShouldBe(0u);
var arr = r[0].Value.ShouldBeOfType<short[]>();
@@ -297,12 +297,12 @@ public sealed class ModbusArrayTests
{
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 opts = new ModbusDriverOptions { Host = "fake", RawTags = [new RawTagEntry("cell/modbus/scalar30", json, false)] };
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);
var r = await drv.ReadAsync(["cell/modbus/scalar30"], CancellationToken.None);
r[0].StatusCode.ShouldBe(0u);
r[0].Value.ShouldBe((ushort)1234);
@@ -316,7 +316,7 @@ public sealed class ModbusArrayTests
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();
ModbusTagDefinitionFactory.FromTagConfig(json, "cell/modbus/arr", out var def).ShouldBeTrue();
def!.ArrayCount.ShouldBe(5);
}
@@ -328,7 +328,7 @@ public sealed class ModbusArrayTests
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();
ModbusTagDefinitionFactory.FromTagConfig(json, "cell/modbus/arr", out var def).ShouldBeTrue();
def!.ArrayCount.ShouldBeNull();
}
@@ -345,7 +345,7 @@ public sealed class ModbusArrayTests
{
// isArray:false, arrayLength:8 → must be scalar (ArrayCount == null).
var json = """{"region":"HoldingRegisters","address":0,"dataType":"Int16","byteOrder":"BigEndian","bitIndex":0,"stringLength":0,"isArray":false,"arrayLength":8}""";
ModbusEquipmentTagParser.TryParse(json, out var def).ShouldBeTrue();
ModbusTagDefinitionFactory.FromTagConfig(json, "cell/modbus/arr", out var def).ShouldBeTrue();
def!.ArrayCount.ShouldBeNull();
}
@@ -359,12 +359,12 @@ public sealed class ModbusArrayTests
// isArray:false, arrayLength:8 → scalar read; only register[40] is consumed.
var json = """{"region":"HoldingRegisters","address":40,"dataType":"Int16","byteOrder":"BigEndian","bitIndex":0,"stringLength":0,"isArray":false,"arrayLength":8}""";
var fake = new ModbusDriverTests.FakeTransport();
var opts = new ModbusDriverOptions { Host = "fake", Tags = [] };
var opts = new ModbusDriverOptions { Host = "fake", RawTags = [new RawTagEntry("cell/modbus/c1scalar40", json, false)] };
var drv = new ModbusDriver(opts, "modbus-c1-scalar", _ => fake);
await drv.InitializeAsync("{}", CancellationToken.None);
fake.HoldingRegisters[40] = 9999;
var r = await drv.ReadAsync([json], CancellationToken.None);
var r = await drv.ReadAsync(["cell/modbus/c1scalar40"], CancellationToken.None);
r[0].StatusCode.ShouldBe(0u);
// Must be a scalar short, NOT a short[].
@@ -380,7 +380,7 @@ public sealed class ModbusArrayTests
public void Parser_IsArrayTrue_ArrayLength1_Gives_ArrayCount_1()
{
var json = """{"region":"HoldingRegisters","address":0,"dataType":"Int16","byteOrder":"BigEndian","bitIndex":0,"stringLength":0,"isArray":true,"arrayLength":1}""";
ModbusEquipmentTagParser.TryParse(json, out var def).ShouldBeTrue();
ModbusTagDefinitionFactory.FromTagConfig(json, "cell/modbus/arr", out var def).ShouldBeTrue();
def!.ArrayCount.ShouldBe(1);
}
@@ -393,12 +393,12 @@ public sealed class ModbusArrayTests
{
var json = """{"region":"HoldingRegisters","address":50,"dataType":"Int16","byteOrder":"BigEndian","bitIndex":0,"stringLength":0,"isArray":true,"arrayLength":1}""";
var fake = new ModbusDriverTests.FakeTransport();
var opts = new ModbusDriverOptions { Host = "fake", Tags = [] };
var opts = new ModbusDriverOptions { Host = "fake", RawTags = [new RawTagEntry("cell/modbus/c1arr50", json, false)] };
var drv = new ModbusDriver(opts, "modbus-c1-arr1", _ => fake);
await drv.InitializeAsync("{}", CancellationToken.None);
fake.HoldingRegisters[50] = 777;
var r = await drv.ReadAsync([json], CancellationToken.None);
var r = await drv.ReadAsync(["cell/modbus/c1arr50"], CancellationToken.None);
r[0].StatusCode.ShouldBe(0u);
// Must be a short[] of length 1, NOT a scalar short.
tests/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Modbus.Tests/ModbusBitRmwTests.cs
+2 -2
View File
@@ -64,7 +64,7 @@ public sealed class ModbusBitRmwTests
var opts = new ModbusDriverOptions
{
Host = "fake",
Tags = tags,
RawTags = ModbusRawTags.Entries(tags),
Probe = new ModbusProbeOptions { Enabled = false },
};
return (new ModbusDriver(opts, "modbus-1", _ => fake), fake);
@@ -198,7 +198,7 @@ public sealed class ModbusBitRmwTests
var opts = new ModbusDriverOptions
{
Host = "fake",
Tags = [new ModbusTagDefinition("Bit5", ModbusRegion.HoldingRegisters, 10, ModbusDataType.BitInRegister, BitIndex: 5)],
RawTags = ModbusRawTags.Entries([new ModbusTagDefinition("Bit5", ModbusRegion.HoldingRegisters, 10, ModbusDataType.BitInRegister, BitIndex: 5)]),
Probe = new ModbusProbeOptions { Enabled = false },
};
var drv = new ModbusDriver(opts, "modbus-rmw-trunc", _ => truncated);
tests/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Modbus.Tests/ModbusCapTests.cs
+5 -5
View File
@@ -66,7 +66,7 @@ public sealed class ModbusCapTests
var tag = new ModbusTagDefinition("S", ModbusRegion.HoldingRegisters, 0, ModbusDataType.String,
StringLength: 40); // 20 regs — fits in default cap (125).
var transport = new RecordingTransport();
var opts = new ModbusDriverOptions { Host = "fake", Tags = [tag], Probe = new ModbusProbeOptions { Enabled = false } };
var opts = new ModbusDriverOptions { Host = "fake", RawTags = ModbusRawTags.Entries([tag]), Probe = new ModbusProbeOptions { Enabled = false } };
await using var drv = new ModbusDriver(opts, "modbus-1", _ => transport);
await drv.InitializeAsync("{}", TestContext.Current.CancellationToken);
@@ -91,7 +91,7 @@ public sealed class ModbusCapTests
var opts = new ModbusDriverOptions
{
Host = "fake",
Tags = [tag],
RawTags = ModbusRawTags.Entries([tag]),
MaxRegistersPerRead = 100,
Probe = new ModbusProbeOptions { Enabled = false },
};
@@ -119,7 +119,7 @@ public sealed class ModbusCapTests
var tag = new ModbusTagDefinition("MitString", ModbusRegion.HoldingRegisters, 0, ModbusDataType.String,
StringLength: 200);
var transport = new RecordingTransport();
var opts = new ModbusDriverOptions { Host = "fake", Tags = [tag], MaxRegistersPerRead = 64, Probe = new ModbusProbeOptions { Enabled = false } };
var opts = new ModbusDriverOptions { Host = "fake", RawTags = ModbusRawTags.Entries([tag]), MaxRegistersPerRead = 64, Probe = new ModbusProbeOptions { Enabled = false } };
await using var drv = new ModbusDriver(opts, "modbus-1", _ => transport);
await drv.InitializeAsync("{}", TestContext.Current.CancellationToken);
@@ -140,7 +140,7 @@ public sealed class ModbusCapTests
var tag = new ModbusTagDefinition("LongStringWrite", ModbusRegion.HoldingRegisters, 0, ModbusDataType.String,
StringLength: 220); // 110 regs.
var transport = new RecordingTransport();
var opts = new ModbusDriverOptions { Host = "fake", Tags = [tag], MaxRegistersPerWrite = 100, Probe = new ModbusProbeOptions { Enabled = false } };
var opts = new ModbusDriverOptions { Host = "fake", RawTags = ModbusRawTags.Entries([tag]), MaxRegistersPerWrite = 100, Probe = new ModbusProbeOptions { Enabled = false } };
await using var drv = new ModbusDriver(opts, "modbus-1", _ => transport);
await drv.InitializeAsync("{}", TestContext.Current.CancellationToken);
@@ -161,7 +161,7 @@ public sealed class ModbusCapTests
var tag = new ModbusTagDefinition("ShortStringWrite", ModbusRegion.HoldingRegisters, 0, ModbusDataType.String,
StringLength: 40); // 20 regs.
var transport = new RecordingTransport();
var opts = new ModbusDriverOptions { Host = "fake", Tags = [tag], MaxRegistersPerWrite = 100, Probe = new ModbusProbeOptions { Enabled = false } };
var opts = new ModbusDriverOptions { Host = "fake", RawTags = ModbusRawTags.Entries([tag]), MaxRegistersPerWrite = 100, Probe = new ModbusProbeOptions { Enabled = false } };
await using var drv = new ModbusDriver(opts, "modbus-1", _ => transport);
await drv.InitializeAsync("{}", TestContext.Current.CancellationToken);
tests/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Modbus.Tests/ModbusCoalescingAutoRecoveryTests.cs
+6 -6
View File
@@ -65,7 +65,7 @@ public sealed class ModbusCoalescingAutoRecoveryTests
var t100 = new ModbusTagDefinition("T100", ModbusRegion.HoldingRegisters, 100, ModbusDataType.Int16);
var t102 = new ModbusTagDefinition("T102", ModbusRegion.HoldingRegisters, 102, ModbusDataType.Int16);
var t104 = new ModbusTagDefinition("T104", ModbusRegion.HoldingRegisters, 104, ModbusDataType.Int16);
var opts = new ModbusDriverOptions { Host = "f", Tags = [t100, t102, t104], MaxReadGap = 5,
var opts = new ModbusDriverOptions { Host = "f", RawTags = ModbusRawTags.Entries([t100, t102, t104]), MaxReadGap = 5,
Probe = new ModbusProbeOptions { Enabled = false } };
var drv = new ModbusDriver(opts, "m1", _ => fake);
await drv.InitializeAsync("{}", CancellationToken.None);
@@ -89,7 +89,7 @@ public sealed class ModbusCoalescingAutoRecoveryTests
var t100 = new ModbusTagDefinition("T100", ModbusRegion.HoldingRegisters, 100, ModbusDataType.Int16);
var t102 = new ModbusTagDefinition("T102", ModbusRegion.HoldingRegisters, 102, ModbusDataType.Int16);
var t104 = new ModbusTagDefinition("T104", ModbusRegion.HoldingRegisters, 104, ModbusDataType.Int16);
var opts = new ModbusDriverOptions { Host = "f", Tags = [t100, t102, t104], MaxReadGap = 5,
var opts = new ModbusDriverOptions { Host = "f", RawTags = ModbusRawTags.Entries([t100, t102, t104]), MaxReadGap = 5,
Probe = new ModbusProbeOptions { Enabled = false } };
var drv = new ModbusDriver(opts, "m1", _ => fake);
await drv.InitializeAsync("{}", CancellationToken.None);
@@ -122,7 +122,7 @@ public sealed class ModbusCoalescingAutoRecoveryTests
var t100 = new ModbusTagDefinition("T100", ModbusRegion.HoldingRegisters, 100, ModbusDataType.Int16);
var t102 = new ModbusTagDefinition("T102", ModbusRegion.HoldingRegisters, 102, ModbusDataType.Int16);
var t104 = new ModbusTagDefinition("T104", ModbusRegion.HoldingRegisters, 104, ModbusDataType.Int16);
var opts = new ModbusDriverOptions { Host = "f", Tags = [t100, t102, t104], MaxReadGap = 5,
var opts = new ModbusDriverOptions { Host = "f", RawTags = ModbusRawTags.Entries([t100, t102, t104]), MaxReadGap = 5,
AutoProhibitReprobeInterval = TimeSpan.FromMilliseconds(100),
Probe = new ModbusProbeOptions { Enabled = false } };
var drv = new ModbusDriver(opts, "m1", _ => fake);
@@ -149,7 +149,7 @@ public sealed class ModbusCoalescingAutoRecoveryTests
var t100 = new ModbusTagDefinition("T100", ModbusRegion.HoldingRegisters, 100, ModbusDataType.Int16);
var t102 = new ModbusTagDefinition("T102", ModbusRegion.HoldingRegisters, 102, ModbusDataType.Int16);
var t104 = new ModbusTagDefinition("T104", ModbusRegion.HoldingRegisters, 104, ModbusDataType.Int16);
var opts = new ModbusDriverOptions { Host = "f", Tags = [t100, t102, t104], MaxReadGap = 5,
var opts = new ModbusDriverOptions { Host = "f", RawTags = ModbusRawTags.Entries([t100, t102, t104]), MaxReadGap = 5,
AutoProhibitReprobeInterval = TimeSpan.FromMilliseconds(100),
Probe = new ModbusProbeOptions { Enabled = false } };
var drv = new ModbusDriver(opts, "m1", _ => fake);
@@ -176,7 +176,7 @@ public sealed class ModbusCoalescingAutoRecoveryTests
var t100 = new ModbusTagDefinition("T100", ModbusRegion.HoldingRegisters, 100, ModbusDataType.Int16);
var t102 = new ModbusTagDefinition("T102", ModbusRegion.HoldingRegisters, 102, ModbusDataType.Int16);
var t104 = new ModbusTagDefinition("T104", ModbusRegion.HoldingRegisters, 104, ModbusDataType.Int16);
var opts = new ModbusDriverOptions { Host = "f", UnitId = 7, Tags = [t100, t102, t104], MaxReadGap = 5,
var opts = new ModbusDriverOptions { Host = "f", UnitId = 7, RawTags = ModbusRawTags.Entries([t100, t102, t104]), MaxReadGap = 5,
Probe = new ModbusProbeOptions { Enabled = false } };
var drv = new ModbusDriver(opts, "m1", _ => fake);
await drv.InitializeAsync("{}", CancellationToken.None);
@@ -211,7 +211,7 @@ public sealed class ModbusCoalescingAutoRecoveryTests
var t104 = new ModbusTagDefinition("T104", ModbusRegion.HoldingRegisters, 104, ModbusDataType.Int16);
var t200 = new ModbusTagDefinition("T200", ModbusRegion.HoldingRegisters, 200, ModbusDataType.Int16);
var t202 = new ModbusTagDefinition("T202", ModbusRegion.HoldingRegisters, 202, ModbusDataType.Int16);
var opts = new ModbusDriverOptions { Host = "f", Tags = [t100, t102, t104, t200, t202], MaxReadGap = 5,
var opts = new ModbusDriverOptions { Host = "f", RawTags = ModbusRawTags.Entries([t100, t102, t104, t200, t202]), MaxReadGap = 5,
Probe = new ModbusProbeOptions { Enabled = false } };
var drv = new ModbusDriver(opts, "m1", _ => fake);
await drv.InitializeAsync("{}", CancellationToken.None);
tests/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Modbus.Tests/ModbusCoalescingBisectionTests.cs
+3 -3
View File
@@ -65,7 +65,7 @@ public sealed class ModbusCoalescingBisectionTests
var tags = Enumerable.Range(100, 11)
.Select(i => new ModbusTagDefinition($"T{i}", ModbusRegion.HoldingRegisters, (ushort)i, ModbusDataType.Int16))
.ToArray();
var opts = new ModbusDriverOptions { Host = "f", Tags = tags, MaxReadGap = 10,
var opts = new ModbusDriverOptions { Host = "f", RawTags = ModbusRawTags.Entries(tags), MaxReadGap = 10,
AutoProhibitReprobeInterval = TimeSpan.FromMilliseconds(100),
Probe = new ModbusProbeOptions { Enabled = false } };
var drv = new ModbusDriver(opts, "m1", _ => fake);
@@ -108,7 +108,7 @@ public sealed class ModbusCoalescingBisectionTests
var tags = Enumerable.Range(100, 11)
.Select(i => new ModbusTagDefinition($"T{i}", ModbusRegion.HoldingRegisters, (ushort)i, ModbusDataType.Int16))
.ToArray();
var opts = new ModbusDriverOptions { Host = "f", Tags = tags, MaxReadGap = 10,
var opts = new ModbusDriverOptions { Host = "f", RawTags = ModbusRawTags.Entries(tags), MaxReadGap = 10,
AutoProhibitReprobeInterval = TimeSpan.FromMilliseconds(100),
Probe = new ModbusProbeOptions { Enabled = false } };
var drv = new ModbusDriver(opts, "m1", _ => fake);
@@ -140,7 +140,7 @@ public sealed class ModbusCoalescingBisectionTests
var tags = Enumerable.Range(100, 11)
.Select(i => new ModbusTagDefinition($"T{i}", ModbusRegion.HoldingRegisters, (ushort)i, ModbusDataType.Int16))
.ToArray();
var opts = new ModbusDriverOptions { Host = "f", Tags = tags, MaxReadGap = 10,
var opts = new ModbusDriverOptions { Host = "f", RawTags = ModbusRawTags.Entries(tags), MaxReadGap = 10,
AutoProhibitReprobeInterval = TimeSpan.FromMilliseconds(100),
Probe = new ModbusProbeOptions { Enabled = false } };
var drv = new ModbusDriver(opts, "m1", _ => twoHole);
tests/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Modbus.Tests/ModbusCoalescingTests.cs
+7 -7
View File
@@ -49,7 +49,7 @@ public sealed class ModbusCoalescingTests
var fake = new CountingTransport();
var t1 = new ModbusTagDefinition("T1", ModbusRegion.HoldingRegisters, 100, ModbusDataType.Int16);
var t2 = new ModbusTagDefinition("T2", ModbusRegion.HoldingRegisters, 102, ModbusDataType.Int16);
var opts = new ModbusDriverOptions { Host = "f", Tags = [t1, t2], MaxReadGap = 0,
var opts = new ModbusDriverOptions { Host = "f", RawTags = ModbusRawTags.Entries([t1, t2]), MaxReadGap = 0,
Probe = new ModbusProbeOptions { Enabled = false } };
var drv = new ModbusDriver(opts, "m1", _ => fake);
await drv.InitializeAsync("{}", CancellationToken.None);
@@ -70,7 +70,7 @@ public sealed class ModbusCoalescingTests
var t1 = new ModbusTagDefinition("T1", ModbusRegion.HoldingRegisters, 100, ModbusDataType.Int16);
var t2 = new ModbusTagDefinition("T2", ModbusRegion.HoldingRegisters, 102, ModbusDataType.Int16);
var t3 = new ModbusTagDefinition("T3", ModbusRegion.HoldingRegisters, 104, ModbusDataType.Int16);
var opts = new ModbusDriverOptions { Host = "f", Tags = [t1, t2, t3], MaxReadGap = 2,
var opts = new ModbusDriverOptions { Host = "f", RawTags = ModbusRawTags.Entries([t1, t2, t3]), MaxReadGap = 2,
Probe = new ModbusProbeOptions { Enabled = false } };
var drv = new ModbusDriver(opts, "m1", _ => fake);
await drv.InitializeAsync("{}", CancellationToken.None);
@@ -92,7 +92,7 @@ public sealed class ModbusCoalescingTests
var t1 = new ModbusTagDefinition("T1", ModbusRegion.HoldingRegisters, 100, ModbusDataType.Int16);
var t2 = new ModbusTagDefinition("T2", ModbusRegion.HoldingRegisters, 102, ModbusDataType.Int16);
var t3 = new ModbusTagDefinition("T3", ModbusRegion.HoldingRegisters, 200, ModbusDataType.Int16);
var opts = new ModbusDriverOptions { Host = "f", Tags = [t1, t2, t3], MaxReadGap = 10,
var opts = new ModbusDriverOptions { Host = "f", RawTags = ModbusRawTags.Entries([t1, t2, t3]), MaxReadGap = 10,
Probe = new ModbusProbeOptions { Enabled = false } };
var drv = new ModbusDriver(opts, "m1", _ => fake);
await drv.InitializeAsync("{}", CancellationToken.None);
@@ -111,7 +111,7 @@ public sealed class ModbusCoalescingTests
var t1 = new ModbusTagDefinition("T1", ModbusRegion.HoldingRegisters, 100, ModbusDataType.Int16);
var t2 = new ModbusTagDefinition("T2", ModbusRegion.HoldingRegisters, 102, ModbusDataType.Int16, CoalesceProhibited: true);
var t3 = new ModbusTagDefinition("T3", ModbusRegion.HoldingRegisters, 104, ModbusDataType.Int16);
var opts = new ModbusDriverOptions { Host = "f", Tags = [t1, t2, t3], MaxReadGap = 10,
var opts = new ModbusDriverOptions { Host = "f", RawTags = ModbusRawTags.Entries([t1, t2, t3]), MaxReadGap = 10,
Probe = new ModbusProbeOptions { Enabled = false } };
var drv = new ModbusDriver(opts, "m1", _ => fake);
await drv.InitializeAsync("{}", CancellationToken.None);
@@ -132,7 +132,7 @@ public sealed class ModbusCoalescingTests
// Same Region + adjacent addresses but different UnitIds → must NOT coalesce.
var t1 = new ModbusTagDefinition("T1", ModbusRegion.HoldingRegisters, 100, ModbusDataType.Int16, UnitId: 1);
var t2 = new ModbusTagDefinition("T2", ModbusRegion.HoldingRegisters, 102, ModbusDataType.Int16, UnitId: 2);
var opts = new ModbusDriverOptions { Host = "f", Tags = [t1, t2], MaxReadGap = 100,
var opts = new ModbusDriverOptions { Host = "f", RawTags = ModbusRawTags.Entries([t1, t2]), MaxReadGap = 100,
Probe = new ModbusProbeOptions { Enabled = false } };
var drv = new ModbusDriver(opts, "m1", _ => fake);
await drv.InitializeAsync("{}", CancellationToken.None);
@@ -154,7 +154,7 @@ public sealed class ModbusCoalescingTests
// resulting span exceeds the cap — it falls back to two separate reads.
var t1 = new ModbusTagDefinition("T1", ModbusRegion.HoldingRegisters, 0, ModbusDataType.Int16);
var t2 = new ModbusTagDefinition("T2", ModbusRegion.HoldingRegisters, 200, ModbusDataType.Int16);
var opts = new ModbusDriverOptions { Host = "f", Tags = [t1, t2], MaxReadGap = 300,
var opts = new ModbusDriverOptions { Host = "f", RawTags = ModbusRawTags.Entries([t1, t2]), MaxReadGap = 300,
MaxRegistersPerRead = 125, Probe = new ModbusProbeOptions { Enabled = false } };
var drv = new ModbusDriver(opts, "m1", _ => fake);
await drv.InitializeAsync("{}", CancellationToken.None);
@@ -174,7 +174,7 @@ public sealed class ModbusCoalescingTests
var fake = new CountingTransport();
var t1 = new ModbusTagDefinition("T1", ModbusRegion.HoldingRegisters, 100, ModbusDataType.Int16);
var t2 = new ModbusTagDefinition("T2", ModbusRegion.HoldingRegisters, 101, ModbusDataType.Int16);
var opts = new ModbusDriverOptions { Host = "f", Tags = [t1, t2], MaxReadGap = 5,
var opts = new ModbusDriverOptions { Host = "f", RawTags = ModbusRawTags.Entries([t1, t2]), MaxReadGap = 5,
Probe = new ModbusProbeOptions { Enabled = false } };
var drv = new ModbusDriver(opts, "m1", _ => fake);
await drv.InitializeAsync("{}", CancellationToken.None);
tests/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Modbus.Tests/ModbusDriverConfigEnumSerializationTests.cs
+23 -18
View File
@@ -6,44 +6,49 @@ using Xunit;
namespace ZB.MOM.WW.OtOpcUa.Driver.Modbus.Tests;
/// <summary>
/// Regression guard for the 2026-06-19 enum-serialization bug (the FB-9 Modbus-Int64 authoring
/// case). The AdminUI Modbus page now serialises tag enums (<see cref="ModbusRegion"/>,
/// <see cref="ModbusDataType"/>, byte-order) as STRINGS. This proves the factory parses that
/// AdminUI-shaped Int64-tag blob, and documents that the pre-fix NUMERIC form threw because the
/// <c>ModbusTagDto</c> enum fields are <c>string?</c>.
/// v3 factory RawTags binding. Under v3 tags are delivered as authored raw tags
/// (<c>{rawPath, tagConfig, writeIdempotent}</c>) — the tag's address enums live INSIDE the opaque
/// <c>tagConfig</c> blob (authored by the AdminUI <c>ModbusTagConfigModel</c>), not in the driver
/// config DTO. This proves the factory binds a <c>rawTags</c> array and documents that the legacy
/// structured/AddressString <c>tags</c> path (and the FB-9 numeric-vs-string tag-enum bug class it
/// carried) is retired.
/// </summary>
public sealed class ModbusDriverConfigEnumSerializationTests
{
// Mirrors the (now fixed) AdminUI ModbusDriverPage._jsonOpts: camelCase + string enums.
// Mirrors the AdminUI ModbusDriverPage._jsonOpts: camelCase + string enums.
private static readonly JsonSerializerOptions _adminPageOpts = new()
{
PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
Converters = { new JsonStringEnumConverter() },
};
/// <summary>Verifies the factory parses an AdminUI-authored Modbus config carrying an Int64
/// holding-register tag (string enums) without throwing.</summary>
/// <summary>Verifies the factory binds an AdminUI-authored Modbus config carrying an Int64
/// holding-register raw tag (string enums inside the tagConfig blob) without throwing.</summary>
[Fact]
public void Factory_parses_admin_authored_int64_string_enum_config()
public void Factory_binds_admin_authored_rawTags_config()
{
var tag = new ModbusTagDefinition("Int64Tag", ModbusRegion.HoldingRegisters, (ushort)100, ModbusDataType.Int64);
var opts = new ModbusDriverOptions { Host = "10.0.0.5", Port = 502, UnitId = 1, Tags = new[] { tag } };
var tag = new ModbusTagDefinition("cell/modbus/dev1/Int64Tag", ModbusRegion.HoldingRegisters, (ushort)100, ModbusDataType.Int64);
var opts = new ModbusDriverOptions { Host = "10.0.0.5", Port = 502, UnitId = 1, RawTags = ModbusRawTags.Entries(new[] { tag }) };
var blob = JsonSerializer.Serialize(opts, _adminPageOpts);
// The fixed AdminUI page must emit tag enums as strings, not numbers.
blob.ShouldContain("\"dataType\":\"Int64\"");
// The raw tag serialises as {rawPath, tagConfig, writeIdempotent}; the address enums live
// inside the (string-encoded) tagConfig blob.
blob.ShouldContain("\"rawPath\":\"cell/modbus/dev1/Int64Tag\"");
blob.ShouldContain("Int64");
using var driver = ModbusDriverFactoryExtensions.CreateInstance("mb-test", blob);
driver.DriverType.ShouldBe("Modbus");
}
/// <summary>Documents the original bug: the pre-fix AdminUI page emitted numeric tag enums
/// (<c>"dataType":5,"region":3</c>) which the string-typed tag DTO cannot bind, so the factory throws.</summary>
/// <summary>Documents the retirement of the legacy structured <c>tags</c> path: a legacy tag array
/// (including the pre-fix numeric-enum shape) is no longer a recognised property, so it binds nothing
/// and the factory succeeds rather than throwing on its enum shape.</summary>
[Fact]
public void Factory_throws_on_the_numeric_enum_form_the_pre_fix_page_emitted()
public void Factory_ignores_the_retired_structured_tags_array()
{
const string numericBlob =
const string legacyBlob =
"{\"host\":\"10.0.0.5\",\"port\":502,\"unitId\":1,\"tags\":[" +
"{\"name\":\"Int64Tag\",\"region\":3,\"address\":100,\"dataType\":5}]}";
Should.Throw<Exception>(() => ModbusDriverFactoryExtensions.CreateInstance("mb-test", numericBlob));
using var driver = ModbusDriverFactoryExtensions.CreateInstance("mb-test", legacyBlob);
driver.DriverType.ShouldBe("Modbus");
}
}
tests/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Modbus.Tests/ModbusDriverTests.cs
+1 -1
View File
@@ -118,7 +118,7 @@ public sealed class ModbusDriverTests
private static (ModbusDriver driver, FakeTransport fake) NewDriver(params ModbusTagDefinition[] tags)
{
var fake = new FakeTransport();
var opts = new ModbusDriverOptions { Host = "fake", Tags = tags };
var opts = new ModbusDriverOptions { Host = "fake", RawTags = ModbusRawTags.Entries(tags)};
var drv = new ModbusDriver(opts, "modbus-1", _ => fake);
return (drv, fake);
}
tests/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Modbus.Tests/ModbusEdgeCaseValidationTests.cs
+25 -54
View File
@@ -7,9 +7,10 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.Modbus.Tests;
/// Regression coverage for Driver.Modbus-009: two configuration edge cases that previously
/// silently produced wrong wire behaviour.
/// (1) <c>StringLength = 0</c> for a <c>String</c>-typed tag — used to flow into an FC03
/// with quantity 0, a spec-illegal request the PLC rejects with exception 03. Now bind-time
/// validation in <c>ModbusDriverFactoryExtensions</c> rejects the misconfiguration with a
/// clear diagnostic.
/// with quantity 0, a spec-illegal request the PLC rejects with exception 03. In v3 the guard
/// moved to the pure mapper (<see cref="ModbusTagDefinitionFactory.FromTagConfig"/>): a String
/// tag with <c>stringLength &lt; 1</c> fails to map (⇒ the driver skips it / surfaces
/// <c>BadNodeIdUnknown</c>) instead of the factory throwing at bind time.
/// (2) Sub-second <see cref="TimeSpan"/> values on <c>ModbusKeepAliveOptions.Time</c> /
/// <c>Interval</c> — the int-cast in <c>EnableKeepAlive</c> truncated <c>500&#160;ms</c> to
/// <c>0</c>, which most OSes interpret as "use the default", silently defeating the
@@ -19,71 +20,41 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.Modbus.Tests;
[Trait("Category", "Unit")]
public sealed class ModbusEdgeCaseValidationTests
{
/// <summary>Verifies that string tags with zero length are rejected during factory creation.</summary>
private const string RawPath = "cell/modbus/dev1/Greeting";
/// <summary>Verifies that a String tag with an explicit zero length fails to map.</summary>
[Fact]
public void Factory_rejects_String_tag_with_StringLength_zero_via_structured_form()
public void Mapper_rejects_String_tag_with_StringLength_zero_explicit()
{
const string json = """
{
"host": "10.0.0.10",
"tags": [
{ "name": "Greeting", "region": "HoldingRegisters", "address": 100, "dataType": "String", "stringLength": 0 }
]
}
""";
var ex = Should.Throw<InvalidOperationException>(
() => ModbusDriverFactoryExtensions.CreateInstance("modbus-1", json));
ex.Message.ShouldContain("StringLength");
ex.Message.ShouldContain("Greeting");
const string json = """{"region":"HoldingRegisters","address":100,"dataType":"String","stringLength":0}""";
ModbusTagDefinitionFactory.FromTagConfig(json, RawPath, out _).ShouldBeFalse();
}
/// <summary>Verifies that omitted string length defaults to zero and is rejected.</summary>
/// <summary>Verifies that a String tag with an omitted length (defaults to zero) fails to map.</summary>
[Fact]
public void Factory_rejects_String_tag_with_StringLength_zero_via_missing_field()
public void Mapper_rejects_String_tag_with_StringLength_zero_missing_field()
{
// No stringLength → defaults to 0. Same misconfiguration via a different DTO shape.
const string json = """
{
"host": "10.0.0.10",
"tags": [
{ "name": "Greeting", "region": "HoldingRegisters", "address": 100, "dataType": "String" }
]
}
""";
var ex = Should.Throw<InvalidOperationException>(
() => ModbusDriverFactoryExtensions.CreateInstance("modbus-1", json));
ex.Message.ShouldContain("StringLength");
// No stringLength → defaults to 0. Same misconfiguration via a different blob shape.
const string json = """{"region":"HoldingRegisters","address":100,"dataType":"String"}""";
ModbusTagDefinitionFactory.FromTagConfig(json, RawPath, out _).ShouldBeFalse();
}
/// <summary>Verifies that string tags with length one are accepted.</summary>
/// <summary>Verifies that a String tag with length one maps successfully.</summary>
[Fact]
public void Factory_accepts_String_tag_with_StringLength_one()
public void Mapper_accepts_String_tag_with_StringLength_one()
{
const string json = """
{
"host": "10.0.0.10",
"tags": [
{ "name": "Greeting", "region": "HoldingRegisters", "address": 100, "dataType": "String", "stringLength": 1 }
]
}
""";
Should.NotThrow(() => ModbusDriverFactoryExtensions.CreateInstance("modbus-1", json));
const string json = """{"region":"HoldingRegisters","address":100,"dataType":"String","stringLength":1}""";
ModbusTagDefinitionFactory.FromTagConfig(json, RawPath, out var def).ShouldBeTrue();
def.StringLength.ShouldBe((ushort)1);
}
/// <summary>Verifies that non-string tags are unaffected by string length zero.</summary>
/// <summary>Verifies that non-String tags are unaffected by a zero string length.</summary>
[Fact]
public void Factory_accepts_non_String_tag_with_StringLength_zero()
public void Mapper_accepts_non_String_tag_with_StringLength_zero()
{
// The validation only kicks in for String tags — Int16 tags with StringLength=0 are normal.
const string json = """
{
"host": "10.0.0.10",
"tags": [
{ "name": "Level", "region": "HoldingRegisters", "address": 100, "dataType": "Int16" }
]
}
""";
Should.NotThrow(() => ModbusDriverFactoryExtensions.CreateInstance("modbus-1", json));
// The guard only kicks in for String tags — Int16 tags with StringLength=0 are normal.
const string json = """{"region":"HoldingRegisters","address":100,"dataType":"Int16"}""";
ModbusTagDefinitionFactory.FromTagConfig(json, RawPath, out _).ShouldBeTrue();
}
/// <summary>Verifies that sub-second time spans are rounded up to at least one second.</summary>
tests/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Modbus.Tests/ModbusExceptionMapperTests.cs
+3 -3
View File
@@ -54,7 +54,7 @@ public sealed class ModbusExceptionMapperTests
{
var transport = new ExceptionRaisingTransport(exceptionCode: 0x02);
var tag = new ModbusTagDefinition("T", ModbusRegion.HoldingRegisters, 0, ModbusDataType.Int16);
var opts = new ModbusDriverOptions { Host = "fake", Tags = [tag], Probe = new ModbusProbeOptions { Enabled = false } };
var opts = new ModbusDriverOptions { Host = "fake", RawTags = ModbusRawTags.Entries([tag]), Probe = new ModbusProbeOptions { Enabled = false } };
await using var drv = new ModbusDriver(opts, "modbus-1", _ => transport);
await drv.InitializeAsync("{}", TestContext.Current.CancellationToken);
@@ -68,7 +68,7 @@ public sealed class ModbusExceptionMapperTests
{
var transport = new ExceptionRaisingTransport(exceptionCode: 0x04);
var tag = new ModbusTagDefinition("T", ModbusRegion.HoldingRegisters, 0, ModbusDataType.Int16);
var opts = new ModbusDriverOptions { Host = "fake", Tags = [tag], Probe = new ModbusProbeOptions { Enabled = false } };
var opts = new ModbusDriverOptions { Host = "fake", RawTags = ModbusRawTags.Entries([tag]), Probe = new ModbusProbeOptions { Enabled = false } };
await using var drv = new ModbusDriver(opts, "modbus-1", _ => transport);
await drv.InitializeAsync("{}", TestContext.Current.CancellationToken);
@@ -104,7 +104,7 @@ public sealed class ModbusExceptionMapperTests
// Socket drop / timeout / malformed frame → transport-layer failure. Should surface
// distinctly from tag-level faults so operators know to check the network, not the config.
var tag = new ModbusTagDefinition("T", ModbusRegion.HoldingRegisters, 0, ModbusDataType.Int16);
var opts = new ModbusDriverOptions { Host = "fake", Tags = [tag], Probe = new ModbusProbeOptions { Enabled = false } };
var opts = new ModbusDriverOptions { Host = "fake", RawTags = ModbusRawTags.Entries([tag]), Probe = new ModbusProbeOptions { Enabled = false } };
await using var drv = new ModbusDriver(opts, "modbus-1", _ => new NonModbusFailureTransport());
await drv.InitializeAsync("{}", TestContext.Current.CancellationToken);
tests/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Modbus.Tests/ModbusLifecycleHygieneTests.cs
+11 -11
View File
@@ -76,12 +76,12 @@ public sealed class ModbusLifecycleHygieneTests
}
/// <summary>
/// Returns a snapshot of the driver's private <c>_tagsByName</c> dictionary so the
/// Returns a snapshot of the driver's private <c>_tagsByRawPath</c> dictionary so the
/// hygiene tests can confirm the cache is empty after teardown.
/// </summary>
private static System.Collections.IDictionary GetTagsByName(ModbusDriver drv) =>
(System.Collections.IDictionary)typeof(ModbusDriver)
.GetField("_tagsByName", BindingFlags.NonPublic | BindingFlags.Instance)!
.GetField("_tagsByRawPath", BindingFlags.NonPublic | BindingFlags.Instance)!
.GetValue(drv)!;
// -------------------- Finding -002 / -012 (2) --------------------
@@ -97,7 +97,7 @@ public sealed class ModbusLifecycleHygieneTests
var opts = new ModbusDriverOptions
{
Host = "fake",
Tags = [new ModbusTagDefinition("A", ModbusRegion.HoldingRegisters, 0, ModbusDataType.Int16)],
RawTags = ModbusRawTags.Entries([new ModbusTagDefinition("A", ModbusRegion.HoldingRegisters, 0, ModbusDataType.Int16)]),
};
var drv = new ModbusDriver(opts, "modbus-1", _ => fake);
await drv.InitializeAsync("{}", CancellationToken.None);
@@ -116,8 +116,8 @@ public sealed class ModbusLifecycleHygieneTests
{
Host = "fake",
WriteOnChangeOnly = true,
Tags = [new ModbusTagDefinition("A", ModbusRegion.HoldingRegisters, 0, ModbusDataType.Int16,
Deadband: 1.0)],
RawTags = ModbusRawTags.Entries([new ModbusTagDefinition("A", ModbusRegion.HoldingRegisters, 0, ModbusDataType.Int16,
Deadband: 1.0)]),
};
var drv = new ModbusDriver(opts, "modbus-1", _ => fake);
await drv.InitializeAsync("{}", CancellationToken.None);
@@ -164,7 +164,7 @@ public sealed class ModbusLifecycleHygieneTests
},
// Re-probe loop also opted in so DisposeAsync exercises both CTS cancellations.
AutoProhibitReprobeInterval = TimeSpan.FromMilliseconds(50),
Tags = [new ModbusTagDefinition("A", ModbusRegion.HoldingRegisters, 0, ModbusDataType.Int16)],
RawTags = ModbusRawTags.Entries([new ModbusTagDefinition("A", ModbusRegion.HoldingRegisters, 0, ModbusDataType.Int16)]),
};
var drv = new ModbusDriver(opts, "modbus-1", _ => fake);
await drv.InitializeAsync("{}", CancellationToken.None);
@@ -195,7 +195,7 @@ public sealed class ModbusLifecycleHygieneTests
{
Host = "fake",
Probe = new ModbusProbeOptions { Enabled = false },
Tags = [new ModbusTagDefinition("A", ModbusRegion.HoldingRegisters, 0, ModbusDataType.Int16)],
RawTags = ModbusRawTags.Entries([new ModbusTagDefinition("A", ModbusRegion.HoldingRegisters, 0, ModbusDataType.Int16)]),
};
var drv = new ModbusDriver(opts, "modbus-1", _ => fake);
await drv.InitializeAsync("{}", CancellationToken.None);
@@ -258,7 +258,7 @@ public sealed class ModbusLifecycleHygieneTests
var opts = new ModbusDriverOptions
{
Host = "fake",
Tags = [new ModbusTagDefinition("Level", ModbusRegion.HoldingRegisters, 0, ModbusDataType.Int16)],
RawTags = ModbusRawTags.Entries([new ModbusTagDefinition("Level", ModbusRegion.HoldingRegisters, 0, ModbusDataType.Int16)]),
};
var drv = new ModbusDriver(opts, "modbus-1", _ => fake);
await drv.InitializeAsync("{}", CancellationToken.None);
@@ -278,7 +278,7 @@ public sealed class ModbusLifecycleHygieneTests
var opts = new ModbusDriverOptions
{
Host = "fake",
Tags = [new ModbusTagDefinition("Level", ModbusRegion.HoldingRegisters, 0, ModbusDataType.Int16)],
RawTags = ModbusRawTags.Entries([new ModbusTagDefinition("Level", ModbusRegion.HoldingRegisters, 0, ModbusDataType.Int16)]),
};
var drv = new ModbusDriver(opts, "modbus-1", _ => fake);
await drv.InitializeAsync("{}", CancellationToken.None);
@@ -300,7 +300,7 @@ public sealed class ModbusLifecycleHygieneTests
var opts = new ModbusDriverOptions
{
Host = "fake",
Tags = [new ModbusTagDefinition("Coil", ModbusRegion.Coils, 0, ModbusDataType.Bool)],
RawTags = ModbusRawTags.Entries([new ModbusTagDefinition("Coil", ModbusRegion.Coils, 0, ModbusDataType.Bool)]),
};
var drv = new ModbusDriver(opts, "modbus-1", _ => fake);
drv.InitializeAsync("{}", CancellationToken.None).GetAwaiter().GetResult();
@@ -347,7 +347,7 @@ public sealed class ModbusLifecycleHygieneTests
var opts = new ModbusDriverOptions
{
Host = "fake",
Tags = [new ModbusTagDefinition("A", ModbusRegion.HoldingRegisters, 0, ModbusDataType.Int16)],
RawTags = ModbusRawTags.Entries([new ModbusTagDefinition("A", ModbusRegion.HoldingRegisters, 0, ModbusDataType.Int16)]),
};
var drv = new ModbusDriver(opts, "modbus-1", _ => fake);
await drv.InitializeAsync("{}", CancellationToken.None);
tests/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Modbus.Tests/ModbusLoggerInjectionTests.cs
+2 -2
View File
@@ -85,7 +85,7 @@ public sealed class ModbusLoggerInjectionTests
var t100 = new ModbusTagDefinition("T100", ModbusRegion.HoldingRegisters, 100, ModbusDataType.Int16);
var t102 = new ModbusTagDefinition("T102", ModbusRegion.HoldingRegisters, 102, ModbusDataType.Int16);
var t104 = new ModbusTagDefinition("T104", ModbusRegion.HoldingRegisters, 104, ModbusDataType.Int16);
var opts = new ModbusDriverOptions { Host = "f", Tags = [t100, t102, t104], MaxReadGap = 5,
var opts = new ModbusDriverOptions { Host = "f", RawTags = ModbusRawTags.Entries([t100, t102, t104]), MaxReadGap = 5,
Probe = new ModbusProbeOptions { Enabled = false } };
var drv = new ModbusDriver(opts, "drv-logged", _ => fake, logger: logger);
await drv.InitializeAsync("{}", CancellationToken.None);
@@ -116,7 +116,7 @@ public sealed class ModbusLoggerInjectionTests
var t100 = new ModbusTagDefinition("T100", ModbusRegion.HoldingRegisters, 100, ModbusDataType.Int16);
var t102 = new ModbusTagDefinition("T102", ModbusRegion.HoldingRegisters, 102, ModbusDataType.Int16);
var t104 = new ModbusTagDefinition("T104", ModbusRegion.HoldingRegisters, 104, ModbusDataType.Int16);
var opts = new ModbusDriverOptions { Host = "f", Tags = [t100, t102, t104], MaxReadGap = 5,
var opts = new ModbusDriverOptions { Host = "f", RawTags = ModbusRawTags.Entries([t100, t102, t104]), MaxReadGap = 5,
AutoProhibitReprobeInterval = TimeSpan.FromHours(1), // long interval — we drive it manually
Probe = new ModbusProbeOptions { Enabled = false } };
var drv = new ModbusDriver(opts, "drv-logged", _ => fake, logger: logger);
tests/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Modbus.Tests/ModbusMultiUnitTests.cs
+4 -4
View File
@@ -47,7 +47,7 @@ public sealed class ModbusMultiUnitTests
var fake = new UnitCapturingTransport();
var tagSlave1 = new ModbusTagDefinition("S1Temp", ModbusRegion.HoldingRegisters, 0, ModbusDataType.Int16, UnitId: 1);
var tagSlave5 = new ModbusTagDefinition("S5Temp", ModbusRegion.HoldingRegisters, 0, ModbusDataType.Int16, UnitId: 5);
var opts = new ModbusDriverOptions { Host = "f", UnitId = 99, Tags = [tagSlave1, tagSlave5],
var opts = new ModbusDriverOptions { Host = "f", UnitId = 99, RawTags = ModbusRawTags.Entries([tagSlave1, tagSlave5]),
Probe = new ModbusProbeOptions { Enabled = false } };
var drv = new ModbusDriver(opts, "m1", _ => fake);
await drv.InitializeAsync("{}", CancellationToken.None);
@@ -66,7 +66,7 @@ public sealed class ModbusMultiUnitTests
{
var fake = new UnitCapturingTransport();
var tag = new ModbusTagDefinition("T", ModbusRegion.HoldingRegisters, 0, ModbusDataType.Int16); // no UnitId override
var opts = new ModbusDriverOptions { Host = "f", UnitId = 7, Tags = [tag],
var opts = new ModbusDriverOptions { Host = "f", UnitId = 7, RawTags = ModbusRawTags.Entries([tag]),
Probe = new ModbusProbeOptions { Enabled = false } };
var drv = new ModbusDriver(opts, "m1", _ => fake);
await drv.InitializeAsync("{}", CancellationToken.None);
@@ -83,7 +83,7 @@ public sealed class ModbusMultiUnitTests
var fake = new UnitCapturingTransport();
var t1 = new ModbusTagDefinition("S1Temp", ModbusRegion.HoldingRegisters, 0, ModbusDataType.Int16, UnitId: 1);
var t5 = new ModbusTagDefinition("S5Temp", ModbusRegion.HoldingRegisters, 0, ModbusDataType.Int16, UnitId: 5);
var opts = new ModbusDriverOptions { Host = "10.1.2.3", Port = 502, Tags = [t1, t5],
var opts = new ModbusDriverOptions { Host = "10.1.2.3", Port = 502, RawTags = ModbusRawTags.Entries([t1, t5]),
Probe = new ModbusProbeOptions { Enabled = false } };
var drv = new ModbusDriver(opts, "m1", _ => fake);
await drv.InitializeAsync("{}", CancellationToken.None);
@@ -101,7 +101,7 @@ public sealed class ModbusMultiUnitTests
public async Task IPerCallHostResolver_Unknown_Tag_Falls_Back_To_HostName()
{
var fake = new UnitCapturingTransport();
var opts = new ModbusDriverOptions { Host = "10.1.2.3", Port = 502, Tags = [],
var opts = new ModbusDriverOptions { Host = "10.1.2.3", Port = 502, RawTags = [],
Probe = new ModbusProbeOptions { Enabled = false } };
var drv = new ModbusDriver(opts, "m1", _ => fake);
await drv.InitializeAsync("{}", CancellationToken.None);
tests/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Modbus.Tests/ModbusProtocolOptionsTests.cs
+5 -5
View File
@@ -75,7 +75,7 @@ public sealed class ModbusProtocolOptionsTests
{
var fake = new CapturingTransport();
var tag = new ModbusTagDefinition("Run", ModbusRegion.Coils, 0, ModbusDataType.Bool);
var drv = new ModbusDriver(new ModbusDriverOptions { Host = "f", Tags = [tag], Probe = new ModbusProbeOptions { Enabled = false } }, "m1", _ => fake);
var drv = new ModbusDriver(new ModbusDriverOptions { Host = "f", RawTags = ModbusRawTags.Entries([tag]), Probe = new ModbusProbeOptions { Enabled = false } }, "m1", _ => fake);
await drv.InitializeAsync("{}", CancellationToken.None);
await drv.WriteAsync([new WriteRequest("Run", true)], CancellationToken.None);
@@ -89,7 +89,7 @@ public sealed class ModbusProtocolOptionsTests
{
var fake = new CapturingTransport();
var tag = new ModbusTagDefinition("Run", ModbusRegion.Coils, 0, ModbusDataType.Bool);
var opts = new ModbusDriverOptions { Host = "f", Tags = [tag], UseFC15ForSingleCoilWrites = true, Probe = new ModbusProbeOptions { Enabled = false } };
var opts = new ModbusDriverOptions { Host = "f", RawTags = ModbusRawTags.Entries([tag]), UseFC15ForSingleCoilWrites = true, Probe = new ModbusProbeOptions { Enabled = false } };
var drv = new ModbusDriver(opts, "m1", _ => fake);
await drv.InitializeAsync("{}", CancellationToken.None);
@@ -104,7 +104,7 @@ public sealed class ModbusProtocolOptionsTests
{
var fake = new CapturingTransport();
var tag = new ModbusTagDefinition("Sp", ModbusRegion.HoldingRegisters, 0, ModbusDataType.Int16);
var drv = new ModbusDriver(new ModbusDriverOptions { Host = "f", Tags = [tag], Probe = new ModbusProbeOptions { Enabled = false } }, "m1", _ => fake);
var drv = new ModbusDriver(new ModbusDriverOptions { Host = "f", RawTags = ModbusRawTags.Entries([tag]), Probe = new ModbusProbeOptions { Enabled = false } }, "m1", _ => fake);
await drv.InitializeAsync("{}", CancellationToken.None);
await drv.WriteAsync([new WriteRequest("Sp", (short)42)], CancellationToken.None);
@@ -118,7 +118,7 @@ public sealed class ModbusProtocolOptionsTests
{
var fake = new CapturingTransport();
var tag = new ModbusTagDefinition("Sp", ModbusRegion.HoldingRegisters, 0, ModbusDataType.Int16);
var opts = new ModbusDriverOptions { Host = "f", Tags = [tag], UseFC16ForSingleRegisterWrites = true, Probe = new ModbusProbeOptions { Enabled = false } };
var opts = new ModbusDriverOptions { Host = "f", RawTags = ModbusRawTags.Entries([tag]), UseFC16ForSingleRegisterWrites = true, Probe = new ModbusProbeOptions { Enabled = false } };
var drv = new ModbusDriver(opts, "m1", _ => fake);
await drv.InitializeAsync("{}", CancellationToken.None);
@@ -134,7 +134,7 @@ public sealed class ModbusProtocolOptionsTests
var fake = new CapturingTransport();
// 2500 coils with cap 2000 → 2 reads (2000 + 500).
var tag = new ModbusTagDefinition("Big", ModbusRegion.Coils, 0, ModbusDataType.Bool, ArrayCount: 2500);
var opts = new ModbusDriverOptions { Host = "f", Tags = [tag], MaxCoilsPerRead = 2000, Probe = new ModbusProbeOptions { Enabled = false } };
var opts = new ModbusDriverOptions { Host = "f", RawTags = ModbusRawTags.Entries([tag]), MaxCoilsPerRead = 2000, Probe = new ModbusProbeOptions { Enabled = false } };
var drv = new ModbusDriver(opts, "m1", _ => fake);
await drv.InitializeAsync("{}", CancellationToken.None);
tests/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Modbus.Tests/ModbusRawTags.cs
+28
View File
@@ -0,0 +1,28 @@
using ZB.MOM.WW.OtOpcUa.Core.Abstractions;
namespace ZB.MOM.WW.OtOpcUa.Driver.Modbus.Tests;
/// <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 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.
/// </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)];
}
tests/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Modbus.Tests/ModbusSubscribeOptionsTests.cs
+5 -5
View File
@@ -61,7 +61,7 @@ public sealed class ModbusSubscribeOptionsTests
{
var fake = new ProgrammableTransport();
var tag = new ModbusTagDefinition("Temp", ModbusRegion.HoldingRegisters, 0, ModbusDataType.Int16, Deadband: 5.0);
var opts = new ModbusDriverOptions { Host = "f", Tags = [tag], Probe = new ModbusProbeOptions { Enabled = false } };
var opts = new ModbusDriverOptions { Host = "f", RawTags = ModbusRawTags.Entries([tag]), Probe = new ModbusProbeOptions { Enabled = false } };
var drv = new ModbusDriver(opts, "m1", _ => fake);
await drv.InitializeAsync("{}", CancellationToken.None);
@@ -102,7 +102,7 @@ public sealed class ModbusSubscribeOptionsTests
{
var fake = new ProgrammableTransport();
var tag = new ModbusTagDefinition("Temp", ModbusRegion.HoldingRegisters, 0, ModbusDataType.Int16); // no deadband
var opts = new ModbusDriverOptions { Host = "f", Tags = [tag], Probe = new ModbusProbeOptions { Enabled = false } };
var opts = new ModbusDriverOptions { Host = "f", RawTags = ModbusRawTags.Entries([tag]), Probe = new ModbusProbeOptions { Enabled = false } };
var drv = new ModbusDriver(opts, "m1", _ => fake);
await drv.InitializeAsync("{}", CancellationToken.None);
@@ -127,7 +127,7 @@ public sealed class ModbusSubscribeOptionsTests
{
var fake = new ProgrammableTransport();
var tag = new ModbusTagDefinition("Sp", ModbusRegion.HoldingRegisters, 0, ModbusDataType.Int16);
var opts = new ModbusDriverOptions { Host = "f", Tags = [tag], WriteOnChangeOnly = true,
var opts = new ModbusDriverOptions { Host = "f", RawTags = ModbusRawTags.Entries([tag]), WriteOnChangeOnly = true,
Probe = new ModbusProbeOptions { Enabled = false } };
var drv = new ModbusDriver(opts, "m1", _ => fake);
await drv.InitializeAsync("{}", CancellationToken.None);
@@ -146,7 +146,7 @@ public sealed class ModbusSubscribeOptionsTests
{
var fake = new ProgrammableTransport();
var tag = new ModbusTagDefinition("Sp", ModbusRegion.HoldingRegisters, 0, ModbusDataType.Int16);
var opts = new ModbusDriverOptions { Host = "f", Tags = [tag],
var opts = new ModbusDriverOptions { Host = "f", RawTags = ModbusRawTags.Entries([tag]),
Probe = new ModbusProbeOptions { Enabled = false } };
var drv = new ModbusDriver(opts, "m1", _ => fake);
await drv.InitializeAsync("{}", CancellationToken.None);
@@ -164,7 +164,7 @@ public sealed class ModbusSubscribeOptionsTests
{
var fake = new ProgrammableTransport();
var tag = new ModbusTagDefinition("Sp", ModbusRegion.HoldingRegisters, 0, ModbusDataType.Int16);
var opts = new ModbusDriverOptions { Host = "f", Tags = [tag], WriteOnChangeOnly = true,
var opts = new ModbusDriverOptions { Host = "f", RawTags = ModbusRawTags.Entries([tag]), WriteOnChangeOnly = true,
Probe = new ModbusProbeOptions { Enabled = false } };
var drv = new ModbusDriver(opts, "m1", _ => fake);
await drv.InitializeAsync("{}", CancellationToken.None);
tests/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Modbus.Tests/ModbusSubscriptionTests.cs
+1 -1
View File
@@ -48,7 +48,7 @@ public sealed class ModbusSubscriptionTests
private static (ModbusDriver drv, FakeTransport fake) NewDriver(params ModbusTagDefinition[] tags)
{
var fake = new FakeTransport();
var opts = new ModbusDriverOptions { Host = "fake", Tags = tags };
var opts = new ModbusDriverOptions { Host = "fake", RawTags = ModbusRawTags.Entries(tags)};
return (new ModbusDriver(opts, "modbus-1", _ => fake), fake);
}
tests/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Modbus.Tests/ModbusEquipmentTagParserStrictnessTests.cs → tests/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Modbus.Tests/ModbusTagDefinitionFactoryStrictnessTests.cs
+23 -19
View File
@@ -5,47 +5,51 @@ using ZB.MOM.WW.OtOpcUa.Driver.Modbus;
namespace ZB.MOM.WW.OtOpcUa.Driver.Modbus.Tests;
/// <summary>
/// R2-11 Phase C strictness surface for the Modbus equipment-tag parser: the runtime is now STRICT — a
/// present-but-invalid (typo'd) enum on any of the three enum fields (<c>region</c> / <c>dataType</c> /
/// <c>byteOrder</c>) rejects the whole tag (<c>TryParse</c> ⇒ <see langword="false"/> ⇒
/// R2-11 Phase C strictness surface for the Modbus tag-definition factory: the mapper is STRICT — a
/// present-but-invalid (typo'd) enum on any enum field (<c>region</c> / <c>dataType</c> /
/// <c>byteOrder</c>) rejects the whole tag (<c>FromTagConfig</c> ⇒ <see langword="false"/> ⇒
/// <c>BadNodeIdUnknown</c>) instead of silently defaulting to a wrong-width <c>Good</c>. <c>Inspect</c>
/// still reports the same typo at deploy time, and the <c>writable</c> key is honoured (default true).
/// Under v3 the mapped definition's <c>Name</c> is the RawPath the mapper was handed, not the blob.
/// </summary>
public sealed class ModbusEquipmentTagParserStrictnessTests
public sealed class ModbusTagDefinitionFactoryStrictnessTests
{
private const string RawPath = "cell/modbus/dev1/T1";
// ---- Phase C: a typo'd enum now rejects the tag (BadNodeIdUnknown), not a silent default ----
[Fact]
public void Typo_dataType_rejects_the_tag()
{
ModbusEquipmentTagParser.TryParse(
"{\"region\":\"HoldingRegisters\",\"address\":1,\"dataType\":\"Intt16\"}", out _)
ModbusTagDefinitionFactory.FromTagConfig(
"{\"region\":\"HoldingRegisters\",\"address\":1,\"dataType\":\"Intt16\"}", RawPath, out _)
.ShouldBeFalse();
}
[Fact]
public void Typo_region_rejects_the_tag()
{
ModbusEquipmentTagParser.TryParse(
"{\"region\":\"HoldingRegisterz\",\"address\":1,\"dataType\":\"Int16\"}", out _)
ModbusTagDefinitionFactory.FromTagConfig(
"{\"region\":\"HoldingRegisterz\",\"address\":1,\"dataType\":\"Int16\"}", RawPath, out _)
.ShouldBeFalse();
}
[Fact]
public void Typo_byteOrder_rejects_the_tag()
{
ModbusEquipmentTagParser.TryParse(
"{\"region\":\"HoldingRegisters\",\"address\":1,\"dataType\":\"Int16\",\"byteOrder\":\"BigEndan\"}", out _)
ModbusTagDefinitionFactory.FromTagConfig(
"{\"region\":\"HoldingRegisters\",\"address\":1,\"dataType\":\"Int16\",\"byteOrder\":\"BigEndan\"}", RawPath, out _)
.ShouldBeFalse();
}
[Fact]
public void Valid_enums_still_parse()
{
ModbusEquipmentTagParser.TryParse(
"{\"region\":\"HoldingRegisters\",\"address\":1,\"dataType\":\"Int16\",\"byteOrder\":\"BigEndian\"}", out var def)
ModbusTagDefinitionFactory.FromTagConfig(
"{\"region\":\"HoldingRegisters\",\"address\":1,\"dataType\":\"Int16\",\"byteOrder\":\"BigEndian\"}", RawPath, out var def)
.ShouldBeTrue();
def.DataType.ShouldBe(ModbusDataType.Int16);
def.Name.ShouldBe(RawPath);
}
// ---- Inspect reports the typo ----
@@ -53,7 +57,7 @@ public sealed class ModbusEquipmentTagParserStrictnessTests
[Fact]
public void Inspect_reports_typo_dataType_with_field_and_valid_values()
{
var warnings = ModbusEquipmentTagParser.Inspect(
var warnings = ModbusTagDefinitionFactory.Inspect(
"{\"region\":\"HoldingRegisters\",\"address\":1,\"dataType\":\"Intt16\"}");
warnings.ShouldHaveSingleItem();
warnings[0].ShouldContain("Intt16");
@@ -64,7 +68,7 @@ public sealed class ModbusEquipmentTagParserStrictnessTests
[Fact]
public void Inspect_clean_config_has_no_warnings()
{
ModbusEquipmentTagParser.Inspect(
ModbusTagDefinitionFactory.Inspect(
"{\"region\":\"HoldingRegisters\",\"address\":1,\"dataType\":\"Int16\"}")
.ShouldBeEmpty();
}
@@ -72,7 +76,7 @@ public sealed class ModbusEquipmentTagParserStrictnessTests
[Fact]
public void Inspect_malformed_json_warns_unresolvable()
{
ModbusEquipmentTagParser.Inspect("{not json").ShouldHaveSingleItem();
ModbusTagDefinitionFactory.Inspect("{not json").ShouldHaveSingleItem();
}
// ---- writable now honoured ----
@@ -80,8 +84,8 @@ public sealed class ModbusEquipmentTagParserStrictnessTests
[Fact]
public void Writable_false_is_honoured()
{
ModbusEquipmentTagParser.TryParse(
"{\"region\":\"HoldingRegisters\",\"address\":1,\"dataType\":\"Int16\",\"writable\":false}", out var def)
ModbusTagDefinitionFactory.FromTagConfig(
"{\"region\":\"HoldingRegisters\",\"address\":1,\"dataType\":\"Int16\",\"writable\":false}", RawPath, out var def)
.ShouldBeTrue();
def.Writable.ShouldBeFalse();
}
@@ -89,8 +93,8 @@ public sealed class ModbusEquipmentTagParserStrictnessTests
[Fact]
public void Writable_absent_defaults_to_true()
{
ModbusEquipmentTagParser.TryParse(
"{\"region\":\"HoldingRegisters\",\"address\":1,\"dataType\":\"Int16\"}", out var def)
ModbusTagDefinitionFactory.FromTagConfig(
"{\"region\":\"HoldingRegisters\",\"address\":1,\"dataType\":\"Int16\"}", RawPath, out var def)
.ShouldBeTrue();
def.Writable.ShouldBeTrue();
}
tests/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Modbus.Tests/ModbusEquipmentTagTests.cs → tests/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Modbus.Tests/ModbusTagDefinitionFactoryTests.cs
+20 -16
View File
@@ -1,18 +1,21 @@
using Shouldly;
using Xunit;
using ZB.MOM.WW.OtOpcUa.Core.Abstractions;
using ZB.MOM.WW.OtOpcUa.Driver.Modbus;
namespace ZB.MOM.WW.OtOpcUa.Driver.Modbus.Tests;
[Trait("Category", "Unit")]
public class ModbusEquipmentTagTests
public class ModbusTagDefinitionFactoryTests
{
private const string RawPath = "cell/modbus/dev1/Reg";
[Fact]
public void Parses_equipment_tagconfig_into_a_transient_definition()
public void Maps_tagconfig_into_a_definition_keyed_by_rawpath()
{
var json = """{"region":"HoldingRegisters","address":40001,"dataType":"UInt16","byteOrder":"BigEndian","bitIndex":0,"stringLength":0}""";
ModbusEquipmentTagParser.TryParse(json, out var def).ShouldBeTrue();
def!.Name.ShouldBe(json);
ModbusTagDefinitionFactory.FromTagConfig(json, RawPath, out var def).ShouldBeTrue();
def!.Name.ShouldBe(RawPath); // v3: identity is the RawPath, not the blob
def.Region.ShouldBe(ModbusRegion.HoldingRegisters);
def.Address.ShouldBe((ushort)40001);
def.DataType.ShouldBe(ModbusDataType.UInt16);
@@ -20,39 +23,40 @@ public class ModbusEquipmentTagTests
[Fact]
public void Rejects_a_non_address_blob()
=> ModbusEquipmentTagParser.TryParse("""{"FullName":"x"}""", out _).ShouldBeFalse();
=> ModbusTagDefinitionFactory.FromTagConfig("""{"FullName":"x"}""", RawPath, out _).ShouldBeFalse();
[Fact]
public void Rejects_garbage()
=> ModbusEquipmentTagParser.TryParse("not json", out _).ShouldBeFalse();
=> ModbusTagDefinitionFactory.FromTagConfig("not json", RawPath, out _).ShouldBeFalse();
[Fact]
public void Rejects_address_as_a_json_string()
=> ModbusEquipmentTagParser.TryParse(
"""{"region":"HoldingRegisters","address":"40001","dataType":"UInt16"}""", out _).ShouldBeFalse();
=> ModbusTagDefinitionFactory.FromTagConfig(
"""{"region":"HoldingRegisters","address":"40001","dataType":"UInt16"}""", RawPath, out _).ShouldBeFalse();
[Fact]
public void Rejects_address_out_of_ushort_range()
=> ModbusEquipmentTagParser.TryParse(
"""{"region":"HoldingRegisters","address":70000,"dataType":"UInt16"}""", out _).ShouldBeFalse();
=> ModbusTagDefinitionFactory.FromTagConfig(
"""{"region":"HoldingRegisters","address":70000,"dataType":"UInt16"}""", RawPath, out _).ShouldBeFalse();
/// <summary>
/// End-to-end driver-level proof: a Modbus driver with NO authored tags can still read an
/// equipment-tag ref (the raw TagConfig JSON) — the resolver parses it into a transient
/// definition and the read goes to the wire instead of returning BadNodeIdUnknown.
/// End-to-end driver-level proof: a Modbus driver handed an authored raw tag (RawPath + TagConfig
/// blob) maps it into its RawPath → definition table and reads by RawPath — the read goes to the
/// wire instead of returning BadNodeIdUnknown.
/// </summary>
[Fact]
public async Task Driver_resolves_an_equipment_ref_and_reads_instead_of_BadNodeIdUnknown()
public async Task Driver_resolves_a_rawpath_and_reads_instead_of_BadNodeIdUnknown()
{
// Address 10 fits the fake transport's 256-register bank (40001 would overflow it).
const string rawPath = "cell/modbus/dev1/U16";
var json = """{"region":"HoldingRegisters","address":10,"dataType":"UInt16","byteOrder":"BigEndian","bitIndex":0,"stringLength":0}""";
var fake = new ModbusDriverTests.FakeTransport();
var opts = new ModbusDriverOptions { Host = "fake", Tags = [] };
var opts = new ModbusDriverOptions { Host = "fake", RawTags = [new RawTagEntry(rawPath, json, false)] };
var drv = new ModbusDriver(opts, "modbus-eq", _ => fake);
await drv.InitializeAsync("{}", CancellationToken.None);
fake.HoldingRegisters[10] = 4242;
var r = await drv.ReadAsync([json], CancellationToken.None);
var r = await drv.ReadAsync([rawPath], CancellationToken.None);
r[0].StatusCode.ShouldBe(0u);
r[0].StatusCode.ShouldNotBe(0x80340000u); // not BadNodeIdUnknown
tests/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Modbus.Tests/ModbusUnitIdResolveHostTests.cs
+33 -20
View File
@@ -1,14 +1,15 @@
using Shouldly;
using Xunit;
using ZB.MOM.WW.OtOpcUa.Core.Abstractions;
namespace ZB.MOM.WW.OtOpcUa.Driver.Modbus.Tests;
/// <summary>
/// CONV-4 (Modbus leg) — Modbus keys per-host resilience per SLAVE UNIT
/// (<c>host:port/unitN</c>). An equipment tag must carry its own <c>unitId</c> so multi-unit
/// equipment tags key their own breaker; <see cref="ModbusDriver.ResolveHost"/> must resolve
/// the equipment ref through the resolver rather than only matching authored names. Scope:
/// <c>unitId</c> ONLY — the parser's other strictness gaps are R2-11's.
/// (<c>host:port/unitN</c>). An authored raw tag carries its own <c>unitId</c> in its TagConfig so
/// multi-unit tags key their own breaker; <see cref="ModbusDriver.ResolveHost"/> resolves a RawPath
/// through the driver's authored RawPath → definition table. Under v3 the reference is always a
/// RawPath — an unauthored RawPath falls back to the driver-level host.
/// </summary>
[Trait("Category", "Unit")]
public sealed class ModbusUnitIdResolveHostTests
@@ -21,43 +22,55 @@ public sealed class ModbusUnitIdResolveHostTests
public ValueTask DisposeAsync() => ValueTask.CompletedTask;
}
private static ModbusDriver NewDriver() => new(
new ModbusDriverOptions { Host = "10.0.0.1", Port = 502, UnitId = 1, Probe = new ModbusProbeOptions { Enabled = false } },
"modbus-1", _ => new NoopTransport());
private static async Task<ModbusDriver> NewDriverAsync(params RawTagEntry[] rawTags)
{
var drv = new ModbusDriver(
new ModbusDriverOptions
{
Host = "10.0.0.1", Port = 502, UnitId = 1, RawTags = rawTags,
Probe = new ModbusProbeOptions { Enabled = false },
},
"modbus-1", _ => new NoopTransport());
await drv.InitializeAsync("{}", CancellationToken.None);
return drv;
}
/// <summary>The parser reads an optional unitId into the transient definition.</summary>
/// <summary>The mapper reads an optional unitId into the definition.</summary>
[Fact]
public void Parser_reads_optional_unitId()
public void FromTagConfig_reads_optional_unitId()
{
var json = """{"region":"HoldingRegisters","address":0,"dataType":"Int16","unitId":7}""";
ModbusEquipmentTagParser.TryParse(json, out var def).ShouldBeTrue();
ModbusTagDefinitionFactory.FromTagConfig(json, "cell/modbus/dev1/U7", out var def).ShouldBeTrue();
def.Name.ShouldBe("cell/modbus/dev1/U7");
def.UnitId.ShouldBe((byte)7);
}
/// <summary>An absent unitId leaves the definition on the driver-level default (null override).</summary>
[Fact]
public void Parser_absent_unitId_is_null()
public void FromTagConfig_absent_unitId_is_null()
{
var json = """{"region":"HoldingRegisters","address":0,"dataType":"Int16"}""";
ModbusEquipmentTagParser.TryParse(json, out var def).ShouldBeTrue();
ModbusTagDefinitionFactory.FromTagConfig(json, "cell/modbus/dev1/U0", out var def).ShouldBeTrue();
def.UnitId.ShouldBeNull();
}
/// <summary>An equipment ref carrying a unitId keys its own per-unit host name.</summary>
/// <summary>An authored RawPath carrying a unitId keys its own per-unit host name.</summary>
[Fact]
public void EquipmentTag_WithUnitId_ResolvesPerUnitHostName()
public async Task RawPath_WithUnitId_ResolvesPerUnitHostName()
{
var drv = NewDriver();
const string rawPath = "cell/modbus/dev1/U7";
var json = """{"region":"HoldingRegisters","address":0,"dataType":"Int16","unitId":7}""";
drv.ResolveHost(json).ShouldBe("10.0.0.1:502/unit7");
var drv = await NewDriverAsync(new RawTagEntry(rawPath, json, false));
drv.ResolveHost(rawPath).ShouldBe("10.0.0.1:502/unit7");
}
/// <summary>An equipment ref without a unitId keys the driver-level unit host name.</summary>
/// <summary>An authored RawPath without a unitId keys the driver-level unit host name.</summary>
[Fact]
public void EquipmentTag_WithoutUnitId_KeysDriverDefaultUnit()
public async Task RawPath_WithoutUnitId_KeysDriverDefaultUnit()
{
var drv = NewDriver();
const string rawPath = "cell/modbus/dev1/U0";
var json = """{"region":"HoldingRegisters","address":0,"dataType":"Int16"}""";
drv.ResolveHost(json).ShouldBe("10.0.0.1:502/unit1");
var drv = await NewDriverAsync(new RawTagEntry(rawPath, json, false));
drv.ResolveHost(rawPath).ShouldBe("10.0.0.1:502/unit1");
}
}