ProviderManagerTests.cs 29 KB

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