Merge pull request #402 from PowerShell/CustomRulePathFixBranch

Add ability to supply collection of custom rule paths

Author: raghushantha

Engine/Commands/GetScriptAnalyzerRuleCommand.cs

@@ -34,12 +34,12 @@ public class GetScriptAnalyzerRuleCommand : PSCmdlet, IOutputWriter
         [ValidateNotNullOrEmpty]
         [SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
         [Alias("CustomizedRulePath")]
-        public string CustomRulePath
+        public string[] CustomRulePath
         {
             get { return customRulePath; }
             set { customRulePath = value; }
         }
-        private string customRulePath;
+        private string[] customRulePath;
 
         /// <summary>
         /// RecurseCustomRulePath: Find rules within subfolders under the path

Engine/Commands/InvokeScriptAnalyzerCommand.cs

@@ -74,12 +74,12 @@ public string ScriptDefinition
         [ValidateNotNull]
         [SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
         [Alias("CustomizedRulePath")]
-        public string CustomRulePath
+        public string[] CustomRulePath
         {
             get { return customRulePath; }
             set { customRulePath = value; }
         }
-        private string customRulePath;
+        private string[] customRulePath;
 
         /// <summary>
         /// RecurseCustomRulePath: Find rules within subfolders under the path

Engine/Helper.cs

@@ -984,38 +984,44 @@ public Tuple<List<SuppressedRecord>, List<DiagnosticRecord>> SuppressRule(string
             return result;
         }
 
-        public static string[] ProcessCustomRulePaths(string rulePath, SessionState sessionState, bool recurse = false)
+        public static string[] ProcessCustomRulePaths(string[] rulePaths, SessionState sessionState, bool recurse = false)
         {
             //if directory is given, list all the psd1 files
             List<string> outPaths = new List<string>();
-            if (rulePath == null)
+            if (rulePaths == null)
             {
                 return null;
             }
-            try
+
+            Collection<PathInfo> pathInfo = new Collection<PathInfo>();
+            foreach (string rulePath in rulePaths)
             {
-                Collection<PathInfo> pathInfo = sessionState.Path.GetResolvedPSPathFromPSPath(rulePath);                
-                foreach (PathInfo pinfo in pathInfo)
+                Collection<PathInfo> pathInfosForRulePath = sessionState.Path.GetResolvedPSPathFromPSPath(rulePath);
+                if (null != pathInfosForRulePath)
                 {
-                    string path = pinfo.Path;
-                    if (Directory.Exists(path))
+                    foreach (PathInfo pathInfoForRulePath in pathInfosForRulePath)
                     {
-                        path = path.TrimEnd('\\');
-                        if (recurse)
-                        {
-                            outPaths.AddRange(Directory.GetDirectories(pinfo.Path, "*", SearchOption.AllDirectories));
-                        }
+                        pathInfo.Add(pathInfoForRulePath);
                     }
-                    outPaths.Add(path);
                 }
-                return outPaths.ToArray();
             }
-            catch
+
+            foreach (PathInfo pinfo in pathInfo)
             {
-                // need to do this as the path validation takes place later in the hierarchy.
-                outPaths.Add(rulePath);
-                return outPaths.ToArray();
+                string path = pinfo.Path;
+                if (Directory.Exists(path))
+                {
+                    path = path.TrimEnd('\\');
+                    if (recurse)
+                    {
+                        outPaths.AddRange(Directory.GetDirectories(pinfo.Path, "*", SearchOption.AllDirectories));
+                    }
+                }
+                outPaths.Add(path);
             }
+            
+            return outPaths.ToArray();
+            
         }
 
 

Tests/Engine/CustomizedRule.tests.ps1

@@ -99,8 +99,8 @@ Describe "Test importing correct customized rules" {
 			}
 
 			It "will show the custom rules when given recurse switch" {
-				$customizedRulePath = Get-ScriptAnalyzerRule  -RecurseCustomRulePath -CustomizedRulePath $directory\samplerule | Where-Object {$_.RuleName -eq $measure}
-				$customizedRulePath.Count | Should be 3
+				$customizedRulePath = Get-ScriptAnalyzerRule  -RecurseCustomRulePath -CustomizedRulePath "$directory\samplerule", "$directory\samplerule\samplerule2" | Where-Object {$_.RuleName -eq $measure}
+				$customizedRulePath.Count | Should be 5
 			}
 
 			it "will show the custom rules when given glob with recurse switch" {

Tests/Engine/GetScriptAnalyzerRule.tests.ps1

@@ -23,10 +23,10 @@ Describe "Test available parameters" {
         }
 
         It "accepts string array" {
-            $params["CustomRulePath"].ParameterType.FullName | Should Be "System.String"
+            $params["CustomRulePath"].ParameterType.FullName | Should Be "System.String[]"
         }
 
-		It "takes CustomizedRulePath parameter as an alias of CustomRulePath paramter" {
+		It "takes CustomizedRulePath parameter as an alias of CustomRulePath parameter" {
 			$params.CustomRulePath.Aliases.Contains("CustomizedRulePath") | Should be $true
 		}
     }
@@ -107,11 +107,11 @@ Describe "Test RuleExtension" {
         It "file cannot be found" {
             try
             {
-                Get-ScriptAnalyzerRule -CustomizedRulePath "Invalid CustomRulePath"
+                Get-ScriptAnalyzerRule -CustomRulePath "Invalid CustomRulePath"
             }
             catch
             {
-                $Error[0].FullyQualifiedErrorId | should match "Cannot find ScriptAnalyzer rules in the specified path,Microsoft.Windows.PowerShell.ScriptAnalyzer.Commands.GetScriptAnalyzerRuleCommand"            
+                $Error[0].FullyQualifiedErrorId | should match "PathNotFound,Microsoft.Windows.PowerShell.ScriptAnalyzer.Commands.GetScriptAnalyzerRuleCommand"            
             }
         }
 

Tests/Engine/InvokeScriptAnalyzer.tests.ps1

@@ -40,15 +40,8 @@ Describe "Test available parameters" {
             $params.ContainsKey("CustomRulePath") | Should Be $true
         }
 
-        It "accepts a string" {
-			if ($testingLibraryUsage)
-			{
+        It "accepts a string array" {
 				$params["CustomRulePath"].ParameterType.FullName | Should Be "System.String[]"
-			}
-			else
-			{
-				$params["CustomRulePath"].ParameterType.FullName | Should Be "System.String"
-			}
         }
 
 		It "has a CustomizedRulePath alias"{
@@ -315,8 +308,15 @@ Describe "Test CustomizedRulePath" {
             $customizedRulePathExclude = Invoke-ScriptAnalyzer $directory\TestScript.ps1 -CustomizedRulePath $directory\CommunityAnalyzerRules\CommunityAnalyzerRules.psm1 -ExcludeRule "Measure-RequiresModules" | Where-Object {$_.RuleName -eq $measureRequired}
             $customizedRulePathExclude.Count | Should be 0
         }
+
+		It "When supplied with a collection of paths" {
+            $customizedRulePath = Invoke-ScriptAnalyzer $directory\TestScript.ps1 -CustomRulePath ("$directory\CommunityAnalyzerRules", "$directory\SampleRule", "$directory\SampleRule\SampleRule2")
+            $customizedRulePath.Count | Should Be 3
+        }		
+
     }
 
+
     Context "When used incorrectly" {
         It "file cannot be found" {            
             try
@@ -327,7 +327,7 @@ Describe "Test CustomizedRulePath" {
             {
                 if (-not $testingLibraryUsage)
 			    {                    
-                    $Error[0].FullyQualifiedErrorId | should match "Cannot find ScriptAnalyzer rules in the specified path,Microsoft.Windows.PowerShell.ScriptAnalyzer.Commands.InvokeScriptAnalyzerCommand"            
+                    $Error[0].FullyQualifiedErrorId | should match "PathNotFound,Microsoft.Windows.PowerShell.ScriptAnalyzer.Commands.InvokeScriptAnalyzerCommand"            
                 }                
             }
         }