UA-.NETStandard/tests/Opc.Ua.Core.Tests/Stack/State/ConditionStateTests.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/
 * ======================================================================*/

// CA2000: test code; many disposables are ownership-transferred to test fixtures or short-lived,
// making CA2000 noisy without a real leak risk. Disabled file-level for the suite.
#pragma warning disable CA2000
using System;
using System.Threading.Tasks;
using NUnit.Framework;
using Opc.Ua.Tests;

namespace Opc.Ua.Core.Tests.Stack.State
{
    /// <summary>
    /// Tests for the ConditionState class.
    /// </summary>
    [TestFixture]
    [Category("ConditionState")]
    [SetCulture("en-us")]
    [SetUICulture("en-us")]
    [Parallelizable]
    public class ConditionStateTests
    {
        private ISystemContext m_context;
        private ITelemetryContext m_telemetry;

        [OneTimeSetUp]
        protected void OneTimeSetUp()
        {
            m_telemetry = NUnitTelemetryContext.Create();
            var messageContext = ServiceMessageContext.Create(m_telemetry);
            // Add OPC UA namespace
            messageContext.NamespaceUris.GetIndexOrAppend(Namespaces.OpcUa);
            m_context = new SystemContext(m_telemetry)
            {
                NamespaceUris = messageContext.NamespaceUris
            };
        }

        [OneTimeTearDown]
        protected void OneTimeTearDown()
        {
            (m_context as IDisposable)?.Dispose();
        }

        [TestCase(true, true, true, true)]
        [TestCase(false, true, true, false)]
        [TestCase(false, false, true, true)]
        [TestCase(true, true, false, false)]
        public async Task AdditionalRetentionPreservesStandardAndDisabledRulesAsync(
            bool additionalRetain, bool acknowledged, bool enabled, bool expectedRetain)
        {
            var condition = new AcknowledgeableConditionState(null);
            condition.Create(m_context, new NodeId(1u), QualifiedName.From("Condition"), default, true);
            condition.SetEnableState(m_context, !enabled);
            condition.SetAcknowledgedState(m_context, acknowledged);
            int evaluated = 0;
            condition.RetainStateProvider = current =>
            {
                Assert.That(current, Is.SameAs(condition));
                evaluated++;
                return additionalRetain;
            };
            MethodState method = enabled ? condition.Enable! : condition.Disable!;
            ServiceResult result = await method.CallAsync(m_context, condition.NodeId, [], [], [])
                .ConfigureAwait(false);
            Assert.That(result.StatusCode, Is.EqualTo(StatusCodes.Good));
            Assert.That(condition.Retain!.Value, Is.EqualTo(expectedRetain));
            Assert.That(evaluated, enabled ? Is.GreaterThan(0) : Is.Zero);
        }

        [Test]
        public void BranchPreservesAdditionalRetentionProvider()
        {
            var condition = new AcknowledgeableConditionState(null);
            condition.Create(m_context, new NodeId(1u), QualifiedName.From("Condition"), default, true);
            condition.SetEnableState(m_context, true);
            condition.RetainStateProvider = current => !current.BranchId!.Value.IsNull;
            ConditionState? branch = condition.CreateBranch(m_context, new NodeId(2u));
            Assert.That(branch, Is.Not.Null);
            Assert.That(branch!.RetainStateProvider, Is.SameAs(condition.RetainStateProvider));
            Assert.That(branch.RetainStateProvider!(branch), Is.True);
            Assert.That(condition.RetainStateProvider(condition), Is.False);
        }

        /// <summary>
        /// Test that SetEnableState updates the timestamp and clears change masks.
        /// </summary>
        [Test]
        public void SetEnableStateUpdatesTimestampAndClearsChangeMasks()
        {
            var condition = new ConditionState(null);
            condition.Create(m_context, new NodeId(1), QualifiedName.From("Condition"), default, true);

            // Set initial state
            DateTimeUtc beforeTime = DateTimeUtc.Now;
            condition.SetEnableState(m_context, true);
            DateTimeUtc afterTime = DateTimeUtc.Now;

            // Verify timestamp is updated
            Assert.That(condition.EnabledState!.Timestamp, Is.GreaterThanOrEqualTo(beforeTime));
            Assert.That(condition.EnabledState.Timestamp, Is.LessThanOrEqualTo(afterTime));

            // Verify change masks are cleared (all should be None)
            Assert.That(condition.ChangeMasks, Is.EqualTo(NodeStateChangeMasks.None));
            Assert.That(condition.EnabledState.ChangeMasks, Is.EqualTo(NodeStateChangeMasks.None));
        }

