PSScriptAnalyzer/Tests/Rules/AvoidDynamicallyCreatingVariableNames.tests.ps1 at ce37bb8b27109b13451d5fa21f7eccd3ebf574c7 · PowerShell/PSScriptAnalyzer · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License.

[Diagnostics.CodeAnalysis.SuppressMessage('PSUseDeclaredVarsMoreThanAssignments', '', Justification = 'False positive')]
[Diagnostics.CodeAnalysis.SuppressMessage('PSAvoidUsingCmdletAliases', 'nv', Justification = 'For test purposes')]
param()

BeforeAll {
    $ruleName = "PSAvoidDynamicallyCreatingVariableNames"
    $ruleMessage = "'{0}' is a dynamic variable name. Please, avoid creating variables with a dynamic name"
}

Describe "AvoidDynamicallyCreatingVariableNames" {
    Context "Violates" {
        It "Basic dynamic variable name" {
            $scriptDefinition = { New-Variable -Name $Test }.ToString()
            $violations = Invoke-ScriptAnalyzer -ScriptDefinition $scriptDefinition -IncludeRule @($ruleName)
            $violations.Count       | Should -Be 1
            $violations.Severity    | Should -Be Information
            $violations.Extent.Text | Should -Be {New-Variable -Name $Test}.ToString()
            $violations.Message     | Should -Be ($ruleMessage -f '$Test')
        }

        It "Using alias" {
            $scriptDefinition = { nv -Name $Test }.ToString()
            $violations = Invoke-ScriptAnalyzer -ScriptDefinition $scriptDefinition -IncludeRule @($ruleName)
            $violations.Count       | Should -Be 1
            $violations.Severity    | Should -Be Information
            $violations.Extent.Text | Should -Be {nv -Name $Test}.ToString()
            $violations.Message     | Should -Be ($ruleMessage -f '$Test')
        }

        It "Using uppercase" {
            $scriptDefinition = { NEW-VARIABLE -Name $Test }.ToString()
            $violations = Invoke-ScriptAnalyzer -ScriptDefinition $scriptDefinition -IncludeRule @($ruleName)
            $violations.Count       | Should -Be 1
            $violations.Severity    | Should -Be Information
            $violations.Extent.Text | Should -Be {NEW-VARIABLE -Name $Test}.ToString()
            $violations.Message     | Should -Be ($ruleMessage -f '$Test')
        }

        It "Common dynamic variable iteration" {
            $scriptDefinition = {
                'One', 'Two', 'Three' | ForEach-Object -Begin { $i = 1 } -Process {
                    New-Variable -Name "My$_" -Value ($i++)
                }
                $MyTwo # returns 2
            }.ToString()
            $violations = Invoke-ScriptAnalyzer -ScriptDefinition $scriptDefinition -IncludeRule @($ruleName)
            $violations.Count       | Should -Be 1
            $violations.Severity    | Should -Be Information
            $violations.Extent.Text | Should -Be {New-Variable -Name "My$_" -Value ($i++)}.ToString()
            $violations.Message     | Should -Be ($ruleMessage -f 'My$_')
        }

        It "Unquoted positional binding" {
            $scriptDefinition = {
                $myVarName = 'foo'
                New-Variable $myVarName
            }.ToString()
            $violations = Invoke-ScriptAnalyzer -ScriptDefinition $scriptDefinition -IncludeRule @($ruleName)
            $violations.Count       | Should -Be 1
            $violations.Severity    | Should -Be Information
            $violations.Extent.Text | Should -Be {New-Variable $myVarName}.ToString()
            $violations.Message     | Should -Be ($ruleMessage -f '$myVarName')
        }

        It "Quoted positional binding" {
            $scriptDefinition = {
                'One', 'Two', 'Three' | ForEach-Object -Begin { $i = 1 } -Process {
                    New-Variable "My$_" ($i++)
                }
                $MyTwo # returns 2
            }.ToString()
            $violations = Invoke-ScriptAnalyzer -ScriptDefinition $scriptDefinition -IncludeRule @($ruleName)
            $violations.Count       | Should -Be 1
            $violations.Severity    | Should -Be Information
            $violations.Extent.Text | Should -Be {New-Variable "My$_" ($i++)}.ToString()
            $violations.Message     | Should -Be ($ruleMessage -f 'My$_')
        }
    }

    Context "Compliant" {
        It "Common hash table population" {
            $scriptDefinition = {
                $My = @{}
                'One', 'Two', 'Three' | ForEach-Object -Begin { $i = 1 } -Process {
                    $My[$_] = $i++
                }
                $My.Two # returns 2
            }.ToString()
            $violations = Invoke-ScriptAnalyzer -ScriptDefinition $scriptDefinition -IncludeRule @($ruleName)
            $violations | Should -BeNullOrEmpty
        }

        It "Scoped hash table population" {
            $scriptDefinition = {
                New-Variable -Name My -Value @{} -Option ReadOnly -Scope Script
                'One', 'Two', 'Three' | ForEach-Object -Begin { $i = 1 } -Process {
                    $Script:My[$_] = $i++
                }
                $Script:My.Two # returns 2
            }.ToString()
            $violations = Invoke-ScriptAnalyzer -ScriptDefinition $scriptDefinition -IncludeRule @($ruleName)
            $violations | Should -BeNullOrEmpty
        }

        It "Verbatim (single quoted) name with dollar sign" {
            $scriptDefinition = {
                New-Variable -Name '$Sign1'
                New-Variable -Name '$Sign2' -Value 'Dollar'
            }.ToString()
            $violations = Invoke-ScriptAnalyzer -ScriptDefinition $scriptDefinition -IncludeRule @($ruleName)
            $violations | Should -BeNullOrEmpty
        }
    }

    Context "Suppressed" {
        It "Basic dynamic variable name" {
            $scriptDefinition = {
                [Diagnostics.CodeAnalysis.SuppressMessage('PSAvoidDynamicallyCreatingVariableNames', '$Test', Justification = 'Test')]
                Param()
                New-Variable -Name $Test
            }.ToString()
            $violations = Invoke-ScriptAnalyzer -ScriptDefinition $scriptDefinition -IncludeRule @($ruleName)
            $violations | Should -BeNullOrEmpty
        }
        It "Common dynamic variable iteration" {
            $scriptDefinition = {
                [Diagnostics.CodeAnalysis.SuppressMessage('PSAvoidDynamicallyCreatingVariableNames', 'My$_', Justification = 'Test')]
                Param()
                'One', 'Two', 'Three' | ForEach-Object -Begin { $i = 1 } -Process {
                    New-Variable -Name "My$_" -Value ($i++)
                }
                $MyTwo # returns 2
            }.ToString()
            $violations = Invoke-ScriptAnalyzer -ScriptDefinition $scriptDefinition -IncludeRule @($ruleName)
            $violations | Should -BeNullOrEmpty
        }
    }
}