Raise error if Rule Suppression ID is used but no match is found

Author: Quoc Truong

Engine/Helper.cs

@@ -5,6 +5,7 @@
 using System.Management.Automation;
 using System.Management.Automation.Language;
 using System.Management.Automation.Runspaces;
+using System.Globalization;
 using Microsoft.Windows.Powershell.ScriptAnalyzer.Generic;
 
 namespace Microsoft.Windows.Powershell.ScriptAnalyzer
@@ -740,6 +741,7 @@ public List<DiagnosticRecord> SuppressRule(string ruleName, Dictionary<string, L
             int ruleSuppressionIndex = 0;
             DiagnosticRecord record = diagnostics.First();
             RuleSuppression ruleSuppression = ruleSuppressions.First();
+            int suppressionCount = 0;
 
             while (recordIndex < diagnostics.Count)
             {
@@ -753,6 +755,7 @@ public List<DiagnosticRecord> SuppressRule(string ruleName, Dictionary<string, L
                     }
 
                     ruleSuppression = ruleSuppressions[ruleSuppressionIndex];
+                    suppressionCount = 0;
 
                     continue;
                 }
@@ -767,12 +770,21 @@ public List<DiagnosticRecord> SuppressRule(string ruleName, Dictionary<string, L
                 {
                     ruleSuppressionIndex += 1;
 
+                    // If we cannot found any error but the rulesuppression has a rulesuppressionid then it must be used wrongly
+                    if (!String.IsNullOrWhiteSpace(ruleSuppression.RuleSuppressionID) && suppressionCount == 0)
+                    {
+                        ruleSuppression.Error = String.Format(CultureInfo.CurrentCulture, Strings.RuleSuppressionErrorFormat, ruleSuppression.StartOffset,
+                                System.IO.Path.GetFileName(record.Extent.File), String.Format(Strings.RuleSuppressionIDError, ruleSuppression.RuleSuppressionID));
+                        Helper.Instance.MyCmdlet.WriteError(new ErrorRecord(new ArgumentException(ruleSuppression.Error), ruleSuppression.Error, ErrorCategory.InvalidArgument, ruleSuppression));
+                    }
+
                     if (ruleSuppressionIndex == ruleSuppressions.Count)
                     {
                         break;
                     }
 
                     ruleSuppression = ruleSuppressions[ruleSuppressionIndex];
+                    suppressionCount = 0;
 
                     continue;
                 }
@@ -785,15 +797,25 @@ public List<DiagnosticRecord> SuppressRule(string ruleName, Dictionary<string, L
                         && !string.Equals(ruleSuppression.RuleSuppressionID, record.RuleSuppressionID, StringComparison.OrdinalIgnoreCase))
                     {
                         results.Add(record);
+                        suppressionCount -= 1;
                     }
                     // otherwise, we ignore the record, move on to the next.
                 }
 
                 // important assumption: this point is reached only if we want to move to the next record
                 recordIndex += 1;
+                suppressionCount += 1;
 
                 if (recordIndex == diagnostics.Count)
                 {
+                    // If we cannot found any error but the rulesuppression has a rulesuppressionid then it must be used wrongly
+                    if (!String.IsNullOrWhiteSpace(ruleSuppression.RuleSuppressionID) && suppressionCount == 0)
+                    {
+                        ruleSuppression.Error = String.Format(CultureInfo.CurrentCulture, Strings.RuleSuppressionErrorFormat, ruleSuppression.StartOffset,
+                                System.IO.Path.GetFileName(record.Extent.File), String.Format(Strings.RuleSuppressionIDError, ruleSuppression.RuleSuppressionID));
+                        Helper.Instance.MyCmdlet.WriteError(new ErrorRecord(new ArgumentException(ruleSuppression.Error), ruleSuppression.Error, ErrorCategory.InvalidArgument, ruleSuppression));
+                    }
+
                     break;
                 }
 

Engine/Strings.Designer.cs

@@ -189,4 +189,7 @@
   <data name="TargetCannotBeFoundError" xml:space="preserve">
     <value>Cannot find any Targets {0} that match the Scope {1} to apply the SuppressMessageAttribute.</value>
   </data>
+  <data name="RuleSuppressionIDError" xml:space="preserve">
+    <value>Cannot find any DiagnosticRecord with the Rule Suppression ID {0}.</value>
+  </data>
 </root>