lmxopcua/tests/Server/ZB.MOM.WW.OtOpcUa.OpcUaServer.Tests/NodeManagerSurgicalShapeUpdateTests.cs

using Opc.Ua;
using Shouldly;
using Xunit;
using ZB.MOM.WW.OtOpcUa.Commons.OpcUa;

namespace ZB.MOM.WW.OtOpcUa.OpcUaServer.Tests;

/// <summary>
///     FB-7 — the BEHAVIOURAL half of the surgical DataType/array-shape in-place write (the applier-level
///     eligibility + dispatch decisions live in <see cref="AddressSpaceApplierTests"/>). Boots a real
///     <see cref="OtOpcUaSdkServer"/> through <see cref="OpcUaApplicationHost"/> (the same harness
///     <see cref="NodeManagerWriteRevertTests"/> uses) so <see cref="OtOpcUaNodeManager.UpdateTagAttributes"/>
///     runs against a live node manager (real <c>Lock</c> + <c>SystemContext</c> + <c>Server</c>), and asserts:
///     <list type="bullet">
///         <item>a DataType / ValueRank / array-length change is applied IN PLACE on the existing node and
///         RESETS its value to BadWaitingForInitialData (no stale wrong-typed value), while the node identity
///         (and therefore client subscriptions) survive;</item>
///         <item>a Writable / Historizing-only change (shape unchanged) does NOT reset the value — the
///         original surgical behaviour is preserved byte-for-byte;</item>
///         <item>the built <c>GeneralModelChangeEvent</c> carries Changes=[{Affected=node, Verb=DataTypeChanged}].</item>
///     </list>
///     <para>
///         Coverage boundary (deliberate, mirrors <see cref="NodeManagerWriteRevertTests"/>): the model-change
///         event is asserted via its <i>builder</i> (<see cref="OtOpcUaNodeManager.BuildNodeShapeChangedEvent"/>)
///         in isolation, not its end-to-end <c>Server.ReportEvent</c> dispatch — observing that would require a
///         subscribed event monitored-item. The single in-lock report call-site is covered by inspection.
///     </para>
/// </summary>
public sealed class NodeManagerSurgicalShapeUpdateTests : IDisposable
{
    private static CancellationToken Ct => TestContext.Current.CancellationToken;

    private readonly string _pkiRoot = Path.Combine(
        Path.GetTempPath(),
        $"otopcua-surgical-shape-{Guid.NewGuid():N}");

    // ───────────────────────────── Shape swap (DataType / ValueRank / array length) ─────────────────────────────

    /// <summary>A DataType change swaps the node's DataType in place and resets the value (the old Float value
    /// must not survive on a now-Int32 node); the node id is unchanged, so client subscriptions are preserved.</summary>
    [Fact]
    public async Task DataType_change_swaps_in_place_and_resets_value()
    {
        var (host, server) = await BootAsync();
        var nm = server.NodeManager!;

        nm.EnsureVariable("eq-1/sp", parentFolderNodeId: null, displayName: "Sp", dataType: "Float", writable: false, realm: AddressSpaceRealm.Uns);
        nm.WriteValue("eq-1/sp", 3.5f, OpcUaStatus.Good, DateTime.UtcNow, realm: AddressSpaceRealm.Uns);
        var node = nm.TryGetVariable("eq-1/sp")!;
        node.DataType.ShouldBe(DataTypeIds.Float); // arrange guard

        var applied = nm.UpdateTagAttributes("eq-1/sp", writable: false, historianTagname: null,
            dataType: "Int32", isArray: false, arrayLength: null, realm: AddressSpaceRealm.Uns);

        applied.ShouldBeTrue();
        node.DataType.ShouldBe(DataTypeIds.Int32);                      // swapped in place
        node.ValueRank.ShouldBe(ValueRanks.Scalar);
        node.Value.ShouldBeNull();                                     // stale Float value dropped
        node.StatusCode.ShouldBe((StatusCode)StatusCodes.BadWaitingForInitialData);

        await host.DisposeAsync();
    }

