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,77 @@
+using CliFx.Attributes;
+using CliFx.Exceptions;
+using CliFx.Infrastructure;
+using Opc.Ua;
+using ZB.MOM.WW.OtOpcUa.Client.Shared;
+using ZB.MOM.WW.OtOpcUa.Client.Shared.Models;
+
+namespace ZB.MOM.WW.OtOpcUa.Client.CLI.Commands;
+
+[Command("shelve", Description = "Shelve or unshelve an active alarm condition (OPC UA Part 9 ShelvedStateMachine)")]
+public class ShelveCommand : CommandBase
+{
+    /// <summary>
+    /// Creates the shelve command used to shelve or unshelve an OPC UA alarm condition from the terminal.
+    /// </summary>
+    /// <param name="factory">The factory that creates the shared client service for the command run.</param>
+    public ShelveCommand(IOpcUaClientServiceFactory factory) : base(factory)
+    {
+    }
+
+    /// <summary>
+    /// Gets the condition node ID of the alarm to shelve or unshelve.
+    /// </summary>
+    [CommandOption("node", 'n', Description = "Condition node ID of the alarm to shelve/unshelve", IsRequired = true)]
+    public string NodeId { get; init; } = default!;
+
+    /// <summary>
+    /// Gets the shelve operation kind: OneShot, Timed, or Unshelve.
+    /// </summary>
+    [CommandOption("kind", 'k', Description = "Shelve operation: OneShot | Timed | Unshelve", IsRequired = true)]
+    public string Kind { get; init; } = default!;
+
+    /// <summary>
+    /// Gets the shelving duration in seconds for Timed shelving (ignored for OneShot and Unshelve).
+    /// </summary>
+    [CommandOption("duration", 'd', Description = "Shelving duration in seconds (required for --kind Timed)")]
+    public double DurationSeconds { get; init; }
+
+    /// <summary>
+    /// Connects to the server and shelves or unshelves the specified alarm condition.
+    /// </summary>
+    /// <param name="console">The CLI console used for output and cancellation handling.</param>
+    public override async ValueTask ExecuteAsync(IConsole console)
+    {
+        ConfigureLogging();
+
+        if (!Enum.TryParse<ShelveKind>(Kind, ignoreCase: true, out var shelveKind))
+            throw new CommandException(
+                $"Invalid --kind value '{Kind}'. Expected one of: OneShot, Timed, Unshelve.");
+
+        if (shelveKind == ShelveKind.Timed && DurationSeconds <= 0)
+            throw new CommandException(
+                "--duration must be greater than 0 when --kind is Timed.");
+
+        IOpcUaClientService? service = null;
+        try
+        {
+            var ct = console.RegisterCancellationHandler();
+            (service, _) = await CreateServiceAndConnectAsync(ct);
+
+            var statusCode = await service.ShelveAlarmAsync(NodeId, shelveKind, DurationSeconds, ct);
+
+            if (StatusCode.IsGood(statusCode))
+                await console.Output.WriteLineAsync($"Shelve ({shelveKind}) successful: {NodeId}");
+            else
+                await console.Output.WriteLineAsync($"Shelve ({shelveKind}) failed: {statusCode}");
+        }
+        finally
+        {
+            if (service != null)
+            {
+                await service.DisconnectAsync();
+                service.Dispose();
+            }
+        }
+    }
+}