Add download cleaner and dry run (#58)

2025-02-16 03:09:07 +02:00
parent 19b3675701
commit 596a5aed8d
86 changed files with 2503 additions and 409 deletions
@@ -0,0 +1,235 @@
+using Common.Configuration.DownloadCleaner;
+using Domain.Enums;
+using Domain.Models.Cache;
+using Infrastructure.Helpers;
+using Infrastructure.Verticals.Context;
+using Infrastructure.Verticals.DownloadClient;
+using NSubstitute;
+using NSubstitute.ClearExtensions;
+using Shouldly;
+
+namespace Infrastructure.Tests.Verticals.DownloadClient;
+
+public class DownloadServiceTests : IClassFixture<DownloadServiceFixture>
+{
+    private readonly DownloadServiceFixture _fixture;
+
+    public DownloadServiceTests(DownloadServiceFixture fixture)
+    {
+        _fixture = fixture;
+        _fixture.Cache.ClearSubstitute();
+        _fixture.Striker.ClearSubstitute();
+    }
+
+    public class ResetStrikesOnProgressTests : DownloadServiceTests
+    {
+        public ResetStrikesOnProgressTests(DownloadServiceFixture fixture) : base(fixture)
+        {
+        }
+
+        [Fact]
+        public void WhenStalledStrikeDisabled_ShouldNotResetStrikes()
+        {
+            // Arrange
+            TestDownloadService sut = _fixture.CreateSut(queueCleanerConfig: new()
+            {
+                Enabled = true,
+                RunSequentially = true,
+                StalledResetStrikesOnProgress = false,
+            });
+
+            // Act
+            sut.ResetStrikesOnProgress("test-hash", 100);
+
+            // Assert
+            _fixture.Cache.ReceivedCalls().ShouldBeEmpty();
+        }
+        
+        [Fact]
+        public void WhenProgressMade_ShouldResetStrikes()
+        {
+            // Arrange
+            const string hash = "test-hash";
+            CacheItem cacheItem = new CacheItem { Downloaded = 100 };
+            
+            _fixture.Cache.TryGetValue(Arg.Any<object>(), out Arg.Any<object?>())
+                .Returns(x =>
+                {
+                    x[1] = cacheItem;
+                    return true;
+                });
+            
+            TestDownloadService sut = _fixture.CreateSut();
+
+            // Act
+            sut.ResetStrikesOnProgress(hash, 200);
+
+            // Assert
+            _fixture.Cache.Received(1).Remove(CacheKeys.Strike(StrikeType.Stalled, hash));
+        }
+
+        [Fact]
+        public void WhenNoProgress_ShouldNotResetStrikes()
+        {
+            // Arrange
+            const string hash = "test-hash";
+            CacheItem cacheItem = new CacheItem { Downloaded = 200 };
+            
+            _fixture.Cache
+                .TryGetValue(Arg.Any<object>(), out Arg.Any<object?>())
+                .Returns(x =>
+                {
+                    x[1] = cacheItem;
+                    return true;
+                });
+            
+            TestDownloadService sut = _fixture.CreateSut();
+
+            // Act
+            sut.ResetStrikesOnProgress(hash, 100);
+
+            // Assert
+            _fixture.Cache.DidNotReceive().Remove(Arg.Any<object>());
+        }
+    }
+
+    public class StrikeAndCheckLimitTests : DownloadServiceTests
+    {
+        public StrikeAndCheckLimitTests(DownloadServiceFixture fixture) : base(fixture)
+        {
+        }
+
+        [Fact]
+        public async Task ShouldDelegateCallToStriker()
+        {
+            // Arrange
+            const string hash = "test-hash";
+            const string itemName = "test-item";
+            _fixture.Striker.StrikeAndCheckLimit(hash, itemName, 3, StrikeType.Stalled)
+                .Returns(true);
+            
+            TestDownloadService sut = _fixture.CreateSut();
+
+            // Act
+            bool result = await sut.StrikeAndCheckLimit(hash, itemName);
+
+            // Assert
+            result.ShouldBeTrue();
+            await _fixture.Striker
+                .Received(1)
+                .StrikeAndCheckLimit(hash, itemName, 3, StrikeType.Stalled);
+        }
+    }
+
+    public class ShouldCleanDownloadTests : DownloadServiceTests
+    {
+        public ShouldCleanDownloadTests(DownloadServiceFixture fixture) : base(fixture) 
+        {
+            ContextProvider.Set("downloadName", "test-download");
+        }
+
+        [Fact]
+        public void WhenRatioAndMinSeedTimeReached_ShouldReturnTrue()
+        {
+            // Arrange
+            Category category = new()
+            {
+                Name = "test",
+                MaxRatio = 1.0,
+                MinSeedTime = 1,
+                MaxSeedTime = -1
+            };
+            const double ratio = 1.5;
+            TimeSpan seedingTime = TimeSpan.FromHours(2);
+            
+            TestDownloadService sut = _fixture.CreateSut();
+
+            // Act
+            var result = sut.ShouldCleanDownload(ratio, seedingTime, category);
+
+            // Assert
+            result.ShouldSatisfyAllConditions(
+                () => result.ShouldClean.ShouldBeTrue(),
+                () => result.Reason.ShouldBe(CleanReason.MaxRatioReached)
+            );
+        }
+
+        [Fact]
+        public void WhenRatioReachedAndMinSeedTimeNotReached_ShouldReturnFalse()
+        {
+            // Arrange
+            Category category = new()
+            {
+                Name = "test",
+                MaxRatio = 1.0,
+                MinSeedTime = 3,
+                MaxSeedTime = -1
+            };
+            const double ratio = 1.5;
+            TimeSpan seedingTime = TimeSpan.FromHours(2);
+            
+            TestDownloadService sut = _fixture.CreateSut();
+
+            // Act
+            var result = sut.ShouldCleanDownload(ratio, seedingTime, category);
+
+            // Assert
+            result.ShouldSatisfyAllConditions(
+                () => result.ShouldClean.ShouldBeFalse(),
+                () => result.Reason.ShouldBe(CleanReason.None)
+            );
+        }
+
+        [Fact]
+        public void WhenMaxSeedTimeReached_ShouldReturnTrue()
+        {
+            // Arrange
+            Category category = new()
+            {
+                Name = "test",
+                MaxRatio = -1,
+                MinSeedTime = 0,
+                MaxSeedTime = 1
+            };
+            const double ratio = 0.5;
+            TimeSpan seedingTime = TimeSpan.FromHours(2);
+            
+            TestDownloadService sut = _fixture.CreateSut();
+
+            // Act
+            SeedingCheckResult result = sut.ShouldCleanDownload(ratio, seedingTime, category);
+
+            // Assert
+            result.ShouldSatisfyAllConditions(
+                () => result.ShouldClean.ShouldBeTrue(),
+                () => result.Reason.ShouldBe(CleanReason.MaxSeedTimeReached)
+            );
+        }
+
+        [Fact]
+        public void WhenNeitherConditionMet_ShouldReturnFalse()
+        {
+            // Arrange
+            Category category = new()
+            {
+                Name = "test",
+                MaxRatio = 2.0,
+                MinSeedTime = 0,
+                MaxSeedTime = 3
+            };
+            const double ratio = 1.0;
+            TimeSpan seedingTime = TimeSpan.FromHours(1);
+            
+            TestDownloadService sut = _fixture.CreateSut();
+
+            // Act
+            var result = sut.ShouldCleanDownload(ratio, seedingTime, category);
+
+            // Assert
+            result.ShouldSatisfyAllConditions(
+                () => result.ShouldClean.ShouldBeFalse(),
+                () => result.Reason.ShouldBe(CleanReason.None)
+            );
+        }
+    }
+}