Merge pull request #164 from PowerShell/BugFixes

Bug fixes

Author: yutingc

Engine/Commands/GetScriptAnalyzerRuleCommand.cs

@@ -142,7 +142,7 @@ protected override void ProcessRecord()
             {
                 if (severity != null)
                 {
-                    var ruleSeverity = severity.Select(item => Enum.Parse(typeof (RuleSeverity), item));
+                    var ruleSeverity = severity.Select(item => Enum.Parse(typeof (RuleSeverity), item, true));
                     rules = rules.Where(item => ruleSeverity.Contains(item.GetSeverity())).ToList();
                 }
 

Engine/Commands/InvokeScriptAnalyzerCommand.cs

@@ -581,7 +581,7 @@ private void AnalyzeFile(string filePath)
 
             if (severity != null)
             {
-                var diagSeverity = severity.Select(item => Enum.Parse(typeof(DiagnosticSeverity), item));
+                var diagSeverity = severity.Select(item => Enum.Parse(typeof(DiagnosticSeverity), item, true));
                 diagnostics = diagnostics.Where(item => diagSeverity.Contains(item.Severity)).ToList();
             }
 

Engine/SpecialVars.cs

@@ -91,6 +91,7 @@ static SpecialVars()
         internal const string WhatIfPreference = "WhatIfPreference";
         internal const string WarningPreference = "WarningPreference";
         internal const string ConfirmPreference = "ConfirmPreference";
+        internal const string ProgressPreference = "ProgressPreference";
 
         internal static readonly string[] PreferenceVariables = new string[]  
                                                                 {  
@@ -99,7 +100,8 @@ static SpecialVars()
                                                                     ErrorActionPreference,  
                                                                     WhatIfPreference,  
                                                                     WarningPreference,  
-                                                                    ConfirmPreference,  
+                                                                    ConfirmPreference,
+                                                                    ProgressPreference
                                                                 };
 
         internal static readonly Type[] PreferenceVariableTypes = new Type[]  
@@ -109,7 +111,8 @@ static SpecialVars()
                                                                     /* ErrorPreference */   typeof(ActionPreference),  
                                                                     /* WhatIfPreference */  typeof(SwitchParameter),  
                                                                     /* WarningPreference */ typeof(ActionPreference),  
-                                                                    /* ConfirmPreference */ typeof(ConfirmImpact),  
+                                                                    /* ConfirmPreference */ typeof(ConfirmImpact), 
+                                                                    /* ProgressPreference */ typeof(Enum),
                                                                 };
 
         internal enum AutomaticVariable

Engine/VariableAnalysis.cs

@@ -339,7 +339,8 @@ public bool IsUninitialized(VariableExpressionAst varTarget)
             }
 
             return analysis.DefinedBlock == null
-                && !SpecialVars.InitializedVariables.Contains(analysis.Name, StringComparer.OrdinalIgnoreCase)
+                && !(SpecialVars.InitializedVariables.Contains(analysis.Name, StringComparer.OrdinalIgnoreCase) || 
+                SpecialVars.InitializedVariables.Contains(analysis.RealName, StringComparer.OrdinalIgnoreCase)) 
                 && !IsGlobalOrEnvironment(varTarget);
         }
 

Rules/AvoidDefaultTrueValueSwitchParameter.cs

