ProviderManagerTests.cs 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618
  1. using System;
  2. using System.Collections.Generic;
  3. using System.Linq;
  4. using System.Net.Http;
  5. using System.Runtime.CompilerServices;
  6. using System.Threading;
  7. using System.Threading.Tasks;
  8. using MediaBrowser.Controller;
  9. using MediaBrowser.Controller.BaseItemManager;
  10. using MediaBrowser.Controller.Configuration;
  11. using MediaBrowser.Controller.Entities;
  12. using MediaBrowser.Controller.Entities.Movies;
  13. using MediaBrowser.Controller.Library;
  14. using MediaBrowser.Controller.Lyrics;
  15. using MediaBrowser.Controller.Providers;
  16. using MediaBrowser.Controller.Subtitles;
  17. using MediaBrowser.Model.Configuration;
  18. using MediaBrowser.Model.IO;
  19. using MediaBrowser.Providers.Manager;
  20. using Microsoft.Extensions.Caching.Memory;
  21. using Microsoft.Extensions.Logging;
  22. using Microsoft.Extensions.Logging.Abstractions;
  23. using Moq;
  24. using Xunit;
  25. // Allow Moq to see internal class
  26. [assembly: InternalsVisibleTo("DynamicProxyGenAssembly2")]
  27. namespace Jellyfin.Providers.Tests.Manager
  28. {
  29. public class ProviderManagerTests
  30. {
  31. private static readonly ILogger<ProviderManager> _logger = new NullLogger<ProviderManager>();
  32. public static TheoryData<Mock<IMetadataService>[], int> RefreshSingleItemOrderData()
  33. => new()
  34. {
  35. // no order set, uses provided order
  36. {
  37. new[]
  38. {
  39. MockIMetadataService(true, true),
  40. MockIMetadataService(true, true)
  41. },
  42. 0
  43. },
  44. // sort order sets priority when all match
  45. {
  46. new[]
  47. {
  48. MockIMetadataService(true, true, 1),
  49. MockIMetadataService(true, true, 0),
  50. MockIMetadataService(true, true, 2)
  51. },
  52. 1
  53. },
  54. // CanRefreshPrimary prioritized
  55. {
  56. new[]
  57. {
  58. MockIMetadataService(false, true),
  59. MockIMetadataService(true, true),
  60. },
  61. 1
  62. },
  63. // falls back to CanRefresh
  64. {
  65. new[]
  66. {
  67. MockIMetadataService(false, false),
  68. MockIMetadataService(false, true)
  69. },
  70. 1
  71. },
  72. };
  73. [Theory]
  74. [MemberData(nameof(RefreshSingleItemOrderData))]
  75. public async Task RefreshSingleItem_ServiceOrdering_FollowsPriority(Mock<IMetadataService>[] servicesList, int expectedIndex)
  76. {
  77. var item = new Movie();
  78. using var providerManager = GetProviderManager();
  79. AddParts(providerManager, metadataServices: servicesList.Select(s => s.Object).ToArray());
  80. var refreshOptions = new MetadataRefreshOptions(Mock.Of<IDirectoryService>(MockBehavior.Strict));
  81. var actual = await providerManager.RefreshSingleItem(item, refreshOptions, CancellationToken.None);
  82. Assert.Equal(ItemUpdateType.MetadataDownload, actual);
  83. for (var i = 0; i < servicesList.Length; i++)
  84. {
  85. var times = i == expectedIndex ? Times.Once() : Times.Never();
  86. servicesList[i].Verify(mock => mock.RefreshMetadata(It.IsAny<BaseItem>(), It.IsAny<MetadataRefreshOptions>(), It.IsAny<CancellationToken>()), times);
  87. }
  88. }
  89. [Theory]
  90. [InlineData(true)]
  91. [InlineData(false)]
  92. public async Task RefreshSingleItem_RefreshMetadata_WhenServiceFound(bool serviceFound)
  93. {
  94. var item = new Movie();
  95. var servicesList = new[] { MockIMetadataService(false, serviceFound) };
  96. using var providerManager = GetProviderManager();
  97. AddParts(providerManager, metadataServices: servicesList.Select(s => s.Object).ToArray());
  98. var refreshOptions = new MetadataRefreshOptions(Mock.Of<IDirectoryService>(MockBehavior.Strict));
  99. var actual = await providerManager.RefreshSingleItem(item, refreshOptions, CancellationToken.None);
  100. var expectedResult = serviceFound ? ItemUpdateType.MetadataDownload : ItemUpdateType.None;
  101. Assert.Equal(expectedResult, actual);
  102. }
  103. public static TheoryData<int, int[]?, int[]?, int?[]?, int[]> GetImageProvidersOrderData()
  104. => new()
  105. {
  106. { 3, null, null, null, new[] { 0, 1, 2 } }, // no order options set
  107. // library options ordering
  108. { 3, Array.Empty<int>(), null, null, new[] { 0, 1, 2 } }, // no order provided
  109. { 3, new[] { 1 }, null, null, new[] { 1, 0, 2 } }, // one item in order
  110. { 3, new[] { 2, 1, 0 }, null, null, new[] { 2, 1, 0 } }, // full reverse order
  111. // server options ordering
  112. { 3, null, Array.Empty<int>(), null, new[] { 0, 1, 2 } }, // no order provided
  113. { 3, null, new[] { 1 }, null, new[] { 1, 0, 2 } }, // one item in order
  114. { 3, null, new[] { 2, 1, 0 }, null, new[] { 2, 1, 0 } }, // full reverse order
  115. // IHasOrder ordering
  116. { 3, null, null, new int?[] { null, 1, null }, new[] { 1, 0, 2 } }, // one item with defined order
  117. { 3, null, null, new int?[] { 2, 1, 0 }, new[] { 2, 1, 0 } }, // full reverse order
  118. // multiple orders set
  119. { 3, new[] { 1 }, new[] { 2, 0, 1 }, null, new[] { 1, 0, 2 } }, // partial library order first, server order ignored
  120. { 3, new[] { 1 }, null, new int?[] { 2, 0, 1 }, new[] { 1, 2, 0 } }, // library order first, then orderby
  121. { 3, new[] { 2, 1, 0 }, new[] { 1, 2, 0 }, new int?[] { 2, 0, 1 }, new[] { 2, 1, 0 } }, // library order wins
  122. };
  123. [Theory]
  124. [MemberData(nameof(GetImageProvidersOrderData))]
  125. public void GetImageProviders_ProviderOrder_MatchesExpected(int providerCount, int[]? libraryOrder, int[]? serverOrder, int?[]? hasOrderOrder, int[] expectedOrder)
  126. {
  127. var item = new Movie();
  128. var nameProvider = new Func<int, string>(i => "Provider" + i);
  129. var providerList = new List<IImageProvider>();
  130. for (var i = 0; i < providerCount; i++)
  131. {
  132. var order = hasOrderOrder?[i];
  133. providerList.Add(MockIImageProvider<ILocalImageProvider>(nameProvider(i), item, order: order));
  134. }
  135. var libraryOptions = CreateLibraryOptions(item.GetType().Name, imageFetcherOrder: libraryOrder?.Select(nameProvider).ToArray());
  136. var serverConfiguration = CreateServerConfiguration(item.GetType().Name, imageFetcherOrder: serverOrder?.Select(nameProvider).ToArray());
  137. using var providerManager = GetProviderManager(serverConfiguration: serverConfiguration, libraryOptions: libraryOptions);
  138. AddParts(providerManager, imageProviders: providerList);
  139. var refreshOptions = new ImageRefreshOptions(Mock.Of<IDirectoryService>(MockBehavior.Strict));
  140. var actualProviders = providerManager.GetImageProviders(item, refreshOptions).ToList();
  141. Assert.Equal(providerList.Count, actualProviders.Count);
  142. var actualOrder = actualProviders.Select(i => providerList.IndexOf(i)).ToArray();
  143. Assert.Equal(expectedOrder, actualOrder);
  144. }
  145. [Theory]
  146. [InlineData(true, false, true)]
  147. [InlineData(false, false, false)]
  148. [InlineData(true, true, false)]
  149. public void GetImageProviders_CanRefreshImagesBasic_WhenSupportsWithoutError(bool supports, bool errorOnSupported, bool expected)
  150. {
  151. GetImageProviders_CanRefreshImages_Tester(nameof(IImageProvider), supports, expected, errorOnSupported: errorOnSupported);
  152. }
  153. [Theory]
  154. [InlineData(nameof(ILocalImageProvider), false, true)]
  155. [InlineData(nameof(ILocalImageProvider), true, true)]
  156. [InlineData(nameof(IImageProvider), false, false)]
  157. [InlineData(nameof(IImageProvider), true, true)]
  158. public void GetImageProviders_CanRefreshImagesLocked_WhenLocalOrFullRefresh(string providerType, bool fullRefresh, bool expected)
  159. {
  160. GetImageProviders_CanRefreshImages_Tester(providerType, true, expected, itemLocked: true, fullRefresh: fullRefresh);
  161. }
  162. [Theory]
  163. [InlineData(nameof(ILocalImageProvider), false, true)]
  164. [InlineData(nameof(IRemoteImageProvider), true, true)]
  165. [InlineData(nameof(IDynamicImageProvider), true, true)]
  166. [InlineData(nameof(IRemoteImageProvider), false, false)]
  167. [InlineData(nameof(IDynamicImageProvider), false, false)]
  168. public void GetImageProviders_CanRefreshImagesBaseItemEnabled_WhenLocalOrEnabled(string providerType, bool enabled, bool expected)
  169. {
  170. GetImageProviders_CanRefreshImages_Tester(providerType, true, expected, baseItemEnabled: enabled);
  171. }
  172. private static void GetImageProviders_CanRefreshImages_Tester(
  173. string providerType,
  174. bool supports,
  175. bool expected,
  176. bool errorOnSupported = false,
  177. bool itemLocked = false,
  178. bool fullRefresh = false,
  179. bool baseItemEnabled = true)
  180. {
  181. var item = new Movie
  182. {
  183. IsLocked = itemLocked
  184. };
  185. var providerName = "provider";
  186. IImageProvider provider = providerType switch
  187. {
  188. "IImageProvider" => MockIImageProvider<IImageProvider>(providerName, item, supports: supports, errorOnSupported: errorOnSupported),
  189. "ILocalImageProvider" => MockIImageProvider<ILocalImageProvider>(providerName, item, supports: supports, errorOnSupported: errorOnSupported),
  190. "IRemoteImageProvider" => MockIImageProvider<IRemoteImageProvider>(providerName, item, supports: supports, errorOnSupported: errorOnSupported),
  191. "IDynamicImageProvider" => MockIImageProvider<IDynamicImageProvider>(providerName, item, supports: supports, errorOnSupported: errorOnSupported),
  192. _ => throw new ArgumentException("Unexpected provider type")
  193. };
  194. var refreshOptions = new ImageRefreshOptions(Mock.Of<IDirectoryService>(MockBehavior.Strict))
  195. {
  196. ImageRefreshMode = fullRefresh ? MetadataRefreshMode.FullRefresh : MetadataRefreshMode.Default
  197. };
  198. var baseItemManager = new Mock<IBaseItemManager>(MockBehavior.Strict);
  199. baseItemManager.Setup(i => i.IsImageFetcherEnabled(item, It.IsAny<TypeOptions>(), providerName))
  200. .Returns(baseItemEnabled);
  201. using var providerManager = GetProviderManager(baseItemManager: baseItemManager.Object);
  202. AddParts(providerManager, imageProviders: new[] { provider });
  203. var actualProviders = providerManager.GetImageProviders(item, refreshOptions).ToArray();
  204. Assert.Equal(expected ? 1 : 0, actualProviders.Length);
  205. }
  206. public static TheoryData<string[], int[]?, int[]?, int[]?, int[]?, int?[]?, int[]> GetMetadataProvidersOrderData()
  207. {
  208. var l = nameof(ILocalMetadataProvider);
  209. var r = nameof(IRemoteMetadataProvider);
  210. return new()
  211. {
  212. { new[] { l, l, r, r }, null, null, null, null, null, new[] { 0, 1, 2, 3 } }, // no order options set
  213. // library options ordering
  214. { new[] { l, l, r, r }, Array.Empty<int>(), Array.Empty<int>(), null, null, null, new[] { 0, 1, 2, 3 } }, // no order provided
  215. // local only
  216. { new[] { r, l, l, l }, new[] { 2 }, null, null, null, null, new[] { 2, 0, 1, 3 } }, // one item in order
  217. { new[] { r, l, l, l }, new[] { 3, 2, 1 }, null, null, null, null, new[] { 3, 2, 1, 0 } }, // full reverse order
  218. // remote only
  219. { new[] { l, r, r, r }, null, new[] { 2 }, null, null, null, new[] { 2, 0, 1, 3 } }, // one item in order
  220. { new[] { l, r, r, r }, null, new[] { 3, 2, 1 }, null, null, null, new[] { 3, 2, 1, 0 } }, // full reverse order
  221. // local and remote, note that results will be interleaved (odd but expected)
  222. { new[] { l, l, r, r }, new[] { 1 }, new[] { 3 }, null, null, null, new[] { 1, 3, 0, 2 } }, // one item in each order
  223. { 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
  224. // // server options ordering
  225. { new[] { l, l, r, r }, null, null, Array.Empty<int>(), Array.Empty<int>(), null, new[] { 0, 1, 2, 3 } }, // no order provided
  226. // local only
  227. { new[] { r, l, l, l }, null, null, new[] { 2 }, null, null, new[] { 2, 0, 1, 3 } }, // one item in order
  228. { new[] { r, l, l, l }, null, null, new[] { 3, 2, 1 }, null, null, new[] { 3, 2, 1, 0 } }, // full reverse order
  229. // remote only
  230. { new[] { l, r, r, r }, null, null, null, new[] { 2 }, null, new[] { 2, 0, 1, 3 } }, // one item in order
  231. { new[] { l, r, r, r }, null, null, null, new[] { 3, 2, 1 }, null, new[] { 3, 2, 1, 0 } }, // full reverse order
  232. // local and remote, note that results will be interleaved (odd but expected)
  233. { new[] { l, l, r, r }, null, null, new[] { 1 }, new[] { 3 }, null, new[] { 1, 3, 0, 2 } }, // one item in each order
  234. { 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
  235. // IHasOrder ordering (not interleaved, doesn't care about types)
  236. { new[] { l, l, r, r }, null, null, null, null, new int?[] { 2, null, 1, null }, new[] { 2, 0, 1, 3 } }, // partially defined
  237. { new[] { l, l, r, r }, null, null, null, null, new int?[] { 3, 2, 1, 0 }, new[] { 3, 2, 1, 0 } }, // full reverse order
  238. // multiple orders set
  239. { 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
  240. { new[] { l, l, l }, new[] { 1 }, null, null, null, new int?[] { 2, 0, 1 }, new[] { 1, 2, 0 } }, // library order first, then orderby
  241. { 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)
  242. };
  243. }
  244. [Theory]
  245. [MemberData(nameof(GetMetadataProvidersOrderData))]
  246. public void GetMetadataProviders_ProviderOrder_MatchesExpected(
  247. string[] providers,
  248. int[]? libraryLocalOrder,
  249. int[]? libraryRemoteOrder,
  250. int[]? serverLocalOrder,
  251. int[]? serverRemoteOrder,
  252. int?[]? hasOrderOrder,
  253. int[] expectedOrder)
  254. {
  255. var item = new MetadataTestItem();
  256. var nameProvider = new Func<int, string>(i => "Provider" + i);
  257. var providerList = new List<IMetadataProvider<MetadataTestItem>>();
  258. for (var i = 0; i < providers.Length; i++)
  259. {
  260. var order = hasOrderOrder?[i];
  261. providerList.Add(MockIMetadataProviderMapper<MetadataTestItem, MetadataTestItemInfo>(providers[i], nameProvider(i), order: order));
  262. }
  263. var libraryOptions = CreateLibraryOptions(
  264. item.GetType().Name,
  265. localMetadataReaderOrder: libraryLocalOrder?.Select(nameProvider).ToArray(),
  266. metadataFetcherOrder: libraryRemoteOrder?.Select(nameProvider).ToArray());
  267. var serverConfiguration = CreateServerConfiguration(
  268. item.GetType().Name,
  269. localMetadataReaderOrder: serverLocalOrder?.Select(nameProvider).ToArray(),
  270. metadataFetcherOrder: serverRemoteOrder?.Select(nameProvider).ToArray());
  271. var baseItemManager = new Mock<IBaseItemManager>(MockBehavior.Strict);
  272. baseItemManager.Setup(i => i.IsMetadataFetcherEnabled(item, It.IsAny<TypeOptions>(), It.IsAny<string>()))
  273. .Returns(true);
  274. using var providerManager = GetProviderManager(serverConfiguration: serverConfiguration, baseItemManager: baseItemManager.Object);
  275. AddParts(providerManager, metadataProviders: providerList);
  276. var actualProviders = providerManager.GetMetadataProviders<MetadataTestItem>(item, libraryOptions).ToList();
  277. Assert.Equal(providerList.Count, actualProviders.Count);
  278. var actualOrder = actualProviders.Select(i => providerList.IndexOf(i)).ToArray();
  279. Assert.Equal(expectedOrder, actualOrder);
  280. }
  281. [Theory]
  282. [InlineData(nameof(IMetadataProvider))]
  283. [InlineData(nameof(ILocalMetadataProvider))]
  284. [InlineData(nameof(IRemoteMetadataProvider))]
  285. [InlineData(nameof(ICustomMetadataProvider))]
  286. public void GetMetadataProviders_CanRefreshMetadataBasic_ReturnsTrue(string providerType)
  287. {
  288. GetMetadataProviders_CanRefreshMetadata_Tester(providerType, true);
  289. }
  290. [Theory]
  291. [InlineData(nameof(ILocalMetadataProvider), false, true)]
  292. [InlineData(nameof(IRemoteMetadataProvider), false, false)]
  293. [InlineData(nameof(ICustomMetadataProvider), false, false)]
  294. [InlineData(nameof(ILocalMetadataProvider), true, true)]
  295. [InlineData(nameof(ICustomMetadataProvider), true, false)]
  296. public void GetMetadataProviders_CanRefreshMetadataLocked_WhenLocalOrForced(string providerType, bool forced, bool expected)
  297. {
  298. GetMetadataProviders_CanRefreshMetadata_Tester(providerType, expected, itemLocked: true, providerForced: forced);
  299. }
  300. [Theory]
  301. [InlineData(nameof(ILocalMetadataProvider), false, true)]
  302. [InlineData(nameof(ICustomMetadataProvider), false, true)]
  303. [InlineData(nameof(IRemoteMetadataProvider), false, false)]
  304. [InlineData(nameof(IRemoteMetadataProvider), true, true)]
  305. public void GetMetadataProviders_CanRefreshMetadataBaseItemEnabled_WhenEnabledOrNotRemote(string providerType, bool baseItemEnabled, bool expected)
  306. {
  307. GetMetadataProviders_CanRefreshMetadata_Tester(providerType, expected, baseItemEnabled: baseItemEnabled);
  308. }
  309. [Theory]
  310. [InlineData(nameof(IRemoteMetadataProvider), false, true)]
  311. [InlineData(nameof(ICustomMetadataProvider), false, true)]
  312. [InlineData(nameof(ILocalMetadataProvider), false, false)]
  313. [InlineData(nameof(ILocalMetadataProvider), true, true)]
  314. public void GetMetadataProviders_CanRefreshMetadataSupportsLocal_WhenSupportsOrNotLocal(string providerType, bool supportsLocalMetadata, bool expected)
  315. {
  316. GetMetadataProviders_CanRefreshMetadata_Tester(providerType, expected, supportsLocalMetadata: supportsLocalMetadata);
  317. }
  318. [Theory]
  319. [InlineData(nameof(ICustomMetadataProvider), true)]
  320. [InlineData(nameof(IRemoteMetadataProvider), true)]
  321. [InlineData(nameof(ILocalMetadataProvider), true)]
  322. public void GetMetadataProviders_CanRefreshMetadataOwned(string providerType, bool expected)
  323. {
  324. GetMetadataProviders_CanRefreshMetadata_Tester(providerType, expected, ownedItem: true);
  325. }
  326. private static void GetMetadataProviders_CanRefreshMetadata_Tester(
  327. string providerType,
  328. bool expected,
  329. bool itemLocked = false,
  330. bool baseItemEnabled = true,
  331. bool providerForced = false,
  332. bool supportsLocalMetadata = true,
  333. bool ownedItem = false)
  334. {
  335. var item = new MetadataTestItem
  336. {
  337. IsLocked = itemLocked,
  338. OwnerId = ownedItem ? Guid.NewGuid() : Guid.Empty,
  339. EnableLocalMetadata = supportsLocalMetadata
  340. };
  341. var providerName = "provider";
  342. var provider = MockIMetadataProviderMapper<MetadataTestItem, MetadataTestItemInfo>(providerType, providerName, forced: providerForced);
  343. var baseItemManager = new Mock<IBaseItemManager>(MockBehavior.Strict);
  344. baseItemManager.Setup(i => i.IsMetadataFetcherEnabled(item, It.IsAny<TypeOptions>(), providerName))
  345. .Returns(baseItemEnabled);
  346. using var providerManager = GetProviderManager(baseItemManager: baseItemManager.Object);
  347. AddParts(providerManager, metadataProviders: new[] { provider });
  348. var actualProviders = providerManager.GetMetadataProviders<MetadataTestItem>(item, new LibraryOptions()).ToArray();
  349. Assert.Equal(expected ? 1 : 0, actualProviders.Length);
  350. }
  351. private static Mock<IMetadataService> MockIMetadataService(bool refreshPrimary, bool canRefresh, int order = 0)
  352. {
  353. var service = new Mock<IMetadataService>(MockBehavior.Strict);
  354. service.Setup(s => s.Order)
  355. .Returns(order);
  356. service.Setup(s => s.CanRefreshPrimary(It.IsAny<Type>()))
  357. .Returns(refreshPrimary);
  358. service.Setup(s => s.CanRefresh(It.IsAny<BaseItem>()))
  359. .Returns(canRefresh);
  360. service.Setup(s => s.RefreshMetadata(It.IsAny<BaseItem>(), It.IsAny<MetadataRefreshOptions>(), It.IsAny<CancellationToken>()))
  361. .Returns(Task.FromResult(ItemUpdateType.MetadataDownload));
  362. return service;
  363. }
  364. private static IImageProvider MockIImageProvider<TProviderType>(string name, BaseItem expectedType, bool supports = true, int? order = null, bool errorOnSupported = false)
  365. where TProviderType : class, IImageProvider
  366. {
  367. Mock<IHasOrder>? hasOrder = null;
  368. if (order is not null)
  369. {
  370. hasOrder = new Mock<IHasOrder>(MockBehavior.Strict);
  371. hasOrder.Setup(i => i.Order)
  372. .Returns((int)order);
  373. }
  374. var provider = hasOrder is null
  375. ? new Mock<TProviderType>(MockBehavior.Strict)
  376. : hasOrder.As<TProviderType>();
  377. provider.Setup(p => p.Name)
  378. .Returns(name);
  379. if (errorOnSupported)
  380. {
  381. provider.Setup(p => p.Supports(It.IsAny<BaseItem>()))
  382. .Throws(new ArgumentException("Provider threw exception on Supports(item)"));
  383. }
  384. else
  385. {
  386. provider.Setup(p => p.Supports(expectedType))
  387. .Returns(supports);
  388. }
  389. return provider.Object;
  390. }
  391. private static IMetadataProvider<TItemType> MockIMetadataProviderMapper<TItemType, TLookupInfoType>(string typeName, string providerName, int? order = null, bool forced = false)
  392. where TItemType : BaseItem, IHasLookupInfo<TLookupInfoType>
  393. where TLookupInfoType : ItemLookupInfo, new()
  394. => typeName switch
  395. {
  396. "ILocalMetadataProvider" => MockIMetadataProvider<ILocalMetadataProvider<TItemType>, TItemType>(providerName, order, forced),
  397. "IRemoteMetadataProvider" => MockIMetadataProvider<IRemoteMetadataProvider<TItemType, TLookupInfoType>, TItemType>(providerName, order, forced),
  398. "ICustomMetadataProvider" => MockIMetadataProvider<ICustomMetadataProvider<TItemType>, TItemType>(providerName, order, forced),
  399. _ => MockIMetadataProvider<IMetadataProvider<TItemType>, TItemType>(providerName, order, forced)
  400. };
  401. private static IMetadataProvider<TItemType> MockIMetadataProvider<TProviderType, TItemType>(string name, int? order = null, bool forced = false)
  402. where TProviderType : class, IMetadataProvider<TItemType>
  403. where TItemType : BaseItem
  404. {
  405. Mock<IForcedProvider>? forcedProvider = null;
  406. if (forced)
  407. {
  408. forcedProvider = new Mock<IForcedProvider>();
  409. }
  410. Mock<IHasOrder>? hasOrder = null;
  411. if (order is not null)
  412. {
  413. hasOrder = forcedProvider is null ? new Mock<IHasOrder>() : forcedProvider.As<IHasOrder>();
  414. hasOrder.Setup(i => i.Order)
  415. .Returns((int)order);
  416. }
  417. var provider = hasOrder is null
  418. ? new Mock<TProviderType>(MockBehavior.Strict)
  419. : hasOrder.As<TProviderType>();
  420. provider.Setup(p => p.Name)
  421. .Returns(name);
  422. return provider.Object;
  423. }
  424. private static LibraryOptions CreateLibraryOptions(
  425. string typeName,
  426. string[]? imageFetcherOrder = null,
  427. string[]? localMetadataReaderOrder = null,
  428. string[]? metadataFetcherOrder = null)
  429. {
  430. var libraryOptions = new LibraryOptions
  431. {
  432. LocalMetadataReaderOrder = localMetadataReaderOrder
  433. };
  434. // only create type options if populating it with something
  435. if (imageFetcherOrder is not null || metadataFetcherOrder is not null)
  436. {
  437. imageFetcherOrder ??= Array.Empty<string>();
  438. metadataFetcherOrder ??= Array.Empty<string>();
  439. libraryOptions.TypeOptions = new[]
  440. {
  441. new TypeOptions
  442. {
  443. Type = typeName,
  444. ImageFetcherOrder = imageFetcherOrder,
  445. MetadataFetcherOrder = metadataFetcherOrder
  446. }
  447. };
  448. }
  449. return libraryOptions;
  450. }
  451. private static ServerConfiguration CreateServerConfiguration(
  452. string typeName,
  453. string[]? imageFetcherOrder = null,
  454. string[]? localMetadataReaderOrder = null,
  455. string[]? metadataFetcherOrder = null)
  456. {
  457. var serverConfiguration = new ServerConfiguration();
  458. // only create type options if populating it with something
  459. if (imageFetcherOrder is not null || localMetadataReaderOrder is not null || metadataFetcherOrder is not null)
  460. {
  461. imageFetcherOrder ??= Array.Empty<string>();
  462. localMetadataReaderOrder ??= Array.Empty<string>();
  463. metadataFetcherOrder ??= Array.Empty<string>();
  464. serverConfiguration.MetadataOptions = new[]
  465. {
  466. new MetadataOptions
  467. {
  468. ItemType = typeName,
  469. ImageFetcherOrder = imageFetcherOrder,
  470. LocalMetadataReaderOrder = localMetadataReaderOrder,
  471. MetadataFetcherOrder = metadataFetcherOrder
  472. }
  473. };
  474. }
  475. return serverConfiguration;
  476. }
  477. private static ProviderManager GetProviderManager(
  478. ServerConfiguration? serverConfiguration = null,
  479. LibraryOptions? libraryOptions = null,
  480. IBaseItemManager? baseItemManager = null)
  481. {
  482. var serverConfigurationManager = new Mock<IServerConfigurationManager>(MockBehavior.Strict);
  483. serverConfigurationManager.Setup(i => i.Configuration)
  484. .Returns(serverConfiguration ?? new ServerConfiguration());
  485. var libraryManager = new Mock<ILibraryManager>(MockBehavior.Strict);
  486. libraryManager.Setup(i => i.GetLibraryOptions(It.IsAny<BaseItem>()))
  487. .Returns(libraryOptions ?? new LibraryOptions());
  488. var providerManager = new ProviderManager(
  489. Mock.Of<IHttpClientFactory>(),
  490. Mock.Of<ISubtitleManager>(),
  491. serverConfigurationManager.Object,
  492. Mock.Of<ILibraryMonitor>(),
  493. _logger,
  494. Mock.Of<IFileSystem>(),
  495. Mock.Of<IServerApplicationPaths>(),
  496. libraryManager.Object,
  497. baseItemManager!,
  498. Mock.Of<ILyricManager>(),
  499. Mock.Of<IMemoryCache>());
  500. return providerManager;
  501. }
  502. private static void AddParts(
  503. ProviderManager providerManager,
  504. IEnumerable<IImageProvider>? imageProviders = null,
  505. IEnumerable<IMetadataService>? metadataServices = null,
  506. IEnumerable<IMetadataProvider>? metadataProviders = null,
  507. IEnumerable<IMetadataSaver>? metadataSavers = null,
  508. IEnumerable<IExternalId>? externalIds = null)
  509. {
  510. imageProviders ??= Array.Empty<IImageProvider>();
  511. metadataServices ??= Array.Empty<IMetadataService>();
  512. metadataProviders ??= Array.Empty<IMetadataProvider>();
  513. metadataSavers ??= Array.Empty<IMetadataSaver>();
  514. externalIds ??= Array.Empty<IExternalId>();
  515. providerManager.AddParts(imageProviders, metadataServices, metadataProviders, metadataSavers, externalIds);
  516. }
  517. /// <summary>
  518. /// Simple <see cref="BaseItem"/> extension to make SupportsLocalMetadata directly settable.
  519. /// </summary>
  520. internal class MetadataTestItem : BaseItem, IHasLookupInfo<MetadataTestItemInfo>
  521. {
  522. public bool EnableLocalMetadata { get; set; } = true;
  523. public override bool SupportsLocalMetadata => EnableLocalMetadata;
  524. public MetadataTestItemInfo GetLookupInfo()
  525. {
  526. return GetItemLookupInfo<MetadataTestItemInfo>();
  527. }
  528. }
  529. internal class MetadataTestItemInfo : ItemLookupInfo
  530. {
  531. }
  532. }
  533. }