Tests/Unit/MSFT_SqlWaitForAG.Tests.ps1
|
<#
.SYNOPSIS Automated unit test for MSFT_SqlWaitForAG DSC resource. .NOTES To run this script locally, please make sure to first run the bootstrap script. Read more at https://github.com/PowerShell/SqlServerDsc/blob/dev/CONTRIBUTING.md#bootstrap-script-assert-testenvironment #> Import-Module -Name (Join-Path -Path $PSScriptRoot -ChildPath '..\TestHelpers\CommonTestHelper.psm1') if (Test-SkipContinuousIntegrationTask -Type 'Unit') { return } $script:dscModuleName = 'SqlServerDsc' $script:dscResourceName = 'MSFT_SqlWaitForAG' #region HEADER # Unit Test Template Version: 1.2.1 $script:moduleRoot = Split-Path -Parent (Split-Path -Parent $PSScriptRoot) if ( (-not (Test-Path -Path (Join-Path -Path $script:moduleRoot -ChildPath 'DSCResource.Tests'))) -or ` (-not (Test-Path -Path (Join-Path -Path $script:moduleRoot -ChildPath 'DSCResource.Tests\TestHelper.psm1'))) ) { & git @('clone','https://github.com/PowerShell/DscResource.Tests.git',(Join-Path -Path $script:moduleRoot -ChildPath 'DSCResource.Tests')) } Import-Module -Name (Join-Path -Path $script:moduleRoot -ChildPath (Join-Path -Path 'DSCResource.Tests' -ChildPath 'TestHelper.psm1')) -Force $TestEnvironment = Initialize-TestEnvironment ` -DSCModuleName $script:dscModuleName ` -DSCResourceName $script:dscResourceName ` -TestType Unit #endregion HEADER function Invoke-TestSetup { } function Invoke-TestCleanup { Restore-TestEnvironment -TestEnvironment $TestEnvironment } # Begin Testing try { Invoke-TestSetup InModuleScope $script:dscResourceName { $mockClusterGroupName = 'AGTest' $mockRetryInterval = 1 $mockRetryCount = 2 $mockOtherClusterGroupName = 'UnknownAG' # Function stub of Get-ClusterGroup (when we do not have Failover Cluster powershell module available) function Get-ClusterGroup { param ( # Will contain the cluster group name so mock can bind filters on it. [Parameter()] [System.String] $Name ) throw '{0}: StubNotImplemented' -f $MyInvocation.MyCommand } $mockGetClusterGroup = { if ($Name -ne $mockExpectedClusterGroupName) { throw ('Mock Get-ClusterGroup called with unexpected name. Expected ''{0}'', but was ''{1}''' -f $mockExpectedClusterGroupName, $Name) } return New-Object -TypeName PSObject -Property @{ Name = $Name } } $mockGetClusterGroup_ParameterFilter_KnownGroup = { $Name -eq $mockClusterGroupName } $mockGetClusterGroup_ParameterFilter_UnknownGroup = { $Name -eq $mockOtherClusterGroupName } # Default parameters that are used for the It-blocks $mockDefaultParameters = @{ Name = $mockClusterGroupName RetryIntervalSec = $mockRetryInterval RetryCount = $mockRetryCount } Describe 'SqlWaitForAG\Get-TargetResource' -Tag 'Get' { BeforeEach { $testParameters = $mockDefaultParameters.Clone() Mock -CommandName Get-ClusterGroup -MockWith $mockGetClusterGroup -ParameterFilter $mockGetClusterGroup_ParameterFilter_KnownGroup -Verifiable Mock -CommandName Get-ClusterGroup -MockWith { return $null } -ParameterFilter $mockGetClusterGroup_ParameterFilter_UnknownGroup -Verifiable } Context 'When the system is in the desired state' { $mockExpectedClusterGroupName = $mockClusterGroupName It 'Should return the same values as passed as parameters' { $result = Get-TargetResource @testParameters $result.RetryIntervalSec | Should -Be $mockRetryInterval $result.RetryCount | Should -Be $mockRetryCount Assert-MockCalled -CommandName Get-ClusterGroup ` -ParameterFilter $mockGetClusterGroup_ParameterFilter_KnownGroup ` -Exactly -Times 1 -Scope It Assert-MockCalled -CommandName Get-ClusterGroup ` -ParameterFilter $mockGetClusterGroup_ParameterFilter_UnknownGroup ` -Exactly -Times 0 -Scope It } It 'Should return that the group exist' { $result = Get-TargetResource @testParameters $result.GroupExist | Should -Be $true } } Context 'When the system is not in the desired state' { BeforeEach { $testParameters.Name = $mockOtherClusterGroupName } $mockExpectedClusterGroupName = $mockOtherClusterGroupName It 'Should return the same values as passed as parameters' { $result = Get-TargetResource @testParameters $result.RetryIntervalSec | Should -Be $mockRetryInterval $result.RetryCount | Should -Be $mockRetryCount Assert-MockCalled -CommandName Get-ClusterGroup ` -ParameterFilter $mockGetClusterGroup_ParameterFilter_KnownGroup ` -Exactly -Times 0 -Scope It Assert-MockCalled -CommandName Get-ClusterGroup ` -ParameterFilter $mockGetClusterGroup_ParameterFilter_UnknownGroup ` -Exactly -Times 1 -Scope It } It 'Should return that the group does not exist' { $result = Get-TargetResource @testParameters $result.GroupExist | Should -Be $false } } Assert-VerifiableMock } Describe 'SqlWaitForAG\Test-TargetResource' -Tag 'Test'{ BeforeEach { $testParameters = $mockDefaultParameters.Clone() Mock -CommandName Get-ClusterGroup -MockWith $mockGetClusterGroup -ParameterFilter $mockGetClusterGroup_ParameterFilter_KnownGroup -Verifiable Mock -CommandName Get-ClusterGroup -MockWith { return $null } -ParameterFilter $mockGetClusterGroup_ParameterFilter_UnknownGroup -Verifiable } Context 'When the system is in the desired state' { $mockExpectedClusterGroupName = $mockClusterGroupName It 'Should return that desired state is present ($true)' { $result = Test-TargetResource @testParameters $result | Should -Be $true Assert-MockCalled -CommandName Get-ClusterGroup ` -ParameterFilter $mockGetClusterGroup_ParameterFilter_KnownGroup ` -Exactly -Times 1 -Scope It Assert-MockCalled -CommandName Get-ClusterGroup ` -ParameterFilter $mockGetClusterGroup_ParameterFilter_UnknownGroup ` -Exactly -Times 0 -Scope It } } Context 'When the system is not in the desired state' { $mockExpectedClusterGroupName = $mockOtherClusterGroupName It 'Should return that desired state is absent ($false)' { $testParameters.Name = $mockOtherClusterGroupName $result = Test-TargetResource @testParameters $result | Should -Be $false Assert-MockCalled -CommandName Get-ClusterGroup ` -ParameterFilter $mockGetClusterGroup_ParameterFilter_KnownGroup ` -Exactly -Times 0 -Scope It Assert-MockCalled -CommandName Get-ClusterGroup ` -ParameterFilter $mockGetClusterGroup_ParameterFilter_UnknownGroup ` -Exactly -Times 1 -Scope It } } Assert-VerifiableMock } Describe 'SqlWaitForAG\Set-TargetResource' -Tag 'Set'{ BeforeEach { $testParameters = $mockDefaultParameters.Clone() Mock -CommandName Start-Sleep Mock -CommandName Get-ClusterGroup -MockWith $mockGetClusterGroup -ParameterFilter $mockGetClusterGroup_ParameterFilter_KnownGroup -Verifiable Mock -CommandName Get-ClusterGroup -MockWith { return $null } -ParameterFilter $mockGetClusterGroup_ParameterFilter_UnknownGroup -Verifiable } Context 'When the system is in the desired state' { $mockExpectedClusterGroupName = $mockClusterGroupName It 'Should find the cluster group and return without throwing' { { Set-TargetResource @testParameters } | Should -Not -Throw Assert-MockCalled -CommandName Get-ClusterGroup ` -ParameterFilter $mockGetClusterGroup_ParameterFilter_KnownGroup ` -Exactly -Times 1 -Scope It Assert-MockCalled -CommandName Get-ClusterGroup ` -ParameterFilter $mockGetClusterGroup_ParameterFilter_UnknownGroup ` -Exactly -Times 0 -Scope It } } Context 'When the system is not in the desired state' { $mockExpectedClusterGroupName = $mockOtherClusterGroupName It 'Should throw the correct error message' { $testParameters.Name = $mockOtherClusterGroupName { Set-TargetResource @testParameters } | Should -Throw ($script:localizedData.FailedMessage -f $mockOtherClusterGroupName) Assert-MockCalled -CommandName Get-ClusterGroup ` -ParameterFilter $mockGetClusterGroup_ParameterFilter_KnownGroup ` -Exactly -Times 0 -Scope It Assert-MockCalled -CommandName Get-ClusterGroup ` -ParameterFilter $mockGetClusterGroup_ParameterFilter_UnknownGroup ` -Exactly -Times 2 -Scope It } } Assert-VerifiableMock } } } finally { Invoke-TestCleanup } |