Test/Private/AdfsHealthChecks.Test.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 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 |
# Determine our script root $parent = Split-Path $PSScriptRoot -Parent $script:root = Split-Path $parent -Parent # Load module via definition Import-Module $script:root\ADFSDiagnostics.psd1 -Force InModuleScope ADFSDiagnostics { # Shared constants $sharedError = "Error message" $sharedErrorException = "System.Management.Automation.RuntimeException: Error message" Describe "TestTrustedDevicesCertificateStore" { It "should pass" { # Arrange Mock -CommandName Get-Item -MockWith { return New-Object PSObject -Property @{ "StoreNames" = @{"AdfsTrustedDevices" = $true} }} # Act $ret = TestTrustedDevicesCertificateStore # Assert $ret.Result | should beexactly Pass } It "should fail" { # Arrange Mock -CommandName Get-Item -MockWith { return New-Object PSObject -Property @{ "StoreNames" = @{} }} # Act $ret = TestTrustedDevicesCertificateStore # Assert $ret.Result | should beexactly Fail $ret.Detail | should beexactly "The AdfsTrustedDevices certificate store does not exist." } It "should error" { Mock -CommandName Get-Item -MockWith { throw $sharedError } # Act $ret = TestTrustedDevicesCertificateStore # Assert $ret.Result | should beexactly Error $ret.ExceptionMessage | should beexactly $sharedError $ret.Exception | should beexactly $sharedErrorException } } Describe "TestAdfsPatches" { It "should pass" { # Arrange Mock -CommandName Get-OsVersion -MockWith { return [OSVersion]::WS2012R2 } Mock -CommandName Get-HotFix -MockWith { return $true } # Act $ret = TestAdfsPatches # Assert $ret.Result | should beexactly Pass } It "should fail" { # Arrange Mock -CommandName Get-OsVersion -MockWith { return [OSVersion]::WS2012R2 } Mock -CommandName Get-HotFix -MockWith { return $false } # Act $ret = TestAdfsPatches # Assert $ret.Result | should beexactly Fail $ret.Detail | should beexactly "There were missing patches that are not installed." $ret.Output.MissingAdfsPatches | should not benullorempty } It "should not run" { # Arrange Mock -CommandName Get-OsVersion -MockWith { return [OSVersion]::WS2016 } # Act $ret = TestAdfsPatches # Assert $ret.Result | should beexactly NotRun } It "should error" { # Arrange Mock -CommandName Get-OsVersion -MockWith { throw $sharedError } # Act $ret = TestAdfsPatches # Assert $ret.Result | should beexactly Error $ret.ExceptionMessage | should beexactly $sharedError $ret.Exception | should beexactly $sharedErrorException } } Describe "TestServicePrincipalName" { BeforeAll { $_upnServiceAccount = "aadcsvc@contoso.com" $_samServiceAccount = "contoso\aadcsvc" $_path = "CN=aadcsvc,CN=Managed Service Accounts,DC=contoso,DC=com" $_fullPath = "LDAP://$_path" $_incorrectLdapPath = "LDAP://CN=badAccount,CN=Managed Service Accounts,DC=contoso,DC=com" $_hostname = "sts.contoso.com" } Context "should pass" { BeforeAll { Mock -CommandName Test-RunningOnAdfsSecondaryServer -MockWith { return $false } Mock -CommandName IsLocalUser -MockWith { return $false } Mock -CommandName IsAdfsServiceRunning -MockWith { return $true } Mock -CommandName GetObjectsFromAD -MockWith { return New-Object PSObject -Property @{ "Path" = $_fullPath } } Mock -CommandName Retrieve-AdfsProperties -MockWith { return New-Object PSObject -Property @{ "Hostname" = $_hostname }} Mock -CommandName Invoke-Expression -MockWith { return @("Existing SPN found!", $_path) } -ParameterFilter { $Command -eq "setspn -f -q HOST/$_hostname"} Mock -CommandName Invoke-Expression -MockWith { return @("Existing SPN found!", $_path) } -ParameterFilter { $Command -eq "setspn -f -q HTTP/$_hostname"} } It "should pass when service account is in UPN format" { # Arrange Mock -CommandName Get-WmiObject -MockWith { return New-Object PSObject -Property @{ "StartName" = $_upnServiceAccount; "Name" = $adfsServiceName } } # Act $ret = TestServicePrincipalName # Assert $ret.Result | should beexactly Pass } It "should pass when service account is in SAM format" { # Arrange Mock -CommandName Get-WmiObject -MockWith { return New-Object PSObject -Property @{ "StartName" = $_samServiceAccount; "Name" = $adfsServiceName } } # Act $ret = TestServicePrincipalName # Assert $ret.Result | should beexactly Pass } It "should pass when no HTTP SPN is found" { # Arrange Mock -CommandName Invoke-Expression -MockWith { return @("No such SPN found.") } -ParameterFilter { $Command -eq "setspn -f -q HTTP/$_hostname"} Mock -CommandName Get-WmiObject -MockWith { return New-Object PSObject -Property @{ "StartName" = $_upnServiceAccount; "Name" = $adfsServiceName } } # Act $ret = TestServicePrincipalName # Assert $ret.Result | should beexactly Pass } } Context "should fail" { BeforeAll { Mock -CommandName Test-RunningOnAdfsSecondaryServer -MockWith { return $false } Mock -CommandName IsLocalUser -MockWith { return $false } Mock -CommandName IsAdfsServiceRunning -MockWith { return $true } Mock -CommandName GetObjectsFromAD -MockWith { return New-Object PSObject -Property @{ "Path" = $_fullPath } } Mock -CommandName Retrieve-AdfsProperties -MockWith { return New-Object PSObject -Property @{ "Hostname" = $_hostname }} Mock -CommandName Get-WmiObject -MockWith { return New-Object PSObject -Property @{ "StartName" = $_upnServiceAccount; "Name" = $adfsServiceName } } } It "when no HOST SPN is found" { # Arrange Mock -CommandName Invoke-Expression -MockWith { return ("No such SPN found.") } -ParameterFilter { $Command -eq "setspn -f -q HOST/$_hostname"} # Act $ret = TestServicePrincipalName # Assert $ret.Result | should beexactly Fail $ret.Detail | should beexactly "No such SPN was found for $_hostname" } It "when HOST SPN resolved service account does not match" { # Arrange Mock -CommandName Invoke-Expression -MockWith { return ("Existing SPN found!" + [Environment]::NewLine + "$_incorrectLdapPath") } -ParameterFilter { $Command -eq "setspn -f -q HOST/$_hostname"} # Act $ret = TestServicePrincipalName # Assert $ret.Result | should beexactly Fail $ret.Detail | should beexactly "An existing SPN was found for HOST/$_hostname but it did not resolve to the ADFS service account." } It "when HTTP SPN resolved service account does not match" { # Arrange Mock -CommandName Invoke-Expression -MockWith { return ("Existing SPN found!" + [Environment]::NewLine + "$_path") } -ParameterFilter { $Command -eq "setspn -f -q HOST/$_hostname"} Mock -CommandName Invoke-Expression -MockWith { return ("Existing SPN found!" + [Environment]::NewLine + "$_incorrectLdapPath") } -ParameterFilter { $Command -eq "setspn -f -q HTTP/$_hostname"} # Act $ret = TestServicePrincipalName # Assert $ret.Result | should beexactly Fail $ret.Detail | should beexactly "An existing SPN was found for HTTP/$_hostname but it did not resolve to the ADFS service account." } } Context "should not run" { It "when on secondary server" { # Arrange Mock -CommandName Test-RunningOnAdfsSecondaryServer -MockWith { return $true } # Act $ret = TestServicePrincipalName # Assert $ret.Result | should beexactly NotRun $ret.Detail | should beexactly "This check runs only on Primary Nodes." } It "when local user" { # Arrange Mock -CommandName Test-RunningOnAdfsSecondaryServer -MockWith { return $false } Mock -CommandName IsLocalUser -MockWith { return $true } # Act $ret = TestServicePrincipalName # Assert $ret.Result | should beexactly NotRun $ret.Detail | should beexactly "Current user madpatel is not a domain account. Cannot execute this test" } It "when AD FS is not running" { # Arrange Mock -CommandName Test-RunningOnAdfsSecondaryServer -MockWith { return $false } Mock -CommandName IsLocalUser -MockWith { return $false } Mock -CommandName IsAdfsServiceRunning -MockWith { return $false } # Act $ret = TestServicePrincipalName # Assert $ret.Result | should beexactly NotRun $ret.Detail | should beexactly "AD FS service is not running" } } Context "should error" { BeforeAll { Mock -CommandName Test-RunningOnAdfsSecondaryServer -MockWith { return $false } Mock -CommandName IsLocalUser -MockWith { return $false } Mock -CommandName IsAdfsServiceRunning -MockWith { return $true } } It "when service account is empty" { # Arrange Mock -CommandName Get-WmiObject -MockWith { return New-Object PSObject -Property @{"Name" = $adfsServiceName; "StartName" = $null}} # Act $ret = TestServicePrincipalName # Assert $ret.Result | should beexactly Error $ret.ExceptionMessage | should beexactly "ADFS Service account is null or empty. The WMI configuration is in an inconsistent state" $ret.Exception | should beexactly "System.Management.Automation.RuntimeException: ADFS Service account is null or empty. The WMI configuration is in an inconsistent state" } It "when service account is not in expected SAM format" { # Arrange Mock -CommandName Get-WmiObject -MockWith { return New-Object PSObject -Property @{"Name" = $adfsServiceName; "StartName" = "badAccount"}} # Act $ret = TestServicePrincipalName # Assert $ret.Result | should beexactly Error $ret.ExceptionMessage | should beexactly "Unexpected value of the service account badAccount. Expected in DOMAIN\\User format" $ret.Exception | should beexactly "System.Management.Automation.RuntimeException: Unexpected value of the service account badAccount. Expected in DOMAIN\\User format" } } } Describe "TestProxyTrustPropagation" { BeforeAll { $_adfsServers = @("sts1.contoso.com", "sts2.contoso.com", "sts3.contoso.com") $_primaryCertificates = @("Cert1", "Cert2", "Cert3") $_missingCertificates = @("Cert2", "Cert3") # since we have to mock out the remote PSSessions that gets created we just return the a PSSession to localhost # we create these session before the actual test because once we mock New-PSSession we cannot unmock it $localPSForPassTest = @() $localPSForFailTest = @() for ($i = 0; $i -lt $_adfsServers.Count; $i++) { $localPSForPassTest += New-PSSession -ComputerName localhost -ErrorAction Stop $localPSForFailTest += New-PSSession -ComputerName localhost -ErrorAction Stop } } It "should pass" { # Arrange Mock -CommandName Test-RunningOnAdfsSecondaryServer -MockWith { return $false } Mock -CommandName GetCertificatesFromAdfsTrustedDevices -MockWith { return $_primaryCertificates } $script:itr = 0 Mock -CommandName New-PSSession -MockWith { $session = $localPSForPassTest[$script:itr] $script:itr += 1 return $session } # Since we get all of the functions from the private folder and run Invoke-Expression on them; that replaces the function's mock with the original function. # We avoid this by setting the invoke expression within this script block to do nothing. Mock Invoke-Command { Return $ScriptBlock.InvokeWithContext(@{"Invoke-Expression" = {}; "VerifyCertificatesArePresent" = { return @() }}, @()) } # Act $ret = TestProxyTrustPropagation $_adfsServers # Assert $ret.Result | should beexactly Pass } It "should warn because no AD FS farm information was provided" { # Arrange Mock -CommandName Test-RunningOnAdfsSecondaryServer -MockWith { return $false } Mock -CommandName Out-Warning -MockWith { } # Act $ret = TestProxyTrustPropagation # Assert Assert-MockCalled Out-Warning $ret.Result | should beexactly Warning $ret.Detail | should beexactly "No AD FS farm information was provided. Specify the list of servers in your farm using the -adfsServers flag." } It "should warn because it cannot connect to an AD FS server" { # Arrange Mock -CommandName Test-RunningOnAdfsSecondaryServer -MockWith { return $false } Mock -CommandName GetCertificatesFromAdfsTrustedDevices -MockWith { return $_primaryCertificates } Mock -CommandName New-PSSession -MockWith { $null } Mock -CommandName Out-Warning -MockWith { } # Act $ret = TestProxyTrustPropagation $_adfsServers # Assert Assert-MockCalled Out-Warning 3 } It "should fail" { # Arrange Mock -CommandName Test-RunningOnAdfsSecondaryServer -MockWith { return $false } Mock -CommandName GetCertificatesFromAdfsTrustedDevices -MockWith { return $_primaryCertificates } $script:itr = 0 Mock -CommandName New-PSSession -MockWith { $session = $localPSForPassTest[$script:itr] $script:itr += 1 return $session } # Since we get all of the functions from the private folder and run Invoke-Expression on them; that replaces the function's mock with the original function. # We avoid this by setting the invoke expression within this script block to do nothing. Mock Invoke-Command { Return $ScriptBlock.InvokeWithContext(@{"Invoke-Expression" = {}; "VerifyCertificatesArePresent" = { return $_missingCertificates }}, @()) } # Act $ret = TestProxyTrustPropagation $_adfsServers # Assert $ret.Result | should beexactly Fail $ret.Detail | should beexactly "There were missing certificates on some of the secondary servers. There may be an issue with proxy trust propogation."\ $_adfsServers | ForEach-Object { $server = $_ $_missingCertificates | ForEach-Object { $ret.Output.ErroneousCertificates[$server] | should contain $_ } } } It "should not run when on secondary server" { # Arrange Mock -CommandName Test-RunningOnAdfsSecondaryServer -MockWith { return $true } # Act $ret = TestProxyTrustPropagation # Assert $ret.Result | should beexactly NotRun $ret.Detail | should beexactly "This check runs only on Primary Nodes." } It "should error" { # Arrange Mock -CommandName Test-RunningOnAdfsSecondaryServer -MockWith { throw $sharedError } # Act $ret = TestProxyTrustPropagation # Assert $ret.Result | should beexactly Error $ret.ExceptionMessage | should beexactly $sharedError $ret.Exception | should beexactly $sharedErrorException } } } |