Tests/Unit/xExchangeHelper.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 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 |
#region HEADER $script:DSCModuleName = 'xExchange' $script:DSCHelperName = "xExchangeHelper" # Unit Test Template Version: 1.2.2 $script:moduleRoot = Split-Path -Parent (Split-Path -Parent $PSScriptRoot) Import-Module -Name (Join-Path -Path $script:moduleRoot -ChildPath (Join-Path -Path 'Modules' -ChildPath 'xExchangeHelper.psm1')) -Force #endregion HEADER function Invoke-TestSetup { } function Invoke-TestCleanup { } # Begin Testing try { Invoke-TestSetup InModuleScope $script:DSCHelperName { # Used for calls to Get-InstallStatus $getInstallStatusParams = @{ Arguments = '/mode:Install /role:Mailbox /Iacceptexchangeserverlicenseterms' } # Get a unique Guid that doesn't resolve to a local path # Use System.Guid, as New-Guid isn't available in PS4 and below do { $guid1 = [System.Guid]::NewGuid().ToString() } while (Test-Path -Path $guid1) # Get a unique Guid that doesn't resolve to a local path do { $guid2 = [System.Guid]::NewGuid().ToString() } while ((Test-Path -Path $guid2) -or $guid1 -like $guid2) Describe 'xExchangeHelper\Get-InstallStatus' -Tag 'Helper' { AfterEach { Assert-MockCalled -CommandName Get-ShouldInstallLanguagePack -Exactly -Times 1 -Scope It Assert-MockCalled -CommandName Get-IsSetupRunning -Exactly -Times 1 -Scope It Assert-MockCalled -CommandName Get-IsSetupComplete -Exactly -Times 1 -Scope It Assert-MockCalled -CommandName Get-IsExchangePresent -Exactly -Times 1 -Scope It } Context 'When Exchange is not present on the system' { It 'Should only recommend starting the install' { Mock -CommandName Get-ShouldInstallLanguagePack -MockWith { return $false } Mock -CommandName Get-IsSetupRunning -MockWith { return $false } Mock -CommandName Get-IsSetupComplete -MockWith { return $false } Mock -CommandName Get-IsExchangePresent -MockWith { return $false } $installStatus = Get-InstallStatus @getInstallStatusParams $installStatus.ShouldInstallLanguagePack | Should -Be $false $installStatus.SetupRunning | Should -Be $false $installStatus.SetupComplete | Should -Be $false $installStatus.ExchangePresent | Should -Be $false $installStatus.ShouldStartInstall | Should -Be $true } } Context 'When Exchange Setup has fully completed' { It 'Should indicate setup is complete and Exchange is present' { Mock -CommandName Get-ShouldInstallLanguagePack -MockWith { return $false } Mock -CommandName Get-IsSetupRunning -MockWith { return $false } Mock -CommandName Get-IsSetupComplete -MockWith { return $true } Mock -CommandName Get-IsExchangePresent -MockWith { return $true } $installStatus = Get-InstallStatus @getInstallStatusParams $installStatus.ShouldInstallLanguagePack | Should -Be $false $installStatus.SetupRunning | Should -Be $false $installStatus.SetupComplete | Should -Be $true $installStatus.ExchangePresent | Should -Be $true $installStatus.ShouldStartInstall | Should -Be $false } } Context 'When Exchange Setup has partially completed' { It 'Should indicate that Exchange is present, but setup is not complete, and recommend starting an install' { Mock -CommandName Get-ShouldInstallLanguagePack -MockWith { return $false } Mock -CommandName Get-IsSetupRunning -MockWith { return $false } Mock -CommandName Get-IsSetupComplete -MockWith { return $false } Mock -CommandName Get-IsExchangePresent -MockWith { return $true } $installStatus = Get-InstallStatus @getInstallStatusParams $installStatus.ShouldInstallLanguagePack | Should -Be $false $installStatus.SetupRunning | Should -Be $false $installStatus.SetupComplete | Should -Be $false $installStatus.ExchangePresent | Should -Be $true $installStatus.ShouldStartInstall | Should -Be $true } } Context 'When Exchange Setup is currently running' { It 'Should indicate that Exchange is present and that setup is running' { Mock -CommandName Get-ShouldInstallLanguagePack -MockWith { return $false } Mock -CommandName Get-IsSetupRunning -MockWith { return $true } Mock -CommandName Get-IsSetupComplete -MockWith { return $false } Mock -CommandName Get-IsExchangePresent -MockWith { return $true } $installStatus = Get-InstallStatus @getInstallStatusParams $installStatus.ShouldInstallLanguagePack | Should -Be $false $installStatus.SetupRunning | Should -Be $true $installStatus.SetupComplete | Should -Be $false $installStatus.ExchangePresent | Should -Be $true $installStatus.ShouldStartInstall | Should -Be $false } } Context 'When a Language Pack install is requested, and the Language Pack has not been installed' { It 'Should indicate that setup has completed and a language pack Should -Be installed' { Mock -CommandName Get-ShouldInstallLanguagePack -MockWith { return $true } Mock -CommandName Get-IsSetupRunning -MockWith { return $false } Mock -CommandName Get-IsSetupComplete -MockWith { return $true } Mock -CommandName Get-IsExchangePresent -MockWith { return $true } $installStatus = Get-InstallStatus @getInstallStatusParams $installStatus.ShouldInstallLanguagePack | Should -Be $true $installStatus.SetupRunning | Should -Be $false $installStatus.SetupComplete | Should -Be $true $installStatus.ExchangePresent | Should -Be $true $installStatus.ShouldStartInstall | Should -Be $true } } } Describe 'xExchangeHelper\Get-PreviousError' -Tag 'Helper' { Context 'After an error occurs' { It 'Should retrieve the most recent error' { # First get whatever error is currently on top of the stack $initialError = Get-PreviousError # Cause an error by trying to get a non-existent item Get-ChildItem -Path $guid1 -ErrorAction SilentlyContinue $firstError = Get-PreviousError # Cause another error by trying to get a non-existent item Get-ChildItem -Path $guid2 -ErrorAction SilentlyContinue $secondError = Get-PreviousError $initialError -ne $firstError | Should -Be $true $secondError -ne $firstError | Should -Be $true $firstError -eq $null | Should -Be $false $secondError -eq $null | Should -Be $false } } Context 'When an error has not occurred' { It 'Should return the same previous error with each call' { # Run Get-PreviousError twice in a row so we can later ensure results are the same $error1 = Get-PreviousError $error2 = Get-PreviousError # Run a command that should always succeed Get-ChildItem | Out-Null # Get the previous error one more time $error3 = Get-PreviousError $error1 -eq $error2 | Should -Be $true $error1 -eq $error3 | Should -Be $true } } } Describe 'xExchangeHelper\Assert-NoNewError' -Tag 'Helper' { Context 'After a new, unique error occurs' { It 'Should throw an exception' { # First get whatever error is currently on top of the stack $initialError = Get-PreviousError # Cause an error by trying to get a non-existent item Get-ChildItem $guid1 -ErrorAction SilentlyContinue $caughtException = $false try { Assert-NoNewError -CmdletBeingRun "Get-ChildItem" -PreviousError $initialError } catch { $caughtException = $true } $caughtException | Should -Be $true } } Context 'When an error has not occurred' { It 'Should not throw an exception' { # First get whatever error is currently on top of the stack $initialError = Get-PreviousError # Run a command that should always succeed Get-ChildItem | Out-Null $caughtException = $false try { Assert-NoNewError -CmdletBeingRun "Get-ChildItem" -PreviousError $initialError } catch { $caughtException = $true } $caughtException | Should -Be $false } } } Describe 'xExchangeHelper\Assert-IsSupportedWithExchangeVersion' -Tag 'Helper' { $supportedVersionTestCases = @( @{Name='2013 Operation Supported on 2013'; ExchangeVersion='2013'; SupportedVersions='2013'} @{Name='2013 Operation Supported on 2013,2019'; ExchangeVersion='2013'; SupportedVersions='2013','2019'} ) $notSupportedVersionTestCases = @( @{Name='2013 Operation Not Supported on 2016'; ExchangeVersion='2013'; SupportedVersions='2016'} @{Name='2013 Operation Not Supported on 2016,2019'; ExchangeVersion='2013'; SupportedVersions='2016','2019'} ) Context 'When a supported version is passed' { It 'Should not throw an exception' -TestCases $supportedVersionTestCases { param($Name, $ExchangeVersion, $SupportedVersions) Mock -CommandName Get-ExchangeVersion -MockWith { return $ExchangeVersion } $caughtException = $false try { Assert-IsSupportedWithExchangeVersion -ObjectOrOperationName $Name -SupportedVersions $SupportedVersions } catch { $caughtException = $true } $caughtException | Should -Be $false } } Context 'When an unsupported version is passed' { It 'Should throw an exception' -TestCases $notSupportedVersionTestCases { param($Name, $ExchangeVersion, $SupportedVersions) Mock -CommandName Get-ExchangeVersion -MockWith { return $ExchangeVersion } $caughtException = $false try { Assert-IsSupportedWithExchangeVersion -ObjectOrOperationName $Name -SupportedVersions $SupportedVersions } catch { $caughtException = $true } $caughtException | Should -Be $true } } } } } finally { Invoke-TestCleanup } |