feat(client): AddComment + comment CLI, drop Galaxy-era alarm fallback, serialize CLI tests (#598); Client.Shared off obsolete sync SDK APIs (#621)

Claude-Session: https://claude.ai/code/session_01Ef2ozxS7QPanGT8uoATbTe
2026-10-08 06:53:57 -04:00
parent 3baa332d6b
commit 48bd266e19
18 changed files with 363 additions and 211 deletions
@@ -0,0 +1,85 @@
+using CliFx.Attributes;
+using CliFx.Exceptions;
+using CliFx.Infrastructure;
+using Opc.Ua;
+using ZB.MOM.WW.OtOpcUa.Client.CLI.Helpers;
+using ZB.MOM.WW.OtOpcUa.Client.Shared;
+
+namespace ZB.MOM.WW.OtOpcUa.Client.CLI.Commands;
+
+[Command("comment", Description = "Add an operator comment to an alarm condition (OPC UA Part 9 AddComment)")]
+public class CommentCommand : CommandBase
+{
+    /// <summary>
+    /// Creates the comment command used to attach an operator comment to an OPC UA condition from the terminal.
+    /// </summary>
+    /// <param name="factory">The factory that creates the shared client service for the command run.</param>
+    public CommentCommand(IOpcUaClientServiceFactory factory) : base(factory)
+    {
+    }
+
+    /// <summary>
+    /// Gets the condition node ID of the alarm event to comment on.
+    /// </summary>
+    [CommandOption("node", 'n', Description = "Condition node ID of the alarm to comment on", IsRequired = true)]
+    public string NodeId { get; init; } = default!;
+
+    /// <summary>
+    /// Gets the event ID (hex-encoded) returned by the server in the alarm notification.
+    /// </summary>
+    [CommandOption("event-id", 'e', Description = "EventId from the alarm notification (hex-encoded byte array)", IsRequired = true)]
+    public string EventId { get; init; } = default!;
+
+    /// <summary>
+    /// Gets the operator comment to attach to the condition.
+    /// </summary>
+    [CommandOption("comment", 'c', Description = "Operator comment to attach", IsRequired = true)]
+    public string Comment { get; init; } = string.Empty;
+
+    /// <inheritdoc />
+    public override async ValueTask ExecuteAsync(IConsole console)
+    {
+        ConfigureLogging();
+
+        try
+        {
+            NodeIdParser.ParseRequired(NodeId);
+        }
+        catch (Exception ex) when (ex is FormatException or ArgumentException)
+        {
+            throw new CommandException($"Invalid --node value: {ex.Message}");
+        }
+
+        byte[] eventId;
+        try
+        {
+            eventId = Convert.FromHexString(EventId);
+        }
+        catch (FormatException ex)
+        {
+            throw new CommandException($"Invalid --event-id value: {ex.Message} (expected hex-encoded bytes, e.g. 0A1B2C)");
+        }
+
+        IOpcUaClientService? service = null;
+        try
+        {
+            var ct = console.RegisterCancellationHandler();
+            (service, _) = await CreateServiceAndConnectAsync(ct);
+
+            var statusCode = await service.AddCommentAsync(NodeId, eventId, Comment, ct);
+
+            if (StatusCode.IsGood(statusCode))
+                await console.Output.WriteLineAsync($"Comment added: {NodeId}");
+            else
+                await console.Output.WriteLineAsync($"Comment failed: {statusCode}");
+        }
+        finally
+        {
+            if (service != null)
+            {
+                await service.DisconnectAsync();
+                service.Dispose();
+            }
+        }
+    }
+}