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

using System;
using System.Threading.Tasks;
using Microsoft.Extensions.Time.Testing;
using NUnit.Framework;

namespace Opc.Ua.Core.Tests.Stack.Client
{
    [TestFixture]
    [Category("Client")]
    public sealed class RetryBudgetTests
    {
        [Test]
        public async Task BudgetExhaustsAfterMaxTimeAsync()
        {
            var timeProvider = new FakeTimeProvider();
            var budget = new RetryBudget(TimeSpan.FromSeconds(1), timeProvider);

            Assert.That(budget.TryConsume(out TimeSpan remaining), Is.True);
            Assert.That(remaining, Is.EqualTo(TimeSpan.FromSeconds(1)));

            timeProvider.Advance(TimeSpan.FromSeconds(1));
            await Task.Yield();

            Assert.That(budget.IsExhausted, Is.True);
            Assert.That(budget.TryConsume(out remaining), Is.False);
            Assert.That(remaining, Is.EqualTo(TimeSpan.Zero));
        }

        [Test]
        public void TryConsumeReturnsRemainingTime()
        {
            var timeProvider = new FakeTimeProvider();
            var budget = new RetryBudget(TimeSpan.FromSeconds(10), timeProvider);

            Assert.That(budget.TryConsume(out TimeSpan remaining), Is.True);
            Assert.That(remaining, Is.EqualTo(TimeSpan.FromSeconds(10)));

            timeProvider.Advance(TimeSpan.FromSeconds(4));

            Assert.That(budget.TryConsume(out remaining), Is.True);
            Assert.That(remaining, Is.EqualTo(TimeSpan.FromSeconds(6)));
        }

        [Test]
        public void ResetClearsElapsed()
        {
            var timeProvider = new FakeTimeProvider();
            var budget = new RetryBudget(TimeSpan.FromSeconds(10), timeProvider);

            Assert.That(budget.TryConsume(out _), Is.True);
            timeProvider.Advance(TimeSpan.FromSeconds(5));

            Assert.That(budget.ElapsedSinceFirstAttempt, Is.EqualTo(TimeSpan.FromSeconds(5)));

            budget.Reset();

            Assert.That(budget.ElapsedSinceFirstAttempt, Is.EqualTo(TimeSpan.Zero));
            Assert.That(budget.TryConsume(out TimeSpan remaining), Is.True);
            Assert.That(remaining, Is.EqualTo(TimeSpan.FromSeconds(10)));
        }
    }
}