Skip to content

FileSystemGlobbing: Allow rootDir paths ending with separator to match files correctly #45139

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.

Sign up for GitHub

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

Merged
jozkee merged 3 commits into from
Mar 30, 2021
Merged

FileSystemGlobbing: Allow rootDir paths ending with separator to match files correctly #45139

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
538b8d9
Allow rootDir paths ending with separator to match files correctly
jozkee Nov 24, 2020
21a8093
Avoid running tests with windows-like absolute paths on non-windows p…
jozkee Mar 1, 2021
346c61c
Address test suggestion
jozkee Mar 1, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 4 additions & 6 deletions src/libraries/Microsoft.Extensions.FileSystemGlobbing/src/InMemoryDirectoryInfo.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,13 +119,11 @@ public override IEnumerable<FileSystemInfoBase> EnumerateFileSystemInfos()

private bool IsRootDirectory(string rootDir, string filePath)
{
if (!filePath.StartsWith(rootDir, StringComparison.Ordinal) ||
filePath.IndexOf(Path.DirectorySeparatorChar, rootDir.Length) != rootDir.Length)
{
return false;
}
int rootDirLength = rootDir.Length;

return true;
return filePath.StartsWith(rootDir, StringComparison.Ordinal) &&
(rootDir[rootDirLength - 1] == Path.DirectorySeparatorChar ||
Comment thread
carlossanlop marked this conversation as resolved.
Outdated
filePath.IndexOf(Path.DirectorySeparatorChar, rootDirLength) == rootDirLength);
Comment on lines 125 to 126

@jozkee jozkee Nov 24, 2020

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Existing condition on line 126 was meant to avoid false positives when the path started with rootDir but it wasn't the complete name of the directory e.g:

var matcher = new Matcher();
matcher.AddInclude(@"**\*");

Console.WriteLine(matcher.Match(rootDir: @"C:\foo", file: @"C:\foo2\bar.cs").HasMatches); 
// prints false, which is correct.

However that same condition was interfering when rootDir = @"C:\foo\" since filePath.IndexOf(Path.DirectorySeparatorChar, rootDirLength) was always going to return the index of the separator of the next directory.

Therefore I added condition on line 125 in order to skip the length check when rootDir ends with a separator.

@iSazonov iSazonov Mar 31, 2021

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems line 126 checks one char in position rootDirLength - why do we use whole IndexOf() method instead of simple index - filePath[rootDirLength] == Path.DirectorySeparatorChar - like in line 125?

}

/// <inheritdoc />
Expand Down
154 changes: 152 additions & 2 deletions src/libraries/Microsoft.Extensions.FileSystemGlobbing/tests/FunctionalTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -635,9 +635,118 @@ public void StemIncludesAllSegmentsFromPatternStartingAtWildcard_TwoDirectoriesD
Assert.Equal(expectedStem, actualStem);
}

private List<string> GetFileList()
[Theory]
[InlineData("/", '/')]
public void RootDir_IsPathRoot_WithInMemory_AllOS(string rootDir, char separator)
{
RootDir_IsPathRoot_WithInMemory(rootDir, separator);
}

[Theory]
[PlatformSpecific(TestPlatforms.Windows)]
[InlineData("C:\\", '\\')]
[InlineData("C:/", '/')]
public void RootDir_IsPathRoot_WithInMemory_WindowsOnly(string rootDir, char separator)
{
return new List<string>
RootDir_IsPathRoot_WithInMemory(rootDir, separator);
}

private static void RootDir_IsPathRoot_WithInMemory(string rootDir, char separator)
{
var matcher = new Matcher();
matcher.AddInclude($"**{separator}*.cs");

IEnumerable<string> files = GetFileList(rootDir, separator);
PatternMatchingResult results = matcher.Match(rootDir, files);

IEnumerable<string> actual = results.Files.Select(match => match.Path);
IEnumerable<string> expected = new string[]
{
"src/project/source1.cs",
"src/project/sub/source2.cs",
"src/project/sub/source3.cs",
"src/project/sub2/source4.cs",
"src/project/sub2/source5.cs",
"src/project/compiler/preprocess/preprocess-source1.cs",
"src/project/compiler/preprocess/sub/preprocess-source2.cs",
"src/project/compiler/preprocess/sub/sub/preprocess-source3.cs",
"src/project/compiler/shared/shared1.cs",
"src/project/compiler/shared/sub/shared2.cs",
"src/project/compiler/shared/sub/sub/sharedsub.cs",
"src/project2/source1.cs",
"src/project2/sub/source2.cs",
"src/project2/sub/source3.cs",
"src/project2/sub2/source4.cs",
"src/project2/sub2/source5.cs",
"src/project2/compiler/preprocess/preprocess-source1.cs",
"src/project2/compiler/preprocess/sub/preprocess-source2.cs",
"src/project2/compiler/preprocess/sub/sub/preprocess-source3.cs",
"src/project2/compiler/shared/shared1.cs",
"src/project2/compiler/shared/sub/shared2.cs",
"src/project2/compiler/shared/sub/sub/sharedsub.cs",
"lib/source6.cs",
"lib/sub3/source7.cs",
"lib/sub4/source8.cs",
};

Assert.Equal(
expected.OrderBy(e => e),
actual.OrderBy(e => e),
StringComparer.OrdinalIgnoreCase);
}

