Merge BugFixes into development

Author: Quoc Truong

Engine/Commands/GetScriptAnalyzerLoggerCommand.cs

@@ -1,4 +1,16 @@
-using Microsoft.Windows.Powershell.ScriptAnalyzer.Generic;
+//
+// Copyright (c) Microsoft Corporation.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+//
+
+using Microsoft.Windows.Powershell.ScriptAnalyzer.Generic;
 using System;
 using System.Collections.Generic;
 using System.ComponentModel.Composition;

Engine/Commands/GetScriptAnalyzerRuleCommand.cs

@@ -1,14 +1,23 @@
-using Microsoft.Windows.Powershell.ScriptAnalyzer.Generic;
+//
+// Copyright (c) Microsoft Corporation.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+//
+
+using Microsoft.PowerShell.Commands;
+using Microsoft.Windows.Powershell.ScriptAnalyzer.Generic;
 using System;
 using System.Collections.Generic;
-using System.ComponentModel.Composition;
 using System.Diagnostics.CodeAnalysis;
 using System.Globalization;
 using System.Linq;
 using System.Management.Automation;
-using System.Resources;
-using System.Threading;
-using System.Reflection;
 
 namespace Microsoft.Windows.Powershell.ScriptAnalyzer.Commands
 {
@@ -44,6 +53,21 @@ public string[] Name
             set { name = value; }
         }
         private string[] name;
+
+        /// <summary>
+        /// Severity: Array of the severity types to be enabled.
+        /// </summary>
+        /// </summary>
+        [ValidateSet("Warning", "Error", "Information", IgnoreCase = true)]
+        [Parameter(Mandatory = false)]
+        [SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
+        public string[] Severity
+        {
+            get { return severity; }
+            set { severity = value; }
+        }
+        private string[] severity;
+
         #endregion Parameters
 
         #region Private Members
@@ -116,9 +140,16 @@ protected override void ProcessRecord()
             }
             else
             {
+                if (severity != null)
+                {
+                    var ruleSeverity = severity.Select(item => Enum.Parse(typeof (RuleSeverity), item));
+                    rules = rules.Where(item => ruleSeverity.Contains(item.GetSeverity())).ToList();
+                }
+
                 foreach (IRule rule in rules)
                 {
-                    WriteObject(new RuleInfo(rule.GetName(), rule.GetCommonName(), rule.GetDescription(), rule.GetSourceType(), rule.GetSourceName()));
+                    WriteObject(new RuleInfo(rule.GetName(), rule.GetCommonName(), rule.GetDescription(),
+                        rule.GetSourceType(), rule.GetSourceName(), rule.GetSeverity()));
                 }
             }
         }

Engine/Commands/InvokeScriptAnalyzerCommand.cs

@@ -1,4 +1,17 @@
-using Microsoft.Windows.Powershell.ScriptAnalyzer.Generic;
+//
+// Copyright (c) Microsoft Corporation.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+//
+
+using System.Text.RegularExpressions;
+using Microsoft.Windows.Powershell.ScriptAnalyzer.Generic;
 using System;
 using System.Collections.Generic;
 using System.ComponentModel.Composition;
@@ -102,6 +115,7 @@ public SwitchParameter Recurse
         /// <summary>
         /// ShowSuppressed: Show the suppressed message
         /// </summary>
