Merge pull request #529 from PowerShell/FixDscConfigRuleSupression

Fix rule suppression with DSC Configuration definition

Author: Kapil Borle

Engine/Helper.cs

@@ -1160,8 +1160,7 @@ public Dictionary<string, List<RuleSuppression>> GetRuleSuppression(Ast ast)
                 ruleSuppressionList.AddRange(GetSuppressionsFunction(funcAst));
             }
 
-            #if !PSV3
-
+#if !PSV3
             // Get rule suppression from classes
             IEnumerable<TypeDefinitionAst> typeAsts = ast.FindAll(item => item is TypeDefinitionAst, true).Cast<TypeDefinitionAst>();
 
@@ -1170,7 +1169,14 @@ public Dictionary<string, List<RuleSuppression>> GetRuleSuppression(Ast ast)
                 ruleSuppressionList.AddRange(GetSuppressionsClass(typeAst));
             }
 
-            #endif
+            // Get rule suppression from configuration definitions
+            IEnumerable<ConfigurationDefinitionAst> configDefAsts = ast.FindAll(item => item is ConfigurationDefinitionAst, true).Cast<ConfigurationDefinitionAst>();
+
+            foreach (var configDefAst in configDefAsts)
+            {
+                ruleSuppressionList.AddRange(GetSuppressionsConfiguration(configDefAst));
+            }
+#endif // !PSV3
 
             ruleSuppressionList.Sort((item, item2) => item.StartOffset.CompareTo(item2.StartOffset));
 
@@ -1188,6 +1194,27 @@ public Dictionary<string, List<RuleSuppression>> GetRuleSuppression(Ast ast)
             return results;
         }
 
+        /// <summary>
+        /// Returns a list of rule suppressions from the configuration
+        /// </summary>
+        /// <param name="configDefAst"></param>
+        /// <returns></returns>
+        internal List<RuleSuppression> GetSuppressionsConfiguration(ConfigurationDefinitionAst configDefAst)
+        {
+            var result = new List<RuleSuppression>();
+            if (configDefAst == null || configDefAst.Body == null)
+            {
+                return result;
+            }
+            var attributeAsts = configDefAst.FindAll(x => x is AttributeAst, true).Cast<AttributeAst>();
+            result.AddRange(RuleSuppression.GetSuppressions(
+                attributeAsts,
+                configDefAst.Extent.StartOffset,
+                configDefAst.Extent.EndOffset,
+                configDefAst));
+            return result;
+        }
+
         /// <summary>
         /// Returns a list of rule suppressions from the function
         /// </summary>

Tests/Engine/RuleSuppression.tests.ps1

@@ -21,6 +21,15 @@ Function do-something
 }
 '@
 
+$ruleSuppressionInConfiguration = @'
+Configuration xFileUpload
+{
+[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingConvertToSecureStringWithPlainText", "")]
+param ([string] $decryptedPassword)
+$securePassword = ConvertTo-SecureString $decryptedPassword -AsPlainText -Force
+}
+'@
+
 Describe "RuleSuppressionWithoutScope" {
     Context "Function" {
         It "Does not raise violations" {
@@ -49,6 +58,13 @@ Describe "RuleSuppressionWithoutScope" {
         }
     }
 
+    Context "Rule suppression within DSC Configuration definition" {
+        It "Suppresses rule" {
+            $suppressedRule = Invoke-ScriptAnalyzer -ScriptDefinition $ruleSuppressionInConfiguration -SuppressedOnly
+            $suppressedRule.Count | Should Be 1
+        }
+    }
+
     if (!$testingLibraryUsage)
     {
 	Context "Bad Rule Suppression" {