Add health check for dl clients removing completed downloads + enable for sab and qbit

(cherry picked from commit 7f2cd8a0e99b537a1c616998514bacdd8468a016)

Closes #2939

src/NzbDrone.Core.Test/HealthCheck/Checks/DownloadClientRemovesCompletedDownloadsCheckFixture.cs

@@ -0,0 +1,78 @@
+using System;
+using Moq;
+using NUnit.Framework;
+using NzbDrone.Core.Download;
+using NzbDrone.Core.Download.Clients;
+using NzbDrone.Core.HealthCheck.Checks;
+using NzbDrone.Core.Localization;
+using NzbDrone.Core.Test.Framework;
+using NzbDrone.Test.Common;
+
+namespace NzbDrone.Core.Test.HealthCheck.Checks
+{
+    [TestFixture]
+    public class DownloadClientRemovesCompletedDownloadsCheckFixture : CoreTest<DownloadClientRemovesCompletedDownloadsCheck>
+    {
+        private DownloadClientInfo _clientStatus;
+        private Mock<IDownloadClient> _downloadClient;
+
+        private static Exception[] DownloadClientExceptions =
+        {
+            new DownloadClientUnavailableException("error"),
+            new DownloadClientAuthenticationException("error"),
+            new DownloadClientException("error")
+        };
+
+        [SetUp]
+        public void Setup()
+        {
+            _clientStatus = new DownloadClientInfo
+            {
+                IsLocalhost = true,
+
+                // SortingMode = null,
+                RemovesCompletedDownloads = true
+            };
+
+            _downloadClient = Mocker.GetMock<IDownloadClient>();
+            _downloadClient.Setup(s => s.Definition)
+                .Returns(new DownloadClientDefinition { Name = "Test" });
+
+            _downloadClient.Setup(s => s.GetStatus())
+                .Returns(_clientStatus);
+
+            Mocker.GetMock<IProvideDownloadClient>()
+                .Setup(s => s.GetDownloadClients(It.IsAny<bool>()))
+                .Returns(new IDownloadClient[] { _downloadClient.Object });
+
+            Mocker.GetMock<ILocalizationService>()
+                .Setup(s => s.GetLocalizedString(It.IsAny<string>()))
+                .Returns("Some Warning Message");
+        }
+
+        [Test]
+        public void should_return_warning_if_removing_completed_downloads_is_enabled()
+        {
+            Subject.Check().ShouldBeWarning();
+        }
+
+        [Test]
+        public void should_return_ok_if_remove_completed_downloads_is_not_enabled()
+        {
+            _clientStatus.RemovesCompletedDownloads = false;
+            Subject.Check().ShouldBeOk();
+        }
+
+        [Test]
+        [TestCaseSource(nameof(DownloadClientExceptions))]
+        public void should_return_ok_if_client_throws_downloadclientexception(Exception ex)
+        {
+            _downloadClient.Setup(s => s.GetStatus())
+                .Throws(ex);
+
+            Subject.Check().ShouldBeOk();
+
+            ExceptionVerification.ExpectedErrors(0);
+        }
+    }
+}

src/NzbDrone.Core/Download/Clients/QBittorrent/QBittorrent.cs

@@ -389,7 +389,8 @@ namespace NzbDrone.Core.Download.Clients.QBittorrent
             return new DownloadClientInfo
             {
                 IsLocalhost = Settings.Host == "127.0.0.1" || Settings.Host == "localhost",
-                OutputRootFolders = new List<OsPath> { _remotePathMappingService.RemapRemoteToLocal(Settings.Host, destDir) }
+                OutputRootFolders = new List<OsPath> { _remotePathMappingService.RemapRemoteToLocal(Settings.Host, destDir) },
+                RemovesCompletedDownloads = (config.MaxRatioEnabled || config.MaxSeedingTimeEnabled) && (config.MaxRatioAction == QBittorrentMaxRatioAction.Remove || config.MaxRatioAction == QBittorrentMaxRatioAction.DeleteFiles)
             };
         }
 

src/NzbDrone.Core/Download/Clients/Sabnzbd/Sabnzbd.cs

@@ -263,6 +263,8 @@ namespace NzbDrone.Core.Download.Clients.Sabnzbd
                 status.OutputRootFolders = new List<OsPath> { _remotePathMappingService.RemapRemoteToLocal(Settings.Host, category.FullPath) };
             }
 
