UA-.NETStandard/tests/Opc.Ua.Features.Tests/MonitoredItemAliasNameRefreshStrategyIntegrationTests.cs

/* ========================================================================
 * Copyright (c) 2005-2025 The OPC Foundation, Inc. All rights reserved.
 *
 * OPC Foundation MIT License 1.00
 *
 * Permission is hereby granted, free of charge, to any person
 * obtaining a copy of this software and associated documentation
 * files (the "Software"), to deal in the Software without
 * restriction, including without limitation the rights to use,
 * copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following
 * conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 *
 * The complete license agreement can be found here:
 * http://opcfoundation.org/License/MIT/1.00/
 * ======================================================================*/

#pragma warning disable CA2007

using System;
using System.Globalization;
using System.IO;
using System.Threading.Tasks;
using NUnit.Framework;
using Opc.Ua.Client.AliasNames;
using Opc.Ua.Client.AliasNames.Refresh;
using Opc.Ua.Client.TestFramework;
using Opc.Ua.Server.TestFramework;
using Opc.Ua.Tests;
using Quickstarts.ReferenceServer;
using ISession = Opc.Ua.Client.ISession;
using Subscription = Opc.Ua.Client.Subscription;

namespace Opc.Ua.Features.Tests
{
    /// <summary>
    /// End-to-end test for <see cref="MonitoredItemAliasNameRefreshStrategy"/>
    /// against the live <c>ReferenceServer</c>. Validates that the
    /// strategy successfully creates a subscription + monitored item on
    /// the well-known <c>Aliases.LastChange</c> property and cleans up
    /// on dispose.
    /// </summary>
    [TestFixture]
    [Category("AliasNames")]
    [Category("Client")]
    [SetCulture("en-us")]
    [SetUICulture("en-us")]
    [NonParallelizable]
    public class MonitoredItemAliasNameRefreshStrategyIntegrationTests
    {
        private ServerFixture<ReferenceServer> m_serverFixture;
#pragma warning disable NUnit1032
        private ClientFixture m_clientFixture;
#pragma warning restore NUnit1032
        private ReferenceServer m_server;
        private ISession m_session;
        private string m_pkiRoot;
        private Uri m_url;

        [OneTimeSetUp]
        public async Task OneTimeSetUpAsync()
        {
            ITelemetryContext telemetry = NUnitTelemetryContext.Create();
            m_pkiRoot = Path.GetTempPath() + Path.GetRandomFileName();

            m_serverFixture = new ServerFixture<ReferenceServer>(t => new ReferenceServer(t))
            {
                UriScheme = Utils.UriSchemeOpcTcp,
                SecurityNone = true,
                AutoAccept = true,
                AllNodeManagers = true,
                OperationLimits = true
            };
            m_server = await m_serverFixture.StartAsync(m_pkiRoot).ConfigureAwait(false);

            m_clientFixture = new ClientFixture(telemetry);
            await m_clientFixture.LoadClientConfigurationAsync(m_pkiRoot).ConfigureAwait(false);
            m_url = new Uri(Utils.UriSchemeOpcTcp +
                "://localhost:" +
                m_serverFixture.Port.ToString(CultureInfo.InvariantCulture));

            try
            {
                m_session = await m_clientFixture.ConnectAsync(
                    m_url, SecurityPolicies.None).ConfigureAwait(false);
            }
            catch (Exception e)
            {
                Assert.Ignore(
                    "MonitoredItem strategy integration setup failed: " + e.Message);
            }
        }

        [OneTimeTearDown]
        public async Task OneTimeTearDownAsync()
        {
            if (m_session != null)
            {
                await m_session.CloseAsync().ConfigureAwait(false);
                m_session.Dispose();
                m_session = null!;
            }
            if (m_serverFixture != null)
            {
                await m_serverFixture.StopAsync().ConfigureAwait(false);
            }
            m_clientFixture?.Dispose();
            m_server?.Dispose();
        }

