Fix exceptions in importing CustomizedRule

yutingc · yutingc · commit 8919af706da2 · 2015-05-04T13:29:17.000-07:00
diff --git a/Engine/Commands/InvokeScriptAnalyzerCommand.cs b/Engine/Commands/InvokeScriptAnalyzerCommand.cs
@@ -14,14 +14,11 @@
 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.Management.Automation.Language;
-using System.Resources;
-using System.Threading;
 using System.Reflection;
 using System.IO;
 using System.Text;
diff --git a/Engine/Generic/SourceType.cs b/Engine/Generic/SourceType.cs
@@ -10,12 +10,6 @@
 // THE SOFTWARE.
 //
 
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
-
 namespace Microsoft.Windows.Powershell.ScriptAnalyzer.Generic
 {
     /// <summary>
diff --git a/Engine/ScriptAnalyzer.cs b/Engine/ScriptAnalyzer.cs
@@ -142,7 +142,7 @@ public void Initilaize(Dictionary<string, List<string>> result)
                 paths = result.ContainsKey("ValidDllPaths") ? result["ValidDllPaths"] : result["ValidPaths"];
                 foreach (string path in paths)
                 {
-                    if (Path.GetExtension(path).ToLower(CultureInfo.CurrentCulture) == ".dll")
+                    if (String.Equals(Path.GetExtension(path),".dll", StringComparison.OrdinalIgnoreCase))
                     {
                         catalog.Catalogs.Add(new AssemblyCatalog(path));
                     }
@@ -241,8 +241,8 @@ public List<ExternalRule> GetExternalRule(string[] moduleNames)
 
                         FunctionInfo funcInfo = (FunctionInfo)psobject.ImmediateBaseObject;
                         ParameterMetadata param = funcInfo.Parameters.Values
-                            .First<ParameterMetadata>(item => item.Name.ToLower(CultureInfo.CurrentCulture).EndsWith("ast", StringComparison.CurrentCulture) ||
-                                                              item.Name.ToLower(CultureInfo.CurrentCulture).EndsWith("token", StringComparison.CurrentCulture));
+                            .First<ParameterMetadata>(item => item.Name.EndsWith("ast", StringComparison.OrdinalIgnoreCase) ||
+                                                              item.Name.EndsWith("token", StringComparison.OrdinalIgnoreCase));
                         
                         //Only add functions that are defined as rules.
                         if (param != null)
@@ -251,7 +251,7 @@ public List<ExternalRule> GetExternalRule(string[] moduleNames)
                             string desc =posh.AddScript(script).Invoke()[0].ImmediateBaseObject.ToString()
                                     .Replace("\r\n", " ").Trim();
 
-                            rules.Add(new ExternalRule(funcInfo.Name, funcInfo.Name, desc, param.Name,
+                            rules.Add(new ExternalRule(funcInfo.Name, funcInfo.Name, desc, param.ParameterType.Name,
                                 funcInfo.ModuleName, funcInfo.Module.Path));
                         }
                     }
@@ -337,7 +337,7 @@ public IEnumerable<DiagnosticRecord> GetExternalRecord(Ast ast, Token[] token, E
                 {
                     // Find all AstTypes that appeared in rule groups.
                     IEnumerable<Ast> childAsts = ast.FindAll(new Func<Ast, bool>((testAst) =>
-                        (testAst.GetType().Name.ToLower(CultureInfo.CurrentCulture) == astRuleGroup.Key.ToLower(CultureInfo.CurrentCulture))), false);
+                        Strings.Equals(testAst.GetType().Name, astRuleGroup.Key)), false);
 
                     foreach (Ast childAst in childAsts)
                     {
@@ -381,30 +381,34 @@ public IEnumerable<DiagnosticRecord> GetExternalRecord(Ast ast, Token[] token, E
                         string message = string.Empty;
                         string ruleName = string.Empty;
 
-                        // Because error stream is merged to output stream,
-                        // we need to handle the error records.
-                        if (psobject.ImmediateBaseObject is ErrorRecord)
+                        //Make sure returned DiagnosticRecord is not null
+                        if (psobject!= null && psobject.ImmediateBaseObject != null)
                         {
-                            ErrorRecord record = (ErrorRecord)psobject.ImmediateBaseObject;
-                            command.WriteError(record);
-                            continue;
-                        }
-
-                        // DiagnosticRecord may not be correctly returned from external rule.
-                        try
-                        {
-                            Enum.TryParse<DiagnosticSeverity>(psobject.Properties["Severity"].Value.ToString().ToUpper(), out severity);
-                            message = psobject.Properties["Message"].Value.ToString();
-                            extent = (IScriptExtent)psobject.Properties["Extent"].Value;
-                            ruleName = psobject.Properties["RuleName"].Value.ToString();
-                        }
-                        catch (Exception ex)
-                        {
-                            command.WriteError(new ErrorRecord(ex, ex.HResult.ToString("X"), ErrorCategory.NotSpecified, this));
-                            continue;
+                            // Because error stream is merged to output stream,
+                            // we need to handle the error records.
+                            if (psobject.ImmediateBaseObject is ErrorRecord)
+                            {
+                                ErrorRecord record = (ErrorRecord)psobject.ImmediateBaseObject;
+                                command.WriteError(record);
+                                continue;
+                            }
+
+                            // DiagnosticRecord may not be correctly returned from external rule.
+                            try
+                            {
+                                Enum.TryParse<DiagnosticSeverity>(psobject.Properties["Severity"].Value.ToString().ToUpper(), out severity);
+                                message = psobject.Properties["Message"].Value.ToString();
+                                extent = (IScriptExtent)psobject.Properties["Extent"].Value;
+                                ruleName = psobject.Properties["RuleName"].Value.ToString();
+                            }
+                            catch (Exception ex)
+                            {
+                                command.WriteError(new ErrorRecord(ex, ex.HResult.ToString("X"), ErrorCategory.NotSpecified, this));
+                                continue;
+                            }
+
+                            if (!string.IsNullOrEmpty(message)) yield return new DiagnosticRecord(message, extent, ruleName, severity, null);
                         }
-
-                        if (!string.IsNullOrEmpty(message)) yield return new DiagnosticRecord(message, extent, ruleName, severity, null);
                     }
                 }
 
@@ -453,7 +457,11 @@ public Dictionary<string, List<string>> CheckRuleExtension(string[] path, PSCmdl
                         // Adds original path, otherwise path.Except<string>(validModPaths) will fail.
                         // It's possible that user can provide something like this:
                         // "..\..\..\ScriptAnalyzer.UnitTest\modules\CommunityAnalyzerRules\CommunityAnalyzerRules.psd1"
-                        if (moduleInfo.ExportedFunctions.Count > 0) validModPaths.Add(childPath);
+                        if (moduleInfo.ExportedFunctions.Count > 0)
+                        {
+                            validModPaths.Add(childPath);
+                            cmdlet.WriteVerbose(string.Format(CultureInfo.CurrentCulture, Strings.ImportCustomizedRuleSuccess, childPath));
+                        }
                     }
                 }
                 catch
@@ -478,7 +486,7 @@ public Dictionary<string, List<string>> CheckRuleExtension(string[] path, PSCmdl
 
                     cmdlet.WriteDebug(string.Format(CultureInfo.CurrentCulture, Strings.CheckAssemblyFile, resolvedPath));
 
-                    if (Path.GetExtension(resolvedPath).ToLower(CultureInfo.CurrentCulture) == ".dll")
+                    if (String.Equals(Path.GetExtension(resolvedPath),".dll",StringComparison.OrdinalIgnoreCase))
                     {
                         if (!File.Exists(resolvedPath))
                         {
diff --git a/Engine/ScriptAnalyzerEngine.csproj b/Engine/ScriptAnalyzerEngine.csproj
@@ -82,7 +82,9 @@
   </ItemGroup>
   <ItemGroup>
     <None Include="PSScriptAnalyzer.psd1" />
-    <None Include="ScriptAnalyzer.format.ps1xml" />
+    <None Include="ScriptAnalyzer.format.ps1xml">
+      <SubType>Designer</SubType>
+    </None>
     <None Include="ScriptAnalyzer.types.ps1xml" />
   </ItemGroup>
   <ItemGroup>
diff --git a/Engine/Strings.Designer.cs b/Engine/Strings.Designer.cs
diff --git a/Engine/Strings.resx b/Engine/Strings.resx
@@ -135,6 +135,9 @@
   <data name="FileNotFound" xml:space="preserve">
     <value>Cannot find file '{0}'.</value>
   </data>
+  <data name="ImportCustomizedRuleSuccess" xml:space="preserve">
+    <value>Customized rules found. Imported to PSScriptAnalyzer rule collections successfully...</value>
+  </data>
   <data name="InvalidPath" xml:space="preserve">
     <value>Cannot find the path '{0}'.</value>
   </data>
diff --git a/Rules/Strings.Designer.cs b/Rules/Strings.Designer.cs
diff --git a/Rules/Strings.resx b/Rules/Strings.resx
@@ -678,4 +678,7 @@
   <data name="AvoidUsingWMIObjectCmdletName" xml:space="preserve">
     <value>AvoidUsingWMIObjectCmdlet</value>
   </data>
+  <data name="ImportCustomizedRuleSuccess" xml:space="preserve">
+    <value>Customized rules found. Imported to PSScriptAnalyzer engine successfully...</value>
+  </data>
 </root>
diff --git a/Rules/UseCmdletCorrectly.cs b/Rules/UseCmdletCorrectly.cs
@@ -45,9 +45,6 @@ public IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName)
             {
                 CommandAst cmdAst = (CommandAst)foundAst;
 
-                // Handles the exception caused by commands like, {& $PLINK $args 2> $TempErrorFile}.
-                // You can also review the remark section in following document,
-                // MSDN: CommandAst.GetCommandName Method
                 if (cmdAst.GetCommandName() == null) continue;
 
                 // Checks mandatory parameters.
diff --git a/Tests/Disabled Rules/AvoidOneChar.tests.ps1 b/Tests/Disabled Rules/AvoidOneChar.tests.ps1
@@ -3,7 +3,7 @@ $oneCharMessage = "The cmdlet name O only has one character."
 $oneCharName = "PSOneChar"
 $directory = Split-Path -Parent $MyInvocation.MyCommand.Path
 $invoke = Invoke-ScriptAnalyzer $directory\AvoidUsingReservedCharOneCharNames.ps1 | Where-Object {$_.RuleName -eq $oneCharName}
-$noViolations = Invoke-ScriptAnalyzer $directory\GoodCmdlet.ps1 | Where-Object {$_.RuleName -eq $oneCharName}
+$noViolations = Invoke-ScriptAnalyzer $directory\..\Rules\GoodCmdlet.ps1 | Where-Object {$_.RuleName -eq $oneCharName}
 
 Describe "Avoid Using One Char" {
     Context "When there are violations" {
diff --git a/Tests/Disabled Rules/CommandNotFound.tests.ps1 b/Tests/Disabled Rules/CommandNotFound.tests.ps1
@@ -1,4 +1,4 @@
-﻿Import-Module -Verbose ScriptAnalyzer
+﻿Import-Module -Verbose PSScriptAnalyzer
 $violationMessage = "Command Get-WrongCommand Is Not Found"
 $violationName = "PSCommandNotFound"
 $directory = Split-Path -Parent $MyInvocation.MyCommand.Path

Original file line number	Diff line number	Diff line change
`@@ -45,9 +45,6 @@ public IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName)`
`45`	`45`	`{`
`46`	`46`	`CommandAst cmdAst = (CommandAst)foundAst;`
`47`	`47`
`48`		`- // Handles the exception caused by commands like, {& $PLINK $args 2> $TempErrorFile}.`
`49`		`- // You can also review the remark section in following document,`
`50`		`- // MSDN: CommandAst.GetCommandName Method`
`51`	`48`	`if (cmdAst.GetCommandName() == null) continue;`
`52`	`49`
`53`	`50`	`// Checks mandatory parameters.`