PSScriptAnalyzer/Tests/Rules/MissingTryBlock.tests.ps1 at f53cc38d58477ba72cfdbb021d8b1f9083e56145 · 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
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License.

[Diagnostics.CodeAnalysis.SuppressMessage('PSUseDeclaredVarsMoreThanAssignments', '', Justification = 'False positive')]
param()

BeforeAll {
    $ruleName = "PSMissingTryBlock"
}

Describe "MissingTryBlock" {
    Context "Violates" {
        It "Catch is missing a try block" {
            $scriptDefinition = { catch { "An error occurred." } }.ToString()
            $violations = Invoke-ScriptAnalyzer -ScriptDefinition $scriptDefinition -IncludeRule @($ruleName)
            $violations.Count             | Should -Be 1
            $violations.Severity          | Should -Be Warning
            $violations.Extent.Text       | Should -Be catch
            $violations.Message           | Should -Be 'Catch is missing a try block'
            $violations.RuleSuppressionID | Should -Be catch
        }

        It "Finally is missing a try block" {
            $scriptDefinition = { finally { "Finalizing..." } }.ToString()
            $violations = Invoke-ScriptAnalyzer -ScriptDefinition $scriptDefinition -IncludeRule @($ruleName)
            $violations.Count             | Should -Be 1
            $violations.Severity          | Should -Be Warning
            $violations.Extent.Text       | Should -Be finally
            $violations.Message           | Should -Be 'Finally is missing a try block'
            $violations.RuleSuppressionID | Should -Be finally
        }

        It "Single line catch and finally is missing a try block" {
            $scriptDefinition = {
                catch { "An error occurred." } finally { "Finalizing..." }
            }.ToString()
            $violations = Invoke-ScriptAnalyzer -ScriptDefinition $scriptDefinition -IncludeRule @($ruleName)
            $violations.Count             | Should -Be 1
            $violations.Severity          | Should -Be Warning
            $violations.Extent.Text       | Should -Be catch
            $violations.Message           | Should -Be 'Catch is missing a try block'
            $violations.RuleSuppressionID | Should -Be catch
        }

        It "Multi line catch and finally is missing a try block" {
            $scriptDefinition = {
                catch { "An error occurred." }
                finally { "Finalizing..." }
            }.ToString()
            $violations = Invoke-ScriptAnalyzer -ScriptDefinition $scriptDefinition -IncludeRule @($ruleName)
            $violations.Count                | Should -Be 2
            $violations[0].Severity          | Should -Be Warning
            $violations[0].Extent.Text       | Should -Be catch
            $violations[0].Message           | Should -Be 'Catch is missing a try block'
            $violations[0].RuleSuppressionID | Should -Be catch
            $violations[1].Severity          | Should -Be Warning
            $violations[1].Extent.Text       | Should -Be finally
            $violations[1].Message           | Should -Be 'Finally is missing a try block'
            $violations[1].RuleSuppressionID | Should -Be finally
        }
    }

    Context "Compliant" {
        It "try-catch block" {
            $scriptDefinition = {
                try { NonsenseString }
                catch { "An error occurred." }
            }.ToString()
            $violations = Invoke-ScriptAnalyzer -ScriptDefinition $scriptDefinition -IncludeRule @($ruleName)
            $violations | Should -BeNullOrEmpty
        }

        It "try-catch-final statement" {
            $scriptDefinition = {
                try { NonsenseString }
                catch { "An error occurred." }
                finally { "Finalizing..." }
            }.ToString()
            $violations = Invoke-ScriptAnalyzer -ScriptDefinition $scriptDefinition -IncludeRule @($ruleName)
            $violations | Should -BeNullOrEmpty
        }

        It "Single line try statement" {
            $scriptDefinition = {
                try { NonsenseString } catch { "An error occurred." } finally { "Finalizing..." }
            }.ToString()
            $violations = Invoke-ScriptAnalyzer -ScriptDefinition $scriptDefinition -IncludeRule @($ruleName)
            $violations | Should -BeNullOrEmpty
        }

        It "Catch as parameter" {
            $scriptDefinition = { Write-Host Catch }.ToString()
            $violations = Invoke-ScriptAnalyzer -ScriptDefinition $scriptDefinition -IncludeRule @($ruleName)
            $violations | Should -BeNullOrEmpty
        }

        It "Catch as double quoted string" {
            $scriptDefinition = { "Catch" }.ToString()
            $violations = Invoke-ScriptAnalyzer -ScriptDefinition $scriptDefinition -IncludeRule @($ruleName)
            $violations | Should -BeNullOrEmpty
        }

        It "Catch as single quoted string" {
            $scriptDefinition = { 'Catch' }.ToString()
            $violations = Invoke-ScriptAnalyzer -ScriptDefinition $scriptDefinition -IncludeRule @($ruleName)
            $violations | Should -BeNullOrEmpty
        }
    }

    Context "Suppressed" {
        It "Multi line catch and finally is missing a try block" {
            $scriptDefinition = {
                [Diagnostics.CodeAnalysis.SuppressMessage('PSMissingTryBlock', '', Justification = 'Test')]
                param()
                catch { "An error occurred." }
                finally { "Finalizing..." }
            }.ToString()
            $violations = Invoke-ScriptAnalyzer -ScriptDefinition $scriptDefinition -IncludeRule @($ruleName)
            $violations | Should -BeNullOrEmpty
        }

        It "Multi line catch and finally is missing a try block for catch only" {
            $scriptDefinition = {
                [Diagnostics.CodeAnalysis.SuppressMessage('PSMissingTryBlock', 'finally', Justification = 'Test')]
                param()
                catch { "An error occurred." }
                finally { "Finalizing..." }
            }.ToString()
            $violations = Invoke-ScriptAnalyzer -ScriptDefinition $scriptDefinition -IncludeRule @($ruleName)
            $violations.Count | Should -Be 1
        }
    }
}