Tests/Unit/MSFT_SqlAlwaysOnService.Tests.ps1
|
<#
.SYNOPSIS Automated unit test for MSFT_SqlAlwaysOnService 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 #> # This is used to make sure the unit test run in a container. [Microsoft.DscResourceKit.UnitTest(ContainerName = 'Container1', ContainerImage = 'microsoft/windowsservercore')] param() $script:DSCModuleName = 'SqlServerDsc' $script:DSCResourceName = 'MSFT_SqlAlwaysOnService' # Unit Test Template Version: 1.1.0 [System.String] $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 (Join-Path -Path $script:moduleRoot -ChildPath 'DSCResource.Tests\TestHelper.psm1') -Force $TestEnvironment = Initialize-TestEnvironment ` -DSCModuleName $script:DSCModuleName ` -DSCResourceName $script:DSCResourceName ` -TestType Unit $disableHadr = @{ Ensure = 'Absent' ServerName = 'Server01' InstanceName = 'MSSQLSERVER' } $enableHadr = @{ Ensure = 'Present' ServerName = 'Server01' InstanceName = 'MSSQLSERVER' } $disableHadrNamedInstance = @{ Ensure = 'Absent' ServerName = 'Server01' InstanceName = 'NamedInstance' } $enableHadrNamedInstance = @{ Ensure = 'Present' ServerName = 'Server01' InstanceName = 'NamedInstance' } # Begin Testing try { Describe "$($script:DSCResourceName)\Get-TargetResource" { Context 'When HADR is disabled' { Mock -CommandName Connect-SQL -MockWith { return New-Object -TypeName PSObject -Property @{ IsHadrEnabled = $false } } -ModuleName $script:DSCResourceName -Verifiable It 'Should return that HADR is disabled' { # Get the current state $result = Get-TargetResource @enableHadr $result.IsHadrEnabled | Should -Be $false Assert-MockCalled -ModuleName $script:DSCResourceName -CommandName Connect-SQL -Scope It -Times 1 -Exactly } It 'Should return that HADR is disabled' { # Get the current state $result = Get-TargetResource @enableHadrNamedInstance $result.IsHadrEnabled | Should -Be $false Assert-MockCalled -ModuleName $script:DSCResourceName -CommandName Connect-SQL -Scope It -Times 1 -Exactly } } Context 'When HADR is enabled' { Mock -CommandName Connect-SQL -MockWith { return New-Object -TypeName PSObject -Property @{ IsHadrEnabled = $true } } -ModuleName $script:DSCResourceName -Verifiable It 'Should return that HADR is enabled' { # Get the current state $result = Get-TargetResource @enableHadr $result.IsHadrEnabled | Should -Be $true Assert-MockCalled -ModuleName $script:DSCResourceName -CommandName Connect-SQL -Scope It -Times 1 -Exactly } It 'Should return that HADR is enabled' { # Get the current state $result = Get-TargetResource @enableHadrNamedInstance $result.IsHadrEnabled | Should -Be $true Assert-MockCalled -ModuleName $script:DSCResourceName -CommandName Connect-SQL -Scope It -Times 1 -Exactly } } # This it regression test for issue #519. Context 'When Server.IsHadrEnabled returns $null' { Mock -CommandName Connect-SQL -MockWith { return New-Object -TypeName PSObject -Property @{ IsHadrEnabled = $null } } -ModuleName $script:DSCResourceName -Verifiable It 'Should fail with the correct error message' { # Regression test for issue #519 { Get-TargetResource @enableHadr } | Should -Not -Throw 'Index operation failed; the array index evaluated to null' $result = Get-TargetResource @enableHadr $result.IsHadrEnabled | Should -Be $false Assert-MockCalled -ModuleName $script:DSCResourceName -CommandName Connect-SQL -Scope It -Times 2 -Exactly } } } Describe "$($script:DSCResourceName)\Set-TargetResource" { # Loading stub cmdlets Import-Module -Name ( Join-Path -Path ( Join-Path -Path $PSScriptRoot -ChildPath Stubs ) -ChildPath SQLPSStub.psm1 ) -Force Mock -CommandName Disable-SqlAlwaysOn -ModuleName $script:DSCResourceName Mock -CommandName Enable-SqlAlwaysOn -ModuleName $script:DSCResourceName Mock -CommandName Import-SQLPSModule -ModuleName $script:DSCResourceName Mock -CommandName New-TerminatingError { $ErrorType } -ModuleName $script:DSCResourceName Mock -CommandName New-VerboseMessage -ModuleName $script:DSCResourceName Mock -CommandName Restart-SqlService -ModuleName $script:DSCResourceName -Verifiable Context 'When HADR is not in the desired state' { It 'Should enable SQL Always On when Ensure is set to Present' { Mock -CommandName Connect-SQL -MockWith { return New-Object -TypeName PSObject -Property @{ IsHadrEnabled = $true } } -ModuleName $script:DSCResourceName -Verifiable Set-TargetResource @enableHadr Assert-MockCalled -ModuleName $script:DSCResourceName -CommandName Connect-SQL -Scope It -Times 1 Assert-MockCalled -ModuleName $script:DSCResourceName -CommandName Disable-SqlAlwaysOn -Scope It -Times 0 Assert-MockCalled -ModuleName $script:DSCResourceName -CommandName Enable-SqlAlwaysOn -Scope It -Times 1 Assert-MockCalled -ModuleName $script:DSCResourceName -CommandName Restart-SqlService -Scope It -Times 1 } It 'Should disable SQL Always On when Ensure is set to Absent' { Mock -CommandName Connect-SQL -MockWith { return New-Object -TypeName PSObject -Property @{ IsHadrEnabled = $false } } -ModuleName $script:DSCResourceName -Verifiable Set-TargetResource @disableHadr Assert-MockCalled -ModuleName $script:DSCResourceName -CommandName Connect-SQL -Scope It -Times 1 Assert-MockCalled -ModuleName $script:DSCResourceName -CommandName Disable-SqlAlwaysOn -Scope It -Times 1 Assert-MockCalled -ModuleName $script:DSCResourceName -CommandName Enable-SqlAlwaysOn -Scope It -Times 0 Assert-MockCalled -ModuleName $script:DSCResourceName -CommandName Restart-SqlService -Scope It -Times 1 } It 'Should enable SQL Always On on a named instance when Ensure is set to Present' { Mock -CommandName Connect-SQL -MockWith { return New-Object -TypeName PSObject -Property @{ IsHadrEnabled = $true } } -ModuleName $script:DSCResourceName -Verifiable Set-TargetResource @enableHadrNamedInstance Assert-MockCalled -ModuleName $script:DSCResourceName -CommandName Connect-SQL -Scope It -Times 1 Assert-MockCalled -ModuleName $script:DSCResourceName -CommandName Disable-SqlAlwaysOn -Scope It -Times 0 Assert-MockCalled -ModuleName $script:DSCResourceName -CommandName Enable-SqlAlwaysOn -Scope It -Times 1 Assert-MockCalled -ModuleName $script:DSCResourceName -CommandName Restart-SqlService -Scope It -Times 1 } It 'Should disable SQL Always On on a named instance when Ensure is set to Absent' { Mock -CommandName Connect-SQL -MockWith { return New-Object -TypeName PSObject -Property @{ IsHadrEnabled = $false } } -ModuleName $script:DSCResourceName -Verifiable Set-TargetResource @disableHadrNamedInstance Assert-MockCalled -ModuleName $script:DSCResourceName -CommandName Connect-SQL -Scope It -Times 1 Assert-MockCalled -ModuleName $script:DSCResourceName -CommandName Disable-SqlAlwaysOn -Scope It -Times 1 Assert-MockCalled -ModuleName $script:DSCResourceName -CommandName Enable-SqlAlwaysOn -Scope It -Times 0 Assert-MockCalled -ModuleName $script:DSCResourceName -CommandName Restart-SqlService -Scope It -Times 1 } It 'Should throw the correct error message when Ensure is set to Present, but IsHadrEnabled is $false' { Mock -CommandName Connect-SQL -MockWith { return New-Object -TypeName PSObject -Property @{ IsHadrEnabled = $false } } -ModuleName $script:DSCResourceName -Verifiable { Set-TargetResource @enableHadr } | Should -Throw 'AlterAlwaysOnServiceFailed' Assert-MockCalled -ModuleName $script:DSCResourceName -CommandName Connect-SQL -Scope It -Times 1 Assert-MockCalled -ModuleName $script:DSCResourceName -CommandName Disable-SqlAlwaysOn -Scope It -Times 0 Assert-MockCalled -ModuleName $script:DSCResourceName -CommandName Enable-SqlAlwaysOn -Scope It -Times 1 Assert-MockCalled -ModuleName $script:DSCResourceName -CommandName Restart-SqlService -Scope It -Times 1 Assert-MockCalled -ModuleName $script:DSCResourceName -CommandName New-TerminatingError -Scope It -Times 1 } It 'Should throw the correct error message when Ensure is set to Absent, but IsHadrEnabled is $true' { Mock -CommandName Connect-SQL -MockWith { return New-Object -TypeName PSObject -Property @{ IsHadrEnabled = $true } } -ModuleName $script:DSCResourceName -Verifiable { Set-TargetResource @disableHadr } | Should -Throw 'AlterAlwaysOnServiceFailed' Assert-MockCalled -ModuleName $script:DSCResourceName -CommandName Connect-SQL -Scope It -Times 1 Assert-MockCalled -ModuleName $script:DSCResourceName -CommandName Disable-SqlAlwaysOn -Scope It -Times 1 Assert-MockCalled -ModuleName $script:DSCResourceName -CommandName Enable-SqlAlwaysOn -Scope It -Times 0 Assert-MockCalled -ModuleName $script:DSCResourceName -CommandName Restart-SqlService -Scope It -Times 1 Assert-MockCalled -ModuleName $script:DSCResourceName -CommandName New-TerminatingError -Scope It -Times 1 } } } Describe "$($script:DSCResourceName)\Test-TargetResource" { Context 'When HADR is not in the desired state' { Mock -CommandName Connect-SQL -MockWith { return New-Object -TypeName PSObject -Property @{ IsHadrEnabled = $true } } -ModuleName $script:DSCResourceName -Verifiable It 'Should cause Test-TargetResource to return false when not in the desired state' { Test-TargetResource @disableHadr | Should -Be $false } } Context 'When HADR is in the desired state' { Mock -CommandName Connect-SQL -MockWith { return New-Object -TypeName PSObject -Property @{ IsHadrEnabled = $true } } -ModuleName $script:DSCResourceName -Verifiable It 'Should cause Test-TargetResource to return true when in the desired state' { Test-TargetResource @enableHadr | Should -Be $true } } } } finally { Restore-TestEnvironment -TestEnvironment $TestEnvironment } |