    /// <summary>A scalar → array flip swaps ValueRank to OneDimension + ArrayDimensions=[len] in place and
    /// resets the value.</summary>
    [Fact]
    public async Task Scalar_to_array_flip_swaps_value_rank_and_resets_value()
    {
        var (host, server) = await BootAsync();
        var nm = server.NodeManager!;

        nm.EnsureVariable("eq-1/buf", parentFolderNodeId: null, displayName: "Buf", dataType: "Int16", writable: false, realm: AddressSpaceRealm.Uns);
        nm.WriteValue("eq-1/buf", (short)42, OpcUaStatus.Good, DateTime.UtcNow, realm: AddressSpaceRealm.Uns);
        var node = nm.TryGetVariable("eq-1/buf")!;
        node.ValueRank.ShouldBe(ValueRanks.Scalar); // arrange guard

        var applied = nm.UpdateTagAttributes("eq-1/buf", writable: false, historianTagname: null,
            dataType: "Int16", isArray: true, arrayLength: 8u, realm: AddressSpaceRealm.Uns);

        applied.ShouldBeTrue();
        node.ValueRank.ShouldBe(ValueRanks.OneDimension);
        node.ArrayDimensions.ShouldNotBeNull();
        node.ArrayDimensions[0].ShouldBe(8u);
        node.Value.ShouldBeNull();                                     // stale scalar value dropped
        node.StatusCode.ShouldBe((StatusCode)StatusCodes.BadWaitingForInitialData);

        await host.DisposeAsync();
    }

    /// <summary>An array-to-array LENGTH change (rank stays OneDimension, only ArrayDimensions[0] differs) is
    /// still treated as a shape change — the dimension is updated and the (now wrong-length) value reset.</summary>
    [Fact]
    public async Task Array_length_change_swaps_dimension_and_resets_value()
    {
        var (host, server) = await BootAsync();
        var nm = server.NodeManager!;

        nm.EnsureVariable("eq-1/buf", parentFolderNodeId: null, displayName: "Buf", dataType: "Int16",
            writable: false, historianTagname: null, isArray: true, arrayLength: 4u, realm: AddressSpaceRealm.Uns);
        nm.WriteValue("eq-1/buf", new short[] { 1, 2, 3, 4 }, OpcUaStatus.Good, DateTime.UtcNow, realm: AddressSpaceRealm.Uns);
        var node = nm.TryGetVariable("eq-1/buf")!;
        node.ArrayDimensions![0].ShouldBe(4u); // arrange guard

        var applied = nm.UpdateTagAttributes("eq-1/buf", writable: false, historianTagname: null,
            dataType: "Int16", isArray: true, arrayLength: 8u, realm: AddressSpaceRealm.Uns);

        applied.ShouldBeTrue();
        node.ArrayDimensions[0].ShouldBe(8u);
        node.Value.ShouldBeNull();
        node.StatusCode.ShouldBe((StatusCode)StatusCodes.BadWaitingForInitialData);

        await host.DisposeAsync();
    }

    /// <summary>The symmetric array → scalar flip: ValueRank drops back to Scalar, ArrayDimensions clears to
    /// null, and the (now wrong-shaped) array value is reset.</summary>
    [Fact]
    public async Task Array_to_scalar_flip_clears_dimensions_and_resets_value()
    {
        var (host, server) = await BootAsync();
        var nm = server.NodeManager!;

        nm.EnsureVariable("eq-1/buf", parentFolderNodeId: null, displayName: "Buf", dataType: "Int16",
            writable: false, historianTagname: null, isArray: true, arrayLength: 4u, realm: AddressSpaceRealm.Uns);
        nm.WriteValue("eq-1/buf", new short[] { 1, 2, 3, 4 }, OpcUaStatus.Good, DateTime.UtcNow, realm: AddressSpaceRealm.Uns);
        var node = nm.TryGetVariable("eq-1/buf")!;
        node.ValueRank.ShouldBe(ValueRanks.OneDimension); // arrange guard

        var applied = nm.UpdateTagAttributes("eq-1/buf", writable: false, historianTagname: null,
            dataType: "Int16", isArray: false, arrayLength: null, realm: AddressSpaceRealm.Uns);

        applied.ShouldBeTrue();
        node.ValueRank.ShouldBe(ValueRanks.Scalar);
        node.ArrayDimensions.ShouldBeNull();
        node.Value.ShouldBeNull();
        node.StatusCode.ShouldBe((StatusCode)StatusCodes.BadWaitingForInitialData);

        await host.DisposeAsync();
    }

    /// <summary>A scalar → array flip with a null arrayLength defaults ArrayDimensions to [0] — mirroring
    /// <see cref="OtOpcUaNodeManager.EnsureVariable"/>'s fresh-node default for an unspecified length.</summary>
    [Fact]
    public async Task Array_flip_with_null_length_defaults_dimension_to_zero()
    {
        var (host, server) = await BootAsync();
        var nm = server.NodeManager!;

        nm.EnsureVariable("eq-1/buf", parentFolderNodeId: null, displayName: "Buf", dataType: "Int16", writable: false, realm: AddressSpaceRealm.Uns);
        var node = nm.TryGetVariable("eq-1/buf")!;

        var applied = nm.UpdateTagAttributes("eq-1/buf", writable: false, historianTagname: null,
            dataType: "Int16", isArray: true, arrayLength: null, realm: AddressSpaceRealm.Uns);

        applied.ShouldBeTrue();
        node.ValueRank.ShouldBe(ValueRanks.OneDimension);
        node.ArrayDimensions.ShouldNotBeNull();
        node.ArrayDimensions[0].ShouldBe(0u); // null length ⇒ [0], same as EnsureVariable

        await host.DisposeAsync();
    }

