lmxopcua/tests/ZB.MOM.WW.OtOpcUa.Historian.Aveva.Tests/HistorianDataSourceLifecycleTests.cs

using System;
using Shouldly;
using Xunit;
using ZB.MOM.WW.OtOpcUa.Historian.Aveva;
using ZB.MOM.WW.OtOpcUa.Host.Configuration;
using ZB.MOM.WW.OtOpcUa.Host.Historian;

namespace ZB.MOM.WW.OtOpcUa.Historian.Aveva.Tests
{
    /// <summary>
    ///     Verifies Historian data source lifecycle behavior: dispose safety,
    ///     post-dispose rejection, connection failure handling, and reconnect-after-error.
    /// </summary>
    public class HistorianDataSourceLifecycleTests
    {
        private static HistorianConfiguration DefaultConfig => new()
        {
            Enabled = true,
            ServerName = "test-historian",
            Port = 32568,
            IntegratedSecurity = true,
            CommandTimeoutSeconds = 5,
            // Zero cooldown so reconnect-after-error tests can retry through the cluster picker
            // on the very next call, matching the pre-cluster behavior they were written against.
            FailureCooldownSeconds = 0
        };

        [Fact]
        public void ReadRawAsync_AfterDispose_ThrowsObjectDisposedException()
        {
            var ds = new HistorianDataSource(DefaultConfig);
            ds.Dispose();

            Should.Throw<ObjectDisposedException>(() =>
                ds.ReadRawAsync("Tag1", DateTime.UtcNow.AddHours(-1), DateTime.UtcNow, 100)
                    .GetAwaiter().GetResult());
        }

        [Fact]
        public void ReadAggregateAsync_AfterDispose_ThrowsObjectDisposedException()
        {
            var ds = new HistorianDataSource(DefaultConfig);
            ds.Dispose();

            Should.Throw<ObjectDisposedException>(() =>
                ds.ReadAggregateAsync("Tag1", DateTime.UtcNow.AddHours(-1), DateTime.UtcNow, 60000, "Average")
                    .GetAwaiter().GetResult());
        }

        [Fact]
        public void ReadAtTimeAsync_AfterDispose_ThrowsObjectDisposedException()
        {
            var ds = new HistorianDataSource(DefaultConfig);
            ds.Dispose();

            Should.Throw<ObjectDisposedException>(() =>
                ds.ReadAtTimeAsync("Tag1", new[] { DateTime.UtcNow })
                    .GetAwaiter().GetResult());
        }

        [Fact]
        public void ReadEventsAsync_AfterDispose_ThrowsObjectDisposedException()
        {
            var ds = new HistorianDataSource(DefaultConfig);
            ds.Dispose();

            Should.Throw<ObjectDisposedException>(() =>
                ds.ReadEventsAsync(null, DateTime.UtcNow.AddHours(-1), DateTime.UtcNow, 100)
                    .GetAwaiter().GetResult());
        }

        [Fact]
        public void Dispose_CalledTwice_DoesNotThrow()
        {
            var ds = new HistorianDataSource(DefaultConfig);
            ds.Dispose();
            Should.NotThrow(() => ds.Dispose());
        }

        [Fact]
        public void HistorianAggregateMap_UnknownColumn_ReturnsNull()
        {
            HistorianAggregateMap.MapAggregateToColumn(new Opc.Ua.NodeId(99999)).ShouldBeNull();
        }

        [Fact]
        public void ReadRawAsync_WhenConnectionFails_ReturnsEmptyResults()
        {
            var factory = new FakeHistorianConnectionFactory
            {
                ConnectException = new InvalidOperationException("Connection refused")
            };
            var ds = new HistorianDataSource(DefaultConfig, factory);

            var results = ds.ReadRawAsync("Tag1", DateTime.UtcNow.AddHours(-1), DateTime.UtcNow, 100)
                .GetAwaiter().GetResult();

            results.Count.ShouldBe(0);
            factory.ConnectCallCount.ShouldBe(1);
        }

        [Fact]
        public void ReadRawAsync_WhenConnectionTimesOut_ReturnsEmptyResults()
        {
            var factory = new FakeHistorianConnectionFactory
            {
                ConnectException = new TimeoutException("Connection timed out")
            };
            var ds = new HistorianDataSource(DefaultConfig, factory);

            var results = ds.ReadRawAsync("Tag1", DateTime.UtcNow.AddHours(-1), DateTime.UtcNow, 100)
                .GetAwaiter().GetResult();

            results.Count.ShouldBe(0);
        }

        [Fact]
        public void ReadRawAsync_AfterConnectionError_AttemptsReconnect()
        {
            var factory = new FakeHistorianConnectionFactory();
            var ds = new HistorianDataSource(DefaultConfig, factory);

            // First call: factory returns a HistorianAccess that isn't actually connected,
            // so the query will fail and HandleConnectionError will reset the connection.
            ds.ReadRawAsync("Tag1", DateTime.UtcNow.AddHours(-1), DateTime.UtcNow, 100)
                .GetAwaiter().GetResult();

            // Second call: should attempt reconnection via the factory
            ds.ReadRawAsync("Tag1", DateTime.UtcNow.AddHours(-1), DateTime.UtcNow, 100)
                .GetAwaiter().GetResult();

            // Factory should have been called twice — once for initial connect, once for reconnect
            factory.ConnectCallCount.ShouldBe(2);
        }