[Theory]
[InlineData("/src/project", '/')]
[InlineData("/src/project/", '/')]
public void RootDir_IsAbsolutePath_WithInMemory_AllOS(string rootDir, char separator)
{
RootDir_IsAbsolutePath_WithInMemory(rootDir, separator);
}

[Theory]
[PlatformSpecific(TestPlatforms.Windows)]
[InlineData("C:\\src\\project", '\\')]
[InlineData("C:\\src\\project\\", '\\')]
[InlineData("C:/src/project", '/')]
[InlineData("C:/src/project/", '/')]
public void RootDir_IsAbsolutePath_WithInMemory_WindowsOnly(string rootDir, char separator)
{
RootDir_IsAbsolutePath_WithInMemory(rootDir, separator);
}

private static void RootDir_IsAbsolutePath_WithInMemory(string rootDir, char separator)
{
var matcher = new Matcher();
matcher.AddInclude($"**{separator}*.cs");

IEnumerable<string> files = GetFileList(Path.GetPathRoot(rootDir), separator);
PatternMatchingResult results = matcher.Match(rootDir, files);

IEnumerable<string> actual = results.Files.Select(match => match.Path);
IEnumerable<string> expected = new string[]
{
"source1.cs",
"sub/source2.cs",
"sub/source3.cs",
"sub2/source4.cs",
"sub2/source5.cs",
"compiler/preprocess/preprocess-source1.cs",
"compiler/preprocess/sub/preprocess-source2.cs",
"compiler/preprocess/sub/sub/preprocess-source3.cs",
"compiler/shared/shared1.cs",
"compiler/shared/sub/shared2.cs",
"compiler/shared/sub/sub/sharedsub.cs"
};

Assert.Equal(
expected.OrderBy(e => e),
actual.OrderBy(e => e),
StringComparer.OrdinalIgnoreCase);
}

private static IEnumerable<string> GetFileList(string rootDir = "", char directorySeparator = '/')
{
var files = new List<string>
{
"root/test.0",
"root/dir1/test.1",
Expand Down Expand Up @@ -693,6 +802,8 @@ private List<string> GetFileList()
".hidden/file1.hid",
".hidden/sub/file2.hid"
};

return files.Select(x => (rootDir + x).Replace('/', directorySeparator));
}

private DisposableFileSystem CreateContext()
Expand All @@ -713,5 +824,44 @@ private void ExecuteAndVerify(Matcher matcher, string directoryPath, params stri

AssertExtensions.CollectionEqual(expected, actual, StringComparer.OrdinalIgnoreCase);
}

[Fact] // https://github.com/dotnet/runtime/issues/44767
public void VerifyAbsolutePaths_HasMatches()
{
var fileMatcher = new Matcher();
fileMatcher.AddInclude("**/*");

if (PlatformDetection.IsWindows)
{
// Windows-like absolute paths are not supported on Unix.
string fakeWindowsPath = "C:\\This\\is\\a\\nested\\windows-like\\path\\somefile.cs";
Assert.True(fileMatcher.Match(Path.GetPathRoot(fakeWindowsPath), fakeWindowsPath).HasMatches);
}
Comment thread
jozkee marked this conversation as resolved.

// Unix-like absolute paths are treated as relative paths on Windows.
string fakeUnixPath = "/This/is/a/nested/unix-like/path/somefile.cs";
Assert.True(fileMatcher.Match(Path.GetPathRoot(fakeUnixPath), fakeUnixPath).HasMatches);
}

[Fact] // https://github.com/dotnet/runtime/issues/36415
public void VerifyInMemoryDirectoryInfo_IsNotEmpty()
{
IEnumerable<string> files = new[] { @"pagefile.sys" };
InMemoryDirectoryInfo directoryInfo;
IEnumerable<FileSystemInfoBase> fileSystemInfos;

if (PlatformDetection.IsWindows)
{
directoryInfo = new InMemoryDirectoryInfo(@"C:\", files);
fileSystemInfos = directoryInfo.EnumerateFileSystemInfos();

Assert.Equal(1, fileSystemInfos.Count());
}

directoryInfo = new InMemoryDirectoryInfo("/", files);
fileSystemInfos = directoryInfo.EnumerateFileSystemInfos();

Assert.Equal(1, fileSystemInfos.Count());
}
}
}