Enable suppression of custom rules when used together with -IncludeDefaultRules (#1245)

* remove faulty error checking

* fix syntax error

* Add test cases

* cleanup

* remove resource string of error message

* Make tests PS4 compatible

Author: bergmeister

Engine/Generic/RuleSuppression.cs

@@ -15,7 +15,6 @@ namespace Microsoft.Windows.PowerShell.ScriptAnalyzer.Generic
     /// </summary>
     public class RuleSuppression
     {
-        private string _ruleName;
 
         /// <summary>
         /// The start offset of the rule suppression attribute (not where it starts to apply)
@@ -49,28 +48,8 @@ public int EndOffset
         /// </summary>
         public string RuleName
         {
-            get
-            {
-                return _ruleName;
-            }
-
-            set
-            {
-                _ruleName = value;
-
-                if (!String.IsNullOrWhiteSpace(_ruleName)
-                    && (ScriptAnalyzer.Instance.ScriptRules != null
-                        && ScriptAnalyzer.Instance.ScriptRules.Count(item => String.Equals(item.GetName(), _ruleName, StringComparison.OrdinalIgnoreCase)) == 0)
-                    && (ScriptAnalyzer.Instance.TokenRules != null
-                        && ScriptAnalyzer.Instance.TokenRules.Count(item => String.Equals(item.GetName(), _ruleName, StringComparison.OrdinalIgnoreCase)) == 0)
-                    && (ScriptAnalyzer.Instance.ExternalRules != null
-                        && ScriptAnalyzer.Instance.ExternalRules.Count(item => String.Equals(item.GetFullName(), _ruleName, StringComparison.OrdinalIgnoreCase)) == 0)
-                    && (ScriptAnalyzer.Instance.DSCResourceRules != null
-                        && ScriptAnalyzer.Instance.DSCResourceRules.Count(item => String.Equals(item.GetName(), _ruleName, StringComparison.OrdinalIgnoreCase)) == 0))
-                {
-                    Error = String.Format(Strings.RuleSuppressionRuleNameNotFound, _ruleName);
-                }
-            }
+            get;
+            set;
         }
 
         /// <summary>

Engine/Strings.Designer.cs

@@ -165,9 +165,6 @@
   <data name="RuleSuppressionErrorFormat" xml:space="preserve">
     <value>Suppression Message Attribute error at line {0} in {1} : {2}</value>
   </data>
-  <data name="RuleSuppressionRuleNameNotFound" xml:space="preserve">
-    <value>Rule {0} cannot be found.</value>
-  </data>
   <data name="StringConstantArgumentsSuppressionAttributeError" xml:space="preserve">
     <value>All the arguments of the Suppress Message Attribute should be string constants.</value>
   </data>

Engine/Strings.resx

@@ -173,6 +173,43 @@ Describe "Test importing correct customized rules" {
             $customizedRulePath.Count | Should -Be 0
 		}
 
+        It "can suppress custom rule with rule name expression '<RuleNameExpression>'" -TestCases @(
+            @{RuleNameExpression = '$MyInvocation.MyCommand.Name'; RuleName = 'WarningAboutDoSomething' }
+            @{RuleNameExpression = '$MyInvocation.InvocationName'; RuleName = 'MyCustomRule\WarningAboutDoSomething' }
+            @{RuleNameExpression = "'MyRuleName'"; RuleName = 'MyRuleName' }
+        ) {
+            Param($RuleNameExpression, $RuleName)
+
+            $script = @"
+			[Diagnostics.CodeAnalysis.SuppressMessageAttribute('$RuleName', '')]
+			Param()
+			Invoke-Something
+"@
+            $customRuleContent = @'
+			function WarningAboutDoSomething {
+				param (
+					[System.Management.Automation.Language.CommandAst]$ast
+				)
+
+				if ($ast.GetCommandName() -eq 'Invoke-Something') {
+					New-Object -Typename 'Microsoft.Windows.PowerShell.ScriptAnalyzer.Generic.DiagnosticRecord' `
+								-ArgumentList 'This is help',$ast.Extent,REPLACE_WITH_RULE_NAME_EXPRESSION,Warning,$ast.Extent.File,$null,$null
+				}
+			}
+'@
+            $customRuleContent = $customRuleContent.Replace('REPLACE_WITH_RULE_NAME_EXPRESSION', $RuleNameExpression)
+            $testScriptPath = "TestDrive:\SuppressedCustomRule.ps1"
+            Set-Content -Path $testScriptPath -Value $script
+            $customRuleScriptPath = Join-Path $TestDrive 'MyCustomRule.psm1'
+			Set-Content -Path $customRuleScriptPath -Value $customRuleContent
+			$violationsWithoutSuppresion = Invoke-ScriptAnalyzer -ScriptDefinition 'Invoke-Something' -CustomRulePath $customRuleScriptPath
+			$violationsWithoutSuppresion.Count | Should -Be 1
+            $violations = Invoke-ScriptAnalyzer -Path $testScriptPath -CustomRulePath $customRuleScriptPath
+			$violations.Count | Should -Be 0
+			$violationsWithIncludeDefaultRules = Invoke-ScriptAnalyzer -Path $testScriptPath -CustomRulePath $customRuleScriptPath -IncludeDefaultRules
+            $violationsWithIncludeDefaultRules.Count | Should -Be 0
+        }
+
         It "will set RuleSuppressionID" {
             $violations = Invoke-ScriptAnalyzer $directory\TestScript.ps1 -CustomizedRulePath $directory\samplerule
             $violations[0].RuleSuppressionID   | Should -Be "MyRuleSuppressionID"