feat(opcua): EnsureVariable array params (ValueRank=OneDimension + ArrayDimensions)

2026-06-16 21:16:07 -04:00
parent 9dfabd279f
commit a792820283
11 changed files with 160 additions and 16 deletions
@@ -0,0 +1,123 @@
+using Microsoft.Extensions.Logging.Abstractions;
+using Opc.Ua;
+using Shouldly;
+using Xunit;
+using ZB.MOM.WW.OtOpcUa.Commons.OpcUa;
+
+namespace ZB.MOM.WW.OtOpcUa.OpcUaServer.Tests;
+
+/// <summary>
+///     Phase 4c Task 1 — node-manager materialisation honours the array intent. Boot a real
+///     <see cref="OtOpcUaSdkServer"/> through <see cref="OpcUaApplicationHost"/> (the same harness
+///     <see cref="NodeManagerHistorizeTests"/> uses), drive
+///     <see cref="OtOpcUaNodeManager.EnsureVariable"/> with / without the new <c>isArray</c> /
+///     <c>arrayLength</c> params, and assert the created <see cref="BaseDataVariableState"/>'s
+///     <c>ValueRank</c> + <c>ArrayDimensions</c>. Also proves the existing value-write path already
+///     round-trips a CLR array with no change.
+/// </summary>
+public sealed class NodeManagerArrayTests : IDisposable
+{
+    private static CancellationToken Ct => TestContext.Current.CancellationToken;
+
+    private readonly string _pkiRoot = Path.Combine(
+        Path.GetTempPath(),
+        $"otopcua-array-{Guid.NewGuid():N}");
+
+    /// <summary>An array variable is created with ValueRank=OneDimension and a single-element
+    /// ArrayDimensions carrying the requested length.</summary>
+    [Fact]
+    public async Task EnsureVariable_with_isArray_sets_one_dimension_rank_and_array_dimensions()
+    {
+        var (host, server) = await BootAsync();
+        var nm = server.NodeManager!;
+
+        nm.EnsureVariable("eq-1/arr", parentFolderNodeId: null, displayName: "arr", dataType: "Int32",
+            writable: false, historianTagname: null, isArray: true, arrayLength: 8);
+
+        var variable = nm.TryGetVariable("eq-1/arr");
+        variable.ShouldNotBeNull();
+        variable!.ValueRank.ShouldBe(ValueRanks.OneDimension);
+        variable.ArrayDimensions.ShouldNotBeNull();
+        variable.ArrayDimensions.ShouldBe(new uint[] { 8u });
+
+        await host.DisposeAsync();
+    }
+
+    /// <summary>A default (scalar) EnsureVariable call keeps ValueRank=Scalar and leaves
+    /// ArrayDimensions null/empty.</summary>
+    [Fact]
+    public async Task EnsureVariable_default_is_scalar_with_no_array_dimensions()
+    {
+        var (host, server) = await BootAsync();
+        var nm = server.NodeManager!;
+
+        nm.EnsureVariable("eq-1/scalar", parentFolderNodeId: null, displayName: "scalar", dataType: "Int32",
+            writable: false);
+
+        var variable = nm.TryGetVariable("eq-1/scalar");
+        variable.ShouldNotBeNull();
+        variable!.ValueRank.ShouldBe(ValueRanks.Scalar);
+        (variable.ArrayDimensions is null || variable.ArrayDimensions.Count == 0).ShouldBeTrue();
+
+        await host.DisposeAsync();
+    }
+
+    /// <summary>The existing WriteValue path round-trips a CLR array onto an array node with no change:
+    /// after EnsureVariable(isArray:true), WriteValue(int[]) surfaces the array verbatim with Good status.</summary>
+    [Fact]
+    public async Task WriteValue_round_trips_a_clr_array_onto_an_array_node()
+    {
+        var (host, server) = await BootAsync();
+        var nm = server.NodeManager!;
+
+        nm.EnsureVariable("eq-1/arrwrite", parentFolderNodeId: null, displayName: "arrwrite", dataType: "Int32",
+            writable: false, historianTagname: null, isArray: true, arrayLength: 3);
+
+        var payload = new[] { 1, 2, 3 };
+        nm.WriteValue("eq-1/arrwrite", payload, OpcUaQuality.Good, DateTime.UtcNow);
+
+        var variable = nm.TryGetVariable("eq-1/arrwrite");
+        variable.ShouldNotBeNull();
+        variable!.Value.ShouldBe(payload);
+        variable.StatusCode.ShouldBe((StatusCode)StatusCodes.Good);
+
+        await host.DisposeAsync();
+    }
+
+    private async Task<(OpcUaApplicationHost Host, OtOpcUaSdkServer Server)> BootAsync()
+    {
+        var host = new OpcUaApplicationHost(
+            new OpcUaApplicationHostOptions
+            {
+                ApplicationName = "OtOpcUa.ArrayTest",
+                ApplicationUri = $"urn:OtOpcUa.ArrayTest:{Guid.NewGuid():N}",
+                OpcUaPort = AllocateFreePort(),
+                PublicHostname = "localhost",
+                PkiStoreRoot = _pkiRoot,
+            },
+            NullLogger<OpcUaApplicationHost>.Instance);
+
+        var server = new OtOpcUaSdkServer();
+        await host.StartAsync(server, Ct);
+        return (host, server);
+    }
+
+    private static int AllocateFreePort()
+    {
+        using var listener = new System.Net.Sockets.TcpListener(System.Net.IPAddress.Loopback, 0);
+        listener.Start();
+        var port = ((System.Net.IPEndPoint)listener.LocalEndpoint).Port;
+        listener.Stop();
+        return port;
+    }
+
+    /// <summary>Cleans up the PKI root directory.</summary>
+    public void Dispose()
+    {
+        if (Directory.Exists(_pkiRoot))
+        {
+            try { Directory.Delete(_pkiRoot, recursive: true); }
+            catch { /* best-effort cleanup */ }
+        }
+    }
+}