        /// <summary>
        /// Test that SetSeverity updates the timestamp and clears change masks.
        /// </summary>
        [Test]
        public void SetSeverityUpdatesTimestampAndClearsChangeMasks()
        {
            var condition = new ConditionState(null);
            condition.Create(m_context, new NodeId(1), QualifiedName.From("Condition"), default, true);

            DateTimeUtc beforeTime = DateTimeUtc.Now;
            condition.SetSeverity(m_context, EventSeverity.High);
            DateTimeUtc afterTime = DateTimeUtc.Now;

            // Verify timestamps are updated
            Assert.That(condition.Severity!.Timestamp, Is.GreaterThanOrEqualTo(beforeTime));
            Assert.That(condition.Severity.Timestamp, Is.LessThanOrEqualTo(afterTime));
            Assert.That(condition.LastSeverity!.Timestamp, Is.GreaterThanOrEqualTo(beforeTime));
            Assert.That(condition.LastSeverity.Timestamp, Is.LessThanOrEqualTo(afterTime));

            // Verify change masks are cleared
            Assert.That(condition.ChangeMasks, Is.EqualTo(NodeStateChangeMasks.None));
        }

        /// <summary>
        /// Test that SetActiveState updates the timestamp and clears change masks.
        /// </summary>
        [Test]
        public void SetActiveStateUpdatesTimestampAndClearsChangeMasks()
        {
            var alarm = new AlarmConditionState(m_telemetry, null!);
            alarm.Create(m_context, new NodeId(1), QualifiedName.From("Alarm"), default, true);

            DateTimeUtc beforeTime = DateTimeUtc.Now;
            alarm.SetActiveState(m_context, true);
            DateTimeUtc afterTime = DateTimeUtc.Now;

            // Verify timestamp is updated
            Assert.That(alarm.ActiveState!.Timestamp, Is.GreaterThanOrEqualTo(beforeTime));
            Assert.That(alarm.ActiveState.Timestamp, Is.LessThanOrEqualTo(afterTime));

            // Verify change masks are cleared
            Assert.That(alarm.ChangeMasks, Is.EqualTo(NodeStateChangeMasks.None));
            Assert.That(alarm.ActiveState.ChangeMasks, Is.EqualTo(NodeStateChangeMasks.None));
        }

        /// <summary>
        /// Test that SetSuppressedState updates the timestamp and clears change masks.
        /// </summary>
        [Test]
        public void SetSuppressedStateUpdatesTimestampAndClearsChangeMasks()
        {
            var alarm = new AlarmConditionState(m_telemetry, null!);
            alarm.Create(m_context, new NodeId(1), QualifiedName.From("Alarm"), default, true);
            alarm.SuppressedState = new TwoStateVariableState(alarm);
            alarm.SuppressedState.Create(m_context, default, QualifiedName.From(BrowseNames.SuppressedState), default, false);

            DateTimeUtc beforeTime = DateTimeUtc.Now;
            alarm.SetSuppressedState(m_context, true);
            DateTimeUtc afterTime = DateTimeUtc.Now;

            // Verify timestamp is updated
            Assert.That(alarm.SuppressedState.Timestamp, Is.GreaterThanOrEqualTo(beforeTime));
            Assert.That(alarm.SuppressedState.Timestamp, Is.LessThanOrEqualTo(afterTime));

            // Verify change masks are cleared
            Assert.That(alarm.ChangeMasks, Is.EqualTo(NodeStateChangeMasks.None));
            Assert.That(alarm.SuppressedState.ChangeMasks, Is.EqualTo(NodeStateChangeMasks.None));
        }

        /// <summary>
        /// Test that SetAcknowledgedState updates the timestamp and clears change masks.
        /// </summary>
        [Test]
        public void SetAcknowledgedStateUpdatesTimestampAndClearsChangeMasks()
        {
            var condition = new AcknowledgeableConditionState(null);
            condition.Create(m_context, new NodeId(1), QualifiedName.From("AckCondition"), default, true);

            DateTimeUtc beforeTime = DateTimeUtc.Now;
            condition.SetAcknowledgedState(m_context, true);
            DateTimeUtc afterTime = DateTimeUtc.Now;

            // Verify timestamp is updated
            Assert.That(condition.AckedState!.Timestamp, Is.GreaterThanOrEqualTo(beforeTime));
            Assert.That(condition.AckedState.Timestamp, Is.LessThanOrEqualTo(afterTime));

            // Verify change masks are cleared
            Assert.That(condition.ChangeMasks, Is.EqualTo(NodeStateChangeMasks.None));
            Assert.That(condition.AckedState.ChangeMasks, Is.EqualTo(NodeStateChangeMasks.None));
        }

