ProviderManagerTests.cs 29 KB

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