+        [Parameter(Mandatory = false)]
         [SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
         public SwitchParameter SuppressedOnly
         {
@@ -270,7 +284,28 @@ private void AnalyzeFile(string filePath)
             List<SuppressedRecord> suppressed = new List<SuppressedRecord>();
 
             // 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>>();            
+            List<KeyValuePair<CommandInfo, IScriptExtent>> cmdInfoTable = new List<KeyValuePair<CommandInfo, IScriptExtent>>();
+
+            //Check wild card input for the Include/ExcludeRules and create regex match patterns
+            List<Regex> includeRegexList = new List<Regex>();
+            List<Regex> excludeRegexList = new List<Regex>();
+            if (includeRule != null)
+            {
+                foreach (string rule in includeRule)
+                {
+                    Regex includeRegex = new Regex(String.Format("^{0}$", Regex.Escape(rule).Replace(@"\*", ".*")), RegexOptions.IgnoreCase);
+                    includeRegexList.Add(includeRegex);
+                }
+            }
+            if (excludeRule != null)
+            {
+                foreach (string rule in excludeRule)
+                {
+                    Regex excludeRegex = new Regex(String.Format("^{0}$", Regex.Escape(rule).Replace(@"\*", ".*")), RegexOptions.IgnoreCase);
+                    excludeRegexList.Add(excludeRegex);
+                }
+            }
+
 
             //Parse the file
             if (File.Exists(filePath))
@@ -327,12 +362,32 @@ private void AnalyzeFile(string filePath)
             #region Run ScriptRules
             //Trim down to the leaf element of the filePath and pass it to Diagnostic Record
             string fileName = System.IO.Path.GetFileName(filePath);
+           
             if (ScriptAnalyzer.Instance.ScriptRules != null)
             {
                 foreach (IScriptRule scriptRule in ScriptAnalyzer.Instance.ScriptRules)
                 {
-                    if ((includeRule == null || includeRule.Contains(scriptRule.GetName(), StringComparer.OrdinalIgnoreCase)) && 
-                        (excludeRule == null || !excludeRule.Contains(scriptRule.GetName(), StringComparer.OrdinalIgnoreCase)))
+                    bool includeRegexMatch = false;
+                    bool excludeRegexMatch = false;
+                    foreach (Regex include in includeRegexList)
+                    {
+                        if (include.IsMatch(scriptRule.GetName()))
+                        {
+                            includeRegexMatch = true;
+                            break;
+                        }
+                    }
+
+                    foreach (Regex exclude in excludeRegexList)
+                    {
+                        if (exclude.IsMatch(scriptRule.GetName()))
+                        {
+                            excludeRegexMatch = true;
+                            break;
+                        }
+                    }
+
+                    if ((includeRule == null || includeRegexMatch) && (excludeRule == null || !excludeRegexMatch))
                     {
                         WriteVerbose(string.Format(CultureInfo.CurrentCulture, Strings.VerboseRunningMessage, scriptRule.GetName()));
 
@@ -347,7 +402,6 @@ private void AnalyzeFile(string filePath)
                         catch (Exception scriptRuleException)
                         {
                             WriteError(new ErrorRecord(scriptRuleException, Strings.RuleErrorMessage, ErrorCategory.InvalidOperation, filePath));
-                            continue;
                         }
                     }
                 }
@@ -361,8 +415,25 @@ private void AnalyzeFile(string filePath)
             {
                 foreach (ITokenRule tokenRule in ScriptAnalyzer.Instance.TokenRules)
                 {
-                    if ((includeRule == null || includeRule.Contains(tokenRule.GetName(), StringComparer.OrdinalIgnoreCase)) && 
-                        (excludeRule == null || !excludeRule.Contains(tokenRule.GetName(), StringComparer.OrdinalIgnoreCase)))
+                    bool includeRegexMatch = false;
+                    bool excludeRegexMatch = false;
+                    foreach (Regex include in includeRegexList)
+                    {
+                        if (include.IsMatch(tokenRule.GetName()))
+                        {
+                            includeRegexMatch = true;
+                            break;
+                        }
+                    }
+                    foreach (Regex exclude in excludeRegexList)
+                    {
+                        if (exclude.IsMatch(tokenRule.GetName()))
+                        {
+                            excludeRegexMatch = true;
+                            break;
+                        }
+                    }
+                    if ((includeRule == null || includeRegexMatch) && (excludeRule == null  || !excludeRegexMatch))
                     {
                         WriteVerbose(string.Format(CultureInfo.CurrentCulture, Strings.VerboseRunningMessage, tokenRule.GetName()));
 
@@ -377,7 +448,6 @@ private void AnalyzeFile(string filePath)
                         catch (Exception tokenRuleException)
                         {
                             WriteError(new ErrorRecord(tokenRuleException, Strings.RuleErrorMessage, ErrorCategory.InvalidOperation, fileName));
-                            continue;
                         } 
                     }
                 }
@@ -391,8 +461,28 @@ private void AnalyzeFile(string filePath)
                 // Run DSC Class rule
                 foreach (IDSCResourceRule dscResourceRule in ScriptAnalyzer.Instance.DSCResourceRules)
                 {
-                    if ((includeRule == null || includeRule.Contains(dscResourceRule.GetName(), StringComparer.OrdinalIgnoreCase)) &&
-                        (excludeRule == null || !excludeRule.Contains(dscResourceRule.GetName(), StringComparer.OrdinalIgnoreCase)))
+                    bool includeRegexMatch = false;
+                    bool excludeRegexMatch = false;
+
+                    foreach (Regex include in includeRegexList)
+                    {
+                        if (include.IsMatch(dscResourceRule.GetName()))
+                        {
+                            includeRegexMatch = true;
+                            break;
+                        }
+                    }
+
+                    foreach (Regex exclude in excludeRegexList)
+                    {
+                        if (exclude.IsMatch(dscResourceRule.GetName()))
+                        {
+                            excludeRegexMatch = true;
+                            break;
+                        }
+                    }
+
+                    if ((includeRule == null || includeRegexMatch) && (excludeRule == null || excludeRegexMatch))
                     {
                         WriteVerbose(string.Format(CultureInfo.CurrentCulture, Strings.VerboseRunningMessage, dscResourceRule.GetName()));
 
@@ -407,7 +497,6 @@ private void AnalyzeFile(string filePath)
                         catch (Exception dscResourceRuleException)
                         {
                             WriteError(new ErrorRecord(dscResourceRuleException, Strings.RuleErrorMessage, ErrorCategory.InvalidOperation, filePath));
-                            continue;
                         }    
                     }
                 }
@@ -435,8 +524,24 @@ private void AnalyzeFile(string filePath)
                                     // Run all DSC Rules
                                     foreach (IDSCResourceRule dscResourceRule in ScriptAnalyzer.Instance.DSCResourceRules)
                                     {
-                                        if ((includeRule == null || includeRule.Contains(dscResourceRule.GetName(), StringComparer.OrdinalIgnoreCase)) &&
-                                            (excludeRule == null || !excludeRule.Contains(dscResourceRule.GetName(), StringComparer.OrdinalIgnoreCase)))
+                                        bool includeRegexMatch = false;
+                                        bool excludeRegexMatch = false;
+                                        foreach (Regex include in includeRegexList)
+                                        {
+                                            if (include.IsMatch(dscResourceRule.GetName()))
+                                            {
+                                                includeRegexMatch = true;
+                                                break;
+                                            }
+                                        }
+                                        foreach (Regex exclude in excludeRegexList)
+                                        {
+                                            if (exclude.IsMatch(dscResourceRule.GetName()))
+                                            {
+                                                excludeRegexMatch = true;
+                                            }
+                                        }
+                                        if ((includeRule == null || includeRegexMatch) && (excludeRule == null || !excludeRegexMatch))
                                         {
                                             WriteVerbose(string.Format(CultureInfo.CurrentCulture, Strings.VerboseRunningMessage, dscResourceRule.GetName()));
 
@@ -451,7 +556,6 @@ private void AnalyzeFile(string filePath)
                                             catch (Exception dscResourceRuleException)
                                             {
                                                 WriteError(new ErrorRecord(dscResourceRuleException, Strings.RuleErrorMessage, ErrorCategory.InvalidOperation, filePath));
-                                                continue;
                                             }  
                                         }
                                     }

Engine/Generic/AvoidCmdletGeneric.cs

@@ -1,4 +1,16 @@
-using System;
+//
+// Copyright (c) Microsoft Corporation.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+//
+
+using System;
 using System.Collections.Generic;
 using System.Linq;
 using System.Text;
@@ -81,5 +93,11 @@ public IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName)
         /// </summary>
         /// <returns>The source type of the rule.</returns>
         public abstract  SourceType GetSourceType();
+
+        /// <summary>
+        /// GetSeverity: Retrieves the severity of the rule: error, warning of information.
+        /// </summary>
+        /// <returns></returns>
+        public abstract RuleSeverity GetSeverity();
     }
 }

Engine/Generic/AvoidParameterGeneric.cs

@@ -1,4 +1,16 @@
-using System;
+//
+// Copyright (c) Microsoft Corporation.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+//
+
+using System;
 using System.Collections.Generic;
 using System.Linq;
 using System.Text;
@@ -92,5 +104,7 @@ public IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName)
         /// </summary>
         /// <returns>The source type of the rule.</returns>
         public abstract  SourceType GetSourceType();
+
+        public abstract RuleSeverity GetSeverity();
     }
 }

Engine/Generic/DiagnosticRecord.cs

@@ -1,4 +1,16 @@
-using System;
+//
+// Copyright (c) Microsoft Corporation.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+//
+
+using System;
 using System.Collections.Generic;
 using System.Linq;
 using System.Text;