Functions/Get-PartnerCenterAccessToken.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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
describe "BitTitan.Runbooks.PartnerCenter/Get-PartnerCenterAccessToken" -Tag "module", "unit" {

    # Import the function to test
    . "$($PSScriptRoot)\Get-PartnerCenterAccessToken.ps1"

    # Declare external functions and mocks
    function Invoke-RestMethod {
        param ($Uri, $ContentType, $Body, $Method)
    }

    context "when there are no issues" {
        # Declare mocks
        mock Invoke-RestMethod {
            return [PSCustomObject]@{
                expires_in      = 1000
                access_token    = "valid-token"
            }
        }

        it "retrieves the access token given the username and the password" {
            # Call the function
            $output = Get-PartnerCenterAccessToken -Username "username@domain.com" -Password ("password" | ConvertTo-SecureString -AsPlainText -Force) `
                -ApplicationId ([Guid]::empty).Guid

            # Verify the mocks
            Assert-MockCalled Invoke-RestMethod -Times 1 -Exactly -ParameterFilter {
                # Verify the URI
                $uriRegexMatch = [Regex]::new("https://login\.windows\.net/([\S]+)/oauth2/token").Match($Uri)
                $uriMatches = $uriRegexMatch.Groups[1].Value -eq "domain.com"

                # Verify the body
                Add-Type -AssemblyName System.Web
                $bodyRegexMatches = [Regex]::new("client_id=([\S]+)&username=([\S]+)&password=([\S]+)&scope=openid").Match($Body)
                $bodyMatches = $bodyRegexMatches.Groups[1].Value -eq ([Guid]::Empty).Guid -and `
                    $bodyRegexMatches.Groups[2].Value -eq "username%40domain.com" -and `
                    $bodyRegexMatches.Groups[3].Value -eq "password"

                $uriMatches -and $bodyMatches -and $ContentType -eq "application/x-www-form-urlencoded" -and $Method -eq "POST"
            } -Scope it

            # Verify the output
            $output | Should Be "valid-token"
        }

        it "retrieves the access token given the endpoint" {
            # Mock the endpoint
            $endpoint = [PSCustomObject]@{
                Name                = "Stub endpoint"
                Credential          = [PSCredential]::new("username@domain.com", ("password" | ConvertTo-SecureString -AsPlainText -Force))
                ExtendedProperties  = @{
                    ApplicationId = ([Guid]::empty).Guid
                }
            }

            # Call the function
            $output = Get-PartnerCenterAccessToken -Endpoint $endpoint

            # Verify the mocks
            Assert-MockCalled Invoke-RestMethod -Times 1 -Exactly -ParameterFilter {
                # Verify the URI
                $uriRegexMatch = [Regex]::new("https://login\.windows\.net/([\S]+)/oauth2/token").Match($Uri)
                $uriMatches = $uriRegexMatch.Groups[1].Value -eq "domain.com"

                # Verify the body
                Add-Type -AssemblyName System.Web
                $bodyRegexMatches = [Regex]::new("client_id=([\S]+)&username=([\S]+)&password=([\S]+)&scope=openid").Match($Body)
                $bodyMatches = $bodyRegexMatches.Groups[1].Value -eq ([Guid]::Empty).Guid -and `
                    $bodyRegexMatches.Groups[2].Value -eq "username%40domain.com" -and `
                    $bodyRegexMatches.Groups[3].Value -eq "password"

                $uriMatches -and $bodyMatches -and $ContentType -eq "application/x-www-form-urlencoded" -and $Method -eq "POST"
            } -Scope it

            # Verify the output
            $output | Should Be "valid-token"
        }
    }

    context "when there is an exception while invoking the REST call" {
        # Declare mocks
        mock Invoke-RestMethod {
            throw "throws exception"
        }

        it "fails to retrieve the access token and outputs an error" {
            # Mock the endpoint
            $endpoint = [PSCustomObject]@{
                Name                = "Stub endpoint"
                Credential          = [PSCredential]::new("username@domain.com", ("password" | ConvertTo-SecureString -AsPlainText -Force))
                ExtendedProperties  = @{
                    ApplicationId = ([Guid]::empty).Guid
                }
            }

            # Call the function
            $output = Get-PartnerCenterAccessToken -Endpoint $endpoint -ErrorAction SilentlyContinue `
                -ErrorVariable errorVariable

            # Verify the mocks
            Assert-MockCalled Invoke-RestMethod -Times 1 -Exactly -ParameterFilter {
                # Verify the URI
                $uriRegexMatch = [Regex]::new("https://login\.windows\.net/([\S]+)/oauth2/token").Match($Uri)
                $uriMatches = $uriRegexMatch.Groups[1].Value -eq "domain.com"

                # Verify the body
                Add-Type -AssemblyName System.Web
                $bodyRegexMatches = [Regex]::new("client_id=([\S]+)&username=([\S]+)&password=([\S]+)&scope=openid").Match($Body)
                $bodyMatches = $bodyRegexMatches.Groups[1].Value -eq ([Guid]::Empty).Guid -and `
                    $bodyRegexMatches.Groups[2].Value -eq "username%40domain.com" -and `
                    $bodyRegexMatches.Groups[3].Value -eq "password"

                $uriMatches -and $bodyMatches -and $ContentType -eq "application/x-www-form-urlencoded" -and $Method -eq "POST"
            } -Scope it

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

    context "when a valid access token is not returned" {
        # Declare mocks
        mock Invoke-RestMethod {
            return $null
        }

        it "fails to retrieve the access token and outputs an error" {
            # Mock the endpoint
            $endpoint = [PSCustomObject]@{
                Name                = "Stub endpoint"
                Credential          = [PSCredential]::new("username@domain.com", ("password" | ConvertTo-SecureString -AsPlainText -Force))
                ExtendedProperties  = @{
                    ApplicationId = ([Guid]::empty).Guid
                }
            }

            # Call the function
            $output = Get-PartnerCenterAccessToken -Endpoint $endpoint -ErrorAction SilentlyContinue `
                -ErrorVariable errorVariable

            # Verify the mocks
            Assert-MockCalled Invoke-RestMethod -Times 1 -Exactly -ParameterFilter {
                # Verify the URI
                $uriRegexMatch = [Regex]::new("https://login\.windows\.net/([\S]+)/oauth2/token").Match($Uri)
                $uriMatches = $uriRegexMatch.Groups[1].Value -eq "domain.com"

                # Verify the body
                Add-Type -AssemblyName System.Web
                $bodyRegexMatches = [Regex]::new("client_id=([\S]+)&username=([\S]+)&password=([\S]+)&scope=openid").Match($Body)
                $bodyMatches = $bodyRegexMatches.Groups[1].Value -eq ([Guid]::Empty).Guid -and `
                    $bodyRegexMatches.Groups[2].Value -eq "username%40domain.com" -and `
                    $bodyRegexMatches.Groups[3].Value -eq "password"

                $uriMatches -and $bodyMatches -and $ContentType -eq "application/x-www-form-urlencoded" -and $Method -eq "POST"
            } -Scope it

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

    context "when the endpoint does not contain an 'ExtendedProperties' property" {
        # Declare mocks
        mock Invoke-RestMethod {
            return [PSCustomObject]@{
                expires_in      = 1000
                access_token    = "valid-token"
            }
        }

        it "fails to retrieve the access token and outputs an error" {
            # Mock the endpoint
            $endpoint = [PSCustomObject]@{
                Name        = "Stub endpoint"
                Credential  = [PSCredential]::new("username@domain.com", ("password" | ConvertTo-SecureString -AsPlainText -Force))
            }

            # Call the function
            $output = Get-PartnerCenterAccessToken -Endpoint $endpoint -ErrorAction SilentlyContinue `
                -ErrorVariable errorVariable

            # Verify the mocks
            Assert-MockCalled Invoke-RestMethod -Times 0 -Exactly -Scope it

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

    context "when the endpoint does not contain an 'ApplicationId' extended property" {
        # Declare mocks
        mock Invoke-RestMethod {
            return [PSCustomObject]@{
                expires_in      = 1000
                access_token    = "valid-token"
            }
        }

        it "fails to retrieve the access token and outputs an error" {
            # Mock the endpoint
            $endpoint = [PSCustomObject]@{
                Name                = "Stub endpoint"
                Credential          = [PSCredential]::new("username@domain.com", ("password" | ConvertTo-SecureString -AsPlainText -Force))
                ExtendedProperties  = @{}
            }

            # Call the function
            $output = Get-PartnerCenterAccessToken -Endpoint $endpoint -ErrorAction SilentlyContinue `
                -ErrorVariable errorVariable

            # Verify the mocks
            Assert-MockCalled Invoke-RestMethod -Times 0 -Exactly -Scope it

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

    context "when the username is not in the form of <user>@<domain>" {
        # Declare mocks
        mock Invoke-RestMethod {
            return [PSCustomObject]@{
                expires_in      = 1000
                access_token    = "valid-token"
            }
        }

        it "fails to retrieve the access token and outputs an error" {
            # Mock the endpoint
            $endpoint = [PSCustomObject]@{
                Name                = "Stub endpoint"
                Credential          = [PSCredential]::new("username", ("password" | ConvertTo-SecureString -AsPlainText -Force))
                ExtendedProperties  = @{
                    ApplicationId = ([Guid]::empty).Guid
                }
            }

            # Call the function
            $output = Get-PartnerCenterAccessToken -Endpoint $endpoint -ErrorAction SilentlyContinue `
                -ErrorVariable errorVariable

            # Verify the mocks
            Assert-MockCalled Invoke-RestMethod -Times 0 -Exactly -Scope it

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