diff options
| author | Cody Robibero <cody@robibe.ro> | 2026-11-20 07:14:33 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2026-11-20 07:14:33 -0500 |
| commit | be19e7c7786f62e79ea79a671908986b73e47a61 (patch) | |
| tree | e9941c3e4e95d0803b8b27be03b06094c3e520e2 /tests | |
| parent | 5c05f2af03642cada0f73a255289c433c88e557c (diff) | |
| parent | 6561d58ad512bdc4dfd6dacf55a5b03b2a143623 (diff) | |
Merge pull request #18275 from Shadowghost/fix/17364-dotignore-library-root
Confine ignore file handling to library root
Diffstat (limited to 'tests')
3 files changed, 249 insertions, 0 deletions
diff --git a/tests/Jellyfin.Server.Implementations.Tests/Library/DotIgnoreIgnoreRuleTest.cs b/tests/Jellyfin.Server.Implementations.Tests/Library/DotIgnoreIgnoreRuleTest.cs index 03c0b4af39..94de2f7b23 100644 --- a/tests/Jellyfin.Server.Implementations.Tests/Library/DotIgnoreIgnoreRuleTest.cs +++ b/tests/Jellyfin.Server.Implementations.Tests/Library/DotIgnoreIgnoreRuleTest.cs @@ -470,4 +470,105 @@ public class DotIgnoreIgnoreRuleTest Directory.Delete(tempDir, true); } } + + [Fact] + public void LibraryRoot_IgnoreFileAboveRoot_IsNotConsulted() + { + var tempDir = Path.Combine(Path.GetTempPath(), Guid.NewGuid().ToString()); + var libraryRoot = Path.Combine(tempDir, "Movies"); + var movieDir = Path.Combine(libraryRoot, "Movie (2020)"); + Directory.CreateDirectory(movieDir); + + try + { + File.WriteAllText(Path.Combine(tempDir, ".ignore"), string.Empty); + + var rule = new DotIgnoreIgnoreRule(); + var fileInfo = new FileSystemMetadata + { + FullName = Path.Combine(movieDir, "Movie (2020).mkv"), + IsDirectory = false + }; + + // Without library roots the walk reaches the filesystem root + Assert.True(rule.ShouldIgnore(fileInfo, null)); + + rule.SetLibraryRootsProvider(() => [libraryRoot + Path.DirectorySeparatorChar]); + Assert.False(rule.ShouldIgnore(fileInfo, null)); + + // A .ignore in the library root itself still applies + File.WriteAllText(Path.Combine(libraryRoot, ".ignore"), "*.mkv"); + rule.ClearDirectoryCache(); + Assert.True(rule.ShouldIgnore(fileInfo, null)); + } + finally + { + Directory.Delete(tempDir, true); + } + } + + [Fact] + public void LibraryRoot_NestedRoots_StopAtOutermost() + { + var tempDir = Path.Combine(Path.GetTempPath(), Guid.NewGuid().ToString()); + var outerRoot = Path.Combine(tempDir, "Media"); + var innerRoot = Path.Combine(outerRoot, "Movies"); + Directory.CreateDirectory(innerRoot); + + try + { + File.WriteAllText(Path.Combine(outerRoot, ".ignore"), "*.mkv"); + + var rule = new DotIgnoreIgnoreRule(); + rule.SetLibraryRootsProvider(() => [innerRoot, outerRoot]); + var fileInfo = new FileSystemMetadata + { + FullName = Path.Combine(innerRoot, "Movie.mkv"), + IsDirectory = false + }; + + Assert.True(rule.ShouldIgnore(fileInfo, null)); + } + finally + { + Directory.Delete(tempDir, true); + } + } + + [Fact] + public void LibraryRoot_PathOutsideLibraries_WalksToFilesystemRoot() + { + var tempDir = Path.Combine(Path.GetTempPath(), Guid.NewGuid().ToString()); + var libraryRoot = Path.Combine(tempDir, "Movies"); + var otherDir = Path.Combine(tempDir, "Other", "Sub"); + Directory.CreateDirectory(libraryRoot); + Directory.CreateDirectory(otherDir); + + try + { + File.WriteAllText(Path.Combine(tempDir, ".ignore"), string.Empty); + + var rule = new DotIgnoreIgnoreRule(); + rule.SetLibraryRootsProvider(() => [libraryRoot]); + + // A sibling whose name only shares the root's prefix is not inside the library + var fileInfo = new FileSystemMetadata + { + FullName = Path.Combine(tempDir, "MoviesExtra", "Movie.mkv"), + IsDirectory = false + }; + Assert.True(rule.ShouldIgnore(fileInfo, null)); + + fileInfo = new FileSystemMetadata + { + FullName = Path.Combine(otherDir, "Movie.mkv"), + IsDirectory = false + }; + Assert.True(rule.ShouldIgnore(fileInfo, null)); + } + finally + { + Directory.Delete(tempDir, true); + } + } } diff --git a/tests/Jellyfin.Server.Implementations.Tests/Library/LibraryManager/LibraryRootIgnoreTests.cs b/tests/Jellyfin.Server.Implementations.Tests/Library/LibraryManager/LibraryRootIgnoreTests.cs new file mode 100644 index 0000000000..f37aadbe8d --- /dev/null +++ b/tests/Jellyfin.Server.Implementations.Tests/Library/LibraryManager/LibraryRootIgnoreTests.cs @@ -0,0 +1,93 @@ +using System; +using System.IO; +using AutoFixture; +using AutoFixture.AutoMoq; +using Emby.Naming.Common; +using Emby.Server.Implementations.IO; +using Emby.Server.Implementations.Library; +using MediaBrowser.Controller; +using MediaBrowser.Controller.Configuration; +using MediaBrowser.Controller.Sorting; +using MediaBrowser.Model.IO; +using Microsoft.Extensions.Logging.Abstractions; +using Moq; +using Xunit; + +namespace Jellyfin.Server.Implementations.Tests.Library.LibraryManager; + +public sealed class LibraryRootIgnoreTests : IDisposable +{ + private readonly string _tempDir; + private readonly string _userViewsPath; + private readonly string _libraryRoot; + private readonly FileSystemMetadata _movieFile; + + public LibraryRootIgnoreTests() + { + _tempDir = Path.Combine(Path.GetTempPath(), Guid.NewGuid().ToString()); + _userViewsPath = Path.Combine(_tempDir, "root", "default"); + _libraryRoot = Path.Combine(_tempDir, "media", "Movies"); + var movieDir = Path.Combine(_libraryRoot, "Movie (2020)"); + Directory.CreateDirectory(movieDir); + + // Ignores everything below it, but sits above the library root + File.WriteAllText(Path.Combine(_tempDir, ".ignore"), string.Empty); + + _movieFile = new FileSystemMetadata + { + FullName = Path.Combine(movieDir, "Movie (2020).mkv"), + IsDirectory = false + }; + } + + public void Dispose() + { + Directory.Delete(_tempDir, true); + } + + [Fact] + public void IgnoreFile_IgnoreFileAboveMblinkLibraryRoot_IsNotConsulted() + { + var libraryDir = Path.Combine(_userViewsPath, "Movies"); + Directory.CreateDirectory(libraryDir); + File.WriteAllText(Path.Combine(libraryDir, "Movies.mblink"), _libraryRoot); + + Assert.False(CreateLibraryManager().IgnoreFile(_movieFile, null)); + } + + [Fact] + public void IgnoreFile_UserViewsPathMissing_WalksToFilesystemRoot() + { + // Before root/default exists there are no library roots, so the .ignore above still applies + Assert.False(Directory.Exists(_userViewsPath)); + Assert.True(CreateLibraryManager().IgnoreFile(_movieFile, null)); + } + + private Emby.Server.Implementations.Library.LibraryManager CreateLibraryManager() + { + var fixture = new Fixture().Customize(new AutoMoqCustomization()); + fixture.Register(() => new NamingOptions()); + var configMock = fixture.Freeze<Mock<IServerConfigurationManager>>(); + configMock.Setup(c => c.ApplicationPaths.ProgramDataPath).Returns(_tempDir); + configMock.Setup(c => c.ApplicationPaths.DefaultUserViewsPath).Returns(_userViewsPath); + fixture.Freeze<Mock<IServerApplicationHost>>() + .Setup(h => h.ExpandVirtualPath(It.IsAny<string>())) + .Returns<string>(path => path); + fixture.Inject<IFileSystem>(new ManagedFileSystem( + NullLogger<ManagedFileSystem>.Instance, + configMock.Object.ApplicationPaths, + [new MbLinkShortcutHandler()])); + + // The same instance LibraryManager hands the roots to must be the one evaluating the rules + var dotIgnoreRule = new DotIgnoreIgnoreRule(); + fixture.Inject(dotIgnoreRule); + + return fixture.Build<Emby.Server.Implementations.Library.LibraryManager>().Do(s => s.AddParts( + [dotIgnoreRule], + [], + [], + Array.Empty<IBaseItemComparer>(), + [])) + .Create(); + } +} diff --git a/tests/Jellyfin.Server.Integration.Tests/DotIgnoreLibraryRootTests.cs b/tests/Jellyfin.Server.Integration.Tests/DotIgnoreLibraryRootTests.cs new file mode 100644 index 0000000000..2fd598e6b2 --- /dev/null +++ b/tests/Jellyfin.Server.Integration.Tests/DotIgnoreLibraryRootTests.cs @@ -0,0 +1,55 @@ +using System; +using System.IO; +using Emby.Server.Implementations.Library; +using MediaBrowser.Controller; +using MediaBrowser.Controller.Entities; +using MediaBrowser.Controller.Library; +using MediaBrowser.Model.IO; +using Microsoft.Extensions.DependencyInjection; +using Xunit; + +namespace Jellyfin.Server.Integration.Tests; + +public sealed class DotIgnoreLibraryRootTests : IClassFixture<JellyfinApplicationFactory> +{ + private readonly JellyfinApplicationFactory _factory; + + public DotIgnoreLibraryRootTests(JellyfinApplicationFactory factory) + { + _factory = factory; + } + + [Fact] + public void IgnoreFile_IgnoreFileAboveLibraryRoot_IsNotConsulted() + { + _ = _factory.CreateClient(); + + var tempDir = Path.Combine(Path.GetTempPath(), Guid.NewGuid().ToString()); + var libraryRoot = Path.Combine(tempDir, "Movies"); + var movieDir = Path.Combine(libraryRoot, "Movie (2020)"); + Directory.CreateDirectory(movieDir); + var libraryDir = Path.Combine(_factory.Services.GetRequiredService<IServerApplicationPaths>().DefaultUserViewsPath, "dotignore-root-test"); + Directory.CreateDirectory(libraryDir); + + try + { + File.WriteAllText(Path.Combine(tempDir, ".ignore"), string.Empty); + File.WriteAllText(Path.Combine(libraryDir, "Movies.mblink"), libraryRoot); + + // The rule the resolver evaluates must be the singleton LibraryManager hands the roots to + _factory.Services.GetRequiredService<DotIgnoreIgnoreRule>().ClearDirectoryCache(); + var fileInfo = new FileSystemMetadata + { + FullName = Path.Combine(movieDir, "Movie (2020).mkv"), + IsDirectory = false + }; + + Assert.False(_factory.Services.GetRequiredService<ILibraryManager>().IgnoreFile(fileInfo, new Folder { Path = movieDir })); + } + finally + { + Directory.Delete(libraryDir, true); + Directory.Delete(tempDir, true); + } + } +} |