+            status.RemovesCompletedDownloads = config.Misc.history_retention != "0";
+
             return status;
         }
 

src/NzbDrone.Core/Download/Clients/Sabnzbd/SabnzbdCategory.cs

@@ -29,6 +29,7 @@ namespace NzbDrone.Core.Download.Clients.Sabnzbd
         public string[] date_categories { get; set; }
         public bool enable_date_sorting { get; set; }
         public bool pre_check { get; set; }
+        public string history_retention { get; set; }
     }
 
     public class SabnzbdCategory

src/NzbDrone.Core/Download/DownloadClientInfo.cs

@@ -11,6 +11,7 @@ namespace NzbDrone.Core.Download
         }
 
         public bool IsLocalhost { get; set; }
+        public bool RemovesCompletedDownloads { get; set; }
         public List<OsPath> OutputRootFolders { get; set; }
     }
 }

src/NzbDrone.Core/HealthCheck/Checks/DownloadClientRemovesCompletedDownloadsCheck.cs

@@ -0,0 +1,64 @@
+using System;
+using NLog;
+using NzbDrone.Core.Datastore.Events;
+using NzbDrone.Core.Download;
+using NzbDrone.Core.Download.Clients;
+using NzbDrone.Core.Localization;
+using NzbDrone.Core.RemotePathMappings;
+using NzbDrone.Core.RootFolders;
+using NzbDrone.Core.ThingiProvider.Events;
+
+namespace NzbDrone.Core.HealthCheck.Checks
+{
+    [CheckOn(typeof(ProviderUpdatedEvent<IDownloadClient>))]
+    [CheckOn(typeof(ProviderDeletedEvent<IDownloadClient>))]
+    [CheckOn(typeof(ModelEvent<RootFolder>))]
+    [CheckOn(typeof(ModelEvent<RemotePathMapping>))]
+
+    public class DownloadClientRemovesCompletedDownloadsCheck : HealthCheckBase, IProvideHealthCheck
+    {
+        private readonly IProvideDownloadClient _downloadClientProvider;
+        private readonly Logger _logger;
+
+        public DownloadClientRemovesCompletedDownloadsCheck(IProvideDownloadClient downloadClientProvider,
+                                          Logger logger,
+                                          ILocalizationService localizationService)
+            : base(localizationService)
+        {
+            _downloadClientProvider = downloadClientProvider;
+            _logger = logger;
+        }
+
+        public override HealthCheck Check()
+        {
+            var clients = _downloadClientProvider.GetDownloadClients(true);
+
+            foreach (var client in clients)
+            {
+                try
+                {
+                    var clientName = client.Definition.Name;
+                    var status = client.GetStatus();
+
+                    if (status.RemovesCompletedDownloads)
+                    {
+                        return new HealthCheck(GetType(),
+                            HealthCheckResult.Warning,
+                            string.Format(_localizationService.GetLocalizedString("DownloadClientRemovesCompletedDownloadsHealthCheckMessage"), clientName, "Readarr"),
+                            "#download-client-removes-completed-downloads");
+                    }
+                }
+                catch (DownloadClientException ex)
+                {
+                    _logger.Debug(ex, "Unable to communicate with {0}", client.Definition.Name);
+                }
+                catch (Exception ex)
+                {
+                    _logger.Error(ex, "Unknown error occurred in DownloadClientHistoryRetentionCheck HealthCheck");
+                }
+            }
+
+            return new HealthCheck(GetType());
+        }
+    }
+}

src/NzbDrone.Core/Localization/Core/en.json

@@ -265,6 +265,7 @@
   "DownloadClientCheckDownloadingToRoot": "Download client {0} places downloads in the root folder {1}. You should not download to a root folder.",
   "DownloadClientCheckNoneAvailableMessage": "No download client is available",
   "DownloadClientCheckUnableToCommunicateMessage": "Unable to communicate with {0}.",
+  "DownloadClientRemovesCompletedDownloadsHealthCheckMessage": "Download client {0} is set to remove completed downloads. This can result in downloads being removed from your client before {1} can import them.",
   "DownloadClientSettings": "Download Client Settings",
   "DownloadClientStatusCheckAllClientMessage": "All download clients are unavailable due to failures",
   "DownloadClientStatusCheckSingleClientMessage": "Download clients unavailable due to failures: {0}",