Merge pull request #393 from PowerShell/ProfileFixBranch

Exclude Default RuleSet when using with CustomRule feature

Author: raghushantha

Engine/ScriptAnalyzer.cs

@@ -358,7 +358,7 @@ private void Initialize(
 
             try
             {
-                this.LoadRules(this.validationResults, invokeCommand);
+                this.LoadRules(this.validationResults, invokeCommand, null == customizedRulePath ? true : false);
             }
             catch (Exception ex)
             {
@@ -426,7 +426,7 @@ private List<string> GetValidCustomRulePaths(string[] customizedRulePath, PathIn
             return paths;
         }
 
-        private void LoadRules(Dictionary<string, List<string>> result, CommandInvocationIntrinsics invokeCommand)
+        private void LoadRules(Dictionary<string, List<string>> result, CommandInvocationIntrinsics invokeCommand, bool loadBuiltInRules)
         {
             List<string> paths = new List<string>();
 
@@ -480,6 +480,11 @@ private void LoadRules(Dictionary<string, List<string>> result, CommandInvocatio
                 }
             }
 
+            if (!loadBuiltInRules)
+            {
+                this.ScriptRules = null;
+            }
+
             // Gets external rules.
             if (result.ContainsKey("ValidModPaths") && result["ValidModPaths"].Count > 0)
             {

Engine/Strings.Designer.cs

@@ -160,7 +160,7 @@
     <value>RULE_ERROR</value>
   </data>
   <data name="RulesNotFound" xml:space="preserve">
-    <value>Cannot find analyzer rules.</value>
+    <value>Cannot find ScriptAnalyzer rules in the specified path</value>
   </data>
   <data name="RuleSuppressionErrorFormat" xml:space="preserve">
     <value>Suppression Message Attribute error at line {0} in {1} : {2}</value>

Engine/Strings.resx

@@ -91,24 +91,28 @@ Describe "Test RuleExtension" {
 
         It "with Name of a built-in rules" {
             $ruleExtension = Get-ScriptAnalyzerRule -CustomizedRulePath $directory\CommunityAnalyzerRules\CommunityAnalyzerRules.psm1 -Name $singularNouns
-            $ruleExtension.Count | Should Be 1
-            $ruleExtension[0].RuleName | Should Be $singularNouns
+            $ruleExtension.Count | Should Be 0            
         }
 
         It "with Names of built-in, DSC and non-built-in rules" {
             $ruleExtension = Get-ScriptAnalyzerRule -CustomizedRulePath $directory\CommunityAnalyzerRules\CommunityAnalyzerRules.psm1 -Name $singularNouns, $measureRequired, $dscIdentical
-            $ruleExtension.Count | Should be 3
+            $ruleExtension.Count | Should be 1
             ($ruleExtension | Where-Object {$_.RuleName -eq $measureRequired}).Count | Should Be 1
-            ($ruleExtension | Where-Object {$_.RuleName -eq $singularNouns}).Count | Should Be 1
-            ($ruleExtension | Where-Object {$_.RuleName -eq $dscIdentical}).Count | Should Be 1
+            ($ruleExtension | Where-Object {$_.RuleName -eq $singularNouns}).Count | Should Be 0
+            ($ruleExtension | Where-Object {$_.RuleName -eq $dscIdentical}).Count | Should Be 0
         }
     }
 
     Context "When used incorrectly" {
         It "file cannot be found" {
-            $wrongFile = Get-ScriptAnalyzerRule -CustomizedRulePath "This is a wrong rule" 3>&1
-            ($wrongFile  | Select-Object -First 1) | Should Match "Cannot find rule extension 'This is a wrong rule'."
-            ($wrongFile | Where-Object {$_.RuleName -eq $singularNouns}).Count | Should Be 1
+            try
+            {
+                Get-ScriptAnalyzerRule -CustomizedRulePath "Invalid CustomRulePath"
+            }
+            catch
+            {
+                $Error[0].FullyQualifiedErrorId | should match "Cannot find ScriptAnalyzer rules in the specified path,Microsoft.Windows.PowerShell.ScriptAnalyzer.Commands.GetScriptAnalyzerRuleCommand"            
+            }
         }
 
     }

Tests/Engine/GetScriptAnalyzerRule.tests.ps1

@@ -318,19 +318,18 @@ Describe "Test CustomizedRulePath" {
     }
 
     Context "When used incorrectly" {
-        It "file cannot be found" {
-            $wrongRule = Invoke-ScriptAnalyzer $directory\TestScript.ps1 -CustomizedRulePath "This is a wrong rule" 3>&1 | Select-Object -First 1
-
-			if ($testingLibraryUsage)
-			{
-				# Special case for library usage testing: warning output written
-				# with PSHost.UI.WriteWarningLine does not get redirected correctly
-				# so we can't use this approach for checking the warning message.
-				# Instead, reach into the test IOutputWriter implementation to find it.
-				$wrongRule = $testOutputWriter.MostRecentWarningMessage
-			}
-
-			$wrongRule | Should Match "Cannot find rule extension 'This is a wrong rule'."
+        It "file cannot be found" {            
+            try
+            {
+                Invoke-ScriptAnalyzer $directory\TestScript.ps1 -CustomRulePath "Invalid CustomRulePath"
+            }
+            catch
+            {
+                if (-not $testingLibraryUsage)
+			    {                    
+                    $Error[0].FullyQualifiedErrorId | should match "Cannot find ScriptAnalyzer rules in the specified path,Microsoft.Windows.PowerShell.ScriptAnalyzer.Commands.InvokeScriptAnalyzerCommand"            
+                }                
+            }
         }
     }
 }