@@ -39,7 +39,7 @@ public IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName)
             // Iterrates all ParamAsts and check if any are switch.
             foreach (ParameterAst paramAst in paramAsts)
             {
-                if (paramAst.Attributes.Any(attr => String.Equals(attr.TypeName.FullName, "switch", StringComparison.OrdinalIgnoreCase))
+                if (paramAst.Attributes.Any(attr => string.Equals(attr.TypeName.GetReflectionType().FullName, "system.management.automation.switchparameter", StringComparison.OrdinalIgnoreCase))
                     && paramAst.DefaultValue != null && String.Equals(paramAst.DefaultValue.Extent.Text, "$true", StringComparison.OrdinalIgnoreCase))
                 {
                     yield return new DiagnosticRecord(

Rules/MissingModuleManifestField.cs

@@ -12,6 +12,7 @@
 
 using System;
 using System.Collections.Generic;
+using System.Collections.ObjectModel;
 using System.Management.Automation.Language;
 using System.Management.Automation;
 using Microsoft.Windows.Powershell.ScriptAnalyzer.Generic;
@@ -44,6 +45,10 @@ public IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName)
                 {
                     ps.AddCommand("Test-ModuleManifest");
                     ps.AddParameter("Path", fileName);
+                    
+                    // Suppress warnings emitted during the execution of Test-ModuleManifest
+                    // ModuleManifest rule must catch any violations (warnings/errors) and generate DiagnosticRecord(s)
+                    ps.AddParameter("WarningAction", ActionPreference.SilentlyContinue);                    
                     ps.Invoke();
 
                 } catch { }

Rules/UseOutputTypeCorrectly.cs

@@ -110,6 +110,7 @@ public override AstVisitAction VisitFunctionDefinition(FunctionDefinitionAst fun
                     || String.Equals(typeof(Unreached).FullName, typeName, StringComparison.OrdinalIgnoreCase)
                     || String.Equals(typeof(Undetermined).FullName, typeName, StringComparison.OrdinalIgnoreCase)
                     || String.Equals(typeof(object).FullName, typeName, StringComparison.OrdinalIgnoreCase)
+                    || String.Equals(typeof(void).FullName, typeName, StringComparison.OrdinalIgnoreCase)
                     || outputTypes.Contains(typeName, StringComparer.OrdinalIgnoreCase))
                 {
                     continue;

Rules/UseSingularNouns.cs

@@ -49,7 +49,7 @@ public IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName) {
                     String noun = funcNamePieces[1];
                     var ps = System.Data.Entity.Design.PluralizationServices.PluralizationService.CreateService(CultureInfo.GetCultureInfo("en-us"));
 
-                    if (ps.IsPlural(noun))
+                    if (!ps.IsSingular(noun))
                     {
                         yield return new DiagnosticRecord(string.Format(CultureInfo.CurrentCulture, Strings.UseSingularNounsError, funcAst.Name),
                             funcAst.Extent, GetName(), DiagnosticSeverity.Warning, fileName);

Tests/Engine/GetScriptAnalyzerRule.tests.ps1

@@ -113,23 +113,28 @@ Describe "Test RuleExtension" {
 Describe "TestSeverity" {
     It "filters rules based on the specified rule severity" {
         $rules = Get-ScriptAnalyzerRule -Severity Error
-        $rules.Count | Should be 4
+        $rules.Count | Should be 6
     }
 
     It "filters rules based on multiple severity inputs"{
         $rules = Get-ScriptAnalyzerRule -Severity Error,Information
-        $rules.Count | Should be 8
+        $rules.Count | Should be 12
+    }
+
+        It "takes lower case inputs" {
+        $rules = Get-ScriptAnalyzerRule -Severity error
+        $rules.Count | Should be 6
     }
 }
 
 Describe "TestWildCard" {
     It "filters rules based on the -Name wild card input" {
         $rules = Get-ScriptAnalyzerRule -Name PSDSC*
-        $rules.Count | Should be 4
+        $rules.Count | Should be 6
     }
 
     It "filters rules based on wild card input and severity"{
         $rules = Get-ScriptAnalyzerRule -Name PSDSC*　-Severity Information
-        $rules.Count | Should be 2
+        $rules.Count | Should be 3
     }
 }

Tests/Engine/InvokeScriptAnalyzer.tests.ps1

@@ -141,7 +141,7 @@ Describe "Test IncludeRule" {
 
         it "includes 2 wildcardrules" {
             $includeWildcard = Invoke-ScriptAnalyzer $directory\..\Rules\BadCmdlet.ps1 -IncludeRule $avoidRules, $useRules 
-            $includeWildcard.Count | Should be 7
+            $includeWildcard.Count | Should be 9
         }
     }
 }
@@ -169,6 +169,11 @@ Describe "Test Severity" {
             $errors = Invoke-ScriptAnalyzer $directory\TestScript.ps1 -Severity Information, Warning
             $errors.Count | Should Be 2
         }
+
+        It "works with lowercase argument"{
+             $errors = Invoke-ScriptAnalyzer $directory\TestScript.ps1 -Severity information, warning
+            $errors.Count | Should Be 2
+        }
     }
 
     Context "When used incorrectly" {

Tests/Rules/AvoidDefaultTrueValueSwitchParameter.ps1

@@ -13,7 +13,11 @@
 
         # Param2 help description
         [switch]
-        $switch=$true
+        $switch=$true,
+        
+        # Param3 help description
+        [System.Management.Automation.SwitchParameter]
+        $switch2 = $true
     )
 
     Begin

Tests/Rules/AvoidDefaultTrueValueSwitchParameter.tests.ps1

@@ -7,8 +7,8 @@ $noViolations = Invoke-ScriptAnalyzer $directory\AvoidDefaultTrueValueSwitchPara
 
 Describe "AvoidDefaultTrueValueSwitchParameter" {
     Context "When there are violations" {
-        It "has 1 avoid using switch parameter default to true violation" {
-            $violations.Count | Should Be 1
+        It "has 2 avoid using switch parameter default to true violation" {
+            $violations.Count | Should Be 2
         }
 
         It "has the correct description message" {

Tests/Rules/AvoidGlobalOrUnitializedVarsNoViolations.ps1

@@ -1,30 +1,41 @@
-function Test {
-    $initialized = "Initialized"
-    $noglobal = "local"
-    $env:ShouldNotRaiseError
-}
-
-$a = 3;
-
-if ($true) {
-    $a = 4;
-    $c = 3;
-} else {
-    $b = 5;
-    $c = 4;
-}
-
-$b = 6;
-$a;
-$b;
-
-stop-process 12,23 -ErrorVariable ev -ErrorAction SilentlyContinue
-if($null -ne $ev)
-{
-    Write-host $ev[0]
-    # no error should be raised here
-    Invoke-Command {$b}
-}
-
-get-process notepad | tee-object -variable proc 
-$proc[0]
+function Test {
+    $initialized = "Initialized"
+    $noglobal = "local"
+    $env:ShouldNotRaiseError
+}
+
+$a = 3;
+
+if ($true) {
+    $a = 4;
+    $c = 3;
+} else {
+    $b = 5;
+    $c = 4;
+}
+
+$b = 6;
+$a;
+$b;
+
+stop-process 12,23 -ErrorVariable ev -ErrorAction SilentlyContinue
+if($null -ne $ev)
+{
+    Write-host $ev[0]
+    # no error should be raised here
+    Invoke-Command {$b}
+}
+
+get-process notepad | tee-object -variable proc 
+$proc[0]
+
+function Test-PreferenceVariable
+{
+
+   if (-not $PSBoundParameters.ContainsKey('Verbose')) {
+       $VerbosePreference = $PSCmdlet.GetVariableValue('VerbosePreference') -as 
+        [System.Management.Automation.ActionPreference]
+        }
+
+        $VerbosePreference
+    }

Tests/Rules/AvoidUsingUninitializedVariable.Tests.ps1

@@ -0,0 +1,24 @@
+Import-Module PSScriptAnalyzer
+$AvoidUninitializedVariable = "PSAvoidUninitializedVariable"
+$violationMessage = "Variable 'MyProgressPreference' is not initialized. Non-global variables must be initialized. To fix a violation of this rule, please initialize non-global variables."
+$directory = Split-Path -Parent $MyInvocation.MyCommand.Path
+$violations = Invoke-ScriptAnalyzer $directory\AvoidUsingUninitializedVariable.ps1 -IncludeRule $AvoidUninitializedVariable
+$noViolations = Invoke-ScriptAnalyzer $directory\AvoidUsingUninitializedVariableNoViolations.ps1 -IncludeRule $AvoidUninitializedVariable
+
+Describe "AvoidUsingUninitializedVariable" {
+    Context "Script uses uninitialized variables - Violation" {
+        It "Have 3 rule violations" {
+            $violations.Count | Should Be 3
+        }
+
+        It "has the correct description message for UninitializedVariable rule violation" {
+            $violations[0].Message | Should Be $violationMessage            
+        }
+    }
+
+    Context "Script uses initialized variables - No violation" {
+        It "results in no rule violations" {
+            $noViolations.Count | Should Be 0
+        }
+    }
+}

Tests/Rules/AvoidUsingUninitializedVariable.ps1

@@ -0,0 +1,10 @@
+# Script has uninitialized variables
+# Must result in AvoidUsingUninitializedVariablerule violations along with other violations
+
+function Test-MyPreference
+{
+    Write-Verbose $MyProgressPreference
+    Write-Verbose $MyVerbosePreference
+}
+
+Write-Verbose $MyProgressPreference

Tests/Rules/AvoidUsingUninitializedVariableNoViolations.ps1

@@ -0,0 +1,11 @@
+# Script uses built-in preference variables
+# Must not result in AvoidUsingUninitializedVariablerule violations
+# However there are other violations in this script - Write-Verbose is not using positional parameters
+
+function Test-Preference
+{
+    Write-Verbose $ProgressPreference
+    Write-Verbose $VerbosePreference
+}
+
+Write-Verbose $ProgressPreference

Tests/Rules/GoodCmdlet.ps1

@@ -91,6 +91,7 @@ function Get-File
     {
         if ($pscmdlet.ShouldContinue("Yes", "No")) {
         }
+        [System.Void] $Param3
     }
 }