    // ───────────────────────────── Backward compatibility (shape unchanged) ─────────────────────────────

    /// <summary>A Writable-only change (DataType + array-ness identical to the live node) must NOT reset the
    /// value — the original surgical behaviour stands. AccessLevel flips to ReadWrite; the prior Good value
    /// survives untouched.</summary>
    [Fact]
    public async Task Writable_only_change_keeps_value_and_does_not_reset()
    {
        var (host, server) = await BootAsync();
        var nm = server.NodeManager!;

        nm.EnsureVariable("eq-1/sp", parentFolderNodeId: null, displayName: "Sp", dataType: "Float", writable: false, realm: AddressSpaceRealm.Uns);
        nm.WriteValue("eq-1/sp", 7.0f, OpcUaStatus.Good, DateTime.UtcNow, realm: AddressSpaceRealm.Uns);
        var node = nm.TryGetVariable("eq-1/sp")!;

        // Same DataType ("Float") + same scalar shape — only Writable flips false → true.
        var applied = nm.UpdateTagAttributes("eq-1/sp", writable: true, historianTagname: null,
            dataType: "Float", isArray: false, arrayLength: null, realm: AddressSpaceRealm.Uns);

        applied.ShouldBeTrue();
        node.Value.ShouldBe(7.0f);                                    // value preserved (NOT reset)
        node.StatusCode.ShouldBe((StatusCode)StatusCodes.Good);       // status preserved
        node.DataType.ShouldBe(DataTypeIds.Float);
        // ReadWrite ⇒ CurrentRead | CurrentWrite.
        node.AccessLevel.ShouldBe((byte)(AccessLevels.CurrentRead | AccessLevels.CurrentWrite));

        await host.DisposeAsync();
    }

    /// <summary>An unknown node id (rebuilt/removed in the interim) returns false so the caller falls back to a
    /// full rebuild; it must not throw.</summary>
    [Fact]
    public async Task Missing_node_returns_false()
    {
        var (host, server) = await BootAsync();
        var nm = server.NodeManager!;

        bool result = true;
        Should.NotThrow(() => result = nm.UpdateTagAttributes("eq-1/gone", writable: false, historianTagname: null,
            dataType: "Int32", isArray: false, arrayLength: null, realm: AddressSpaceRealm.Uns));
        result.ShouldBeFalse();

        await host.DisposeAsync();
    }

    // ───────────────────────────── GeneralModelChangeEvent builder ─────────────────────────────

    /// <summary>The built model-change event announces the affected node with verb DataTypeChanged and the
    /// node's TypeDefinition as AffectedType — what model-aware clients consume to re-read the definition.</summary>
    [Fact]
    public async Task Built_model_change_event_reflects_the_affected_node()
    {
        var (host, server) = await BootAsync();
        var nm = server.NodeManager!;

        nm.EnsureVariable("eq-1/sp", parentFolderNodeId: null, displayName: "Sp", dataType: "Float", writable: false, realm: AddressSpaceRealm.Uns);
        var node = nm.TryGetVariable("eq-1/sp")!;

        var e = nm.BuildNodeShapeChangedEvent(node);

        e.ShouldNotBeNull();
        e.Changes.ShouldNotBeNull();
        var changes = e.Changes.Value;
        changes.Length.ShouldBe(1);
        changes[0].Affected.ShouldBe(node.NodeId);
        changes[0].AffectedType.ShouldBe(VariableTypeIds.BaseDataVariableType);
        changes[0].Verb.ShouldBe((byte)ModelChangeStructureVerbMask.DataTypeChanged);

        await host.DisposeAsync();
    }

    private async Task<(OpcUaApplicationHost Host, OtOpcUaSdkServer Server)> BootAsync()
    {
        var host = new OpcUaApplicationHost(
            new OpcUaApplicationHostOptions
            {
                ApplicationName = "OtOpcUa.SurgicalShapeTest",
                ApplicationUri = $"urn:OtOpcUa.SurgicalShapeTest:{Guid.NewGuid():N}",
                OpcUaPort = AllocateFreePort(),
                PublicHostname = "localhost",
                PkiStoreRoot = _pkiRoot,
            },
            Microsoft.Extensions.Logging.Abstractions.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 */ }
        }
    }
}