Tests/Unit/MSFT_SqlDatabaseRole.Tests.ps1
|
<#
.SYNOPSIS Automated unit test for MSFT_SqlDatabaseRole 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_SqlDatabaseRole' #region HEADER # Unit Test Template Version: 1.2.0 $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 function Invoke-TestSetup { # Loading mocked classes Add-Type -Path (Join-Path -Path (Join-Path -Path $PSScriptRoot -ChildPath 'Stubs') -ChildPath 'SMO.cs') } function Invoke-TestCleanup { Restore-TestEnvironment -TestEnvironment $TestEnvironment } # Begin Testing try { Invoke-TestSetup InModuleScope $script:dscResourceName { $mockServerName = 'localhost' $mockInstanceName = 'MSSQLSERVER' $mockSqlDatabaseName = 'AdventureWorks' $mockSqlServerLogin = 'John' $mockSqlServerLoginOne = 'CONTOSO\KingJulian' $mockSqlServerLoginTwo = 'CONTOSO\SQLAdmin' $mockSqlServerLoginType = 'WindowsUser' $mockSqlDatabaseRole = 'MyRole' $mockSqlDatabaseRoleSecond = 'MySecondRole' $mockExpectedSqlDatabaseRole = 'MyRole' $mockInvalidOperationForAddMemberMethod = $false $mockInvalidOperationForDropMemberMethod = $false $mockInvalidOperationForCreateMethod = $false $mockExpectedForAddMemberMethod = 'MySecondRole' $mockExpectedForDropMemberMethod = 'MyRole' $mockExpectedForCreateMethod = 'John' # Default parameters that are used for the It-blocks $mockDefaultParameters = @{ InstanceName = $mockInstanceName ServerName = $mockServerName } #region Function mocks $mockConnectSQL = { return @( ( New-Object -TypeName Object | Add-Member -MemberType NoteProperty -Name InstanceName -Value $mockInstanceName -PassThru | Add-Member -MemberType NoteProperty -Name ComputerNamePhysicalNetBIOS -Value $mockServerName -PassThru | Add-Member -MemberType ScriptProperty -Name Databases -Value { return @{ $mockSqlDatabaseName = @(( New-Object -TypeName Object | Add-Member -MemberType NoteProperty -Name Name -Value $mockSqlDatabaseName -PassThru | Add-Member -MemberType ScriptProperty -Name Users -Value { return @{ $mockSqlServerLoginOne = @(( New-Object -TypeName Object | Add-Member -MemberType ScriptMethod -Name IsMember -Value { param( [System.String] $mockSqlDatabaseRole ) if ( $mockSqlDatabaseRole -eq $mockExpectedSqlDatabaseRole ) { return $true } else { return $false } } -PassThru )) $mockSqlServerLoginTwo = @(( New-Object -TypeName Object | Add-Member -MemberType ScriptMethod -Name IsMember -Value { return $true } -PassThru )) } } -PassThru | Add-Member -MemberType ScriptProperty -Name Roles -Value { return @{ $mockSqlDatabaseRole = @(( New-Object -TypeName Object | Add-Member -MemberType NoteProperty -Name Name -Value $mockSqlDatabaseRole -PassThru | Add-Member -MemberType ScriptMethod -Name AddMember -Value { param( [System.String] $mockSqlServerLogin ) if ($mockInvalidOperationForAddMemberMethod) { throw 'Mock AddMember Method was called with invalid operation.' } if ( $this.Name -ne $mockExpectedForAddMemberMethod ) { throw "Called mocked AddMember() method without adding the right user. Expected '{0}'. But was '{1}'." ` -f $mockExpectedForAddMemberMethod, $this.Name } } -PassThru | Add-Member -MemberType ScriptMethod -Name DropMember -Value { param( [System.String] $mockSqlServerLogin ) if ($mockInvalidOperationForDropMemberMethod) { throw 'Mock DropMember Method was called with invalid operation.' } if ( $this.Name -ne $mockExpectedForDropMemberMethod ) { throw "Called mocked Drop() method without adding the right user. Expected '{0}'. But was '{1}'." ` -f $mockExpectedForDropMemberMethod, $this.Name } } -PassThru )) $mockSqlDatabaseRoleSecond = @(( New-Object -TypeName Object | Add-Member -MemberType NoteProperty -Name Name -Value $mockSqlDatabaseRoleSecond -PassThru | Add-Member -MemberType ScriptMethod -Name AddMember -Value { param( [System.String] $mockSqlServerLogin ) if ($mockInvalidOperationForAddMemberMethod) { throw 'Mock AddMember Method was called with invalid operation.' } if ( $this.Name -ne $mockExpectedForAddMemberMethod ) { throw "Called mocked AddMember() method without adding the right user. Expected '{0}'. But was '{1}'." ` -f $mockExpectedForAddMemberMethod, $this.Name } } -PassThru | Add-Member -MemberType ScriptMethod -Name DropMember -Value { param( [System.String] $mockSqlServerLogin ) if ($mockInvalidOperationForDropMemberMethod) { throw 'Mock DropMember Method was called with invalid operation.' } if ( $this.Name -ne $mockExpectedForDropMemberMethod ) { throw "Called mocked Drop() method without adding the right user. Expected '{0}'. But was '{1}'." ` -f $mockExpectedForDropMemberMethod, $this.Name } } -PassThru )) } }-PassThru -Force )) } } -PassThru -Force | Add-Member -MemberType ScriptProperty -Name Logins -Value { return @{ $mockSqlServerLoginOne = @(( New-Object -TypeName Object | Add-Member -MemberType NoteProperty -Name LoginType -Value $mockSqlServerLoginType -PassThru )) $mockSqlServerLoginTwo = @(( New-Object -TypeName Object | Add-Member -MemberType NoteProperty -Name LoginType -Value $mockSqlServerLoginType -PassThru )) $mockSqlServerLogin = @(( New-Object -TypeName Object | Add-Member -MemberType NoteProperty -Name LoginType -Value $mockSqlServerLoginType -PassThru )) } } -PassThru -Force ) ) } $mockNewObjectUser = { return @( ( New-Object -TypeName Object | Add-Member -MemberType NoteProperty -Name Name -Value $mockSqlServerLogin -PassThru | Add-Member -MemberType NoteProperty -Name Login -Value $mockSqlServerLogin -PassThru | Add-Member -MemberType ScriptMethod -Name Create -Value { if ($mockInvalidOperationForCreateMethod) { throw 'Mock Create Method was called with invalid operation.' } if ( $this.Name -ne $mockExpectedForCreateMethod ) { throw "Called mocked Create() method without adding the right user. Expected '{0}'. But was '{1}'." ` -f $mockExpectedForCreateMethod, $this.Name } } -PassThru -Force ) ) } #endregion Describe "MSFT_SqlDatabaseRole\Get-TargetResource" -Tag 'Get' { BeforeEach { Mock -CommandName Connect-SQL -MockWith $mockConnectSQL -Verifiable } Context 'When passing values to parameters and database name does not exist' { It 'Should throw the correct error' { $testParameters = $mockDefaultParameters $testParameters += @{ Name = $mockSqlServerLoginOne Database = 'unknownDatabaseName' Role = $mockSqlDatabaseRole } $throwInvalidOperation = ("Database 'unknownDatabaseName' does not exist " + ` "on SQL server 'localhost\MSSQLSERVER'.") { Get-TargetResource @testParameters } | Should -Throw $throwInvalidOperation } It 'Should call the mock function Connect-SQL' { Assert-MockCalled Connect-SQL -Exactly -Times 1 -Scope Context } } Context 'When passing values to parameters and role does not exist' { It 'Should throw the correct error' { $testParameters = $mockDefaultParameters $testParameters += @{ Name = $mockSqlServerLoginOne Database = $mockSqlDatabaseName Role = 'unknownRoleName' } $throwInvalidOperation = ("Role 'unknownRoleName' does not exist on database " + ` "'AdventureWorks' on SQL server 'localhost\MSSQLSERVER'.") { Get-TargetResource @testParameters } | Should -Throw $throwInvalidOperation } It 'Should call the mock function Connect-SQL' { Assert-MockCalled Connect-SQL -Exactly -Times 1 -Scope Context } } Context 'When passing values to parameters and multiple values to Role parameter' { It 'Should not throw' { $testParameters = $mockDefaultParameters $testParameters += @{ Name = $mockSqlServerLoginOne Database = $mockSqlDatabaseName Role = @($mockSqlDatabaseRole, $mockSqlDatabaseRoleSecond) } { Get-TargetResource @testParameters } | Should -Not -Throw } It 'Should call the mock function Connect-SQL' { Assert-MockCalled Connect-SQL -Exactly -Times 1 -Scope Context } } Context 'When passing values to parameters and login does not exist' { It 'Should throw the correct error' { $testParameters = $mockDefaultParameters $testParameters += @{ Name = 'unknownLoginName' Database = $mockSqlDatabaseName Role = $mockSqlDatabaseRole } $throwInvalidOperation = ("Login 'unknownLoginName' does not exist " + ` "on SQL server 'localhost\MSSQLSERVER'.") { Get-TargetResource @testParameters } | Should -Throw $throwInvalidOperation } It 'Should call the mock function Connect-SQL' { Assert-MockCalled Connect-SQL -Exactly -Times 1 -Scope Context } } Context 'When the system is not in the desired state, with one role' { $testParameters = $mockDefaultParameters $testParameters += @{ Name = $mockSqlServerLoginOne Database = $mockSqlDatabaseName Role = $mockSqlDatabaseRoleSecond } It 'Should return the state as absent' { $result = Get-TargetResource @testParameters $result.Ensure | Should -Be 'Absent' Assert-MockCalled Connect-SQL -Exactly -Times 1 -Scope It } It 'Should not return any granted roles' { $result = Get-TargetResource @testParameters $result.Role | Should -Be $null Assert-MockCalled Connect-SQL -Exactly -Times 1 -Scope It } It 'Should return the same values as passed as parameters' { $result = Get-TargetResource @testParameters $result.ServerName | Should -Be $testParameters.ServerName $result.InstanceName | Should -Be $testParameters.InstanceName $result.Database | Should -Be $testParameters.Database $result.Name | Should -Be $testParameters.Name Assert-MockCalled Connect-SQL -Exactly -Times 1 -Scope It } } Context 'When the system is not in the desired state, with two roles' { $testParameters = $mockDefaultParameters $testParameters += @{ Name = $mockSqlServerLoginOne Database = $mockSqlDatabaseName Role = @($mockSqlDatabaseRole, $mockSqlDatabaseRoleSecond) } It 'Should return the state as absent' { $result = Get-TargetResource @testParameters $result.Ensure | Should -Be 'Absent' Assert-MockCalled Connect-SQL -Exactly -Times 1 -Scope It } It 'Should only return the one granted role' { $result = Get-TargetResource @testParameters $result.Role | Should -Be $mockSqlDatabaseRole Assert-MockCalled Connect-SQL -Exactly -Times 1 -Scope It } It 'Should return the same values as passed as parameters' { $result = Get-TargetResource @testParameters $result.ServerName | Should -Be $testParameters.ServerName $result.InstanceName | Should -Be $testParameters.InstanceName $result.Database | Should -Be $testParameters.Database $result.Name | Should -Be $testParameters.Name Assert-MockCalled Connect-SQL -Exactly -Times 1 -Scope It } } Context 'When the system is not in the desired state, and login is not a member of the database' { $testParameters = $mockDefaultParameters $testParameters += @{ Name = $mockSqlServerLogin Database = $mockSqlDatabaseName Role = $mockSqlDatabaseRole } It 'Should return the state as absent' { $result = Get-TargetResource @testParameters $result.Ensure | Should -Be 'Absent' Assert-MockCalled Connect-SQL -Exactly -Times 1 -Scope It } It 'Should return the same values as passed as parameters' { $result = Get-TargetResource @testParameters $result.ServerName | Should -Be $testParameters.ServerName $result.InstanceName | Should -Be $testParameters.InstanceName $result.Database | Should -Be $testParameters.Database $result.Name | Should -Be $testParameters.Name Assert-MockCalled Connect-SQL -Exactly -Times 1 -Scope It } } Context 'When the system is in the desired state for a Windows user' { $testParameters = $mockDefaultParameters $testParameters += @{ Name = $mockSqlServerLoginOne Database = $mockSqlDatabaseName Role = $mockSqlDatabaseRole } It 'Should return the state as absent' { $result = Get-TargetResource @testParameters $result.Ensure | Should -Be 'Present' Assert-MockCalled Connect-SQL -Exactly -Times 1 -Scope It } It 'Should return the same values as passed as parameters' { $result = Get-TargetResource @testParameters $result.ServerName | Should -Be $testParameters.ServerName $result.InstanceName | Should -Be $testParameters.InstanceName $result.Database | Should -Be $testParameters.Database $result.Name | Should -Be $testParameters.Name $result.Role | Should -Be $testParameters.Role Assert-MockCalled Connect-SQL -Exactly -Times 1 -Scope It } } Assert-VerifiableMock } Describe "MSFT_SqlDatabaseRole\Test-TargetResource" -Tag 'Test' { BeforeEach { Mock -CommandName Connect-SQL -MockWith $mockConnectSQL -Verifiable } Context 'When the system is not in the desired state and Ensure is set to Present' { It 'Should return the state as false when one desired role is not configured' { $testParameters = $mockDefaultParameters $testParameters += @{ Name = $mockSqlServerLoginOne Database = $mockSqlDatabaseName Role = $mockSqlDatabaseRoleSecond Ensure = 'Present' } $result = Test-TargetResource @testParameters $result | Should -Be $false } It 'Should call the mock function Connect-SQL' { Assert-MockCalled Connect-SQL -Exactly -Times 1 -Scope Context } } Context 'When the system is not in the desired state and Ensure is set to Present' { It 'Should return the state as false when two desired roles are not configured' { $testParameters = $mockDefaultParameters $testParameters += @{ Name = $mockSqlServerLoginOne Database = $mockSqlDatabaseName Role = @($mockSqlDatabaseRole, $mockSqlDatabaseRoleSecond) Ensure = 'Present' } $result = Test-TargetResource @testParameters $result | Should -Be $false } It 'Should call the mock function Connect-SQL' { Assert-MockCalled Connect-SQL -Exactly -Times 1 -Scope Context } } Context 'When the system is not in the desired state and Ensure is set to Absent' { It 'Should return the state as false when undesired roles are not configured' { $testParameters = $mockDefaultParameters $testParameters += @{ Name = $mockSqlServerLoginTwo Database = $mockSqlDatabaseName Role = @($mockSqlDatabaseRole, $mockSqlDatabaseRoleSecond) Ensure = 'Absent' } $result = Test-TargetResource @testParameters $result | Should -Be $false } It 'Should call the mock function Connect-SQL' { Assert-MockCalled Connect-SQL -Exactly -Times 1 -Scope Context } } Context 'When the system is in the desired state and Ensure is set to Present' { It 'Should return the state as true when one desired role is correctly configured' { $testParameters = $mockDefaultParameters $testParameters += @{ Name = $mockSqlServerLoginOne Database = $mockSqlDatabaseName Role = $mockSqlDatabaseRole Ensure = 'Present' } $result = Test-TargetResource @testParameters $result | Should -Be $true } It 'Should call the mock function Connect-SQL' { Assert-MockCalled Connect-SQL -Exactly -Times 1 -Scope Context } } Context 'When the system is in the desired state and Ensure is set to Present' { It 'Should return the state as true when two desired role are correctly configured' { $testParameters = $mockDefaultParameters $testParameters += @{ Name = $mockSqlServerLoginTwo Database = $mockSqlDatabaseName Role = @($mockSqlDatabaseRole, $mockSqlDatabaseRoleSecond) Ensure = 'Present' } $result = Test-TargetResource @testParameters $result | Should -Be $true } It 'Should call the mock function Connect-SQL' { Assert-MockCalled Connect-SQL -Exactly -Times 1 -Scope Context } } Context 'When the system is in the desired state and Ensure is set to Absent' { It 'Should return the state as true when two desired role are correctly configured' { $testParameters = $mockDefaultParameters $testParameters += @{ Name = $mockSqlServerLoginOne Database = $mockSqlDatabaseName Role = $mockSqlDatabaseRoleSecond Ensure = 'Absent' } $result = Test-TargetResource @testParameters $result | Should -Be $true } It 'Should call the mock function Connect-SQL' { Assert-MockCalled Connect-SQL -Exactly -Times 1 -Scope Context } } Assert-VerifiableMock } Describe "MSFT_SqlDatabaseRole\Set-TargetResource" -Tag 'Set' { BeforeEach { Mock -CommandName Connect-SQL -MockWith $mockConnectSQL -Verifiable Mock -CommandName New-Object -MockWith $mockNewObjectUser -ParameterFilter { $TypeName -eq 'Microsoft.SqlServer.Management.Smo.User' } -Verifiable } Context 'When the system is not in the desired state, Ensure is set to Present and Login does not exist' { It 'Should Not Throw when Ensure parameter is set to Present' { $mockExpectedForAddMemberMethod = 'MyRole' $testParameters = $mockDefaultParameters $testParameters += @{ Name = $mockSqlServerLogin Database = $mockSqlDatabaseName Role = $mockSqlDatabaseRole Ensure = 'Present' } { Set-TargetResource @testParameters } | Should -Not -Throw } It 'Should call the mock function Connect-SQL' { Assert-MockCalled Connect-SQL -Exactly -Times 1 -Scope Context } It 'Should call the mock function New-Object with TypeName equal to Microsoft.SqlServer.Management.Smo.User' { Assert-MockCalled New-Object -Exactly -Times 1 -ParameterFilter { $TypeName -eq 'Microsoft.SqlServer.Management.Smo.User' } -Scope Context } } Context 'When the system is not in the desired state, Ensure is set to Present and Login does not exist' { It 'Should Throw the correct error when Ensure parameter is set to Present' { $mockInvalidOperationForCreateMethod = $true $testParameters = $mockDefaultParameters $testParameters += @{ Name = $mockSqlServerLogin Database = $mockSqlDatabaseName Role = $mockSqlDatabaseRoleSecond Ensure = 'Present' } $throwInvalidOperation = ('Failed adding the login John as a user of the database AdventureWorks, on ' + ` 'the instance localhost\MSSQLSERVER. InnerException: Exception calling "Create" ' + ` 'with "0" argument(s): "Mock Create Method was called with invalid operation."') { Set-TargetResource @testParameters } | Should -Throw $throwInvalidOperation } It 'Should call the mock function Connect-SQL' { Assert-MockCalled Connect-SQL -Exactly -Times 1 -Scope Context } It 'Should call the mock function New-Object with TypeName equal to Microsoft.SqlServer.Management.Smo.User' { Assert-MockCalled New-Object -Exactly -Times 1 -ParameterFilter { $TypeName -eq 'Microsoft.SqlServer.Management.Smo.User' } -Scope Context } } Context 'When the system is not in the desired state, Ensure is set to Present and Login already exist' { It 'Should Not Throw when Ensure parameter is set to Present' { $mockExpectedForAddMemberMethod = 'MySecondRole' $mockSqlServerLogin = $mockSqlServerLoginOne $testParameters = $mockDefaultParameters $testParameters += @{ Name = $mockSqlServerLogin Database = $mockSqlDatabaseName Role = $mockSqlDatabaseRoleSecond Ensure = 'Present' } { Set-TargetResource @testParameters } | Should -Not -Throw } It 'Should call the mock function Connect-SQL' { Assert-MockCalled Connect-SQL -Exactly -Times 1 -Scope Context } It 'Should not call the mock function New-Object with TypeName equal to Microsoft.SqlServer.Management.Smo.User' { Assert-MockCalled New-Object -Exactly -Times 0 -ParameterFilter { $TypeName -eq 'Microsoft.SqlServer.Management.Smo.User' } -Scope Context } } Context 'When the system is not in the desired state, Ensure is set to Present and Login already exist' { It 'Should Throw the correct error when Ensure parameter is set to Present' { $mockInvalidOperationForAddMemberMethod = $true $testParameters = $mockDefaultParameters $testParameters += @{ Name = $mockSqlServerLoginOne Database = $mockSqlDatabaseName Role = $mockSqlDatabaseRoleSecond Ensure = 'Present' } $throwInvalidOperation = ('Failed adding the login CONTOSO\KingJulian to the role MySecondRole on ' + ` 'the database AdventureWorks, on the instance localhost\MSSQLSERVER. ' + ` 'InnerException: Exception calling "AddMember" with "1" argument(s): ' + ` '"Mock AddMember Method was called with invalid operation."') { Set-TargetResource @testParameters } | Should -Throw $throwInvalidOperation } It 'Should call the mock function Connect-SQL' { Assert-MockCalled Connect-SQL -Exactly -Times 1 -Scope Context } It 'Should not call the mock function New-Object with TypeName equal to Microsoft.SqlServer.Management.Smo.User' { Assert-MockCalled New-Object -Exactly -Times 0 -ParameterFilter { $TypeName -eq 'Microsoft.SqlServer.Management.Smo.User' } -Scope Context } } Context 'When the system is not in the desired state, Ensure is set to Absent' { It 'Should not throw the correct error when Ensure parameter is set to Absent' { $testParameters = $mockDefaultParameters $testParameters += @{ Name = $mockSqlServerLoginTwo Database = $mockSqlDatabaseName Role = $mockSqlDatabaseRole Ensure = 'Absent' } { Set-TargetResource @testParameters } | Should -Not -Throw } It 'Should call the mock function Connect-SQL' { Assert-MockCalled Connect-SQL -Exactly -Times 1 -Scope Context } It 'Should not call the mock function New-Object with TypeName equal to Microsoft.SqlServer.Management.Smo.User' { Assert-MockCalled New-Object -Exactly -Times 0 -ParameterFilter { $TypeName -eq 'Microsoft.SqlServer.Management.Smo.User' } -Scope Context } } $mockInvalidOperationForDropMemberMethod = $true Context 'When the system is not in the desired state, Ensure is set to Absent' { It 'Should not throw the correct error when Ensure parameter is set to Absent' { $testParameters = $mockDefaultParameters $testParameters += @{ Name = $mockSqlServerLoginTwo Database = $mockSqlDatabaseName Role = $mockSqlDatabaseRole Ensure = 'Absent' } $throwInvalidOperation = ('Failed removing the login CONTOSO\SQLAdmin from the role MyRole on ' + ` 'the database AdventureWorks, on the instance localhost\MSSQLSERVER. ' + ` 'InnerException: Exception calling "DropMember" with "1" argument(s): ' + ` '"Mock DropMember Method was called with invalid operation."') { Set-TargetResource @testParameters } | Should -Throw $throwInvalidOperation } It 'Should call the mock function Connect-SQL' { Assert-MockCalled Connect-SQL -Exactly -Times 1 -Scope Context } It 'Should not call the mock function New-Object with TypeName equal to Microsoft.SqlServer.Management.Smo.User' { Assert-MockCalled New-Object -Exactly -Times 0 -ParameterFilter { $TypeName -eq 'Microsoft.SqlServer.Management.Smo.User' } -Scope Context } } Assert-VerifiableMock } } } finally { Invoke-TestCleanup } |