Tests/Unit/MSFT_xSQLServerLogin.Tests.ps1
# Suppressing this rule because PlainText is required for one of the functions used in this test [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingConvertToSecureStringWithPlainText', '')] param() $script:DSCModuleName = 'xSQLServer' $script:DSCResourceName = 'MSFT_xSQLServerLogin' #region HEADER # Unit Test Template Version: 1.1.0 [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 #endregion HEADER # Begin Testing try { #region Pester Test Initialization # Loading mocked classes Add-Type -Path (Join-Path -Path $script:moduleRoot -ChildPath 'Tests\Unit\Stubs\SMO.cs') $nodeName = 'localhost' $instanceName = 'MSSQLSERVER' $mockSqlLoginUser = "dba" $mockSqlLoginPassword = "dummyPassw0rd" | ConvertTo-SecureString -asPlainText -Force $mockSqlLoginCredential = New-Object System.Management.Automation.PSCredential( $mockSqlLoginUser, $mockSqlLoginPassword ) $defaultParameters = @{ SQLInstanceName = $instanceName SQLServer = $nodeName } #endregion Pester Test Initialization Describe "$($script:DSCResourceName)\Get-TargetResource" { Mock -CommandName Connect-SQL -MockWith { return New-Object Object | Add-Member ScriptProperty Logins { return @{ 'COMPANY\Stacy' = @( ( New-Object Microsoft.SqlServer.Management.Smo.Login -ArgumentList @( $null, 'COMPANY\Stacy') -Property @{ LoginType = 'WindowsUser'} ) ) 'John' = @( ( New-Object Microsoft.SqlServer.Management.Smo.Login -ArgumentList @( $null, 'John') -Property @{ LoginType = 'SqlLogin'} ) ) 'COMPANY\SqlUsers' = @( ( New-Object Microsoft.SqlServer.Management.Smo.Login -ArgumentList @( $null, 'COMPANY\SqlUsers') -Property @{ LoginType = 'WindowsGroup'} ) ) } } -PassThru -Force } -ModuleName $script:DSCResourceName -Verifiable Context 'When the system is not in the desired state' { $testParameters = $defaultParameters $testParameters += @{ Name = 'COMPANY\UnknownUser' } $result = Get-TargetResource @testParameters It 'Should not return the state as absent' { $result.Ensure | Should Be 'Absent' $result.LoginType | Should Be '' } It 'Should return the same values as passed as parameters' { $result.SQLServer | Should Be $testParameters.SQLServer $result.SQLInstanceName | Should Be $testParameters.SQLInstanceName $result.Name | Should Be $testParameters.Name } It 'Should call the mock function Connect-SQL' { Assert-MockCalled Connect-SQL -Exactly -Times 1 -ModuleName $script:DSCResourceName -Scope Context } } Context 'When the system is in the desired state for a Windows user' { $testParameters = $defaultParameters $testParameters += @{ Name = 'COMPANY\Stacy' } $result = Get-TargetResource @testParameters It 'Should not return the state as present' { $result.Ensure | Should Be 'Present' $result.LoginType | Should Be 'WindowsUser' } It 'Should return the same values as passed as parameters' { $result.SQLServer | Should Be $testParameters.SQLServer $result.SQLInstanceName | Should Be $testParameters.SQLInstanceName $result.Name | Should Be $testParameters.Name } It 'Should call the mock function Connect-SQL' { Assert-MockCalled Connect-SQL -Exactly -Times 1 -ModuleName $script:DSCResourceName -Scope Context } } Context 'When the system is in the desired state for a Windows group' { $testParameters = $defaultParameters $testParameters += @{ Name = 'COMPANY\SqlUsers' } $result = Get-TargetResource @testParameters It 'Should return the state as present' { $result.Ensure | Should Be 'Present' $result.LoginType | Should Be 'WindowsGroup' } It 'Should return the same values as passed as parameters' { $result.SQLServer | Should Be $testParameters.SQLServer $result.SQLInstanceName | Should Be $testParameters.SQLInstanceName $result.Name | Should Be $testParameters.Name } It 'Should call the mock function Connect-SQL' { Assert-MockCalled Connect-SQL -Exactly -Times 1 -ModuleName $script:DSCResourceName -Scope Context } } Context 'When the system is in the desired state for a SQL login' { $testParameters = $defaultParameters $testParameters += @{ Name = 'John' } $result = Get-TargetResource @testParameters It 'Should return the state as present' { $result.Ensure | Should Be 'Present' $result.LoginType | Should Be 'SqlLogin' } It 'Should return the same values as passed as parameters' { $result.SQLServer | Should Be $testParameters.SQLServer $result.SQLInstanceName | Should Be $testParameters.SQLInstanceName $result.Name | Should Be $testParameters.Name } It 'Should call the mock function Connect-SQL' { Assert-MockCalled Connect-SQL -Exactly -Times 1 -ModuleName $script:DSCResourceName -Scope Context } } Assert-VerifiableMocks } Describe "$($script:DSCResourceName)\Test-TargetResource" { Mock -CommandName Connect-SQL -MockWith { return New-Object Object | Add-Member ScriptProperty Logins { return @{ 'COMPANY\Stacy' = @( ( New-Object Microsoft.SqlServer.Management.Smo.Login -ArgumentList @( $null, 'COMPANY\Stacy') -Property @{ LoginType = 'WindowsUser'} ) ) 'John' = @( ( New-Object Microsoft.SqlServer.Management.Smo.Login -ArgumentList @( $null, 'John') -Property @{ LoginType = 'SqlLogin'} ) ) 'COMPANY\SqlUsers' = @( ( New-Object Microsoft.SqlServer.Management.Smo.Login -ArgumentList @( $null, 'COMPANY\SqlUsers') -Property @{ LoginType = 'WindowsGroup'} ) ) } } -PassThru -Force } -ModuleName $script:DSCResourceName -Verifiable Context 'When the system is not in the desired state' { It 'Should return the state as absent when desired windows user does not exist' { $testParameters = $defaultParameters $testParameters += @{ Name = 'COMPANY\UnknownUser' } $result = Test-TargetResource @testParameters $result | Should Be $false Assert-MockCalled Connect-SQL -Exactly -Times 1 -ModuleName $script:DSCResourceName -Scope It } It 'Should return the state as present when desired login exists and login type is SQL login' { $testParameters = $defaultParameters $testParameters += @{ Name = 'COMPANY\SqlUsers' LoginType = 'SqlLogin' } $result = Test-TargetResource @testParameters $result | Should Be $true Assert-MockCalled Connect-SQL -Exactly -Times 1 -ModuleName $script:DSCResourceName -Scope It } It 'Should return the state as present when desired login exists and login type is Windows' { $testParameters = $defaultParameters $testParameters += @{ Name = 'John' LoginType = 'WindowsUser' } $result = Test-TargetResource @testParameters $result | Should Be $true Assert-MockCalled Connect-SQL -Exactly -Times 1 -ModuleName $script:DSCResourceName -Scope It } } Context 'When the system is in the desired state' { It 'Should return the state as present when desired windows user exists' { $testParameters = $defaultParameters $testParameters += @{ Name = 'COMPANY\Stacy' } $result = Test-TargetResource @testParameters $result | Should Be $true Assert-MockCalled Connect-SQL -Exactly -Times 1 -ModuleName $script:DSCResourceName -Scope It } It 'Should return the state as present when desired windows group exists' { $testParameters = $defaultParameters $testParameters += @{ Name = 'COMPANY\SqlUsers' LoginType = 'WindowsGroup' } $result = Test-TargetResource @testParameters $result | Should Be $true Assert-MockCalled Connect-SQL -Exactly -Times 1 -ModuleName $script:DSCResourceName -Scope It } It 'Should return the state as present when desired sql login exists' { $testParameters = $defaultParameters $testParameters += @{ Name = 'John' LoginType = 'SqlLogin' } $result = Test-TargetResource @testParameters $result | Should Be $true Assert-MockCalled Connect-SQL -Exactly -Times 1 -ModuleName $script:DSCResourceName -Scope It } } Assert-VerifiableMocks } Describe "$($script:DSCResourceName)\Set-TargetResource" { Mock -CommandName Connect-SQL -MockWith { return New-Object Object | Add-Member ScriptProperty Logins { return @{ 'COMPANY\Stacy' = @( ( New-Object Microsoft.SqlServer.Management.Smo.Login -ArgumentList @( $null, 'COMPANY\Stacy') -Property @{ LoginType = 'WindowsUser'} ) ) 'John' = @( ( New-Object Microsoft.SqlServer.Management.Smo.Login -ArgumentList @( $null, 'John') -Property @{ LoginType = 'SqlLogin'} ) ) 'COMPANY\SqlUsers' = @( ( New-Object Microsoft.SqlServer.Management.Smo.Login -ArgumentList @( $null, 'COMPANY\SqlUsers') -Property @{ LoginType = 'WindowsGroup'} ) ) } } -PassThru -Force } -ModuleName $script:DSCResourceName -Verifiable Context 'When the system is not in the desired state' { $testParameters = $defaultParameters $testParameters += @{ Name = 'UnknownSqlLogin' LoginType = 'SqlLogin' } It 'Should throw an error when desired login type is a SQL login and LoginCredential parameter is not passed' { { Set-TargetResource @testParameters } | Should Throw Assert-MockCalled Connect-SQL -Exactly -Times 0 -ModuleName $script:DSCResourceName -Scope It } $testParameters += @{ LoginCredential = $mockSqlLoginCredential } It 'Should not throw an error when desired login type is a SQL login' { Mock -CommandName Get-TargetResource -MockWith { @{ Ensure = 'Present' LoginType = 'SqlLogin' } } -ModuleName $script:DSCResourceName -Verifiable { Set-TargetResource @testParameters } | Should Not Throw Assert-MockCalled Connect-SQL -Exactly -Times 1 -ModuleName $script:DSCResourceName -Scope It } $testParameters = $defaultParameters $testParameters += @{ Name = 'COMPANY\UnknownUser' LoginType = 'WindowsUser' } It 'Should not throw an error when desired login type is a Windows User' { Mock -CommandName Get-TargetResource -MockWith { @{ Ensure = 'Present' LoginType = 'WindowsUser' } } -ModuleName $script:DSCResourceName -Verifiable { Set-TargetResource @testParameters } | Should Not Throw Assert-MockCalled Connect-SQL -Exactly -Times 1 -ModuleName $script:DSCResourceName -Scope It } $testParameters = $defaultParameters $testParameters += @{ Name = 'COMPANY\UnknownGroup' LoginType = 'WindowsGroup' } It 'Should not throw an error when desired login type is a Windows Group' { Mock -CommandName Get-TargetResource -MockWith { @{ Ensure = 'Present' LoginType = 'WindowsGroup' } } -ModuleName $script:DSCResourceName -Verifiable { Set-TargetResource @testParameters } | Should Not Throw Assert-MockCalled Connect-SQL -Exactly -Times 1 -ModuleName $script:DSCResourceName -Scope It } $testParameters = $defaultParameters $testParameters += @{ Ensure = 'Absent' Name = 'COMPANY\Stacy' } It 'Should call the function Remove-SqlLogin when desired state should be absent' { # Mock the return value from the Get-method, because Test-method is ran at the end of the Set-method to validate that the removal (in this case) was successful. Mock -CommandName Get-TargetResource -MockWith { @{ Ensure = 'Absent' } } -ModuleName $script:DSCResourceName -Verifiable Mock -CommandName Remove-SqlLogin -MockWith {} -ModuleName $script:DSCResourceName -Verifiable Set-TargetResource @testParameters Assert-MockCalled Connect-SQL -Exactly -Times 1 -ModuleName $script:DSCResourceName -Scope It Assert-MockCalled Remove-SqlLogin -Exactly -Times 1 -ModuleName $script:DSCResourceName -Scope It } } Context 'When the system is in the desired state' { $testParameters = $defaultParameters $testParameters += @{ Name = 'John' LoginType = 'SqlLogin' } It 'Should throw an error when desired login type is a SQL login and LoginCredential parameter is not passed' { { Set-TargetResource @testParameters } | Should Throw Assert-MockCalled Connect-SQL -Exactly -Times 0 -ModuleName $script:DSCResourceName -Scope It } $testParameters += @{ LoginCredential = $mockSqlLoginCredential } It 'Should not throw an error when desired login type is a SQL login' { Mock -CommandName Get-TargetResource -MockWith { @{ Ensure = 'Present' LoginType = 'SqlLogin' } } -ModuleName $script:DSCResourceName -Verifiable { Set-TargetResource @testParameters } | Should Not Throw Assert-MockCalled Connect-SQL -Exactly -Times 1 -ModuleName $script:DSCResourceName -Scope It } $testParameters = $defaultParameters $testParameters += @{ Name = 'COMPANY\Stacy' LoginType = 'WindowsUser' } It 'Should not throw an error when desired login type is a Windows User' { Mock -CommandName Get-TargetResource -MockWith { @{ Ensure = 'Present' LoginType = 'WindowsUser' } } -ModuleName $script:DSCResourceName -Verifiable { Set-TargetResource @testParameters } | Should Not Throw Assert-MockCalled Connect-SQL -Exactly -Times 1 -ModuleName $script:DSCResourceName -Scope It } $testParameters = $defaultParameters $testParameters += @{ Name = 'COMPANY\SqlUsers' LoginType = 'WindowsGroup' } It 'Should not throw an error when desired login type is a Windows Group' { Mock -CommandName Get-TargetResource -MockWith { @{ Ensure = 'Present' LoginType = 'WindowsGroup' } } -ModuleName $script:DSCResourceName -Verifiable { Set-TargetResource @testParameters } | Should Not Throw Assert-MockCalled Connect-SQL -Exactly -Times 1 -ModuleName $script:DSCResourceName -Scope It } $testParameters = $defaultParameters $testParameters += @{ Ensure = 'Absent' Name = 'COMPANY\UnknownUser' LoginType = 'SqlLogin' } It 'Should not call the function Remove-SqlLogin when desired state is already absent' { # Mock the return value from the Get-method, because Test-method is ran at the end of the Set-method to validate that the removal (in this case) was successful. Mock -CommandName Get-TargetResource -MockWith { @{ Ensure = 'Absent' } } -ModuleName $script:DSCResourceName -Verifiable Mock -CommandName Remove-SqlLogin -MockWith {} -ModuleName $script:DSCResourceName -Verifiable Set-TargetResource @testParameters Assert-MockCalled Connect-SQL -Exactly -Times 1 -ModuleName $script:DSCResourceName -Scope It Assert-MockCalled Remove-SqlLogin -Exactly -Times 0 -ModuleName $script:DSCResourceName -Scope It } } Assert-VerifiableMocks } } finally { #region FOOTER Restore-TestEnvironment -TestEnvironment $TestEnvironment #endregion } |