        /// <summary>
        /// Test that SetConfirmedState updates the timestamp and clears change masks.
        /// </summary>
        [Test]
        public void SetConfirmedStateUpdatesTimestampAndClearsChangeMasks()
        {
            var condition = new AcknowledgeableConditionState(null);
            condition.Create(m_context, new NodeId(1), QualifiedName.From("AckCondition"), default, true);
            condition.ConfirmedState = new TwoStateVariableState(condition);
            condition.ConfirmedState.Create(m_context, default, QualifiedName.From(BrowseNames.ConfirmedState), default, false);

            DateTimeUtc beforeTime = DateTimeUtc.Now;
            condition.SetConfirmedState(m_context, true);
            DateTimeUtc afterTime = DateTimeUtc.Now;

            // Verify timestamp is updated
            Assert.That(condition.ConfirmedState.Timestamp, Is.GreaterThanOrEqualTo(beforeTime));
            Assert.That(condition.ConfirmedState.Timestamp, Is.LessThanOrEqualTo(afterTime));

            // Verify change masks are cleared
            Assert.That(condition.ChangeMasks, Is.EqualTo(NodeStateChangeMasks.None));
            Assert.That(condition.ConfirmedState.ChangeMasks, Is.EqualTo(NodeStateChangeMasks.None));
        }

        /// <summary>
        /// Test that SetShelvingState updates the timestamp and clears change masks.
        /// </summary>
        [Test]
        public void SetShelvingStateUpdatesTimestampAndClearsChangeMasks()
        {
            var alarm = new AlarmConditionState(m_telemetry, null!);
            alarm.Create(m_context, new NodeId(1), QualifiedName.From("Alarm"), default, true);
            alarm.ShelvingState = new ShelvedStateMachineState(alarm);
            alarm.ShelvingState.Create(m_context, default, QualifiedName.From(BrowseNames.ShelvingState), default, false);
            alarm.ShelvingState.UnshelveTime = PropertyState<double>.With<VariantBuilder>(alarm.ShelvingState);

            DateTimeUtc beforeTime = DateTimeUtc.Now;
            alarm.SetShelvingState(m_context, true, false, 1000);
            DateTimeUtc afterTime = DateTimeUtc.Now;

            // Verify timestamp is updated on UnshelveTime
            Assert.That(alarm.ShelvingState.UnshelveTime.Timestamp, Is.GreaterThanOrEqualTo(beforeTime));
            Assert.That(alarm.ShelvingState.UnshelveTime.Timestamp, Is.LessThanOrEqualTo(afterTime));

            // Verify change masks are cleared
            Assert.That(alarm.ChangeMasks, Is.EqualTo(NodeStateChangeMasks.None));
        }

        /// <summary>
        /// Test that subscribed clients are notified when SetActiveState is called.
        /// This simulates the issue scenario.
        /// </summary>
        [Test]
        public void SetActiveStateNotifiesSubscribers()
        {
            var alarm = new AlarmConditionState(m_telemetry, null!);
            alarm.Create(m_context, new NodeId(1), QualifiedName.From("Alarm"), default, true);

            // Initially inactive
            alarm.SetActiveState(m_context, false);

            // Now activate the alarm - timestamp should be greater than or equal to the initial timestamp
            // since both could be set to DateTimeUtc.Now which has limited precision
            DateTimeUtc beforeActivation = DateTimeUtc.Now;
            alarm.SetActiveState(m_context, true);
            DateTimeUtc afterActivation = DateTimeUtc.Now;

            // Verify that the timestamp is within the expected range
            Assert.That(alarm.ActiveState!.Timestamp, Is.GreaterThanOrEqualTo(beforeActivation));
            Assert.That(alarm.ActiveState.Timestamp, Is.LessThanOrEqualTo(afterActivation));

            // Verify that change masks were cleared (indicating subscribers were notified)
            Assert.That(alarm.ActiveState.ChangeMasks, Is.EqualTo(NodeStateChangeMasks.None));
        }

        /// <summary>
        /// Test that UpdateStateAfterEnable calls EvaluateRetainStateOnEnable
        /// and that the default implementation sets Retain based on GetRetainState.
        /// </summary>
        [Test]
        public void UpdateStateAfterEnableCallsEvaluateRetainStateOnEnable()
        {
            // Arrange
            var condition = new ConditionState(null);
            condition.Create(m_context, default, QualifiedName.From("TestCondition"), default, true);

            // Initially disabled
            condition.SetEnableState(m_context, false);
            Assert.That(condition.EnabledState!.Id!.Value, Is.False);
            Assert.That(condition.Retain!.Value, Is.False);

            // Act - Enable the condition
            condition.SetEnableState(m_context, true);

            // Assert - Enabled state should be true
            Assert.That(condition.EnabledState.Id.Value, Is.True);

            // The default implementation should call UpdateRetainState which uses GetRetainState
            // For base ConditionState with no branches, GetRetainState returns false when enabled
            Assert.That(condition.Retain.Value, Is.False);
        }

