File Globbing (#197)

* File Globbing

* Distinct

* string.Equals(Path, other.Path, StringComparison.OrdinalIgnoreCase);

* Case sensitive for linux

* Print file paths

* Fix tests

Author: thomhurst

src/ModularPipelines.Build/ReleaseNotes.md

@@ -0,0 +1 @@
+*   File globbing search

src/ModularPipelines/Engine/ModuleIgnoreHandler.cs

@@ -2,7 +2,6 @@
 using EnumerableAsyncProcessor.Extensions;
 using Microsoft.Extensions.Options;
 using ModularPipelines.Attributes;
-using ModularPipelines.Extensions;
 using ModularPipelines.Modules;
 using ModularPipelines.Options;
 

src/ModularPipelines/FileSystem/File.cs

@@ -186,6 +186,11 @@ public bool Equals(File? other)
             return true;
         }
 
+        if (OperatingSystem.IsWindows())
+        {
+            return string.Equals(Path, other.Path, StringComparison.OrdinalIgnoreCase);
+        }
+
         return Path == other.Path;
     }
 

src/ModularPipelines/FileSystem/Folder.cs

@@ -1,4 +1,6 @@
 using System.Diagnostics.CodeAnalysis;
+using Microsoft.Extensions.FileSystemGlobbing;
+using Microsoft.Extensions.FileSystemGlobbing.Abstractions;
 
 namespace ModularPipelines.FileSystem;
 
@@ -105,11 +107,23 @@ public Folder MoveTo(string path)
 
     public IEnumerable<Folder> GetFolders(Func<Folder, bool> predicate) => DirectoryInfo.EnumerateDirectories("*", SearchOption.AllDirectories)
         .Select(x => new Folder(x))
+        .Distinct()
         .Where(predicate);
 
     public IEnumerable<File> GetFiles(Func<File, bool> predicate) => DirectoryInfo.EnumerateFiles("*", SearchOption.AllDirectories)
         .Select(x => new File(x))
+        .Distinct()
         .Where(predicate);
+    
+    public IEnumerable<File> GetFiles(string globPattern)
+    {
+        return new Matcher(StringComparison.OrdinalIgnoreCase)
+            .AddInclude(globPattern)
+            .Execute(new DirectoryInfoWrapper(DirectoryInfo))
+            .Files
+            .Select(x => new File(x.Path))
+            .Distinct();
+    }
 
     public File? FindFile(Func<File, bool> predicate) => GetFiles(predicate).FirstOrDefault();
 
@@ -118,13 +132,15 @@ public IEnumerable<File> GetFiles(Func<File, bool> predicate) => DirectoryInfo.E
     public IEnumerable<File> ListFiles()
     {
         return DirectoryInfo.EnumerateFiles("*", SearchOption.TopDirectoryOnly)
-            .Select(x => new File(x));
+            .Select(x => new File(x))
+            .Distinct();
     }
 
     public IEnumerable<Folder> ListFolders()
     {
         return DirectoryInfo.EnumerateDirectories("*", SearchOption.TopDirectoryOnly)
-            .Select(x => new Folder(x));
+            .Select(x => new Folder(x))
+            .Distinct();
     }
 
     public static Folder CreateTemporaryFolder()
@@ -179,6 +195,11 @@ public bool Equals(Folder? other)
             return true;
         }
 
+        if (OperatingSystem.IsWindows())
+        {
+            return string.Equals(Path, other.Path, StringComparison.OrdinalIgnoreCase);
+        }
+
         return Path == other.Path;
     }
 

test/ModularPipelines.UnitTests/Data/Nest1/Nest2/Nest3/Nest4/Nest5/Blah.txt

@@ -0,0 +1 @@
+Blah!

…odularPipelines.UnitTests/Data/Lorem.txt …arPipelines.UnitTests/Data/Zip/Lorem.txttest/ModularPipelines.UnitTests/Data/Lorem.txt renamed to test/ModularPipelines.UnitTests/Data/Zip/Lorem.txt test/ModularPipelines.UnitTests/Data/Lorem.txt renamed to test/ModularPipelines.UnitTests/Data/Zip/Lorem.txt

@@ -1,5 +1,6 @@
 using System.Globalization;
 using ModularPipelines.Extensions;
+using ModularPipelines.FileSystem;
 using ModularPipelines.UnitTests.Attributes;
 using File = ModularPipelines.FileSystem.File;
 
@@ -298,6 +299,31 @@ public void EqualityFalse()
         });
     }
 
+    [TestCase("**/Nest2/**/*.txt")]
+    [TestCase("**/blah.txt")]
+    [TestCase("**/Blah.txt")]
+    [TestCase("**/Nest1/Nest2/Nest3/Nest4/Nest5/*.txt")]
+    public void GlobTests(string globPattern)
+    {
+        var workingDirectory = new Folder(Environment.CurrentDirectory);
+        var files = workingDirectory.GetFiles(globPattern).ToList();
+        
+        Assert.That(files, Has.Count.EqualTo(1));
+        Assert.That(files[0].Name, Is.EqualTo("Blah.txt"));
+    }
+    
+    [Test]
+    public void GlobTest2()
+    {
+        var folder = new Folder(Environment.CurrentDirectory)
+            .FindFolder(x => x.Name == "Nest5")!;
+        
+        var files = folder.GetFiles("Blah.txt").ToList();
+        
+        Assert.That(files, Has.Count.EqualTo(1));
+        Assert.That(files[0].Name, Is.EqualTo("Blah.txt"));
+    }
+
     private static async Task<File> CreateRandomFile()
     {
         var path = File.GetNewTemporaryFilePath();

test/ModularPipelines.UnitTests/FileTests.cs

@@ -14,7 +14,10 @@ private class ZipModule : Module<string>
         {
             await Task.Yield();
 
-            var directory = context.Git().RootDirectory.GetFolder("test").GetFolder("ModularPipelines.UnitTests").GetFolder("Data");
+            var directory = context.Git().RootDirectory.GetFolder("test")
+                .GetFolder("ModularPipelines.UnitTests")
+                .GetFolder("Data")
+                .GetFolder("Zip");
 
             var fileToWrite = context.Environment.WorkingDirectory.GetFile("LoremData.zip");
 
@@ -98,7 +101,7 @@ public async Task UnZipped_Folder_Exists()
         Assert.Multiple(() =>
         {
             Assert.That(expectedFolder.Exists, Is.True);
-            Assert.That(expectedFolder.GetFiles("*", SearchOption.AllDirectories), Has.Length.GreaterThanOrEqualTo(1));
+            Assert.That(expectedFolder.GetFiles("*", SearchOption.AllDirectories), Has.Length.EqualTo(1));
         });
     }
 }

test/ModularPipelines.UnitTests/Helpers/ZipTests.cs

@@ -47,14 +47,9 @@
     </ItemGroup>
 
     <ItemGroup>
-      <None Update="Data\Foo.txt">
-        <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
-      </None>
-      <None Update="Data\BashTest.sh">
-        <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
-      </None>
+        <None Update="Data\**">
+            <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+        </None>
     </ItemGroup>
-
-
-
+    
 </Project>