ProviderManagerTests.cs 30 KB

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