        /// <summary>
        /// Test that UpdateStateAfterDisable sets Retain to false as per specification.
        /// </summary>
        [Test]
        public void UpdateStateAfterDisableSetsRetainToFalse()
        {
            // Arrange
            var condition = new TestConditionStateWithRetain(null!);
            condition.Create(m_context, default, QualifiedName.From("TestCondition"), default, true);

            // Enable the condition and set retain to true
            condition.SetEnableState(m_context, true);
            condition.ForceRetain(true);
            Assert.That(condition.Retain!.Value, Is.True);

            // Act - Disable the condition
            condition.SetEnableState(m_context, false);

            // Assert - Retain should be false per specification
            Assert.That(condition.EnabledState!.Id!.Value, Is.False);
            Assert.That(condition.Retain.Value, Is.False);
        }

        /// <summary>
        /// Test that a derived class can override EvaluateRetainStateOnEnable
        /// to provide custom logic for determining the Retain value.
        /// </summary>
        [Test]
        public void DerivedClassCanOverrideEvaluateRetainStateOnEnable()
        {
            // Arrange
            var condition = new TestConditionStateWithCustomRetain(null!);
            condition.Create(m_context, default, QualifiedName.From("TestCondition"), default, true);

            // Initially disabled
            condition.SetEnableState(m_context, false);
            Assert.That(condition.Retain!.Value, Is.False);

            // Act - Enable the condition
            condition.SetEnableState(m_context, true);

            // Assert - The custom implementation should have been called
            Assert.That(condition.EnabledState!.Id!.Value, Is.True);
            Assert.That(condition.EvaluateCalled, Is.True);
            Assert.That(condition.Retain.Value, Is.True);  // Custom logic always sets to true
        }

        /// <summary>
        /// Test that the branch collection can be safely created, enumerated and
        /// cleared from multiple threads concurrently without throwing.
        /// Reproduces the race that previously crashed the process when the
        /// branch dictionary was enumerated while being modified.
        /// </summary>
        [Test]
        [CancelAfter(10_000)]
        public void ConcurrentBranchAccessIsThreadSafe()
        {
            var condition = new ConditionState(null);
            condition.Create(m_context, new NodeId(1), QualifiedName.From("Condition"), default, true);
            // Ensure each created branch receives a unique EventId.
            condition.AutoReportStateChanges = true;
            condition.SetEnableState(m_context, true);

            const int iterations = 2000;
            using var cts = new System.Threading.CancellationTokenSource();

            // Writer: continuously creates and clears branches.
            var writer = System.Threading.Tasks.Task.Run(() =>
            {
                for (int i = 0; i < iterations; i++)
                {
                    condition.CreateBranch(m_context, new NodeId((uint)(i + 2)));
                    if (i % 10 == 0)
                    {
                        condition.ClearBranches();
                    }
                }
            });

            // Reader: continuously enumerates and counts branches.
            var reader = System.Threading.Tasks.Task.Run(() =>
            {
                while (!cts.Token.IsCancellationRequested)
                {
                    foreach (System.Collections.Generic.KeyValuePair<string, ConditionState> branch
                        in condition.GetBranches())
                    {
                        Assert.That(branch.Value, Is.Not.Null);
                    }

                    _ = condition.GetBranchCount();
                }
            });

            Assert.That(() =>
            {
                try
                {
                    writer.GetAwaiter().GetResult();
                }
                finally
                {
                    cts.Cancel();
                }

                reader.GetAwaiter().GetResult();
            }, Throws.Nothing);
        }

        /// <summary>
        /// Test condition that exposes method to force Retain value for testing.
        /// </summary>
        private sealed class TestConditionStateWithRetain : ConditionState
        {
            public TestConditionStateWithRetain(NodeState parent)
                : base(parent)
            {
            }

            public void ForceRetain(bool value)
            {
                Retain!.Value = value;
            }
        }

        /// <summary>
        /// Test condition that overrides EvaluateRetainStateOnEnable.
        /// </summary>
        private sealed class TestConditionStateWithCustomRetain : ConditionState
        {
            public bool EvaluateCalled { get; private set; }

            public TestConditionStateWithCustomRetain(NodeState parent)
                : base(parent)
            {
            }

            protected override void EvaluateRetainStateOnEnable(ISystemContext context)
            {
                EvaluateCalled = true;
                // Custom logic: always set Retain to true when enabled
                Retain!.Value = true;
            }
        }
    }
}