Merge pull request #739 from PowerShell/kapilmb/fix-case-whitelist

Fix whitelisted aliases comparison in PSAvoidUsingCmdletAliases rule

Author: Kapil Borle

Rules/AvoidAlias.cs

@@ -18,6 +18,7 @@
 using System.ComponentModel.Composition;
 #endif
 using System.Globalization;
+using System.Linq;
 
 namespace Microsoft.Windows.PowerShell.ScriptAnalyzer.BuiltinRules
 {
@@ -119,7 +120,7 @@ public IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName)
                 // You can also review the remark section in following document,
                 // MSDN: CommandAst.GetCommandName Method
                 if (aliasName == null
-                    || whiteList.Contains(aliasName))
+                    || whiteList.Contains<string>(aliasName, StringComparer.OrdinalIgnoreCase))
                 {
                     continue;
                 }

Tests/Rules/AvoidUsingAlias.tests.ps1

@@ -61,7 +61,16 @@ Configuration MyDscConfiguration {
     }
 
     Context "Settings file provides whitelist" {
-        $whiteListTestScriptDef = 'gci; cd;'
+        BeforeAll {
+            $whiteListTestScriptDef = 'gci; cd;'
+            $settings = @{
+                'Rules' = @{
+                    'PSAvoidUsingCmdletAliases' = @{
+                        'Whitelist' = @('cd')
+                    }
+                }
+            }
+        }
 
         It "honors the whitelist provided as hashtable" {
             $settings = @{
@@ -81,5 +90,10 @@ Configuration MyDscConfiguration {
             $violations = Invoke-ScriptAnalyzer -ScriptDefinition $whiteListTestScriptDef -Settings $settingsFilePath -IncludeRule $violationName
             $violations.Count | Should be 1
         }
+
+        It "honors the whitelist in a case-insensitive manner" {
+            $violations = Invoke-ScriptAnalyzer -ScriptDefinition "CD" -Settings $settings -IncludeRule $violationName
+            $violations.Count | Should Be 0
+        }
     }
 }