Separate suppressed and non-suppressed records

Author: Quoc Truong

Engine/Commands/InvokeScriptAnalyzerCommand.cs

@@ -99,6 +99,18 @@ public SwitchParameter Recurse
         }
         private bool recurse;
 
+        /// <summary>
+        /// ShowSuppressed: Show the suppressed message
+        /// </summary>
+        [Parameter(Mandatory = false)]
+        [SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
+        public SwitchParameter ShowSuppressed
+        {
+            get { return showSuppressed; }
+            set { showSuppressed = value; }
+        }
+        private bool showSuppressed;
+
         #endregion Parameters
 
         #region Private Members
@@ -256,6 +268,7 @@ private void AnalyzeFile(string filePath)
             Token[] tokens = null;
             ParseError[] errors = null;
             List<DiagnosticRecord> diagnostics = new List<DiagnosticRecord>();
+            List<DiagnosticRecord> suppressed = new List<DiagnosticRecord>();
 
             // Use a List of KVP rather than dictionary, since for a script containing inline functions with same signature, keys clash
             List<KeyValuePair<CommandInfo, IScriptExtent>> cmdInfoTable = new List<KeyValuePair<CommandInfo, IScriptExtent>>();            
@@ -331,6 +344,7 @@ private void AnalyzeFile(string filePath)
                             var records = scriptRule.AnalyzeScript(ast, filePath).ToList();
                             Helper.Instance.SuppressRule(scriptRule.GetName(), ruleSuppressions, records);
                             diagnostics.AddRange(records.Where(record => record.Suppression == null));
+                            suppressed.AddRange(records.Where(record => record.Suppression != null));
                         }
                         catch (Exception scriptRuleException)
                         {
@@ -361,6 +375,7 @@ private void AnalyzeFile(string filePath)
                             var records = tokenRule.AnalyzeTokens(tokens, fileName).ToList();
                             Helper.Instance.SuppressRule(tokenRule.GetName(), ruleSuppressions, records);
                             diagnostics.AddRange(records.Where(record => record.Suppression == null));
+                            suppressed.AddRange(records.Where(record => record.Suppression != null));
                         }
                         catch (Exception tokenRuleException)
                         {
@@ -391,6 +406,7 @@ private void AnalyzeFile(string filePath)
                             var records = dscResourceRule.AnalyzeDSCClass(ast, filePath).ToList();
                             Helper.Instance.SuppressRule(dscResourceRule.GetName(), ruleSuppressions, records);
                             diagnostics.AddRange(records.Where(record => record.Suppression == null));
+                            suppressed.AddRange(records.Where(record => record.Suppression != null));
                         }
                         catch (Exception dscResourceRuleException)
                         {
@@ -435,6 +451,7 @@ private void AnalyzeFile(string filePath)
                                                 var records = dscResourceRule.AnalyzeDSCResource(ast, filePath).ToList();
                                                 Helper.Instance.SuppressRule(dscResourceRule.GetName(), ruleSuppressions, records);
                                                 diagnostics.AddRange(records.Where(record => record.Suppression == null));
+                                                suppressed.AddRange(records.Where(record => record.Suppression != null));
                                             }
                                             catch (Exception dscResourceRuleException)
                                             {
@@ -492,9 +509,19 @@ private void AnalyzeFile(string filePath)
             //Output through loggers
             foreach (ILogger logger in ScriptAnalyzer.Instance.Loggers)
             {
-                foreach (DiagnosticRecord diagnostic in diagnostics)
+                if (ShowSuppressed)
                 {
-                    logger.LogMessage(diagnostic, this);
+                    foreach (DiagnosticRecord suppressRecord in suppressed)
+                    {
+                        logger.LogObject(suppressRecord, this);
+                    }
+                }
+                else
+                {
+                    foreach (DiagnosticRecord diagnostic in diagnostics)
+                    {
+                        logger.LogObject(diagnostic, this);
+                    }
                 }
             }
         }

Engine/Generic/DiagnosticRecord.cs

@@ -19,6 +19,7 @@ public class DiagnosticRecord
         private DiagnosticSeverity severity;
         private string scriptName;
         private string ruleSuppressionId;
+        private RuleSuppression suppression;
 
         /// <summary>
         /// Represents a string from the rule about why this diagnostic was created.
@@ -34,8 +35,15 @@ public string Message
         /// </summary>
         public RuleSuppression Suppression
         {
-            get;
-            set;
+            get { return suppression; }
+            set
+            {
+                suppression = value;
+                if (suppression != null)
+                {
+                    Message = suppression.Justification;
+                }
+            }
         }
 
         /// <summary>

Engine/Generic/ILogger.cs

@@ -15,9 +15,9 @@ public interface ILogger
         /// <summary>
         /// LogMessage: Logs the given diagnostic, using the command for Write methods if needed.
         /// </summary>
-        /// <param name="diagnostic">The DiagnosticRecord to be logged.</param>
+        /// <param name="obj">The object to be logged.</param>
         /// <param name="command">The InvokePSScriptAnalyzerCommand that this logger is running off of.</param>
-        void LogMessage(DiagnosticRecord diagnostic, InvokeScriptAnalyzerCommand command);
+        void LogObject(Object obj, InvokeScriptAnalyzerCommand command);
 
         /// <summary>
         /// GetName: Retrieves the name of the logger.

Engine/Loggers/WriteObjectsLogger.cs

@@ -30,21 +30,21 @@ public class WriteObjectsLogger : ILogger
         #region Methods
 
         /// <summary>
-        /// LogMessage: Logs the given diagnostic though WriteObject.
+        /// LogObject: Logs the given object though WriteObject.
         /// </summary>
-        /// <param name="diagnostic">The diagnostic to be logged</param>
+        /// <param name="obj">The object to be logged</param>
         /// <param name="command">The Invoke-PSLint command this logger is running through</param>
-        public void LogMessage(DiagnosticRecord diagnostic, InvokeScriptAnalyzerCommand command)
+        public void LogObject(Object obj, InvokeScriptAnalyzerCommand command)
         {
             if (command == null)
             {
                 throw new ArgumentNullException("command");
             }
-            if (diagnostic == null)
+            if (obj == null)
             {
                 throw new ArgumentNullException("diagnostic");
             }
-            command.WriteObject(diagnostic);
+            command.WriteObject(obj);
         }
 
         /// <summary>