mirror of
https://github.com/jellyfin/jellyfin.git
synced 2024-07-21 21:20:39 +02:00
Extract configured order up front instead of for each provider Non-IHasOrder providers default to middle, not beginning Merge image and metadata sort helper methods
402 lines
20 KiB
C#
402 lines
20 KiB
C#
using System;
|
|
using System.Collections.Generic;
|
|
using System.Linq;
|
|
using MediaBrowser.Controller.BaseItemManager;
|
|
using MediaBrowser.Controller.Configuration;
|
|
using MediaBrowser.Controller.Entities;
|
|
using MediaBrowser.Controller.Entities.Movies;
|
|
using MediaBrowser.Controller.Library;
|
|
using MediaBrowser.Controller.Providers;
|
|
using MediaBrowser.Model.Configuration;
|
|
using MediaBrowser.Providers.Manager;
|
|
using Microsoft.Extensions.Logging.Abstractions;
|
|
using Moq;
|
|
using Xunit;
|
|
|
|
namespace Jellyfin.Providers.Tests.Manager
|
|
{
|
|
public class ProviderManagerTests
|
|
{
|
|
private static TheoryData<int, int[]?, int[]?, int?[]?, int[]> GetImageProvidersOrderData()
|
|
=> new ()
|
|
{
|
|
{ 3, null, null, null, new[] { 0, 1, 2 } }, // no order options set
|
|
|
|
// library options ordering
|
|
{ 3, Array.Empty<int>(), null, null, new[] { 0, 1, 2 } }, // no order provided
|
|
{ 3, new[] { 1 }, null, null, new[] { 1, 0, 2 } }, // one item in order
|
|
{ 3, new[] { 2, 1, 0 }, null, null, new[] { 2, 1, 0 } }, // full reverse order
|
|
|
|
// server options ordering
|
|
{ 3, null, Array.Empty<int>(), null, new[] { 0, 1, 2 } }, // no order provided
|
|
{ 3, null, new[] { 1 }, null, new[] { 1, 0, 2 } }, // one item in order
|
|
{ 3, null, new[] { 2, 1, 0 }, null, new[] { 2, 1, 0 } }, // full reverse order
|
|
|
|
// IHasOrder ordering
|
|
{ 3, null, null, new int?[] { null, 1, null }, new[] { 1, 0, 2 } }, // one item with defined order
|
|
{ 3, null, null, new int?[] { 2, 1, 0 }, new[] { 2, 1, 0 } }, // full reverse order
|
|
|
|
// multiple orders set
|
|
{ 3, new[] { 1 }, new[] { 2, 0, 1 }, null, new[] { 1, 0, 2 } }, // partial library order first, server order ignored
|
|
{ 3, new[] { 1 }, null, new int?[] { 2, 0, 1 }, new[] { 1, 2, 0 } }, // library order first, then orderby
|
|
{ 3, new[] { 2, 1, 0 }, new[] { 1, 2, 0 }, new int?[] { 2, 0, 1 }, new[] { 2, 1, 0 } }, // library order wins
|
|
};
|
|
|
|
[Theory]
|
|
[MemberData(nameof(GetImageProvidersOrderData))]
|
|
public void GetImageProviders_ProviderOrder_MatchesExpected(int providerCount, int[]? libraryOrder, int[]? serverOrder, int?[]? hasOrderOrder, int[] expectedOrder)
|
|
{
|
|
var item = new Movie();
|
|
|
|
var nameProvider = new Func<int, string>(i => "Provider" + i);
|
|
|
|
var providerList = new List<IImageProvider>();
|
|
for (var i = 0; i < providerCount; i++)
|
|
{
|
|
var order = hasOrderOrder?[i];
|
|
providerList.Add(MockIImageProvider<IImageProvider>(nameProvider(i), item, order: order));
|
|
}
|
|
|
|
var libraryOptions = new LibraryOptions();
|
|
if (libraryOrder != null)
|
|
{
|
|
libraryOptions.TypeOptions = new[]
|
|
{
|
|
new TypeOptions
|
|
{
|
|
Type = item.GetType().Name,
|
|
ImageFetcherOrder = libraryOrder.Select(nameProvider).ToArray()
|
|
}
|
|
};
|
|
}
|
|
|
|
var serverConfiguration = new ServerConfiguration();
|
|
if (serverOrder != null)
|
|
{
|
|
serverConfiguration.MetadataOptions = new[]
|
|
{
|
|
new MetadataOptions
|
|
{
|
|
ItemType = item.GetType().Name,
|
|
ImageFetcherOrder = serverOrder.Select(nameProvider).ToArray()
|
|
}
|
|
};
|
|
}
|
|
|
|
var providerManager = GetProviderManager(serverConfiguration: serverConfiguration, libraryOptions: libraryOptions);
|
|
AddParts(providerManager, imageProviders: providerList);
|
|
|
|
var refreshOptions = new ImageRefreshOptions(Mock.Of<IDirectoryService>(MockBehavior.Strict));
|
|
var actualProviders = providerManager.GetImageProviders(item, refreshOptions).ToList();
|
|
|
|
Assert.Equal(providerList.Count, actualProviders.Count);
|
|
var actualOrder = actualProviders.Select(i => providerList.IndexOf(i)).ToArray();
|
|
Assert.Equal(expectedOrder, actualOrder);
|
|
}
|
|
|
|
[Theory]
|
|
[InlineData(true, false, true)]
|
|
[InlineData(false, false, false)]
|
|
[InlineData(true, true, false)]
|
|
public void GetImageProviders_CanRefreshImagesBasic_WhenSupportsWithoutError(bool supports, bool errorOnSupported, bool expected)
|
|
{
|
|
GetImageProviders_CanRefreshImages_Tester(typeof(IImageProvider), supports, expected, errorOnSupported: errorOnSupported);
|
|
}
|
|
|
|
[Theory]
|
|
[InlineData(typeof(ILocalImageProvider), false, true)]
|
|
[InlineData(typeof(ILocalImageProvider), true, true)]
|
|
[InlineData(typeof(IImageProvider), false, false)]
|
|
[InlineData(typeof(IImageProvider), true, true)]
|
|
public void GetImageProviders_CanRefreshImagesLocked_WhenLocalOrFullRefresh(Type providerType, bool fullRefresh, bool expected)
|
|
{
|
|
GetImageProviders_CanRefreshImages_Tester(providerType, true, expected, itemLocked: true, fullRefresh: fullRefresh);
|
|
}
|
|
|
|
[Theory]
|
|
[InlineData(typeof(ILocalImageProvider), false, true)]
|
|
[InlineData(typeof(IRemoteImageProvider), true, true)]
|
|
[InlineData(typeof(IDynamicImageProvider), true, true)]
|
|
[InlineData(typeof(IRemoteImageProvider), false, false)]
|
|
[InlineData(typeof(IDynamicImageProvider), false, false)]
|
|
public void GetImageProviders_CanRefreshImagesEnabled_WhenLocalOrEnabled(Type providerType, bool enabled, bool expected)
|
|
{
|
|
GetImageProviders_CanRefreshImages_Tester(providerType, true, expected, baseItemEnabled: enabled);
|
|
}
|
|
|
|
private static void GetImageProviders_CanRefreshImages_Tester(Type providerType, bool supports, bool expected, bool errorOnSupported = false, bool itemLocked = false, bool fullRefresh = false, bool baseItemEnabled = true)
|
|
{
|
|
var item = new Movie
|
|
{
|
|
IsLocked = itemLocked
|
|
};
|
|
|
|
var providerName = "provider";
|
|
IImageProvider provider = providerType.Name switch
|
|
{
|
|
"IImageProvider" => MockIImageProvider<IImageProvider>(providerName, item, supports: supports, errorOnSupported: errorOnSupported),
|
|
"ILocalImageProvider" => MockIImageProvider<ILocalImageProvider>(providerName, item, supports: supports, errorOnSupported: errorOnSupported),
|
|
"IRemoteImageProvider" => MockIImageProvider<IRemoteImageProvider>(providerName, item, supports: supports, errorOnSupported: errorOnSupported),
|
|
"IDynamicImageProvider" => MockIImageProvider<IDynamicImageProvider>(providerName, item, supports: supports, errorOnSupported: errorOnSupported),
|
|
_ => throw new ArgumentException("Unexpected provider type")
|
|
};
|
|
|
|
var refreshOptions = new ImageRefreshOptions(Mock.Of<IDirectoryService>(MockBehavior.Strict))
|
|
{
|
|
ImageRefreshMode = fullRefresh ? MetadataRefreshMode.FullRefresh : MetadataRefreshMode.Default
|
|
};
|
|
|
|
var baseItemManager = new Mock<IBaseItemManager>(MockBehavior.Strict);
|
|
baseItemManager.Setup(i => i.IsImageFetcherEnabled(item, It.IsAny<LibraryOptions>(), providerName))
|
|
.Returns(baseItemEnabled);
|
|
|
|
var providerManager = GetProviderManager(baseItemManager: baseItemManager.Object);
|
|
AddParts(providerManager, imageProviders: new[] { provider });
|
|
|
|
var actualProviders = providerManager.GetImageProviders(item, refreshOptions);
|
|
|
|
if (expected)
|
|
{
|
|
Assert.Single(actualProviders);
|
|
}
|
|
else
|
|
{
|
|
Assert.Empty(actualProviders);
|
|
}
|
|
}
|
|
|
|
private static TheoryData<string[], int[]?, int[]?, int[]?, int[]?, int?[]?, int[]> GetMetadataProvidersOrderData()
|
|
{
|
|
var l = nameof(ILocalMetadataProvider);
|
|
var r = nameof(IRemoteMetadataProvider);
|
|
return new ()
|
|
{
|
|
{ new[] { l, l, r, r }, null, null, null, null, null, new[] { 0, 1, 2, 3 } }, // no order options set
|
|
|
|
// library options ordering
|
|
{ new[] { l, l, r, r }, Array.Empty<int>(), Array.Empty<int>(), null, null, null, new[] { 0, 1, 2, 3 } }, // no order provided
|
|
// local only
|
|
{ new[] { r, l, l, l }, new[] { 2 }, null, null, null, null, new[] { 2, 0, 1, 3 } }, // one item in order
|
|
{ new[] { r, l, l, l }, new[] { 3, 2, 1 }, null, null, null, null, new[] { 3, 2, 1, 0 } }, // full reverse order
|
|
// remote only
|
|
{ new[] { l, r, r, r }, null, new[] { 2 }, null, null, null, new[] { 2, 0, 1, 3 } }, // one item in order
|
|
{ new[] { l, r, r, r }, null, new[] { 3, 2, 1 }, null, null, null, new[] { 3, 2, 1, 0 } }, // full reverse order
|
|
// local and remote, note that results will be interleaved (odd but expected)
|
|
{ new[] { l, l, r, r }, new[] { 1 }, new[] { 3 }, null, null, null, new[] { 1, 3, 0, 2 } }, // one item in each order
|
|
{ new[] { l, l, l, r, r, r }, new[] { 2, 1, 0 }, new[] { 5, 4, 3 }, null, null, null, new[] { 2, 5, 1, 4, 0, 3 } }, // full reverse order
|
|
|
|
// // server options ordering
|
|
{ new[] { l, l, r, r }, null, null, Array.Empty<int>(), Array.Empty<int>(), null, new[] { 0, 1, 2, 3 } }, // no order provided
|
|
// local only
|
|
{ new[] { r, l, l, l }, null, null, new[] { 2 }, null, null, new[] { 2, 0, 1, 3 } }, // one item in order
|
|
{ new[] { r, l, l, l }, null, null, new[] { 3, 2, 1 }, null, null, new[] { 3, 2, 1, 0 } }, // full reverse order
|
|
// remote only
|
|
{ new[] { l, r, r, r }, null, null, null, new[] { 2 }, null, new[] { 2, 0, 1, 3 } }, // one item in order
|
|
{ new[] { l, r, r, r }, null, null, null, new[] { 3, 2, 1 }, null, new[] { 3, 2, 1, 0 } }, // full reverse order
|
|
// local and remote, note that results will be interleaved (odd but expected)
|
|
{ new[] { l, l, r, r }, null, null, new[] { 1 }, new[] { 3 }, null, new[] { 1, 3, 0, 2 } }, // one item in each order
|
|
{ new[] { l, l, l, r, r, r }, null, null, new[] { 2, 1, 0 }, new[] { 5, 4, 3 }, null, new[] { 2, 5, 1, 4, 0, 3 } }, // full reverse order
|
|
|
|
// IHasOrder ordering (not interleaved, doesn't care about types)
|
|
{ new[] { l, l, r, r }, null, null, null, null, new int?[] { 2, null, 1, null }, new[] { 2, 0, 1, 3 } }, // partially defined
|
|
{ new[] { l, l, r, r }, null, null, null, null, new int?[] { 3, 2, 1, 0 }, new[] { 3, 2, 1, 0 } }, // full reverse order
|
|
// note odd interaction - orderby determines order of slot when local and remote both have a slot 0
|
|
{ new[] { l, l, r, r }, new[] { 1 }, new[] { 3 }, null, null, new int?[] { null, 2, null, 1 }, new[] { 3, 1, 0, 2 } }, // sorts interleaved results
|
|
|
|
// multiple orders set
|
|
{ new[] { l, l, l, r, r, r }, new[] { 1 }, new[] { 4 }, new[] { 2, 1, 0 }, new[] { 5, 4, 3 }, null, new[] { 1, 4, 0, 2, 3, 5 } }, // partial library order first, server order ignored
|
|
{ new[] { l, l, l }, new[] { 1 }, null, null, null, new int?[] { 2, 0, 1 }, new[] { 1, 2, 0 } }, // library order first, then orderby
|
|
{ new[] { l, l, l, r, r, r }, new[] { 2, 1, 0 }, new[] { 5, 4, 3 }, new[] { 1, 2, 0 }, new[] { 4, 5, 3 }, new int?[] { 5, 4, 1, 6, 3, 2 }, new[] { 2, 5, 4, 1, 0, 3 } }, // library order wins (with orderby between local/remote)
|
|
};
|
|
}
|
|
|
|
[Theory]
|
|
[MemberData(nameof(GetMetadataProvidersOrderData))]
|
|
public void GetMetadataProviders_ProviderOrder_MatchesExpected(string[] providers, int[]? libraryLocalOrder, int[]? libraryRemoteOrder, int[]? serverLocalOrder, int[]? serverRemoteOrder, int?[]? hasOrderOrder, int[] expectedOrder)
|
|
{
|
|
var item = new MetadataTestItem();
|
|
|
|
var nameProvider = new Func<int, string>(i => "Provider" + i);
|
|
|
|
var providerList = new List<IMetadataProvider<MetadataTestItem>>();
|
|
for (var i = 0; i < providers.Length; i++)
|
|
{
|
|
var order = hasOrderOrder?[i];
|
|
providerList.Add(MockIMetadataProviderMapper<MetadataTestItem, MetadataTestItemInfo>(providers[i], nameProvider(i), order: order));
|
|
}
|
|
|
|
var libraryOptions = new LibraryOptions();
|
|
if (libraryLocalOrder != null)
|
|
{
|
|
libraryOptions.LocalMetadataReaderOrder = libraryLocalOrder.Select(nameProvider).ToArray();
|
|
}
|
|
|
|
if (libraryRemoteOrder != null)
|
|
{
|
|
libraryOptions.TypeOptions = new[]
|
|
{
|
|
new TypeOptions
|
|
{
|
|
Type = item.GetType().Name,
|
|
MetadataFetcherOrder = libraryRemoteOrder.Select(nameProvider).ToArray()
|
|
}
|
|
};
|
|
}
|
|
|
|
var serverConfiguration = new ServerConfiguration();
|
|
if (serverLocalOrder != null || serverRemoteOrder != null)
|
|
{
|
|
serverConfiguration.MetadataOptions = new[]
|
|
{
|
|
new MetadataOptions
|
|
{
|
|
ItemType = item.GetType().Name
|
|
}
|
|
};
|
|
if (serverLocalOrder != null)
|
|
{
|
|
serverConfiguration.MetadataOptions[0].LocalMetadataReaderOrder = serverLocalOrder.Select(nameProvider).ToArray();
|
|
}
|
|
|
|
if (serverRemoteOrder != null)
|
|
{
|
|
serverConfiguration.MetadataOptions[0].MetadataFetcherOrder = serverRemoteOrder.Select(nameProvider).ToArray();
|
|
}
|
|
}
|
|
|
|
var baseItemManager = new Mock<IBaseItemManager>(MockBehavior.Strict);
|
|
baseItemManager.Setup(i => i.IsMetadataFetcherEnabled(item, It.IsAny<LibraryOptions>(), It.IsAny<string>()))
|
|
.Returns(true);
|
|
|
|
var providerManager = GetProviderManager(serverConfiguration: serverConfiguration, baseItemManager: baseItemManager.Object);
|
|
AddParts(providerManager, metadataProviders: providerList);
|
|
|
|
var actualProviders = providerManager.GetMetadataProviders<MetadataTestItem>(item, libraryOptions).ToList();
|
|
|
|
Assert.Equal(providerList.Count, actualProviders.Count);
|
|
var actualOrder = actualProviders.Select(i => providerList.IndexOf(i)).ToArray();
|
|
Assert.Equal(expectedOrder, actualOrder);
|
|
}
|
|
|
|
private static IImageProvider MockIImageProvider<TProviderType>(string name, BaseItem expectedType, bool supports = true, int? order = null, bool errorOnSupported = false)
|
|
where TProviderType : class, IImageProvider
|
|
{
|
|
Mock<IHasOrder>? hasOrder = null;
|
|
if (order != null)
|
|
{
|
|
hasOrder = new Mock<IHasOrder>(MockBehavior.Strict);
|
|
hasOrder.Setup(i => i.Order)
|
|
.Returns((int)order);
|
|
}
|
|
|
|
var provider = hasOrder == null
|
|
? new Mock<TProviderType>(MockBehavior.Strict)
|
|
: hasOrder.As<TProviderType>();
|
|
provider.Setup(p => p.Name)
|
|
.Returns(name);
|
|
if (errorOnSupported)
|
|
{
|
|
provider.Setup(p => p.Supports(It.IsAny<BaseItem>()))
|
|
.Throws(new ArgumentException());
|
|
}
|
|
else
|
|
{
|
|
provider.Setup(p => p.Supports(expectedType))
|
|
.Returns(supports);
|
|
}
|
|
|
|
return provider.Object;
|
|
}
|
|
|
|
private static IMetadataProvider<TItemType> MockIMetadataProviderMapper<TItemType, TLookupInfoType>(string typeName, string providerName, int? order = null)
|
|
where TItemType : BaseItem, IHasLookupInfo<TLookupInfoType>
|
|
where TLookupInfoType : ItemLookupInfo, new()
|
|
=> typeName switch
|
|
{
|
|
"ILocalMetadataProvider" => MockIMetadataProvider<ILocalMetadataProvider<TItemType>, TItemType>(providerName, order),
|
|
"IRemoteMetadataProvider" => MockIMetadataProvider<IRemoteMetadataProvider<TItemType, TLookupInfoType>, TItemType>(providerName, order),
|
|
"ICustomMetadataProvider" => MockIMetadataProvider<ICustomMetadataProvider<TItemType>, TItemType>(providerName, order),
|
|
_ => MockIMetadataProvider<IMetadataProvider<TItemType>, TItemType>(providerName, order)
|
|
};
|
|
|
|
private static IMetadataProvider<TItemType> MockIMetadataProvider<TProviderType, TItemType>(string name, int? order = null)
|
|
where TProviderType : class, IMetadataProvider<TItemType>
|
|
where TItemType : BaseItem
|
|
{
|
|
Mock<IHasOrder>? hasOrder = null;
|
|
if (order != null)
|
|
{
|
|
hasOrder = new Mock<IHasOrder>(MockBehavior.Strict);
|
|
hasOrder.Setup(i => i.Order)
|
|
.Returns((int)order);
|
|
}
|
|
|
|
var provider = hasOrder == null
|
|
? new Mock<TProviderType>(MockBehavior.Strict)
|
|
: hasOrder.As<TProviderType>();
|
|
provider.Setup(p => p.Name)
|
|
.Returns(name);
|
|
|
|
return provider.Object;
|
|
}
|
|
|
|
private static ProviderManager GetProviderManager(ServerConfiguration? serverConfiguration = null, LibraryOptions? libraryOptions = null, IBaseItemManager? baseItemManager = null)
|
|
{
|
|
var serverConfigurationManager = new Mock<IServerConfigurationManager>(MockBehavior.Strict);
|
|
serverConfigurationManager.Setup(i => i.Configuration)
|
|
.Returns(serverConfiguration ?? new ServerConfiguration());
|
|
|
|
var libraryManager = new Mock<ILibraryManager>(MockBehavior.Strict);
|
|
libraryManager.Setup(i => i.GetLibraryOptions(It.IsAny<BaseItem>()))
|
|
.Returns(libraryOptions ?? new LibraryOptions());
|
|
|
|
var providerManager = new ProviderManager(
|
|
null,
|
|
null,
|
|
serverConfigurationManager.Object,
|
|
null,
|
|
new NullLogger<ProviderManager>(),
|
|
null,
|
|
null,
|
|
libraryManager.Object,
|
|
baseItemManager);
|
|
|
|
return providerManager;
|
|
}
|
|
|
|
private static void AddParts(
|
|
ProviderManager providerManager,
|
|
IEnumerable<IImageProvider>? imageProviders = null,
|
|
IEnumerable<IMetadataService>? metadataServices = null,
|
|
IEnumerable<IMetadataProvider>? metadataProviders = null,
|
|
IEnumerable<IMetadataSaver>? metadataSavers = null,
|
|
IEnumerable<IExternalId>? externalIds = null)
|
|
{
|
|
imageProviders ??= Array.Empty<IImageProvider>();
|
|
metadataServices ??= Array.Empty<IMetadataService>();
|
|
metadataProviders ??= Array.Empty<IMetadataProvider>();
|
|
metadataSavers ??= Array.Empty<IMetadataSaver>();
|
|
externalIds ??= Array.Empty<IExternalId>();
|
|
|
|
providerManager.AddParts(imageProviders, metadataServices, metadataProviders, metadataSavers, externalIds);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Simple <see cref="BaseItem"/> extension to force SupportsLocalMetadata to true.
|
|
/// </summary>
|
|
public class MetadataTestItem : BaseItem, IHasLookupInfo<MetadataTestItemInfo>
|
|
{
|
|
public override bool SupportsLocalMetadata => true;
|
|
|
|
public MetadataTestItemInfo GetLookupInfo()
|
|
{
|
|
return GetItemLookupInfo<MetadataTestItemInfo>();
|
|
}
|
|
}
|
|
|
|
public class MetadataTestItemInfo : ItemLookupInfo
|
|
{
|
|
}
|
|
}
|
|
}
|