        [Fact]
        public void ReadRawAsync_ConnectionFailure_DoesNotCorruptState()
        {
            var callCount = 0;
            var factory = new FakeHistorianConnectionFactory
            {
                OnConnect = count =>
                {
                    callCount = count;
                    if (count == 1)
                        throw new InvalidOperationException("First connection fails");
                    // Second call succeeds (returns unconnected HistorianAccess, but that's OK for lifecycle testing)
                }
            };
            var ds = new HistorianDataSource(DefaultConfig, factory);

            // First read: connection fails
            var r1 = ds.ReadRawAsync("Tag1", DateTime.UtcNow.AddHours(-1), DateTime.UtcNow, 100)
                .GetAwaiter().GetResult();
            r1.Count.ShouldBe(0);

            // Second read: should attempt new connection without throwing from internal state corruption
            var r2 = ds.ReadRawAsync("Tag1", DateTime.UtcNow.AddHours(-1), DateTime.UtcNow, 100)
                .GetAwaiter().GetResult();

            callCount.ShouldBe(2);
        }

        [Fact]
        public void Dispose_DuringConnectionFailure_DoesNotThrow()
        {
            var factory = new FakeHistorianConnectionFactory
            {
                ConnectException = new InvalidOperationException("Connection refused")
            };
            var ds = new HistorianDataSource(DefaultConfig, factory);

            // Trigger a failed connection attempt
            ds.ReadRawAsync("Tag1", DateTime.UtcNow.AddHours(-1), DateTime.UtcNow, 100)
                .GetAwaiter().GetResult();

            // Dispose should handle the null connection gracefully
            Should.NotThrow(() => ds.Dispose());
        }

        // ---------- HistorianHealthSnapshot instrumentation ----------

        [Fact]
        public void GetHealthSnapshot_FreshDataSource_ReportsZeroCounters()
        {
            var ds = new HistorianDataSource(DefaultConfig, new FakeHistorianConnectionFactory());
            var snap = ds.GetHealthSnapshot();

            snap.TotalQueries.ShouldBe(0);
            snap.TotalSuccesses.ShouldBe(0);
            snap.TotalFailures.ShouldBe(0);
            snap.ConsecutiveFailures.ShouldBe(0);
            snap.LastSuccessTime.ShouldBeNull();
            snap.LastFailureTime.ShouldBeNull();
            snap.LastError.ShouldBeNull();
            snap.ProcessConnectionOpen.ShouldBeFalse();
            snap.EventConnectionOpen.ShouldBeFalse();
        }

        [Fact]
        public void GetHealthSnapshot_AfterConnectionFailure_RecordsFailure()
        {
            var factory = new FakeHistorianConnectionFactory
            {
                ConnectException = new InvalidOperationException("Connection refused")
            };
            var ds = new HistorianDataSource(DefaultConfig, factory);

            ds.ReadRawAsync("Tag1", DateTime.UtcNow.AddHours(-1), DateTime.UtcNow, 100)
                .GetAwaiter().GetResult();

            var snap = ds.GetHealthSnapshot();
            snap.TotalQueries.ShouldBe(1);
            snap.TotalFailures.ShouldBe(1);
            snap.TotalSuccesses.ShouldBe(0);
            snap.ConsecutiveFailures.ShouldBe(1);
            snap.LastFailureTime.ShouldNotBeNull();
            snap.LastError.ShouldContain("Connection refused");
            snap.ProcessConnectionOpen.ShouldBeFalse();
        }

        [Fact]
        public void GetHealthSnapshot_AfterMultipleFailures_IncrementsConsecutive()
        {
            var factory = new FakeHistorianConnectionFactory
            {
                ConnectException = new InvalidOperationException("boom")
            };
            var ds = new HistorianDataSource(DefaultConfig, factory);

            for (var i = 0; i < 4; i++)
                ds.ReadRawAsync("Tag1", DateTime.UtcNow.AddHours(-1), DateTime.UtcNow, 100)
                    .GetAwaiter().GetResult();

            var snap = ds.GetHealthSnapshot();
            snap.TotalFailures.ShouldBe(4);
            snap.ConsecutiveFailures.ShouldBe(4);
            snap.TotalSuccesses.ShouldBe(0);
        }

        [Fact]
        public void GetHealthSnapshot_AcrossReadPaths_CountsAllFailures()
        {
            var factory = new FakeHistorianConnectionFactory
            {
                ConnectException = new InvalidOperationException("sdk down")
            };
            var ds = new HistorianDataSource(DefaultConfig, factory);

            ds.ReadRawAsync("Tag1", DateTime.UtcNow.AddHours(-1), DateTime.UtcNow, 10)
                .GetAwaiter().GetResult();
            ds.ReadAggregateAsync("Tag1", DateTime.UtcNow.AddHours(-1), DateTime.UtcNow, 60000, "Average")
                .GetAwaiter().GetResult();
            ds.ReadAtTimeAsync("Tag1", new[] { DateTime.UtcNow })
                .GetAwaiter().GetResult();
            ds.ReadEventsAsync(null, DateTime.UtcNow.AddHours(-1), DateTime.UtcNow, 10)
                .GetAwaiter().GetResult();

            var snap = ds.GetHealthSnapshot();
            snap.TotalFailures.ShouldBe(4);
            snap.TotalQueries.ShouldBe(4);
            snap.LastError.ShouldContain("sdk down");
        }

        [Fact]
        public void GetHealthSnapshot_ErrorMessageCarriesReadPath()
        {
            var factory = new FakeHistorianConnectionFactory
            {
                ConnectException = new InvalidOperationException("unreachable")
            };
            var ds = new HistorianDataSource(DefaultConfig, factory);

            ds.ReadAggregateAsync("Tag1", DateTime.UtcNow.AddHours(-1), DateTime.UtcNow, 60000, "Average")
                .GetAwaiter().GetResult();

            var snap = ds.GetHealthSnapshot();
            snap.LastError.ShouldStartWith("aggregate:");
        }
    }
}