feat(client-cli): add ack/confirm/shelve alarm commands with service layer

Adds ConfirmAlarmAsync and ShelveAlarmAsync to IOpcUaClientService and OpcUaClientService (mirroring the AcknowledgeAlarmAsync pattern: same CallMethodAsync/ServiceResultException/StatusCode contract). Adds ShelveKind enum (OneShot/Timed/Unshelve). Adds three new CLI commands — ack, confirm, shelve — with hex EventId input and per-command argument validation. Updates both fakes (CLI + UI) to implement the new interface members and record calls. Adds 16 unit tests covering argument mapping, invalid-input CommandException paths, bad-status output, and disconnect-in-finally.
2026-06-11 05:46:25 -04:00
parent a6fed85ac9
commit 1f172e55f7
11 changed files with 819 additions and 1 deletions
@@ -0,0 +1,106 @@
+using CliFx.Exceptions;
+using Opc.Ua;
+using Shouldly;
+using Xunit;
+using ZB.MOM.WW.OtOpcUa.Client.CLI.Commands;
+using ZB.MOM.WW.OtOpcUa.Client.CLI.Tests.Fakes;
+
+namespace ZB.MOM.WW.OtOpcUa.Client.CLI.Tests;
+
+public class AcknowledgeCommandTests
+{
+    private static string HexOf(byte[] bytes) => Convert.ToHexString(bytes);
+
+    /// <summary>Verifies that a successful ack prints a success message.</summary>
+    [Fact]
+    public async Task Execute_Success_PrintsSuccessMessage()
+    {
+        var fakeService = new FakeOpcUaClientService
+        {
+            AcknowledgeAlarmResult = StatusCodes.Good
+        };
+        var factory = new FakeOpcUaClientServiceFactory(fakeService);
+        var eventId = new byte[] { 0x01, 0x02, 0x03 };
+        var command = new AcknowledgeCommand(factory)
+        {
+            Url = "opc.tcp://localhost:4840",
+            NodeId = "ns=2;s=MyAlarm",
+            EventId = HexOf(eventId),
+            Comment = "test comment"
+        };
+
+        using var console = TestConsoleHelper.CreateConsole();
+        await command.ExecuteAsync(console);
+
+        var output = TestConsoleHelper.GetOutput(console);
+        output.ShouldContain("Acknowledge successful");
+        fakeService.AcknowledgeAlarmCalls.Count.ShouldBe(1);
+        fakeService.AcknowledgeAlarmCalls[0].ConditionNodeId.ShouldBe("ns=2;s=MyAlarm");
+        fakeService.AcknowledgeAlarmCalls[0].EventId.ShouldBe(eventId);
+        fakeService.AcknowledgeAlarmCalls[0].Comment.ShouldBe("test comment");
+    }
+
+    /// <summary>Verifies that a bad StatusCode from the service prints a failure message.</summary>
+    [Fact]
+    public async Task Execute_BadStatus_PrintsFailureMessage()
+    {
+        var fakeService = new FakeOpcUaClientService
+        {
+            AcknowledgeAlarmResult = StatusCodes.BadEventNotAcknowledgeable
+        };
+        var factory = new FakeOpcUaClientServiceFactory(fakeService);
+        var command = new AcknowledgeCommand(factory)
+        {
+            Url = "opc.tcp://localhost:4840",
+            NodeId = "ns=2;s=MyAlarm",
+            EventId = HexOf(new byte[] { 0xAB }),
+            Comment = ""
+        };
+
+        using var console = TestConsoleHelper.CreateConsole();
+        await command.ExecuteAsync(console);
+
+        var output = TestConsoleHelper.GetOutput(console);
+        output.ShouldContain("Acknowledge failed");
+    }
+
+    /// <summary>Verifies that an invalid hex event-id throws CommandException.</summary>
+    [Fact]
+    public async Task Execute_InvalidEventId_ThrowsCommandException()
+    {
+        var fakeService = new FakeOpcUaClientService();
+        var factory = new FakeOpcUaClientServiceFactory(fakeService);
+        var command = new AcknowledgeCommand(factory)
+        {
+            Url = "opc.tcp://localhost:4840",
+            NodeId = "ns=2;s=MyAlarm",
+            EventId = "not-hex!",
+            Comment = ""
+        };
+
+        using var console = TestConsoleHelper.CreateConsole();
+        var ex = await Should.ThrowAsync<CommandException>(async () => await command.ExecuteAsync(console));
+        ex.Message.ShouldContain("event-id", Case.Insensitive);
+    }
+
+    /// <summary>Verifies that the command disconnects in the finally block.</summary>
+    [Fact]
+    public async Task Execute_DisconnectsInFinally()
+    {
+        var fakeService = new FakeOpcUaClientService();
+        var factory = new FakeOpcUaClientServiceFactory(fakeService);
+        var command = new AcknowledgeCommand(factory)
+        {
+            Url = "opc.tcp://localhost:4840",
+            NodeId = "ns=2;s=MyAlarm",
+            EventId = HexOf(new byte[] { 0x01 }),
+            Comment = ""
+        };
+
+        using var console = TestConsoleHelper.CreateConsole();
+        await command.ExecuteAsync(console);
+
+        fakeService.DisconnectCalled.ShouldBeTrue();
+        fakeService.DisposeCalled.ShouldBeTrue();
+    }
+}