(cake-buildGH-2199) Add GlobPattern class

* fixes cake-build#2199
devlead · Oct 22, 2020 · fb87ca2 · fb87ca2
1 parent 6ed66fb
commit fb87ca2
Show file tree

Hide file tree

Showing 32 changed files with 235 additions and 61 deletions.
diff --git a/src/Cake.Common.Tests/Unit/Security/DirectoryHashCalculatorTests.cs b/src/Cake.Common.Tests/Unit/Security/DirectoryHashCalculatorTests.cs
@@ -24,7 +24,7 @@ public void Should_Throw_If_Directory_Path_Is_Null()
                 var calculator = new DirectoryHashCalculator(cakeContext, hashAlgorithmBuilder);
 
                 // When
-                var result = Record.Exception(() => calculator.Calculate(null, null, HashAlgorithm.MD5));
+                var result = Record.Exception(() => calculator.Calculate(null, null as string[], HashAlgorithm.MD5));
 
                 // Then
                 AssertEx.IsArgumentNullException(result, "directoryPath");

diff --git a/src/Cake.Common/IO/DirectoryAliases.cs b/src/Cake.Common/IO/DirectoryAliases.cs
@@ -151,7 +151,7 @@ public static void DeleteDirectory(this ICakeContext context, DirectoryPath path
         /// <param name="pattern">The pattern to match.</param>
         [CakeMethodAlias]
         [CakeAliasCategory("Clean")]
-        public static void CleanDirectories(this ICakeContext context, string pattern)
+        public static void CleanDirectories(this ICakeContext context, GlobPattern pattern)
         {
             var directories = context.GetDirectories(pattern);
             if (directories.Count == 0)
@@ -180,7 +180,7 @@ public static void CleanDirectories(this ICakeContext context, string pattern)
         /// <param name="predicate">The predicate used to filter directories based on file system information.</param>
         [CakeMethodAlias]
         [CakeAliasCategory("Clean")]
-        public static void CleanDirectories(this ICakeContext context, string pattern, Func<IFileSystemInfo, bool> predicate)
+        public static void CleanDirectories(this ICakeContext context, GlobPattern pattern, Func<IFileSystemInfo, bool> predicate)
         {
             var directories = context.GetDirectories(pattern, new GlobberSettings { Predicate = predicate });
             if (directories.Count == 0)

diff --git a/src/Cake.Common/IO/FileAliases.cs b/src/Cake.Common/IO/FileAliases.cs
@@ -100,7 +100,7 @@ public static void CopyFile(this ICakeContext context, FilePath filePath, FilePa
         /// </example>
         [CakeMethodAlias]
         [CakeAliasCategory("Copy")]
-        public static void CopyFiles(this ICakeContext context, string pattern, DirectoryPath targetDirectoryPath)
+        public static void CopyFiles(this ICakeContext context, GlobPattern pattern, DirectoryPath targetDirectoryPath)
         {
             FileCopier.CopyFiles(context, pattern, targetDirectoryPath, false);
         }
@@ -166,7 +166,7 @@ public static void CopyFiles(this ICakeContext context, IEnumerable<string> file
         /// </example>
         [CakeMethodAlias]
         [CakeAliasCategory("Copy")]
-        public static void CopyFiles(this ICakeContext context, string pattern, DirectoryPath targetDirectoryPath, bool preserveFolderStructure)
+        public static void CopyFiles(this ICakeContext context, GlobPattern pattern, DirectoryPath targetDirectoryPath, bool preserveFolderStructure)
         {
             FileCopier.CopyFiles(context, pattern, targetDirectoryPath, preserveFolderStructure);
         }
@@ -251,7 +251,7 @@ public static void MoveFileToDirectory(this ICakeContext context, FilePath fileP
         /// </example>
         [CakeMethodAlias]
         [CakeAliasCategory("Move")]
-        public static void MoveFiles(this ICakeContext context, string pattern, DirectoryPath targetDirectoryPath)
+        public static void MoveFiles(this ICakeContext context, GlobPattern pattern, DirectoryPath targetDirectoryPath)
         {
             FileMover.MoveFiles(context, pattern, targetDirectoryPath);
         }
@@ -305,7 +305,7 @@ public static void MoveFile(this ICakeContext context, FilePath filePath, FilePa
         /// </example>
         [CakeMethodAlias]
         [CakeAliasCategory("Delete")]
-        public static void DeleteFiles(this ICakeContext context, string pattern)
+        public static void DeleteFiles(this ICakeContext context, GlobPattern pattern)
         {
             FileDeleter.DeleteFiles(context, pattern);
         }

diff --git a/src/Cake.Common/IO/FileCopier.cs b/src/Cake.Common/IO/FileCopier.cs
@@ -60,7 +60,7 @@ public static void CopyFile(ICakeContext context, FilePath filePath, FilePath ta
             CopyFileCore(context, filePath, targetFilePath, null);
         }
 
-        public static void CopyFiles(ICakeContext context, string pattern, DirectoryPath targetDirectoryPath, bool preserverFolderStructure)
+        public static void CopyFiles(ICakeContext context, GlobPattern pattern, DirectoryPath targetDirectoryPath, bool preserverFolderStructure)
         {
             if (context == null)
             {

diff --git a/src/Cake.Common/IO/FileDeleter.cs b/src/Cake.Common/IO/FileDeleter.cs
@@ -14,7 +14,7 @@ namespace Cake.Common.IO
 {
     internal static class FileDeleter
     {
-        public static void DeleteFiles(ICakeContext context, string pattern)
+        public static void DeleteFiles(ICakeContext context, GlobPattern pattern)
         {
             if (context == null)
             {

diff --git a/src/Cake.Common/IO/FileMover.cs b/src/Cake.Common/IO/FileMover.cs
@@ -31,7 +31,7 @@ public static void MoveFileToDirectory(ICakeContext context, FilePath filePath,
             MoveFile(context, filePath, targetDirectoryPath.GetFilePath(filePath));
         }
 
-        public static void MoveFiles(ICakeContext context, string pattern, DirectoryPath targetDirectoryPath)
+        public static void MoveFiles(ICakeContext context, GlobPattern pattern, DirectoryPath targetDirectoryPath)
         {
             if (context == null)
             {

diff --git a/src/Cake.Common/IO/GlobbingAliases.cs b/src/Cake.Common/IO/GlobbingAliases.cs
@@ -33,7 +33,7 @@ public static class GlobbingAliases
         /// <returns>A <see cref="FilePathCollection" />.</returns>
         [CakeMethodAlias]
         [CakeAliasCategory("Files")]
-        public static FilePathCollection GetFiles(this ICakeContext context, string pattern)
+        public static FilePathCollection GetFiles(this ICakeContext context, GlobPattern pattern)
         {
             if (context == null)
             {
@@ -65,7 +65,7 @@ public static FilePathCollection GetFiles(this ICakeContext context, string patt
         /// <returns>A <see cref="FilePathCollection" />.</returns>
         [CakeMethodAlias]
         [CakeAliasCategory("Files")]
-        public static FilePathCollection GetFiles(this ICakeContext context, string pattern, GlobberSettings settings)
+        public static FilePathCollection GetFiles(this ICakeContext context, GlobPattern pattern, GlobberSettings settings)
         {
             if (context == null)
             {
@@ -92,7 +92,7 @@ public static FilePathCollection GetFiles(this ICakeContext context, string patt
         /// <returns>A <see cref="DirectoryPathCollection" />.</returns>
         [CakeMethodAlias]
         [CakeAliasCategory("Directories")]
-        public static DirectoryPathCollection GetDirectories(this ICakeContext context, string pattern)
+        public static DirectoryPathCollection GetDirectories(this ICakeContext context, GlobPattern pattern)
         {
             if (context == null)
             {
@@ -124,7 +124,7 @@ public static DirectoryPathCollection GetDirectories(this ICakeContext context,
         /// <returns>A <see cref="DirectoryPathCollection" />.</returns>
         [CakeMethodAlias]
         [CakeAliasCategory("Directories")]
-        public static DirectoryPathCollection GetDirectories(this ICakeContext context, string pattern, GlobberSettings settings)
+        public static DirectoryPathCollection GetDirectories(this ICakeContext context, GlobPattern pattern, GlobberSettings settings)
         {
             if (context == null)
             {
@@ -151,7 +151,7 @@ public static DirectoryPathCollection GetDirectories(this ICakeContext context,
         /// <returns>A <see cref="PathCollection" />.</returns>
         [CakeMethodAlias]
         [CakeAliasCategory("Paths")]
-        public static PathCollection GetPaths(this ICakeContext context, string pattern)
+        public static PathCollection GetPaths(this ICakeContext context, GlobPattern pattern)
         {
             if (context == null)
             {
@@ -183,7 +183,7 @@ public static PathCollection GetPaths(this ICakeContext context, string pattern)
         /// <returns>A <see cref="PathCollection" />.</returns>
         [CakeMethodAlias]
         [CakeAliasCategory("Paths")]
-        public static PathCollection GetPaths(this ICakeContext context, string pattern, GlobberSettings settings)
+        public static PathCollection GetPaths(this ICakeContext context, GlobPattern pattern, GlobberSettings settings)
         {
             if (context == null)
             {

diff --git a/src/Cake.Common/Security/DirectoryHashCalculator.cs b/src/Cake.Common/Security/DirectoryHashCalculator.cs
@@ -56,7 +56,7 @@ public DirectoryHashCalculator(ICakeContext context, IHashAlgorithmBuilder hashA
         /// </example>
         public DirectoryHash Calculate(
             DirectoryPath directoryPath,
-            IEnumerable<string> pattern,
+            IEnumerable<GlobPattern> pattern,
             HashAlgorithm hashAlgorithm)
         {
             if (directoryPath == null)
@@ -104,9 +104,44 @@ public DirectoryHash Calculate(
             }
         }
 
+        /// <summary>
+        /// Calculates the hash for a given directory.
+        /// </summary>
+        /// <param name="directoryPath">The directory path.</param>
+        /// <param name="pattern">The glob pattern to match.</param>
+        /// <param name="hashAlgorithm">The hash algorithm to use.</param>
+        /// <returns>A <see cref="DirectoryHash"/> instance representing the calculated hash.</returns>
+        /// <example>
+        /// <code>
+        /// Information(
+        ///     "Cake It calculates the hashes from all cs files in all subdirectories using a MD5 hash: {0}",
+        ///     CalculateDirectoryHash("C:\directoryToHash", "./**/*.cs", HashAlgorithm.MD5).ToHex());
+        /// </code>
+        /// </example>
+        public DirectoryHash Calculate(
+            DirectoryPath directoryPath,
+            IEnumerable<string> pattern,
+            HashAlgorithm hashAlgorithm)
+        {
+            if (directoryPath == null)
+            {
+                throw new ArgumentNullException(nameof(directoryPath));
+            }
+
+            if (pattern == null)
+            {
+                throw new ArgumentNullException(nameof(pattern));
+            }
+
+            return Calculate(
+                directoryPath,
+                pattern.Select(GlobPattern.FromString),
+                hashAlgorithm);
+        }
+
         private FilePathCollection GetDirectoryFiles(
             DirectoryPath directoryPath,
-            IEnumerable<string> pattern)
+            IEnumerable<GlobPattern> pattern)
         {
             var directory = new Directory(directoryPath);
 
@@ -118,7 +153,7 @@ private FilePathCollection GetDirectoryFiles(
             }
 
             var filePathCollection = new FilePathCollection();
-            var fullGlobs = pattern.Select(x => directoryPath + x).ToArray();
+            var fullGlobs = pattern.Select(x => directoryPath + x.Pattern).ToArray();
 
             foreach (var glob in fullGlobs)
             {

diff --git a/src/Cake.Common/Security/SecurityAliases.cs b/src/Cake.Common/Security/SecurityAliases.cs
@@ -62,6 +62,55 @@ public static FileHash CalculateFileHash(this ICakeContext context, FilePath fil
             return fileHashCalculator.Calculate(filePath, hashAlgorithm);
         }
 
+        /// <summary>
+        /// Calculates the hash for a given directory using the default (SHA256) algorithm.
+        /// </summary>
+        /// <param name="context">The context.</param>
+        /// <param name="directoryPath">The file path.</param>
+        /// <param name="globs">The glob pattern to match.</param>
+        /// <returns>A <see cref="DirectoryHash"/> instance representing the calculated hash.</returns>
+        /// <example>
+        /// <code>
+        /// Information(
+        ///     "Cake It calculates the hashes from all cs files in all subdirectories using a SHA256 hash: {0}",
+        ///     CalculateDirectoryHash("C:\directoryToHash", "./**/*.cs").ToHex());
+        /// </code>
+        /// </example>
+        [CakeMethodAlias]
+        public static DirectoryHash CalculateDirectoryHash(this ICakeContext context,
+            IEnumerable<GlobPattern> globs, DirectoryPath directoryPath)
+        {
+            return CalculateDirectoryHash(context, directoryPath, globs, HashAlgorithm.SHA256);
+        }
+
+        /// <summary>
+        /// Calculates the hash for a given directory.
+        /// </summary>
+        /// <param name="context">The context.</param>
+        /// <param name="directoryPath">The file path.</param>
+        /// <param name="globs">The glob pattern to match.</param>
+        /// <param name="hashAlgorithm">The hash algorithm to use.</param>
+        /// <returns>A <see cref="DirectoryHash"/> instance representing the calculated hash.</returns>
+        /// <example>
+        /// <code>
+        /// Information(
+        ///     "Cake It calculates the hashes from all cs files in all subdirectories using a MD5 hash: {0}",
+        ///     CalculateDirectoryHash("C:\directoryToHash", "./**/*.cs", HashAlgorithm.MD5).ToHex());
+        /// </code>
+        /// </example>
+        [CakeMethodAlias]
+        public static DirectoryHash CalculateDirectoryHash(this ICakeContext context,
+            DirectoryPath directoryPath, IEnumerable<GlobPattern> globs, HashAlgorithm hashAlgorithm)
+        {
+            if (context == null)
+            {
+                throw new ArgumentNullException(nameof(context));
+            }
+
+            var directoryHashCalculator = new DirectoryHashCalculator(context, new HashAlgorithmBuilder());
+            return directoryHashCalculator.Calculate(directoryPath, globs, hashAlgorithm);
+        }
+
         /// <summary>
         /// Calculates the hash for a given directory using the default (SHA256) algorithm.
         /// </summary>

diff --git a/src/Cake.Common/Solution/Project/XmlDoc/XmlDocAliases.cs b/src/Cake.Common/Solution/Project/XmlDoc/XmlDocAliases.cs
@@ -72,14 +72,14 @@ public static IEnumerable<XmlDocExampleCode> ParseXmlDocExampleCode(this ICakeCo
         /// </code>
         /// </example>
         [CakeMethodAlias]
-        public static IEnumerable<XmlDocExampleCode> ParseXmlDocFilesExampleCode(this ICakeContext context, string pattern)
+        public static IEnumerable<XmlDocExampleCode> ParseXmlDocFilesExampleCode(this ICakeContext context, GlobPattern pattern)
         {
             if (context == null)
             {
                 throw new ArgumentNullException(nameof(context));
             }
 
-            if (string.IsNullOrWhiteSpace(pattern))
+            if (string.IsNullOrWhiteSpace(pattern?.Pattern))
             {
                 throw new ArgumentNullException(nameof(pattern));
             }

diff --git a/src/Cake.Common/Solution/Project/XmlDoc/XmlDocExampleCodeParser.cs b/src/Cake.Common/Solution/Project/XmlDoc/XmlDocExampleCodeParser.cs
@@ -90,9 +90,9 @@ from code in example.Elements("code")
         /// </summary>
         /// <param name="pattern">The globber file pattern.</param>
         /// <returns>Parsed Example Code.</returns>
-        public IEnumerable<XmlDocExampleCode> ParseFiles(string pattern)
+        public IEnumerable<XmlDocExampleCode> ParseFiles(GlobPattern pattern)
         {
-            if (string.IsNullOrWhiteSpace(pattern))
+            if (string.IsNullOrWhiteSpace(pattern?.Pattern))
             {
                 throw new ArgumentNullException(nameof(pattern), "Invalid pattern supplied.");
             }

diff --git a/src/Cake.Common/Tools/DotNetCore/DotNetCoreAliases.cs b/src/Cake.Common/Tools/DotNetCore/DotNetCoreAliases.cs
@@ -1276,7 +1276,7 @@ public static void DotNetCoreMSBuild(this ICakeContext context, string projectOr
         [CakeMethodAlias]
         [CakeAliasCategory("Test")]
         [CakeNamespaceImport("Cake.Common.Tools.DotNetCore.VSTest")]
-        public static void DotNetCoreVSTest(this ICakeContext context, string testFile) => context.DotNetCoreVSTest(testFile, null);
+        public static void DotNetCoreVSTest(this ICakeContext context, GlobPattern testFile) => context.DotNetCoreVSTest(testFile, null);
 
         /// <summary>
         /// Test one or more projects specified by a path or glob pattern with settings using the VS Test host runner.
@@ -1310,7 +1310,7 @@ public static void DotNetCoreMSBuild(this ICakeContext context, string projectOr
         [CakeMethodAlias]
         [CakeAliasCategory("Test")]
         [CakeNamespaceImport("Cake.Common.Tools.DotNetCore.VSTest")]
-        public static void DotNetCoreVSTest(this ICakeContext context, string testFile, DotNetCoreVSTestSettings settings)
+        public static void DotNetCoreVSTest(this ICakeContext context, GlobPattern testFile, DotNetCoreVSTestSettings settings)
         {
             var testFiles = context.GetFiles(testFile);
 

diff --git a/src/Cake.Common/Tools/DupFinder/DupFinderAliases.cs b/src/Cake.Common/Tools/DupFinder/DupFinderAliases.cs
@@ -145,7 +145,7 @@ public static void DupFinder(this ICakeContext context, IEnumerable<FilePath> fi
         /// </example>
         [CakeMethodAlias]
         [CakeAliasCategory("DupFinder")]
-        public static void DupFinder(this ICakeContext context, string pattern)
+        public static void DupFinder(this ICakeContext context, GlobPattern pattern)
         {
             DupFinder(context, pattern, new DupFinderSettings());
         }
@@ -169,7 +169,7 @@ public static void DupFinder(this ICakeContext context, string pattern)
         /// </example>
         [CakeMethodAlias]
         [CakeAliasCategory("DupFinder")]
-        public static void DupFinder(this ICakeContext context, string pattern, DupFinderSettings settings)
+        public static void DupFinder(this ICakeContext context, GlobPattern pattern, DupFinderSettings settings)
         {
             if (context == null)
             {

diff --git a/src/Cake.Common/Tools/Fixie/FixieAliases.cs b/src/Cake.Common/Tools/Fixie/FixieAliases.cs
@@ -36,7 +36,7 @@ public static class FixieAliases
         /// <param name="context">The context.</param>
         /// <param name="pattern">The pattern.</param>
         [CakeMethodAlias]
-        public static void Fixie(this ICakeContext context, string pattern)
+        public static void Fixie(this ICakeContext context, GlobPattern pattern)
         {
             if (context == null)
             {
@@ -68,7 +68,7 @@ public static void Fixie(this ICakeContext context, string pattern)
         /// <param name="pattern">The pattern.</param>
         /// <param name="settings">The settings.</param>
         [CakeMethodAlias]
-        public static void Fixie(this ICakeContext context, string pattern, FixieSettings settings)
+        public static void Fixie(this ICakeContext context, GlobPattern pattern, FixieSettings settings)
         {
             if (context == null)
             {

diff --git a/src/Cake.Common/Tools/MSTest/MSTestAliases.cs b/src/Cake.Common/Tools/MSTest/MSTestAliases.cs
@@ -34,7 +34,7 @@ public static class MSTestAliases
         /// <param name="context">The context.</param>
         /// <param name="pattern">The pattern.</param>
         [CakeMethodAlias]
-        public static void MSTest(this ICakeContext context, string pattern)
+        public static void MSTest(this ICakeContext context, GlobPattern pattern)
         {
             if (context == null)
             {
@@ -63,7 +63,7 @@ public static void MSTest(this ICakeContext context, string pattern)
         /// <param name="pattern">The pattern.</param>
         /// <param name="settings">The settings.</param>
         [CakeMethodAlias]
-        public static void MSTest(this ICakeContext context, string pattern, MSTestSettings settings)
+        public static void MSTest(this ICakeContext context, GlobPattern pattern, MSTestSettings settings)
         {
             if (context == null)
             {

diff --git a/src/Cake.Common/Tools/MSpec/MSpecAliases.cs b/src/Cake.Common/Tools/MSpec/MSpecAliases.cs
@@ -36,7 +36,7 @@ public static class MSpecAliases
         /// </code>
         /// </example>
         [CakeMethodAlias]
-        public static void MSpec(this ICakeContext context, string pattern)
+        public static void MSpec(this ICakeContext context, GlobPattern pattern)
         {
             if (context == null)
             {
@@ -71,7 +71,7 @@ public static void MSpec(this ICakeContext context, string pattern)
         /// </code>
         /// </example>
         [CakeMethodAlias]
-        public static void MSpec(this ICakeContext context, string pattern, MSpecSettings settings)
+        public static void MSpec(this ICakeContext context, GlobPattern pattern, MSpecSettings settings)
         {
             if (context == null)
             {