using Shouldly; using Xunit; using ZB.MOM.WW.OtOpcUa.Core.Abstractions; namespace ZB.MOM.WW.OtOpcUa.Driver.Modbus.Tests; /// /// Unit tests for the Modbus-exception-code → OPC UA StatusCode mapping added in PR 52. /// Before PR 52 every server exception + every transport failure collapsed to /// BadInternalError (0x80020000), which made field diagnosis "is this a bad tag or a bad /// driver?" impossible. These tests lock in the translation table documented on /// . /// [Trait("Category", "Unit")] public sealed class ModbusExceptionMapperTests { [Theory] [InlineData((byte)0x01, 0x803D0000u)] // Illegal Function → BadNotSupported [InlineData((byte)0x02, 0x803C0000u)] // Illegal Data Address → BadOutOfRange [InlineData((byte)0x03, 0x803C0000u)] // Illegal Data Value → BadOutOfRange [InlineData((byte)0x04, 0x80550000u)] // Server Failure → BadDeviceFailure [InlineData((byte)0x05, 0x80550000u)] // Acknowledge (long op) → BadDeviceFailure [InlineData((byte)0x06, 0x80550000u)] // Server Busy → BadDeviceFailure [InlineData((byte)0x0A, 0x80050000u)] // Gateway path unavailable → BadCommunicationError [InlineData((byte)0x0B, 0x80050000u)] // Gateway target failed to respond → BadCommunicationError [InlineData((byte)0xFF, 0x80020000u)] // Unknown code → BadInternalError fallback public void MapModbusExceptionToStatus_returns_informative_status(byte code, uint expected) => ModbusDriver.MapModbusExceptionToStatus(code).ShouldBe(expected); private sealed class ExceptionRaisingTransport(byte exceptionCode) : IModbusTransport { public Task ConnectAsync(CancellationToken ct) => Task.CompletedTask; public Task SendAsync(byte unitId, byte[] pdu, CancellationToken ct) => Task.FromException(new ModbusException(pdu[0], exceptionCode, $"fc={pdu[0]} code={exceptionCode}")); public ValueTask DisposeAsync() => ValueTask.CompletedTask; } [Fact] public async Task Read_surface_exception_02_as_BadOutOfRange_not_BadInternalError() { 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 } }; await using var drv = new ModbusDriver(opts, "modbus-1", _ => transport); await drv.InitializeAsync("{}", TestContext.Current.CancellationToken); var results = await drv.ReadAsync(["T"], TestContext.Current.CancellationToken); results[0].StatusCode.ShouldBe(0x803C0000u, "FC03 at an unmapped register must bubble out as BadOutOfRange so operators can spot a bad tag config"); } [Fact] public async Task Write_surface_exception_04_as_BadDeviceFailure() { 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 } }; await using var drv = new ModbusDriver(opts, "modbus-1", _ => transport); await drv.InitializeAsync("{}", TestContext.Current.CancellationToken); var writes = await drv.WriteAsync( [new WriteRequest("T", (short)42)], TestContext.Current.CancellationToken); writes[0].StatusCode.ShouldBe(0x80550000u, "FC06 returning exception 04 (CPU in PROGRAM mode) maps to BadDeviceFailure"); } private sealed class NonModbusFailureTransport : IModbusTransport { public Task ConnectAsync(CancellationToken ct) => Task.CompletedTask; public Task SendAsync(byte unitId, byte[] pdu, CancellationToken ct) => Task.FromException(new EndOfStreamException("socket closed mid-response")); public ValueTask DisposeAsync() => ValueTask.CompletedTask; } [Fact] public async Task Read_non_modbus_failure_maps_to_BadCommunicationError_not_BadInternalError() { // 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 } }; await using var drv = new ModbusDriver(opts, "modbus-1", _ => new NonModbusFailureTransport()); await drv.InitializeAsync("{}", TestContext.Current.CancellationToken); var results = await drv.ReadAsync(["T"], TestContext.Current.CancellationToken); results[0].StatusCode.ShouldBe(0x80050000u); } }