From 0ca352703dd6dc72f9be3f0e59ccab4ecdfb6a95 Mon Sep 17 00:00:00 2001 From: Vladimir Pecanac Date: Fri, 13 Nov 2026 13:05:24 +0100 Subject: [PATCH] Directory and DirectoryInfo sample: net11.0, xUnit 2.9.3, temp-folder paths, MoveTo and traversal examples Retarget both projects to net11.0 and update the test packages. CreateADirectory returns Directory.CreateDirectory directly, DeleteEmptyDirectory added, CreateSubDirectories returns the new DirectoryInfo and EnumerateDirectories prints names. New SafePaths.ResolveInside traversal check. GrantFullControl replaces GetSetAccessControl and is marked Windows-only. Program.cs runs the article's snippets in order under the temp folder. Each test class uses its own temp folder and implements IDisposable; new tests cover CreateDirectory on an existing directory, Delete on a non-empty directory, MoveTo, and the traversal check. --- .../DirectoryAndDirectoryInfo.csproj | 2 +- .../DirectoryInfoMethods.cs | 6 +- .../DirectoryMethods.cs | 21 ++--- .../DirectorySecurityAndPermissions.cs | 12 ++- .../DirectoryAndDirectoryInfo/Program.cs | 65 +++++++++++++-- .../DirectoryAndDirectoryInfo/SafePaths.cs | 14 ++++ .../Tests/DirectoryInfoTests.cs | 79 ++++++++++++++----- .../Tests/DirectoryTest.cs | 59 ++++++++++---- .../Tests/SafePathsTests.cs | 30 +++++++ .../Tests/Tests.csproj | 10 +-- 10 files changed, 230 insertions(+), 68 deletions(-) create mode 100644 files-csharp/DirectoryAndDirectoryInfo/DirectoryAndDirectoryInfo/SafePaths.cs create mode 100644 files-csharp/DirectoryAndDirectoryInfo/Tests/SafePathsTests.cs diff --git a/files-csharp/DirectoryAndDirectoryInfo/DirectoryAndDirectoryInfo/DirectoryAndDirectoryInfo.csproj b/files-csharp/DirectoryAndDirectoryInfo/DirectoryAndDirectoryInfo/DirectoryAndDirectoryInfo.csproj index f02677bf64..5bf6c9b8cf 100644 --- a/files-csharp/DirectoryAndDirectoryInfo/DirectoryAndDirectoryInfo/DirectoryAndDirectoryInfo.csproj +++ b/files-csharp/DirectoryAndDirectoryInfo/DirectoryAndDirectoryInfo/DirectoryAndDirectoryInfo.csproj @@ -2,7 +2,7 @@ Exe - net7.0 + net11.0 enable enable diff --git a/files-csharp/DirectoryAndDirectoryInfo/DirectoryAndDirectoryInfo/DirectoryInfoMethods.cs b/files-csharp/DirectoryAndDirectoryInfo/DirectoryAndDirectoryInfo/DirectoryInfoMethods.cs index 19ee789b7c..25d95db12f 100644 --- a/files-csharp/DirectoryAndDirectoryInfo/DirectoryAndDirectoryInfo/DirectoryInfoMethods.cs +++ b/files-csharp/DirectoryAndDirectoryInfo/DirectoryAndDirectoryInfo/DirectoryInfoMethods.cs @@ -2,9 +2,9 @@ { public class DirectoryInfoMethods { - public void CreateSubDirectories(DirectoryInfo directory, string subDirectory) + public DirectoryInfo CreateSubDirectories(DirectoryInfo directory, string subDirectory) { - directory.CreateSubdirectory(subDirectory); + return directory.CreateSubdirectory(subDirectory); } public void MoveDirectories(DirectoryInfo sourceDirectory, string destDirectory) @@ -16,7 +16,7 @@ public void EnumerateDirectories(DirectoryInfo directoryInfo) { foreach (var subdirectory in directoryInfo.EnumerateDirectories()) { - Console.WriteLine(subdirectory.FullName); + Console.WriteLine(subdirectory.Name); } } } diff --git a/files-csharp/DirectoryAndDirectoryInfo/DirectoryAndDirectoryInfo/DirectoryMethods.cs b/files-csharp/DirectoryAndDirectoryInfo/DirectoryAndDirectoryInfo/DirectoryMethods.cs index 81dbf21b3f..8e1a49186e 100644 --- a/files-csharp/DirectoryAndDirectoryInfo/DirectoryAndDirectoryInfo/DirectoryMethods.cs +++ b/files-csharp/DirectoryAndDirectoryInfo/DirectoryAndDirectoryInfo/DirectoryMethods.cs @@ -2,22 +2,15 @@ { public class DirectoryMethods { - public static DirectoryInfo? CreateADirectory(string path) + public static DirectoryInfo CreateADirectory(string path) { - try - { - if (Directory.Exists(path)) - { - return new DirectoryInfo(path); - } + var newDirectory = Directory.CreateDirectory(path); + return newDirectory; + } - var newDirectory = Directory.CreateDirectory(path); - return newDirectory; - } - catch (Exception) - { - return null; - } + public static void DeleteEmptyDirectory(string path) + { + Directory.Delete(path); } public static void DeleteDirectory(string path) diff --git a/files-csharp/DirectoryAndDirectoryInfo/DirectoryAndDirectoryInfo/DirectorySecurityAndPermissions.cs b/files-csharp/DirectoryAndDirectoryInfo/DirectoryAndDirectoryInfo/DirectorySecurityAndPermissions.cs index c7c1b4a7ff..2f8ef4feed 100644 --- a/files-csharp/DirectoryAndDirectoryInfo/DirectoryAndDirectoryInfo/DirectorySecurityAndPermissions.cs +++ b/files-csharp/DirectoryAndDirectoryInfo/DirectoryAndDirectoryInfo/DirectorySecurityAndPermissions.cs @@ -1,17 +1,21 @@ -using System.Security.AccessControl; +using System.Runtime.Versioning; +using System.Security.AccessControl; namespace DirectoryAndDirectoryInfo { public class DirectorySecurityAndPermissions { - public void GetSetAccessControl() + [SupportedOSPlatform("windows")] + public void GrantFullControl(string directoryPath, string identity) { - var directoryPath = @"C:\Users\Public\CM-Demos"; var directoryInfo = new DirectoryInfo(directoryPath); DirectorySecurity directorySecurity = directoryInfo.GetAccessControl(); - directorySecurity.AddAccessRule(new FileSystemAccessRule("UserName", FileSystemRights.FullControl, AccessControlType.Allow)); + directorySecurity.AddAccessRule(new FileSystemAccessRule( + identity, + FileSystemRights.FullControl, + AccessControlType.Allow)); directoryInfo.SetAccessControl(directorySecurity); } diff --git a/files-csharp/DirectoryAndDirectoryInfo/DirectoryAndDirectoryInfo/Program.cs b/files-csharp/DirectoryAndDirectoryInfo/DirectoryAndDirectoryInfo/Program.cs index a427647357..47f7047956 100644 --- a/files-csharp/DirectoryAndDirectoryInfo/DirectoryAndDirectoryInfo/Program.cs +++ b/files-csharp/DirectoryAndDirectoryInfo/DirectoryAndDirectoryInfo/Program.cs @@ -1,8 +1,61 @@ -// See https://aka.ms/new-console-template for more information -using DirectoryAndDirectoryInfo; +using DirectoryAndDirectoryInfo; -var path = @"C:\Public\CM-Demos"; +var path = Path.Combine(Path.GetTempPath(), "CM-Demos"); -DirectoryMethods.CreateADirectory(path); -DirectoryMethods.GetFilesInDirectory(path); -DirectoryMethods.DeleteDirectory(path); +// Create a directory, then ask for the same one again +var newDirectory = Directory.CreateDirectory(path); +File.WriteAllText(Path.Combine(path, "notes.txt"), "Keep me"); + +var sameDirectory = Directory.CreateDirectory(path); +Console.WriteLine($"{sameDirectory.Name} exists: {sameDirectory.Exists}"); +Console.WriteLine($"Files kept: {Directory.GetFiles(path).Length}"); + +// Delete without the recursive flag +try +{ + Directory.Delete(path); +} +catch (IOException ex) +{ + Console.WriteLine($"{ex.GetType().Name}: the directory is not empty"); +} + +// Create subdirectories +var directory = new DirectoryInfo(path); +var subDirectory = directory.CreateSubdirectory("SubFolder"); + +// Move a directory +var sourceDirectory = new DirectoryInfo(path); +var destDirectory = Path.Combine(Path.GetTempPath(), "CM-Demos-Moved"); + +sourceDirectory.MoveTo(destDirectory); + +Console.WriteLine(sourceDirectory.Name); +Console.WriteLine(sourceDirectory.GetFiles().Length); +Console.WriteLine(Directory.Exists(path)); + +Console.WriteLine(subDirectory.Exists); + +// Enumerate directories +var directoryInfo = new DirectoryInfo(destDirectory); +foreach (var subdirectory in directoryInfo.EnumerateDirectories()) +{ + Console.WriteLine(subdirectory.Name); +} + +// Directory traversal check +var uploads = Path.Combine(destDirectory, "SubFolder"); +foreach (var userInput in new[] { "report.txt", "../notes.txt", "../SubFolder2/report.txt" }) +{ + var resolved = SafePaths.ResolveInside(uploads, userInput); + Console.WriteLine($"{userInput} -> {(resolved is null ? "rejected" : "allowed")}"); +} + +// Directory security (Windows only) +if (OperatingSystem.IsWindows()) +{ + var identity = $@"{Environment.UserDomainName}\{Environment.UserName}"; + new DirectorySecurityAndPermissions().GrantFullControl(destDirectory, identity); +} + +Directory.Delete(destDirectory, true); diff --git a/files-csharp/DirectoryAndDirectoryInfo/DirectoryAndDirectoryInfo/SafePaths.cs b/files-csharp/DirectoryAndDirectoryInfo/DirectoryAndDirectoryInfo/SafePaths.cs new file mode 100644 index 0000000000..713b6bbbab --- /dev/null +++ b/files-csharp/DirectoryAndDirectoryInfo/DirectoryAndDirectoryInfo/SafePaths.cs @@ -0,0 +1,14 @@ +namespace DirectoryAndDirectoryInfo +{ + public static class SafePaths + { + public static string? ResolveInside(string rootDirectory, string userInput) + { + var root = Path.TrimEndingDirectorySeparator(Path.GetFullPath(rootDirectory)) + + Path.DirectorySeparatorChar; + var fullPath = Path.GetFullPath(Path.Join(root, userInput)); + + return fullPath.StartsWith(root, StringComparison.Ordinal) ? fullPath : null; + } + } +} diff --git a/files-csharp/DirectoryAndDirectoryInfo/Tests/DirectoryInfoTests.cs b/files-csharp/DirectoryAndDirectoryInfo/Tests/DirectoryInfoTests.cs index b3ec3977a9..354b00bf4e 100644 --- a/files-csharp/DirectoryAndDirectoryInfo/Tests/DirectoryInfoTests.cs +++ b/files-csharp/DirectoryAndDirectoryInfo/Tests/DirectoryInfoTests.cs @@ -4,7 +4,8 @@ namespace Tests { public class DirectoryInfoMethodsTests : IDisposable { - private readonly string _testDirectoryPath = @"C:\Public\CM-Demos\Test"; + private readonly string _testDirectoryPath = + Path.Combine(Path.GetTempPath(), "CM-Demos-Tests", Guid.NewGuid().ToString()); public DirectoryInfoMethodsTests() { @@ -14,61 +15,97 @@ public DirectoryInfoMethodsTests() [Fact] public void WhenCreateSubDirectoriesIsCalled_ShouldCreateSubDirectory() { - // Arrange var directoryInfoMethods = new DirectoryInfoMethods(); var directoryInfo = new DirectoryInfo(_testDirectoryPath); - var subDirectory = "SubFolder"; - var subDirectoryPath = Path.Combine(_testDirectoryPath, subDirectory); + var subDirectoryPath = Path.Combine(_testDirectoryPath, "SubFolder"); - // Act - directoryInfoMethods.CreateSubDirectories(directoryInfo, subDirectory); + directoryInfoMethods.CreateSubDirectories(directoryInfo, "SubFolder"); - // Assert Assert.True(Directory.Exists(subDirectoryPath)); } + [Fact] + public void GivenMissingParent_WhenCreateSubDirectoriesIsCalled_ThenParentIsCreatedToo() + { + var directoryInfoMethods = new DirectoryInfoMethods(); + var parent = new DirectoryInfo(Path.Combine(_testDirectoryPath, "NotYetThere")); + + var subDirectory = directoryInfoMethods.CreateSubDirectories(parent, "SubFolder"); + + Assert.True(Directory.Exists(parent.FullName)); + Assert.True(subDirectory.Exists); + } + [Fact] public void WhenSourceDirectoryInfoIsMoved_ShouldDeleteOldDirectoryPath() { - // Arrange var directoryInfoMethods = new DirectoryInfoMethods(); var sourceDirectoryPath = Path.Combine(_testDirectoryPath, "Directory"); var sourceDirectoryInfo = Directory.CreateDirectory(sourceDirectoryPath); var destDirectoryPath = Path.Combine(_testDirectoryPath, "NewDirectory"); - - // Act directoryInfoMethods.MoveDirectories(sourceDirectoryInfo, destDirectoryPath); - // Assert Assert.False(Directory.Exists(sourceDirectoryPath)); Assert.True(Directory.Exists(destDirectoryPath)); } [Fact] - public void WhenEnumerateDirectoriesIsCalled_ShouldPrintSubDirectoriesToConsole() + public void GivenMovedDirectory_WhenTheSameReferenceIsUsed_ThenItPointsToTheNewPath() + { + var directoryInfoMethods = new DirectoryInfoMethods(); + var sourceDirectoryInfo = Directory.CreateDirectory(Path.Combine(_testDirectoryPath, "Directory")); + File.WriteAllText(Path.Combine(sourceDirectoryInfo.FullName, "notes.txt"), "x"); + var subDirectory = sourceDirectoryInfo.CreateSubdirectory("SubFolder"); + + directoryInfoMethods.MoveDirectories(sourceDirectoryInfo, Path.Combine(_testDirectoryPath, "NewDirectory")); + + Assert.Equal("NewDirectory", sourceDirectoryInfo.Name); + Assert.Single(sourceDirectoryInfo.GetFiles()); + Assert.False(subDirectory.Exists); + Assert.Throws(() => subDirectory.GetFiles()); + } + + [Fact] + public void GivenSubDirectoryOfItself_WhenMoveDirectoriesIsCalled_ThenIOExceptionIsThrown() { - // Arrange - var directoryMethods = new DirectoryInfoMethods(); + var directoryInfoMethods = new DirectoryInfoMethods(); + var sourceDirectoryInfo = Directory.CreateDirectory(Path.Combine(_testDirectoryPath, "Directory")); + + Assert.Throws(() => directoryInfoMethods.MoveDirectories( + sourceDirectoryInfo, Path.Combine(sourceDirectoryInfo.FullName, "NewDirectory"))); + } + + [Fact] + public void WhenEnumerateDirectoriesIsCalled_ShouldPrintSubDirectoryNames() + { + var directoryInfoMethods = new DirectoryInfoMethods(); var directoryInfo = new DirectoryInfo(_testDirectoryPath); + directoryInfo.CreateSubdirectory("Archive"); + directoryInfo.CreateSubdirectory("SubFolder"); var output = new StringWriter(); + var originalOut = Console.Out; Console.SetOut(output); - // Act - directoryMethods.EnumerateDirectories(directoryInfo); + try + { + directoryInfoMethods.EnumerateDirectories(directoryInfo); + } + finally + { + Console.SetOut(originalOut); + } - // Assert - if (!directoryInfo.GetDirectories().Any()) - Assert.Equal(string.Empty, output.ToString()); + var names = output.ToString().Split(Environment.NewLine, StringSplitOptions.RemoveEmptyEntries); + Assert.Equal(["Archive", "SubFolder"], names.Order()); } public void Dispose() { - // Clean up the test directory after tests if (Directory.Exists(_testDirectoryPath)) { Directory.Delete(_testDirectoryPath, true); } } } -} \ No newline at end of file +} diff --git a/files-csharp/DirectoryAndDirectoryInfo/Tests/DirectoryTest.cs b/files-csharp/DirectoryAndDirectoryInfo/Tests/DirectoryTest.cs index b946c6b7d7..e006a55887 100644 --- a/files-csharp/DirectoryAndDirectoryInfo/Tests/DirectoryTest.cs +++ b/files-csharp/DirectoryAndDirectoryInfo/Tests/DirectoryTest.cs @@ -2,9 +2,10 @@ namespace Tests { - public class DirectoryMethodsTests + public class DirectoryMethodsTests : IDisposable { - private readonly string _testDirectoryPath = @"C:\Public\CM-Demos\Test"; + private readonly string _testDirectoryPath = + Path.Combine(Path.GetTempPath(), "CM-Demos-Tests", Guid.NewGuid().ToString()); public DirectoryMethodsTests() { @@ -12,37 +13,67 @@ public DirectoryMethodsTests() } [Fact] - public void WhenCreateADirectoryIsCallled_ShouldReturnDirectoryInfo() + public void WhenCreateADirectoryIsCalled_ShouldReturnDirectoryInfo() { - // Arrange var path = Path.Combine(_testDirectoryPath, "test_directory"); - // Act - DirectoryInfo? result = DirectoryMethods.CreateADirectory(path); + DirectoryInfo result = DirectoryMethods.CreateADirectory(path); - // Assert - Assert.NotNull(result); + Assert.True(result.Exists); + Assert.True(Directory.Exists(path)); } [Fact] - public void WhenDeleteDirectoryIsCalled_ShouldDeletesDirectory() + public void GivenExistingDirectory_WhenCreateADirectoryIsCalledAgain_ThenItReturnsTheSameDirectoryAndKeepsItsFiles() { - // Act + var path = Path.Combine(_testDirectoryPath, "existing"); + DirectoryMethods.CreateADirectory(path); + File.WriteAllText(Path.Combine(path, "notes.txt"), "Keep me"); + + DirectoryInfo result = DirectoryMethods.CreateADirectory(path); + + Assert.True(result.Exists); + Assert.Single(Directory.GetFiles(path)); + } + + [Fact] + public void GivenNonEmptyDirectory_WhenDeleteEmptyDirectoryIsCalled_ThenIOExceptionIsThrown() + { + File.WriteAllText(Path.Combine(_testDirectoryPath, "notes.txt"), "Keep me"); + + Assert.Throws(() => DirectoryMethods.DeleteEmptyDirectory(_testDirectoryPath)); + Assert.True(Directory.Exists(_testDirectoryPath)); + } + + [Fact] + public void WhenDeleteDirectoryIsCalled_ShouldDeleteDirectoryAndItsContents() + { + Directory.CreateDirectory(Path.Combine(_testDirectoryPath, "SubFolder")); + File.WriteAllText(Path.Combine(_testDirectoryPath, "notes.txt"), "Delete me"); + DirectoryMethods.DeleteDirectory(_testDirectoryPath); - // Assert Assert.False(Directory.Exists(_testDirectoryPath)); } + [Fact] + public void WhenGetFilesAndGetDirectoriesAreCalled_ShouldReturnFullPaths() + { + var filePath = Path.Combine(_testDirectoryPath, "notes.txt"); + var subDirectoryPath = Path.Combine(_testDirectoryPath, "SubFolder"); + File.WriteAllText(filePath, "x"); + Directory.CreateDirectory(subDirectoryPath); + + Assert.Equal([filePath], DirectoryMethods.GetFilesInDirectory(_testDirectoryPath)); + Assert.Equal([subDirectoryPath], DirectoryMethods.GetDirectories(_testDirectoryPath)); + } + public void Dispose() { - // Clean up the test directory after tests if (Directory.Exists(_testDirectoryPath)) { Directory.Delete(_testDirectoryPath, true); } } - } } - diff --git a/files-csharp/DirectoryAndDirectoryInfo/Tests/SafePathsTests.cs b/files-csharp/DirectoryAndDirectoryInfo/Tests/SafePathsTests.cs new file mode 100644 index 0000000000..a8a37dfad6 --- /dev/null +++ b/files-csharp/DirectoryAndDirectoryInfo/Tests/SafePathsTests.cs @@ -0,0 +1,30 @@ +using DirectoryAndDirectoryInfo; + +namespace Tests +{ + public class SafePathsTests + { + private readonly string _root = Path.Combine(Path.GetTempPath(), "CM-Demos", "SubFolder"); + + [Theory] + [InlineData("report.txt")] + [InlineData("reports/2026/report.txt")] + [InlineData("reports/../report.txt")] + public void GivenPathInsideRoot_WhenResolveInsideIsCalled_ThenFullPathIsReturned(string userInput) + { + var resolved = SafePaths.ResolveInside(_root, userInput); + + Assert.NotNull(resolved); + Assert.StartsWith(_root + Path.DirectorySeparatorChar, resolved); + } + + [Theory] + [InlineData("../notes.txt")] + [InlineData("../../secret.txt")] + [InlineData("../SubFolder2/report.txt")] + public void GivenPathOutsideRoot_WhenResolveInsideIsCalled_ThenNullIsReturned(string userInput) + { + Assert.Null(SafePaths.ResolveInside(_root, userInput)); + } + } +} diff --git a/files-csharp/DirectoryAndDirectoryInfo/Tests/Tests.csproj b/files-csharp/DirectoryAndDirectoryInfo/Tests/Tests.csproj index 0e2a98ae44..3461a1c51f 100644 --- a/files-csharp/DirectoryAndDirectoryInfo/Tests/Tests.csproj +++ b/files-csharp/DirectoryAndDirectoryInfo/Tests/Tests.csproj @@ -1,7 +1,7 @@ - net7.0 + net11.0 enable enable @@ -10,13 +10,13 @@ - - - + + + runtime; build; native; contentfiles; analyzers; buildtransitive all - + runtime; build; native; contentfiles; analyzers; buildtransitive all