Functions/Connect-ExchangeOnlineAdminAccount.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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
describe "BitTitan.Runbooks.ExchangeOnline/Connect-ExchangeOnlineAdminAccount" -Tag "module", "unit" {

    # Import the function to test
    . "$($PSScriptRoot)\Connect-ExchangeOnlineAdminAccount.ps1"

    context "when there are no issues" {
        # Declare mocks
        mock New-PSSession {
            return New-MockObject -Type System.Management.Automation.Runspaces.PSSession
        }
        mock Import-PSSession {
            return New-MockObject -Type PSModuleInfo
        }
        mock Import-Module {}

        it "connects using the username and password" {
            # Call the function
            $output = Connect-ExchangeOnlineAdminAccount -Username "username" `
                -Password ("password" | ConvertTo-SecureString -AsPlainText -Force)

            # Verify the mocks
            Assert-MockCalled New-PSSession -Times 1 -Exactly -ParameterFilter {
                $ConfigurationName -eq "Microsoft.Exchange" -and
                $ConnectionUri -eq "https://outlook.office365.com/powershell-liveid/" -and
                $Credential.Username -eq "username" -and
                $Credential.GetNetworkCredential().Password -eq "password" -and
                $Name -eq "ExchangeOnline"
            } -Scope it
            Assert-MockCalled Import-PSSession -Times 1 -Exactly -Scope it
            Assert-MockCalled Import-Module -Times 1 -Exactly -Scope it

            # Verify the output
            $output | Should Be $true
        }

        it "connects using an endpoint" {
            # Mock the endpoint
            $endpoint = [PSCustomObject]@{
                Credential = [PSCredential]::new("username", ("password" | ConvertTo-SecureString -AsPlainText -Force))
            }

            # Call the function
            $output = Connect-ExchangeOnlineAdminAccount -Endpoint $endpoint

            # Verify the mocks
            Assert-MockCalled New-PSSession -Times 1 -Exactly -ParameterFilter {
                $ConfigurationName -eq "Microsoft.Exchange" -and
                $ConnectionUri -eq "https://outlook.office365.com/powershell-liveid/" -and
                $Credential.Username -eq "username" -and
                $Credential.GetNetworkCredential().Password -eq "password" -and
                $Name -eq "ExchangeOnline"
            } -Scope it
            Assert-MockCalled Import-PSSession -Times 1 -Exactly -Scope it
            Assert-MockCalled Import-Module -Times 1 -Exactly -Scope it

            # Verify the output
            $output | Should Be $true
        }
    }

    # Declare the functions to throw exceptions
    $functionsToThrowExceptions = @(
        "New-PSSession",
        "Import-PSSession",
        "Import-Module"
    )
    foreach ($function in $functionsToThrowExceptions) {
        context "when $($function) throws an exception" {
            # Declare mocks
            mock New-PSSession {
                return New-MockObject -Type System.Management.Automation.Runspaces.PSSession
            }
            mock Import-PSSession {
                return New-MockObject -Type PSModuleInfo
            }

            # Mock the function to throw an exception
            mock $function {
                throw "throws exception"
            }

            it "fails to connect and outputs an error message" {
                # Mock the endpoint
                $endpoint = [PSCustomObject]@{
                    Credential = [PSCredential]::new("username", ("password" | ConvertTo-SecureString -AsPlainText -Force))
                }

                # Call the function
                $output = Connect-ExchangeOnlineAdminAccount -Endpoint $endpoint `
                    -ErrorAction SilentlyContinue -ErrorVariable errorVariable

                # Verify the output
                $errorVariable | Should Not BeNullOrEmpty
                $output | Should Be $false
            }
        }
    }

    context "when runspace creation is being throttled" {
        # Declare mocks
        mock New-PSSession {
            throw "Fail to create runspace because you have exceeded your budget to create runspace"
        }
        mock Import-PSSession {
            return New-MockObject -Type PSModuleInfo
        }
        mock Import-Module {}
        mock Start-Sleep {}

        it "waits and tries again" {
            # Mock the endpoint
            $endpoint = [PSCustomObject]@{
                Credential = [PSCredential]::new("username", ("password" | ConvertTo-SecureString -AsPlainText -Force))
            }

            # Call the function
            $numberOfAttempts = 4
            $output = Connect-ExchangeOnlineAdminAccount -Endpoint $endpoint -MaximumAttempts $numberOfAttempts

            # Verify the mocks
            Assert-MockCalled New-PSSession -Times $numberOfAttempts -Exactly -ParameterFilter {
                $ConfigurationName -eq "Microsoft.Exchange" -and
                $ConnectionUri -eq "https://outlook.office365.com/powershell-liveid/" -and
                $Credential.Username -eq "username" -and
                $Credential.GetNetworkCredential().Password -eq "password" -and
                $Name -eq "ExchangeOnline"
            } -Scope it
            Assert-MockCalled Import-PSSession -Times 0 -Exactly -Scope it
            Assert-MockCalled Import-Module -Times 0 -Exactly -Scope it
            Assert-MockCalled Start-Sleep -Times ($numberOfAttempts - 1) -Exactly -ParameterFilter {
                $Seconds -eq 60
            } -Scope it

            # Verify the output
            $output | Should Be $false
        }
    }

    context "when the remote shell has encountered an error" {
        # Declare mocks
        mock New-PSSession {
            throw "failed because the shell was not found on the server."
        }
        mock Import-PSSession {
            return New-MockObject -Type PSModuleInfo
        }
        mock Import-Module {}
        mock Start-Sleep {}

        it "waits and tries again" {
            # Mock the endpoint
            $endpoint = [PSCustomObject]@{
                Credential = [PSCredential]::new("username", ("password" | ConvertTo-SecureString -AsPlainText -Force))
            }

            # Call the function
            $numberOfAttempts = 4
            $output = Connect-ExchangeOnlineAdminAccount -Endpoint $endpoint -MaximumAttempts $numberOfAttempts

            # Verify the mocks
            Assert-MockCalled New-PSSession -Times $numberOfAttempts -Exactly -ParameterFilter {
                $ConfigurationName -eq "Microsoft.Exchange" -and
                $ConnectionUri -eq "https://outlook.office365.com/powershell-liveid/" -and
                $Credential.Username -eq "username" -and
                $Credential.GetNetworkCredential().Password -eq "password" -and
                $Name -eq "ExchangeOnline"
            } -Scope it
            Assert-MockCalled Import-PSSession -Times 0 -Exactly -Scope it
            Assert-MockCalled Import-Module -Times 0 -Exactly -Scope it
            Assert-MockCalled Start-Sleep -Times ($numberOfAttempts - 1) -Exactly -ParameterFilter {
                $Seconds -eq 10
            } -Scope it

            # Verify the output
            $output | Should Be $false
        }
    }

    context "when the remote server outputs any other error" {
        # Declare mocks
        mock New-PSSession {
            Write-Error "Some unknown error message"
            return New-MockObject -Type System.Management.Automation.Runspaces.PSSession
        }
        mock Import-PSSession {
            return New-MockObject -Type PSModuleInfo
        }
        mock Import-Module {}

        it "fails to connect and outputs an error message" {
            # Mock the endpoint
            $endpoint = [PSCustomObject]@{
                Credential = [PSCredential]::new("username", ("password" | ConvertTo-SecureString -AsPlainText -Force))
            }

            # Call the function
            $output = Connect-ExchangeOnlineAdminAccount -Endpoint $endpoint -ErrorAction SilentlyContinue `
                -ErrorVariable errorVariable

            # Verify the mocks
            Assert-MockCalled New-PSSession -Times 1 -Exactly -ParameterFilter {
                $ConfigurationName -eq "Microsoft.Exchange" -and
                $ConnectionUri -eq "https://outlook.office365.com/powershell-liveid/" -and
                $Credential.Username -eq "username" -and
                $Credential.GetNetworkCredential().Password -eq "password" -and
                $Name -eq "ExchangeOnline"
            } -Scope it
            Assert-MockCalled Import-PSSession -Times 1 -Exactly -Scope it
            Assert-MockCalled Import-Module -Times 1 -Exactly -Scope it

            # Verify the output
            $errorVariable | Should Not BeNullOrEmpty
            $output | Should Be $false
        }
    }
}