powershell-az.tests.ps1

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
142
143
144
145
146
147
148
149
150
151
#Requires -Version 7
#Requires -Module @{ModuleName='Pester';ModuleVersion='5.2.0'}

Describe 'powershell-az.psm1' {
    BeforeAll {
        Import-Module $PSCommandPath.Replace('.tests.ps1','.psm1') -Force -Verbose:$false -Debug:$false
    }

    Context 'Invoke-AzCommand' {
        BeforeAll {
            Mock -ModuleName powershell-az Invoke-Az {}

            function Out-Error ($Message) {
                [System.Management.Automation.ErrorRecord]::new([System.Management.Automation.RemoteException]::new($Message), 'NativeCommandErrorMessage', [System.Management.Automation.ErrorCategory]::NotSpecified, $null)
            }
        }

        AfterEach {
            $global:VerbosePreference = 'SilentlyContinue'
            $global:DebugPreference = 'SilentlyContinue'
            $env:TF_BUILD=$null
            $env:GITHUB_ACTIONS=$null
        }

        It 'should return JSON content as hashtable' {
            Mock -ModuleName powershell-az Invoke-Az { @{ key = 'value'} | ConvertTo-Json -Compress }
            $Result = az command
            $Result | Should -BeOfType [Hashtable]
        }

        It 'should string a string is --output is not json or jsonc' {
            Mock -ModuleName powershell-az Invoke-Az { 'value' }
            $Result = az command --output tsv
            $Result | Should -BeOfType [string]
        }

        It 'should add --debug if DebugPreference is not SilentlyContinue' {
            Mock -ModuleName powershell-az Invoke-Az {} -ParameterFilter { $args[1] -eq '--debug' } -Verifiable
            $global:DebugPreference = 'Continue'
            az command
            Should -InvokeVerifiable
        }

        It 'should add --verbose if VerbosePreference is not SilentlyContinue' {
            Mock -ModuleName powershell-az Invoke-Az {} -ParameterFilter { $args[1] -eq '--verbose' } -Verifiable
            $global:VerbosePreference = 'Continue'
            az command
            Should -InvokeVerifiable
        }

        It 'when env:TF_BUILD is defined should write command' {
            $env:TF_BUILD=1
            az command *>&1 | Should -BeLike '##`[command`]*'
        }

        It 'when env:GITHUB_ACTIONS is defined should write command' {
            $env:GITHUB_ACTIONS=1
            $Output = @(az command *>&1)
            $Output[0] | Should -BeLike '::group::*'
            $Output[1] | Should -Be '::endgroup::'
        }

        It 'when WARNING error output then should Write-Warning' {
            Mock -ModuleName powershell-az Invoke-Az { Out-Error 'WARNING: Message' }
            az command 3>&1 | Should -BeLike 'Message*'
        }

        It 'when ERROR error output then should Write-Error' {
            Mock -ModuleName powershell-az Invoke-Az { Out-Error 'ERROR: Message' }
            az command 2>&1 | Should -BeLike 'az command failed: Message*'
        }

        It 'when INFO error output then should Write-Verbose' {
            Mock -ModuleName powershell-az Invoke-Az { Out-Error 'INFO: Message' }
            $global:VerbosePreference = 'Continue'
            az command 4>&1 | Should -BeLike 'Message*'
        }

        It 'when VERBOSE error output then should Write-Verbose' {
            Mock -ModuleName powershell-az Invoke-Az { Out-Error 'VERBOSE: Message' }
            $global:VerbosePreference = 'Continue'
            az command 4>&1 | Should -BeLike 'Message*'
        }

        It 'when DEBUG error output then should Write-Debug' {
            Mock -ModuleName powershell-az Invoke-Az { Out-Error 'DEBUG: Message' }
            $global:DebugPreference = 'Continue'
            az command 5>&1 | Should -BeLike 'Message*'
        }
    }

    Context 'ConvertTo-AzJson' {
        It 'should encode JSON as string without quotes' {
            $Value = @{} | ConvertTo-Json
            $Value | Should -Be '{}'
        }
    }

    Context 'Out-AzJsonFile' {
        AfterEach {
            if (Test-Path -Path $Path -PathType Leaf) {
                Remove-Item -Path $Path -Force
            }
        }

        It 'should create temporary file when -Path is not provided' {
            $Path = @{} | Out-AzJsonFile
            Test-Path -Path $Path -PathType Leaf | Should -Be $true
        }

        It 'should write to -Path when provided' {
            $Path = [System.IO.Path]::GetTempFileName()
            $ActualPath = @{} | Out-AzJsonFile -Path $Path
            $ActualPath | Should -Be $Path
            Get-Content -Path $Path | Should -Not -BeNullOrEmpty
        }

        It 'should write json to file' {
            $Path = @{ key = 'value' } | Out-AzJsonFile
            $Json = Get-Content -Path $Path | ConvertFrom-Json
            $Json.key | Should -Be 'value'
        }
    }

    Context 'Out-AzDeploymentParameters' {
        AfterEach {
            if (Test-Path -Path $Path -PathType Leaf) {
                Remove-Item -Path $Path -Force
            }
        }

        It 'should create temporary file when -Path is not provided' {
            $Path = @{} | Out-AzDeploymentParameters
            Test-Path -Path $Path -PathType Leaf | Should -Be $true
        }

        It 'should write to -Path when provided' {
            $Path = [System.IO.Path]::GetTempFileName()
            $ActualPath = @{} | Out-AzDeploymentParameters -Path $Path
            $ActualPath | Should -Be $Path
            Get-Content -Path $Path | Should -Not -BeNullOrEmpty
        }

        It 'should map key/value to parameters' {
            $Path = @{ key = 'value' } | Out-AzDeploymentParameters
            $Parameters = (Get-Content -Path $Path | ConvertFrom-Json).parameters
            $Parameters.key | Should -Not -BeNullOrEmpty
            $Parameters.key.value | Should -Be 'value'
        }
    }
}