Tests/Unit/MSFT_AuditPolicyOption.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 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 |
$script:DSCModuleName = 'AuditPolicyDsc' $script:DSCResourceName = 'MSFT_AuditPolicyOption' #region HEADER [String] $script:moduleRoot = Split-Path -Parent (Split-Path -Parent (Split-Path -Parent $script:MyInvocation.MyCommand.Path)) if ( (-not (Test-Path -Path (Join-Path -Path $moduleRoot -ChildPath 'DSCResource.Tests'))) -or ` (-not (Test-Path -Path (Join-Path -Path $moduleRoot -ChildPath 'DSCResource.Tests\TestHelper.psm1'))) ) { & git @('clone','https://github.com/PowerShell/DscResource.Tests.git',(Join-Path -Path $moduleRoot -ChildPath '\DSCResource.Tests\')) } else { & git @('-C',(Join-Path -Path $moduleRoot -ChildPath '\DSCResource.Tests\'),'pull') } Import-Module (Join-Path -Path $moduleRoot -ChildPath 'DSCResource.Tests\TestHelper.psm1') -Force $TestEnvironment = Initialize-TestEnvironment ` -DSCModuleName $script:DSCModuleName ` -DSCResourceName $script:DSCResourceName ` -TestType Unit #endregion # Begin Testing try { #region Pester Tests InModuleScope $script:DSCResourceName { # The script scope does not pierce the InModuleScope $script:DSCResourceName = 'MSFT_AuditPolicyOption' #region Pester Test Initialization # set the audit option test strings to Mock $testParameters = @{ Name = 'CrashOnAuditFail' Value = 'Enabled' } #endregion #region Function Get-TargetResource Describe "$($script:DSCResourceName)\Get-TargetResource" { Context 'Option Enabled' { Mock -CommandName Get-AuditOption -MockWith { return 'Enabled' } -ModuleName MSFT_AuditPolicyOption -Verifiable It 'Should not throw an exception' { { $script:getTargetResourceResult = Get-TargetResource @testParameters } | Should Not Throw } It 'Should return the correct hashtable properties' { $script:getTargetResourceResult.Name | Should Be $testParameters.Name $script:getTargetResourceResult.Value | Should Be $testParameters.Value } It 'Should call expected Mocks' { Assert-VerifiableMock Assert-MockCalled -CommandName Get-AuditOption -Exactly 1 } } Context 'Option Disabled' { $testParameters.Value = 'Disabled' Mock -CommandName Get-AuditOption -MockWith { return 'Disabled' } -ModuleName MSFT_AuditPolicyOption -Verifiable It 'Should not throw an exception' { { $script:getTargetResourceResult = Get-TargetResource @testParameters } | Should Not Throw } It 'Should return the correct hashtable properties' { $script:getTargetResourceResult.Name | Should Be $testParameters.Name $script:getTargetResourceResult.Value | Should Be $testParameters.Value } It 'Should call expected Mocks' { Assert-VerifiableMock Assert-MockCalled -CommandName Get-AuditOption -Exactly 1 } } } #endregion #region Function Test-TargetResource Describe "$($script:DSCResourceName)\Test-TargetResource" { $testParameters.Value = 'Enabled' Context 'Option set to enabled and should be' { Mock -CommandName Get-AuditOption -MockWith { return 'Enabled' } -ModuleName MSFT_AuditPolicyOption -Verifiable It 'Should not throw an exception' { { $script:testTargetResourceResult = Test-TargetResource @testParameters } | Should Not Throw } It 'Should return true' { $script:testTargetResourceResult | Should Be $true } It 'Should call expected Mocks' { Assert-VerifiableMock Assert-MockCalled -CommandName Get-AuditOption -Exactly 1 } } Context 'Option set to enabled and should not be' { Mock -CommandName Get-AuditOption -MockWith { return 'Disabled' } -ModuleName MSFT_AuditPolicyOption -Verifiable It 'Should not throw an exception' { { $script:testTargetResourceResult = Test-TargetResource @testParameters } | Should Not Throw } It 'Should return false' { $script:testTargetResourceResult | Should Be $false } It 'Should call expected Mocks' { Assert-VerifiableMock Assert-MockCalled -CommandName Get-AuditOption -Exactly 1 } } $testParameters.Value = 'Disabled' Context 'Option set to disabled and should be' { Mock -CommandName Get-AuditOption -MockWith { return 'Disabled' } -ModuleName MSFT_AuditPolicyOption -Verifiable It 'Should not throw an exception' { { $script:testTargetResourceResult = Test-TargetResource @testParameters } | Should Not Throw } It 'Should return true' { $script:testTargetResourceResult | Should Be $true } It 'Should call expected Mocks' { Assert-VerifiableMock Assert-MockCalled -CommandName Get-AuditOption -Exactly 1 } } Context 'Option set to disabled and should not be' { Mock -CommandName Get-AuditOption -MockWith { return 'Enabled' } -ModuleName MSFT_AuditPolicyOption -Verifiable It 'Should not throw an exception' { { $script:testTargetResourceResult = Test-TargetResource @testParameters } | Should Not Throw } It 'Should return false' { $script:testTargetResourceResult | Should Be $false } It 'Should call expected Mocks' { Assert-VerifiableMock Assert-MockCalled -CommandName Get-AuditOption -Exactly 1 } } } #endregion #region Function Set-TargetResource Describe "$($script:DSCResourceName)\Set-TargetResource" { $testParameters.Value = 'Enabled' Context 'Option to Enabled' { Mock -CommandName Set-AuditOption -MockWith { } ` -ModuleName MSFT_AuditPolicyOption -Verifiable It 'Should not throw an exception' { { Set-TargetResource @testParameters } | Should Not Throw } It 'Should call expected Mocks' { Assert-VerifiableMock Assert-MockCalled -CommandName Set-AuditOption -Exactly 1 } } $testParameters.Value = 'Disabled' Context 'Option to Disabled' { Mock -CommandName Set-AuditOption -MockWith { } ` -ModuleName MSFT_AuditPolicyOption -Verifiable It 'Should not throw an exception' { { Set-TargetResource @testParameters } | Should Not Throw } It 'Should call expected Mocks' { Assert-VerifiableMock Assert-MockCalled -CommandName Set-AuditOption -Exactly 1 } } } #endregion #region Helper Cmdlets Describe 'Private function Get-AuditOption' { [String] $name = 'CrashOnAuditFail' Context 'Get audit policy option enabled' { [String] $value = 'Enabled' Mock -CommandName Invoke-Auditpol -MockWith { @{ 'Machine Name'= $env:COMPUTERNAME 'Policy Target' = '' 'Subcategory' = "Option:$name" 'Subcategory GUID' = '' 'Inclusion Setting' = $value 'Exclusion Setting' = '' } } -ParameterFilter { $Command -eq 'Get' } -Verifiable It 'Should not throw an exception' { { $script:getAuditOptionResult = Get-AuditOption -Name $name } | Should Not Throw } It 'Should return the correct value' { $script:getAuditOptionResult | Should Be $value } It 'Should call expected Mocks' { Assert-VerifiableMock Assert-MockCalled -CommandName Invoke-Auditpol -Exactly 1 } } Context 'Get audit policy option disabled' { [String] $value = 'Disabled' Mock -CommandName Invoke-Auditpol -MockWith { @{ 'Machine Name'= $env:COMPUTERNAME 'Policy Target' = '' 'Subcategory' = "Option:$name" 'Subcategory GUID' = '' 'Inclusion Setting' = $value 'Exclusion Setting' = '' } } -ParameterFilter { $Command -eq 'Get' } -Verifiable It 'Should not throw an exception' { { $script:getAuditOptionResult = Get-AuditOption -Name $name } | Should Not Throw } It 'Should return the correct value' { $script:getAuditOptionResult | Should Be $value } It 'Should call expected Mocks' { Assert-VerifiableMock Assert-MockCalled -CommandName Invoke-Auditpol -Exactly 1 } } } Describe 'Private function Set-AuditOption' { [String] $name = "CrashOnAuditFail" Context "Set audit poliy option to enabled" { [String] $value = "Enabled" Mock -CommandName Invoke-Auditpol -MockWith { } -ParameterFilter { $Command -eq 'Set' } -Verifiable It 'Should not throw an exception' { { Set-AuditOption -Name $name -Value $value } | Should Not Throw } It 'Should call expected Mocks' { Assert-VerifiableMock Assert-MockCalled -CommandName Invoke-Auditpol -Exactly 1 } } Context "Set audit policy option to disabled" { [String] $value = "Disabled" Mock -CommandName Invoke-Auditpol -MockWith { } -ParameterFilter { $Command -eq 'Set' } -Verifiable It 'Should not throw an exception' { { Set-AuditOption -Name $name -Value $value } | Should Not Throw } It 'Should call expected Mocks' { Assert-VerifiableMock Assert-MockCalled -CommandName Invoke-Auditpol -Exactly 1 } } } #endregion } #endregion } finally { #region FOOTER Restore-TestEnvironment -TestEnvironment $TestEnvironment #endregion } |