Tests/Unit/MSFT_xWaitForADDomain.Tests.ps1
|
[System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingConvertToSecureStringWithPlainText', '')] param() $Global:DSCModuleName = 'xActiveDirectory' $Global:DSCResourceName = 'MSFT_xWaitForADDomain' #region HEADER [String] $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\')) } Import-Module (Join-Path -Path $moduleRoot -ChildPath 'DSCResource.Tests\TestHelper.psm1') -Force $TestEnvironment = Initialize-TestEnvironment ` -DSCModuleName $Global:DSCModuleName ` -DSCResourceName $Global:DSCResourceName ` -TestType Unit #endregion # Begin Testing try { #region Pester Tests # The InModuleScope command allows you to perform white-box unit testing on the internal # (non-exported) code of a Script Module. InModuleScope $Global:DSCResourceName { #region Pester Test Initialization $password = 'Password' | ConvertTo-SecureString -AsPlainText -Force $DomainUserCredential = New-Object pscredential('Username', $password) $domainName = 'example.com' $testParams = @{ DomainName = $domainName DomainUserCredential = $DomainUserCredential RetryIntervalSec = 10 RetryCount = 5 } $rebootTestParams = @{ DomainName = $domainName DomainUserCredential = $DomainUserCredential RetryIntervalSec = 10 RetryCount = 5 RebootRetryCount = 3 } $fakeDomainObject = @{Name = $domainName} #endregion #region Function Get-TargetResource Describe "$($Global:DSCResourceName)\Get-TargetResource" { It 'Returns a "System.Collections.Hashtable" object type' { Mock -CommandName Get-Domain -MockWith {return $fakeDomainObject} $targetResource = Get-TargetResource @testParams $targetResource -is [System.Collections.Hashtable] | Should Be $true } It "Returns DomainName = $($testParams.DomainName) when domain is found" { Mock -CommandName Get-Domain -MockWith {return $fakeDomainObject} $targetResource = Get-TargetResource @testParams $targetResource.DomainName | Should Be $testParams.DomainName } It "Returns an empty DomainName when domain is not found" { Mock -CommandName Get-Domain $targetResource = Get-TargetResource @testParams $targetResource.DomainName | Should Be $null } } #endregion #region Function Test-TargetResource Describe "$($Global:DSCResourceName)\Test-TargetResource" { It 'Returns a "System.Boolean" object type' { Mock -CommandName Get-Domain -MockWith {return $fakeDomainObject} $targetResource = Test-TargetResource @testParams $targetResource -is [System.Boolean] | Should Be $true } It 'Passes when domain found' { Mock -CommandName Get-Domain -MockWith {return $fakeDomainObject} Test-TargetResource @testParams | Should Be $true } It 'Fails when domain not found' { Mock -CommandName Get-Domain Test-TargetResource @testParams | Should Be $false } } #endregion #region Function Set-TargetResource Describe "$($Global:DSCResourceName)\Set-TargetResource" { BeforeEach{ $global:DSCMachineStatus = $null } It "Doesn't throw exception and doesn't call Start-Sleep, Clear-DnsClientCache or set `$global:DSCMachineStatus when domain found" { Mock -CommandName Get-Domain -MockWith {return $fakeDomainObject} Mock -CommandName Start-Sleep Mock -CommandName Clear-DnsClientCache {Set-TargetResource @testParams} | Should Not Throw $global:DSCMachineStatus | should not be 1 Assert-MockCalled -CommandName Start-Sleep -Times 0 -Scope It Assert-MockCalled -CommandName Clear-DnsClientCache -Times 0 -Scope It } It "Throws exception and does not set `$global:DSCMachineStatus when domain not found after $($testParams.RetryCount) retries when RebootRetryCount is not set" { Mock -CommandName Get-Domain {Set-TargetResource @testParams} | Should Throw $global:DSCMachineStatus | should not be 1 } It "Throws exception when domain not found after $($rebootTestParams.RebootRetryCount) reboot retries when RebootRetryCount is exceeded" { Mock -CommandName Get-Domain Mock -CommandName Get-Content -MockWith {return $rebootTestParams.RebootRetryCount} {Set-TargetResource @rebootTestParams} | Should Throw } It "Calls Set-Content if reboot count is less than RebootRetryCount when domain not found" { Mock -CommandName Get-Domain Mock -CommandName Get-Content -MockWith {return 0} Mock -CommandName Set-Content {Set-TargetResource @rebootTestParams} | Should Not Throw Assert-MockCalled -CommandName Set-Content -Times 1 -Exactly -Scope It } It "Sets `$global:DSCMachineStatus = 1 and does not throw an exception if the domain is not found and RebootRetryCount is not exceeded" { Mock -CommandName Get-Domain Mock -CommandName Get-Content -MockWith {return 0} {Set-TargetResource @rebootTestParams} | Should Not Throw $global:DSCMachineStatus | should be 1 } It "Calls Get-Domain exactly $($testParams.RetryCount) times when domain not found" { Mock -CommandName Get-Domain Mock -CommandName Start-Sleep Mock -CommandName Clear-DnsClientCache {Set-TargetResource @testParams} | Should Throw Assert-MockCalled -CommandName Get-Domain -Times $testParams.RetryCount -Exactly -Scope It } It "Calls Start-Sleep exactly $($testParams.RetryCount) times when domain not found" { Mock -CommandName Get-Domain Mock -CommandName Start-Sleep Mock -CommandName Clear-DnsClientCache {Set-TargetResource @testParams} | Should Throw Assert-MockCalled -CommandName Start-Sleep -Times $testParams.RetryCount -Exactly -Scope It } It "Calls Clear-DnsClientCache exactly $($testParams.RetryCount) times when domain not found" { Mock -CommandName Get-Domain Mock -CommandName Start-Sleep Mock -CommandName Clear-DnsClientCache {Set-TargetResource @testParams} | Should Throw Assert-MockCalled -CommandName Clear-DnsClientCache -Times $testParams.RetryCount -Exactly -Scope It } } #endregion } #endregion } finally { #region FOOTER Restore-TestEnvironment -TestEnvironment $TestEnvironment #endregion } |