        [Test]
        public async Task StrategyCreatesAndDisposesSubscriptionAsync()
        {
            int initialCount = m_session.SubscriptionCount;
            var client = AliasNameClient.OpenStandardAliases(m_session);

            AliasNameResolver resolver = new(
                client,
                new AliasNameResolverOptions
                {
                    RefreshMode = AliasNameResolverRefreshMode
                        .AutoOnLastChangeMonitoredItem,
                    PublishingIntervalMs = 500,
                    LastChangeSamplingIntervalMs = 500
                });
            try
            {
                await resolver.EnsureLoadedAsync().ConfigureAwait(false);
                Assert.That(m_session.SubscriptionCount,
                    Is.EqualTo(initialCount + 1),
                    "MonitoredItem strategy must add one subscription.");
            }
            finally
            {
                await resolver.DisposeAsync().ConfigureAwait(false);
            }

            // Allow a moment for the RemoveSubscription/Delete round-trips.
            for (int i = 0; i < 20 &&
                m_session.SubscriptionCount != initialCount; i++)
            {
                await Task.Delay(50).ConfigureAwait(false);
            }
            Assert.That(m_session.SubscriptionCount, Is.EqualTo(initialCount),
                "Owned subscription must be removed on DisposeAsync.");
        }

        [Test]
        public async Task ManualResolverDoesNotCreateSubscriptionAsync()
        {
            int initialCount = m_session.SubscriptionCount;
            var client = AliasNameClient.OpenStandardAliases(m_session);

            await using var resolver = new AliasNameResolver(
                client,
                new AliasNameResolverOptions
                {
                    RefreshMode = AliasNameResolverRefreshMode.Manual
                });
            await resolver.EnsureLoadedAsync().ConfigureAwait(false);

            Assert.That(m_session.SubscriptionCount, Is.EqualTo(initialCount));
        }

        [Test]
        public async Task StrategyWithSharedSubscriptionDoesNotOwnItAsync()
        {
            // Pre-create a subscription owned by the test (NOT the
            // strategy). The strategy must hook a MonitoredItem onto it
            // without taking ownership, so that disposing the strategy
            // leaves the subscription alive on the session for the test
            // to reuse and dispose explicitly.
            int initialCount = m_session.SubscriptionCount;
            using var sharedSubscription = new Subscription(
                m_session.MessageContext.Telemetry)
            {
                DisplayName = "shared-by-test",
                PublishingEnabled = true,
                PublishingInterval = 500
            };
            m_session.AddSubscription(sharedSubscription);
            await sharedSubscription.CreateAsync().ConfigureAwait(false);
            Assert.That(m_session.SubscriptionCount,
                Is.EqualTo(initialCount + 1),
                "Test setup must own the subscription.");

            int sharedItemCountBefore = (int)sharedSubscription.MonitoredItemCount;
            var client = AliasNameClient.OpenStandardAliases(m_session);

            var resolver = new AliasNameResolver(
                client,
                new AliasNameResolverOptions
                {
                    RefreshStrategy = new MonitoredItemAliasNameRefreshStrategy(
                        new MonitoredItemAliasNameRefreshStrategyOptions
                        {
                            SharedSubscription = sharedSubscription,
                            SamplingIntervalMs = 500
                        })
                });
            try
            {
                await resolver.EnsureLoadedAsync().ConfigureAwait(false);

                Assert.That(m_session.SubscriptionCount,
                    Is.EqualTo(initialCount + 1),
                    "Shared-mode strategy must NOT create a new subscription.");
                Assert.That(sharedSubscription.MonitoredItemCount,
                    Is.GreaterThan(sharedItemCountBefore),
                    "Strategy must hook its MonitoredItem onto the shared subscription.");
            }
            finally
            {
                await resolver.DisposeAsync().ConfigureAwait(false);
            }

            // After the strategy disposes, the shared subscription must
            // still be alive on the session and reusable. The strategy
            // SHOULD have removed its own monitored item (best-effort) —
            // but must NOT have removed/deleted the subscription itself.
            Assert.That(m_session.SubscriptionCount,
                Is.EqualTo(initialCount + 1),
                "Strategy.DisposeAsync must NOT remove a shared subscription from the session.");
            Assert.That(sharedSubscription.Created, Is.True,
                "Shared subscription must remain in the Created state after strategy disposal.");

            // Test owns the subscription — clean it up.
            try
            {
                await m_session.RemoveSubscriptionAsync(sharedSubscription).ConfigureAwait(false);
                await sharedSubscription.DeleteAsync(silent: true).ConfigureAwait(false);
            }
            catch
            {
                // Best-effort teardown.
            }
        }
    }
}