Archive-Team
/
sonarr-repo-only
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

New: End Jackett 'all' endpoint support 

(cherry picked from commit 54c914d48fefa730728518d50fc9e49032d0947b)

Closes #4437
This commit is contained in:
Robin Dadswell 2021-12-08 22:08:10 +00:00 committed by Mark McDowall
parent 69ccb96a36
commit 1bf87bf873
5 changed files with 188 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
frontend/src/System/Status/Health/Health.js
View File

@ -18,6 +18,7 @@ function getInternalLink(source) {
case 'IndexerRssCheck':
case 'IndexerSearchCheck':
case 'IndexerStatusCheck':
case 'IndexerJackettAllCheck':
case 'IndexerLongTermStatusCheck':
return (
<IconButton

69
src/NzbDrone.Core.Test/HealthCheck/Checks/IndexerJackettAllCheckFixture.cs Normal file
View File

@ -0,0 +1,69 @@
using System.Collections.Generic;
using Moq;
using NUnit.Framework;
using NzbDrone.Core.HealthCheck.Checks;
using NzbDrone.Core.Indexers;
using NzbDrone.Core.Indexers.Torznab;
using NzbDrone.Core.Test.Framework;
namespace NzbDrone.Core.Test.HealthCheck.Checks
{
[TestFixture]
public class IndexerJackettAllCheckFixture : CoreTest<IndexerJackettAllCheck>
{
private List<IndexerDefinition> _indexers = new List<IndexerDefinition>();
private IndexerDefinition _definition;
[SetUp]
public void SetUp()
{
Mocker.GetMock<IIndexerFactory>()
.Setup(v => v.All())
.Returns(_indexers);
}
private void GivenIndexer(string baseUrl, string apiPath)
{
var torznabSettings = new TorznabSettings
{
BaseUrl = baseUrl,
ApiPath = apiPath
};
_definition = new IndexerDefinition
{
Name = "Indexer",
ConfigContract = "TorznabSettings",
Settings = torznabSettings
};
_indexers.Add(_definition);
}
[Test]
public void should_not_return_error_when_no_indexers()
{
Subject.Check().ShouldBeOk();
}
[TestCase("http://localhost:9117/", "api")]
public void should_not_return_error_when_no_jackett_all_indexers(string baseUrl, string apiPath)
{
GivenIndexer(baseUrl, apiPath);
Subject.Check().ShouldBeOk();
}
[TestCase("http://localhost:9117/torznab/all/api", "api")]
[TestCase("http://localhost:9117/api/v2.0/indexers/all/results/torznab", "api")]
[TestCase("http://localhost:9117/", "/torznab/all/api")]
[TestCase("http://localhost:9117/", "/api/v2.0/indexers/all/results/torznab")]
public void should_return_warning_if_any_jackett_all_indexer_exists(string baseUrl, string apiPath)
{
GivenIndexer(baseUrl, apiPath);
Subject.Check().ShouldBeWarning();
}
}
}

53
src/NzbDrone.Core.Test/IndexerTests/TorznabTests/TorznabFixture.cs
View File

@ -1,5 +1,6 @@
using System;
using System.Linq;
using FizzWare.NBuilder;
using FluentAssertions;
using Moq;
using NUnit.Framework;
@ -9,6 +10,7 @@ using NzbDrone.Core.Indexers.Newznab;
using NzbDrone.Core.Indexers.Torznab;
using NzbDrone.Core.Parser.Model;
using NzbDrone.Core.Test.Framework;
using NzbDrone.Core.Validation;
namespace NzbDrone.Core.Test.IndexerTests.TorznabTests
{
@ -30,7 +32,11 @@ namespace NzbDrone.Core.Test.IndexerTests.TorznabTests
}
};
_caps = new NewznabCapabilities();
_caps = new NewznabCapabilities
{
Categories = Builder<NewznabCategory>.CreateListOfSize(1).All().With(t => t.Id = 1).Build().ToList()
};
Mocker.GetMock<INewznabCapabilitiesProvider>()
.Setup(v => v.GetCapabilities(It.IsAny<NewznabSettings>()))
.Returns(_caps);
@ -136,5 +142,50 @@ namespace NzbDrone.Core.Test.IndexerTests.TorznabTests
Subject.PageSize.Should().Be(25);
}
[TestCase("http://localhost:9117/", "/api")]
public void url_and_api_not_jackett_all(string baseUrl, string apiPath)
{
var setting = new TorznabSettings()
{
BaseUrl = baseUrl,
ApiPath = apiPath
};
setting.Validate().IsValid.Should().BeTrue();
}
[TestCase("http://localhost:9117/torznab/all/api")]
[TestCase("http://localhost:9117/api/v2.0/indexers/all/results/torznab")]
public void jackett_all_url_should_not_validate(string baseUrl)
{
var recentFeed = ReadAllText(@"Files/Indexers/Torznab/torznab_tpb.xml");
(Subject.Definition.Settings as TorznabSettings).BaseUrl = baseUrl;
Mocker.GetMock<IHttpClient>()
.Setup(o => o.Execute(It.Is<HttpRequest>(v => v.Method == HttpMethod.GET)))
.Returns<HttpRequest>(r => new HttpResponse(r, new HttpHeader(), recentFeed));
var result = new NzbDroneValidationResult(Subject.Test());
result.IsValid.Should().BeTrue();
result.HasWarnings.Should().BeTrue();
}
[TestCase("/torznab/all/api")]
[TestCase("/api/v2.0/indexers/all/results/torznab")]
public void jackett_all_api_should_not_validate(string apiPath)
{
var recentFeed = ReadAllText(@"Files/Indexers/Torznab/torznab_tpb.xml");
Mocker.GetMock<IHttpClient>()
.Setup(o => o.Execute(It.Is<HttpRequest>(v => v.Method == HttpMethod.GET)))
.Returns<HttpRequest>(r => new HttpResponse(r, new HttpHeader(), recentFeed));
(Subject.Definition.Settings as TorznabSettings).ApiPath = apiPath;
var result = new NzbDroneValidationResult(Subject.Test());
result.IsValid.Should().BeTrue();
result.HasWarnings.Should().BeTrue();
}
}
}

