-
Notifications
You must be signed in to change notification settings - Fork 9
[refactor] Centralize filesystem entry classification in inventory flow #276
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
paul-fresquet
wants to merge
1
commit into
master
Choose a base branch
from
feature/263-classify-entry-inspector
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
2 changes: 2 additions & 0 deletions
2
src/ByteSync.Client/Interfaces/Controls/Inventories/IFileSystemInspector.cs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -1,4 +1,5 @@ | ||||||
| using System.IO; | ||||||
| using ByteSync.Business.Inventories; | ||||||
| using ByteSync.Common.Business.Misc; | ||||||
| using ByteSync.Interfaces.Controls.Inventories; | ||||||
|
|
||||||
|
|
@@ -7,6 +8,48 @@ namespace ByteSync.Services.Inventories; | |||||
| public class FileSystemInspector : IFileSystemInspector | ||||||
| { | ||||||
| private const int FILE_ATTRIBUTE_RECALL_ON_DATA_ACCESS = 4194304; | ||||||
| private readonly IPosixFileTypeClassifier _posixFileTypeClassifier; | ||||||
|
|
||||||
| public FileSystemInspector(IPosixFileTypeClassifier? posixFileTypeClassifier = null) | ||||||
| { | ||||||
| _posixFileTypeClassifier = posixFileTypeClassifier ?? new PosixFileTypeClassifier(); | ||||||
| } | ||||||
|
|
||||||
| public FileSystemEntryKind ClassifyEntry(FileSystemInfo fsi) | ||||||
| { | ||||||
| if (fsi is null) | ||||||
| { | ||||||
| return FileSystemEntryKind.Unknown; | ||||||
| } | ||||||
|
|
||||||
| if (HasLinkTarget(fsi) || SafeIsReparsePoint(fsi)) | ||||||
| { | ||||||
| return FileSystemEntryKind.Symlink; | ||||||
| } | ||||||
|
|
||||||
| if (!OperatingSystem.IsWindows()) | ||||||
| { | ||||||
| try | ||||||
| { | ||||||
| var posixKind = _posixFileTypeClassifier.ClassifyPosixEntry(fsi.FullName); | ||||||
| if (posixKind != FileSystemEntryKind.Unknown) | ||||||
| { | ||||||
| return posixKind; | ||||||
| } | ||||||
| } | ||||||
| catch (Exception) | ||||||
| { | ||||||
| return FileSystemEntryKind.Unknown; | ||||||
|
||||||
| return FileSystemEntryKind.Unknown; | |
| // Ignore POSIX classification failures and fall back to type-based classification below. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
122 changes: 122 additions & 0 deletions
122
tests/ByteSync.Client.UnitTests/Services/Inventories/FileSystemInspectorTests.cs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,122 @@ | ||
| using ByteSync.Business.Inventories; | ||
| using ByteSync.Interfaces.Controls.Inventories; | ||
| using ByteSync.Services.Inventories; | ||
| using FluentAssertions; | ||
| using Moq; | ||
| using NUnit.Framework; | ||
|
|
||
| namespace ByteSync.Client.UnitTests.Services.Inventories; | ||
|
|
||
| public class FileSystemInspectorTests | ||
| { | ||
| [Test] | ||
| public void ClassifyEntry_ReturnsDirectory_ForDirectoryInfo() | ||
| { | ||
| var posix = new Mock<IPosixFileTypeClassifier>(MockBehavior.Strict); | ||
| posix.Setup(p => p.ClassifyPosixEntry(It.IsAny<string>())).Returns(FileSystemEntryKind.Unknown); | ||
| var inspector = new FileSystemInspector(posix.Object); | ||
| var tempDirectory = Directory.CreateDirectory(Path.Combine(Path.GetTempPath(), Guid.NewGuid().ToString("N"))); | ||
|
|
||
| try | ||
| { | ||
| var result = inspector.ClassifyEntry(tempDirectory); | ||
|
|
||
| result.Should().Be(FileSystemEntryKind.Directory); | ||
| } | ||
| finally | ||
| { | ||
| Directory.Delete(tempDirectory.FullName, true); | ||
| } | ||
| } | ||
|
|
||
| [Test] | ||
| public void ClassifyEntry_ReturnsRegularFile_ForFileInfo() | ||
| { | ||
| var posix = new Mock<IPosixFileTypeClassifier>(MockBehavior.Strict); | ||
| posix.Setup(p => p.ClassifyPosixEntry(It.IsAny<string>())).Returns(FileSystemEntryKind.Unknown); | ||
| var inspector = new FileSystemInspector(posix.Object); | ||
| var tempDirectory = Directory.CreateDirectory(Path.Combine(Path.GetTempPath(), Guid.NewGuid().ToString("N"))); | ||
| var tempFilePath = Path.Combine(tempDirectory.FullName, "file.txt"); | ||
| File.WriteAllText(tempFilePath, "x"); | ||
| var fileInfo = new FileInfo(tempFilePath); | ||
|
|
||
| try | ||
| { | ||
| var result = inspector.ClassifyEntry(fileInfo); | ||
|
|
||
| result.Should().Be(FileSystemEntryKind.RegularFile); | ||
| } | ||
| finally | ||
| { | ||
| Directory.Delete(tempDirectory.FullName, true); | ||
| } | ||
| } | ||
|
|
||
| [Test] | ||
| public void ClassifyEntry_ReturnsSymlink_WhenLinkTargetExists() | ||
| { | ||
| var posix = new Mock<IPosixFileTypeClassifier>(MockBehavior.Strict); | ||
| posix.Setup(p => p.ClassifyPosixEntry(It.IsAny<string>())).Returns(FileSystemEntryKind.Unknown); | ||
| var inspector = new FileSystemInspector(posix.Object); | ||
| var tempDirectory = Directory.CreateDirectory(Path.Combine(Path.GetTempPath(), Guid.NewGuid().ToString("N"))); | ||
| var targetPath = Path.Combine(tempDirectory.FullName, "target.txt"); | ||
| File.WriteAllText(targetPath, "x"); | ||
| var linkPath = Path.Combine(tempDirectory.FullName, "link.txt"); | ||
|
|
||
| try | ||
| { | ||
| try | ||
| { | ||
| File.CreateSymbolicLink(linkPath, targetPath); | ||
| } | ||
| catch (Exception ex) | ||
| { | ||
| Assert.Ignore($"Symbolic link creation failed: {ex.GetType().Name}"); | ||
| } | ||
|
|
||
| var result = inspector.ClassifyEntry(new FileInfo(linkPath)); | ||
|
|
||
| result.Should().Be(FileSystemEntryKind.Symlink); | ||
| } | ||
| finally | ||
| { | ||
| Directory.Delete(tempDirectory.FullName, true); | ||
| } | ||
| } | ||
|
|
||
| [Test] | ||
| [Platform(Include = "Linux,MacOsX")] | ||
| public void ClassifyEntry_ReturnsPosixSpecialKind_WhenClassifierProvidesOne() | ||
| { | ||
| var posix = new Mock<IPosixFileTypeClassifier>(MockBehavior.Strict); | ||
| posix.Setup(p => p.ClassifyPosixEntry(It.IsAny<string>())).Returns(FileSystemEntryKind.Fifo); | ||
| var inspector = new FileSystemInspector(posix.Object); | ||
| var tempDirectory = Directory.CreateDirectory(Path.Combine(Path.GetTempPath(), Guid.NewGuid().ToString("N"))); | ||
| var tempFilePath = Path.Combine(tempDirectory.FullName, "file.txt"); | ||
| File.WriteAllText(tempFilePath, "x"); | ||
| var fileInfo = new FileInfo(tempFilePath); | ||
|
|
||
| try | ||
| { | ||
| var result = inspector.ClassifyEntry(fileInfo); | ||
|
|
||
| result.Should().Be(FileSystemEntryKind.Fifo); | ||
| } | ||
| finally | ||
| { | ||
| Directory.Delete(tempDirectory.FullName, true); | ||
| } | ||
| } | ||
|
|
||
| [Test] | ||
| public void ClassifyEntry_ReturnsUnknown_ForNullEntry() | ||
| { | ||
| var posix = new Mock<IPosixFileTypeClassifier>(MockBehavior.Strict); | ||
| posix.Setup(p => p.ClassifyPosixEntry(It.IsAny<string>())).Returns(FileSystemEntryKind.Unknown); | ||
| var inspector = new FileSystemInspector(posix.Object); | ||
|
|
||
| var result = inspector.ClassifyEntry(null!); | ||
|
|
||
| result.Should().Be(FileSystemEntryKind.Unknown); | ||
| } | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ClassifyEntrydefensively handlesnullinputs, but the interface contract uses a non-nullableFileSystemInfoparameter. With nullable enabled, consider changing the signature toFileSystemInfo?to reflect the supported input and avoid callers needingnull!in tests.