43
src/NzbDrone.Core/HealthCheck/Checks/IndexerJackettAllCheck.cs Normal file
View File

@ -0,0 +1,43 @@
using System;
using System.Linq;
using NzbDrone.Common.Extensions;
using NzbDrone.Core.Indexers;
using NzbDrone.Core.Indexers.Torznab;
using NzbDrone.Core.ThingiProvider.Events;
namespace NzbDrone.Core.HealthCheck.Checks
{
[CheckOn(typeof(ProviderUpdatedEvent<IIndexer>))]
[CheckOn(typeof(ProviderDeletedEvent<IIndexer>))]
[CheckOn(typeof(ProviderStatusChangedEvent<IIndexer>))]
public class IndexerJackettAllCheck : HealthCheckBase
{
private readonly IIndexerFactory _providerFactory;
public IndexerJackettAllCheck(IIndexerFactory providerFactory)
{
_providerFactory = providerFactory;
}
public override HealthCheck Check()
{
var jackettAllProviders = _providerFactory.All().Where(
i => i.ConfigContract.Equals("TorznabSettings") &&
((i.Settings as TorznabSettings).BaseUrl.Contains("/torznab/all/api") ||
(i.Settings as TorznabSettings).BaseUrl.Contains("/api/v2.0/indexers/all/results/torznab") ||
(i.Settings as TorznabSettings).ApiPath.Contains("/torznab/all/api") ||
(i.Settings as TorznabSettings).ApiPath.Contains("/api/v2.0/indexers/all/results/torznab")));
if (jackettAllProviders.Empty())
{
return new HealthCheck(GetType());
}
return new HealthCheck(GetType(),
HealthCheckResult.Warning,
string.Format("Indexers using the unsupported Jackett 'all' endpoint: {0}",
string.Join(", ", jackettAllProviders.Select(i => i.Name))),
"#jackett-all-endpoint-used");
}
}
}

24
src/NzbDrone.Core/Indexers/Torznab/Torznab.cs
View File

@ -93,7 +93,12 @@ namespace NzbDrone.Core.Indexers.Torznab
protected override void Test(List<ValidationFailure> failures)
{
base.Test(failures);
if (failures.HasErrors()) return;
if (failures.HasErrors())
{
return;
}
failures.AddIfNotNull(JackettAll());
failures.AddIfNotNull(TestCapabilities());
}
@ -125,6 +130,23 @@ namespace NzbDrone.Core.Indexers.Torznab
}
}
protected virtual ValidationFailure JackettAll()
{
if (Settings.ApiPath.Contains("/torznab/all") ||
Settings.ApiPath.Contains("/api/v2.0/indexers/all/results/torznab") ||
Settings.BaseUrl.Contains("/torznab/all") ||
Settings.BaseUrl.Contains("/api/v2.0/indexers/all/results/torznab"))
{
return new NzbDroneValidationFailure("ApiPath", "Jackett's all endpoint is not supported, please add indexers individually")
{
IsWarning = true,
DetailedDescription = "Jackett's all endpoint is not supported, please add indexers individually"
};
}
return null;
}
public override object RequestAction(string action, IDictionary<string, string> query)
{
if (action == "newznabCategories")