Tests/Unit/MSFT_SqlServerRole.Tests.ps1
|
<#
.SYNOPSIS Automated unit test for MSFT_SqlServerRole 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_SqlServerRole' #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 { } function Invoke-TestCleanup { Restore-TestEnvironment -TestEnvironment $TestEnvironment } # Begin Testing try { Invoke-TestSetup InModuleScope $script:dscResourceName { $mockServerName = 'localhost' $mockInstanceName = 'MSSQLSERVER' $mockSqlServerRole = 'AdminSqlforBI' $mockSqlServerLoginOne = 'CONTOSO\John' $mockSqlServerLoginTwo = 'CONTOSO\Kelly' $mockSqlServerLoginTree = 'CONTOSO\Lucy' $mockSqlServerLoginFour = 'CONTOSO\Steve' $mockEnumMemberNames = @($mockSqlServerLoginOne, $mockSqlServerLoginTwo) $mockSqlServerLoginType = 'WindowsUser' $mockExpectedServerRoleToDrop = 'ServerRoleToDrop' # 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 Roles -Value { return @{ $mockSqlServerRole = ( New-Object -TypeName Object | Add-Member -MemberType NoteProperty -Name Name -Value $mockSqlServerRole -PassThru | Add-Member -MemberType ScriptMethod -Name EnumMemberNames -Value { if ($mockInvalidOperationForEnumMethod) { throw 'Mock EnumMemberNames Method was called with invalid operation.' } else { $mockEnumMemberNames } } -PassThru | Add-Member -MemberType ScriptMethod -Name Drop -Value { if ($mockInvalidOperationForDropMethod) { throw 'Mock Drop Method was called with invalid operation.' } if ( $this.Name -ne $mockExpectedServerRoleToDrop ) { throw "Called mocked drop() method without dropping the right server role. Expected '{0}'. But was '{1}'." ` -f $mockExpectedServerRoleToDrop, $this.Name } } -PassThru | Add-Member -MemberType ScriptMethod -Name AddMember -Value { if ($mockInvalidOperationForAddMemberMethod) { throw 'Mock AddMember Method was called with invalid operation.' } if ( $mockSqlServerLoginToAdd -ne $mockExpectedMemberToAdd ) { throw "Called mocked AddMember() method without adding the right login. Expected '{0}'. But was '{1}'." ` -f $mockExpectedMemberToAdd, $mockSqlServerLoginToAdd } } -PassThru | Add-Member -MemberType ScriptMethod -Name DropMember -Value { if ($mockInvalidOperationForDropMemberMethod) { throw 'Mock DropMember Method was called with invalid operation.' } if ( $mockSqlServerLoginToDrop -ne $mockExpectedMemberToDrop ) { throw "Called mocked DropMember() method without removing the right login. Expected '{0}'. But was '{1}'." ` -f $mockExpectedMemberToDrop, $mockSqlServerLoginToDrop } } -PassThru ) } } -PassThru | 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 )) $mockSqlServerLoginTree = @(( New-Object -TypeName Object | Add-Member -MemberType NoteProperty -Name LoginType -Value $mockSqlServerLoginType -PassThru )) $mockSqlServerLoginFour = @(( New-Object -TypeName Object | Add-Member -MemberType NoteProperty -Name LoginType -Value $mockSqlServerLoginType -PassThru )) } } -PassThru -Force ) ) } $mockNewObjectServerRole = { return @( ( New-Object -TypeName Object | Add-Member -MemberType NoteProperty -Name Name -Value $mockSqlServerRoleAdd -PassThru | Add-Member -MemberType ScriptMethod -Name Create -Value { if ($mockInvalidOperationForCreateMethod) { throw 'Mock Create Method was called with invalid operation.' } if ( $this.Name -ne $mockExpectedServerRoleToCreate ) { throw "Called mocked Create() method without adding the right server role. Expected '{0}'. But was '{1}'." ` -f $mockExpectedServerRoleToCreate, $this.Name } } -PassThru -Force ) ) } #endregion Describe "MSFT_SqlServerRole\Get-TargetResource" -Tag 'Get' { BeforeEach { Mock -CommandName Connect-SQL -MockWith $mockConnectSQL -Verifiable } Context 'When the system is in the desired state and ensure is set to Absent' { $testParameters = $mockDefaultParameters $testParameters += @{ ServerRoleName = 'UnknownRoleName' } It 'Should return the state as absent when the role does not exist' { $result = Get-TargetResource @testParameters $result.Ensure | Should -Be 'Absent' Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It } It 'Should return the members as null' { $result = Get-TargetResource @testParameters $result.Members | Should -Be $null Assert-MockCalled -CommandName 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.ServerRoleName | Should -Be $testParameters.ServerRoleName Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It } } Context 'When the system is not in the desired state and ensure is set to Absent' { $testParameters = $mockDefaultParameters $testParameters += @{ ServerRoleName = $mockSqlServerRole } It 'Should not return the state as absent when the role exist' { $result = Get-TargetResource @testParameters $result.Ensure | Should -Not -Be 'Absent' Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It } It 'Should return the members as not null' { $result = Get-TargetResource @testParameters $result.Members | Should -Not -Be $null Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It } # Regression test for issue #790 It 'Should return the members as string array' { $result = Get-TargetResource @testParameters ($result.Members -is [System.String[]]) | Should -Be $true Assert-MockCalled -CommandName 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.ServerRoleName | Should -Be $testParameters.ServerRoleName Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It } } Context 'When passing values to parameters and throwing with EnumMemberNames method' { It 'Should throw the correct error' { $mockInvalidOperationForEnumMethod = $true $testParameters = $mockDefaultParameters $testParameters += @{ ServerRoleName = $mockSqlServerRole } $errorMessage = $script:localizedData.EnumMemberNamesServerRoleGetError ` -f $mockServerName, $mockInstanceName, $mockSqlServerRole { Get-TargetResource @testParameters } | Should -Throw $errorMessage } It 'Should call the mock function Connect-SQL' { Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope Context } } Context 'When the system is in the desired state, parameter Members is assigned a value and ensure is set to Present' { $testParameters = $mockDefaultParameters $testParameters += @{ ServerRoleName = $mockSqlServerRole Members = $mockEnumMemberNames } It 'Should return the state as present when the members are correct' { $result = Get-TargetResource @testParameters $result.Ensure | Should -Be 'Present' Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It } It 'Should return the members as not null' { $result = Get-TargetResource @testParameters $result.Members | Should -Be $testParameters.Members Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It } # Regression test for issue #790 It 'Should return the members as string array' { $result = Get-TargetResource @testParameters ($result.Members -is [System.String[]]) | Should -Be $true Assert-MockCalled -CommandName 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.ServerRoleName | Should -Be $testParameters.ServerRoleName Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It } } Context 'When the system is in the desired state, parameter MembersToInclude is assigned a value and ensure is set to Present' { $testParameters = $mockDefaultParameters $testParameters += @{ ServerRoleName = $mockSqlServerRole MembersToInclude = $mockSqlServerLoginTwo } It 'Should return the state as present when the correct members exist' { $result = Get-TargetResource @testParameters $result.Ensure | Should -Be 'Present' Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It } It 'Should return the members as not null' { $result = Get-TargetResource @testParameters $result.Members | Should -Not -Be $null Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It } # Regression test for issue #790 It 'Should return the members as string array' { $result = Get-TargetResource @testParameters ($result.Members -is [System.String[]]) | Should -Be $true Assert-MockCalled -CommandName 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.ServerRoleName | Should -Be $testParameters.ServerRoleName $result.MembersToInclude | Should -Be $testParameters.MembersToInclude Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It } } Context 'When the system is in the desired state, parameter MembersToExclude is assigned a value and ensure is set to Present' { $testParameters = $mockDefaultParameters $testParameters += @{ ServerRoleName = $mockSqlServerRole MembersToExclude = $mockSqlServerLoginTree } It 'Should return the state as present when the members does not exist' { $result = Get-TargetResource @testParameters $result.Ensure | Should -Be 'Present' Assert-MockCalled -CommandName 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.ServerRoleName | Should -Be $testParameters.ServerRoleName $result.MembersToExclude | Should -Be $testParameters.MembersToExclude Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It } } Context 'When the system is not in the desired state, parameter MembersToInclude is assigned a value, parameter Members is assigned a value, and ensure is set to Present' { It 'Should throw the correct error' { $testParameters = $mockDefaultParameters $testParameters += @{ ServerRoleName = $mockSqlServerRole Members = $mockEnumMemberNames MembersToInclude = $mockSqlServerLoginTree } $errorMessage = $script:localizedData.MembersToIncludeAndExcludeParamMustBeNull { Get-TargetResource @testParameters } | Should -Throw $errorMessage } It 'Should call the mock function Connect-SQL' { Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope Context } } Context 'When the system is not in the desired state, parameter MembersToExclude is assigned a value, parameter Members is assigned a value, and ensure is set to Present' { It 'Should throw the correct error' { $testParameters = $mockDefaultParameters $testParameters += @{ ServerRoleName = $mockSqlServerRole Members = $mockEnumMemberNames MembersToExclude = $mockSqlServerLoginTree } $errorMessage = $script:localizedData.MembersToIncludeAndExcludeParamMustBeNull { Get-TargetResource @testParameters } | Should -Throw $errorMessage } It 'Should call the mock function Connect-SQL' { Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope Context } } Context 'When the system is not in the desired state and ensure is set to Present' { $testParameters = $mockDefaultParameters $testParameters += @{ ServerRoleName = 'UnknownRoleName' } It 'Should return the state as absent when the role does not exist' { $result = Get-TargetResource @testParameters $result.Ensure | Should -Be 'Absent' Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It } It 'Should return the members as null' { $result = Get-TargetResource @testParameters $result.Members | Should -Be $null Assert-MockCalled -CommandName 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.ServerRoleName | Should -Be $testParameters.ServerRoleName Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It } } Context 'When the system is not in the desired state, parameter Members is assigned a value and ensure is set to Present' { $testParameters = $mockDefaultParameters $testParameters += @{ ServerRoleName = $mockSqlServerRole Members = @($mockSqlServerLoginOne, $mockSqlServerLoginTree) } It 'Should return the state as absent when the members in the role are wrong' { $result = Get-TargetResource @testParameters $result.Ensure | Should -Be 'Absent' Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It } It 'Should return the members as not null' { $result = Get-TargetResource @testParameters $result.Members | Should -Not -Be $null Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It } # Regression test for issue #790 It 'Should return the members as string array' { $result = Get-TargetResource @testParameters ($result.Members -is [System.String[]]) | Should -Be $true Assert-MockCalled -CommandName 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.ServerRoleName | Should -Be $testParameters.ServerRoleName Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It } } Context 'When the system is not in the desired state, parameter MembersToInclude is assigned a value and ensure is set to Present' { $testParameters = $mockDefaultParameters $testParameters += @{ ServerRoleName = $mockSqlServerRole MembersToInclude = $mockSqlServerLoginTree } It 'Should return the state as absent when the members in the role are missing' { $result = Get-TargetResource @testParameters $result.Ensure | Should -Be 'Absent' Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It } It 'Should return the members as not null' { $result = Get-TargetResource @testParameters $result.Members | Should -Not -Be $null Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It } # Regression test for issue #790 It 'Should return the members as string array' { $result = Get-TargetResource @testParameters ($result.Members -is [System.String[]]) | Should -Be $true Assert-MockCalled -CommandName 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.ServerRoleName | Should -Be $testParameters.ServerRoleName $result.MembersToInclude | Should -Be $testParameters.MembersToInclude Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It } } Context 'When the system is not in the desired state, parameter MembersToExclude is assigned a value and ensure is set to Present' { $testParameters = $mockDefaultParameters $testParameters += @{ ServerRoleName = $mockSqlServerRole MembersToExclude = $mockSqlServerLoginTwo } It 'Should return the state as absent when the members in the role are present' { $result = Get-TargetResource @testParameters $result.Ensure | Should -Be 'Absent' Assert-MockCalled -CommandName 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.ServerRoleName | Should -Be $testParameters.ServerRoleName $result.MembersToExclude | Should -Be $testParameters.MembersToExclude Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It } } Assert-VerifiableMock } Describe "MSFT_SqlServerRole\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 Absent' { It 'Should return false when desired server role exist' { $testParameters = $mockDefaultParameters $testParameters += @{ Ensure = 'Absent' ServerRoleName = $mockSqlServerRole } $result = Test-TargetResource @testParameters $result | Should -Be $false Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It } } Context 'When the system is in the desired state and ensure is set to Absent' { It 'Should return true when desired server role does not exist' { $testParameters = $mockDefaultParameters $testParameters += @{ Ensure = 'Absent' ServerRoleName = 'newServerRole' } $result = Test-TargetResource @testParameters $result | Should -Be $true Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It } } Context 'When the system is in the desired state and ensure is set to Present' { It 'Should return true when desired server role exist' { $testParameters = $mockDefaultParameters $testParameters += @{ Ensure = 'Present' ServerRoleName = $mockSqlServerRole } $result = Test-TargetResource @testParameters $result | Should -Be $true Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It } } Context 'When the system is not in the desired state and ensure parameter is set to Present' { It 'Should return false when desired members are not in desired server role' { $testParameters = $mockDefaultParameters $testParameters += @{ Ensure = 'Present' ServerRoleName = $mockSqlServerRole Members = @($mockSqlServerLoginTree, $mockSqlServerLoginFour) } $result = Test-TargetResource @testParameters $result | Should -Be $false Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It } } Context 'When both the parameters Members and MembersToInclude are assigned a value and ensure is set to Present' { It 'Should throw the correct error' { $testParameters = $mockDefaultParameters $testParameters += @{ Ensure = 'Present' ServerRoleName = $mockSqlServerRole Members = $mockEnumMemberNames MembersToInclude = $mockSqlServerLoginTree } $errorMessage = $script:localizedData.MembersToIncludeAndExcludeParamMustBeNull { Test-TargetResource @testParameters } | Should -Throw $errorMessage Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It } } Context 'When parameter MembersToInclude is assigned a value, parameter Members is not assigned a value, and ensure is set to Present' { It 'Should return true when desired server role exist' { $testParameters = $mockDefaultParameters $testParameters += @{ Ensure = 'Present' ServerRoleName = $mockSqlServerRole MembersToInclude = $mockSqlServerLoginTwo } $result = Test-TargetResource @testParameters $result | Should -Be $true Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It } } Context 'When parameter MembersToInclude is assigned a value, parameter Members is not assigned a value, and ensure is set to Present' { It 'Should return false when desired server role does not exist' { $testParameters = $mockDefaultParameters $testParameters += @{ Ensure = 'Present' ServerRoleName = $mockSqlServerRole MembersToInclude = $mockSqlServerLoginTree } $result = Test-TargetResource @testParameters $result | Should -Be $false Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It } } Context 'When both the parameters Members and MembersToExclude are assigned a value and ensure is set to Present' { It 'Should throw the correct error' { $testParameters = $mockDefaultParameters $testParameters += @{ Ensure = 'Present' ServerRoleName = $mockSqlServerRole Members = $mockEnumMemberNames MembersToExclude = $mockSqlServerLoginTwo } $errorMessage = $script:localizedData.MembersToIncludeAndExcludeParamMustBeNull { Test-TargetResource @testParameters } | Should -Throw $errorMessage Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It } } Context 'When parameter MembersToExclude is assigned a value, parameter Members is not assigned a value, and ensure is set to Present' { It 'Should return true when desired server role does not exist' { $testParameters = $mockDefaultParameters $testParameters += @{ Ensure = 'Present' ServerRoleName = $mockSqlServerRole MembersToExclude = $mockSqlServerLoginTree } $result = Test-TargetResource @testParameters $result | Should -Be $true Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It } } Context 'When parameter MembersToExclude is assigned a value, parameter Members is not assigned a value, and ensure is set to Present' { It 'Should return false when desired server role exist' { $testParameters = $mockDefaultParameters $testParameters += @{ Ensure = 'Present' ServerRoleName = $mockSqlServerRole MembersToExclude = $mockSqlServerLoginTwo } $result = Test-TargetResource @testParameters $result | Should -Be $false Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It } } Assert-VerifiableMock } Describe "MSFT_SqlServerRole\Set-TargetResource" -Tag 'Set' { BeforeEach { Mock -CommandName Connect-SQL -MockWith $mockConnectSQL -Verifiable Mock -CommandName New-Object -MockWith $mockNewObjectServerRole -ParameterFilter { $TypeName -eq 'Microsoft.SqlServer.Management.Smo.ServerRole' } } Context 'When the system is not in the desired state and ensure is set to Absent' { It 'Should not throw when calling the drop method' { $mockSqlServerRole = 'ServerRoleToDrop' $mockExpectedServerRoleToDrop = 'ServerRoleToDrop' $testParameters = $mockDefaultParameters $testParameters += @{ Ensure = 'Absent' ServerRoleName = $mockSqlServerRole } { Set-TargetResource @testParameters } | Should -Not -Throw Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It } } Context 'When the system is not in the desired state and ensure is set to Absent' { It 'Should throw the correct error when calling the drop method' { $mockInvalidOperationForDropMethod = $true $testParameters = $mockDefaultParameters $testParameters += @{ Ensure = 'Absent' ServerRoleName = $mockSqlServerRole } $errorMessage = $script:localizedData.DropServerRoleSetError ` -f $mockServerName, $mockInstanceName, $mockSqlServerRole { Set-TargetResource @testParameters } | Should -Throw $errorMessage Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It } } Context 'When the system is not in the desired state and ensure is set to Present' { It 'Should not throw when calling the create method' { $mockSqlServerRoleAdd = 'ServerRoleToAdd' $mockExpectedServerRoleToCreate = 'ServerRoleToAdd' $testParameters = $mockDefaultParameters $testParameters += @{ Ensure = 'Present' ServerRoleName = $mockSqlServerRoleAdd } { Set-TargetResource @testParameters } | Should -Not -Throw Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It } It 'Should call the mock function New-Object with TypeName equal to Microsoft.SqlServer.Management.Smo.ServerRole' { Assert-MockCalled -CommandName New-Object -Exactly -Times 1 -ParameterFilter { $TypeName -eq 'Microsoft.SqlServer.Management.Smo.ServerRole' } -Scope Context } } Context 'When the system is not in the desired state and ensure is set to Present' { It 'Should throw the correct error when calling the create method' { $mockSqlServerRoleAdd = 'ServerRoleToAdd' $mockExpectedServerRoleToCreate = 'ServerRoleToAdd' $mockInvalidOperationForCreateMethod = $true $testParameters = $mockDefaultParameters $testParameters += @{ Ensure = 'Present' ServerRoleName = $mockSqlServerRoleAdd } $errorMessage = $script:localizedData.CreateServerRoleSetError ` -f $mockServerName, $mockInstanceName, $mockSqlServerRoleAdd { Set-TargetResource @testParameters } | Should -Throw $errorMessage Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It } It 'Should call the mock function New-Object with TypeName equal to Microsoft.SqlServer.Management.Smo.ServerRole' { Assert-MockCalled -CommandName New-Object -Exactly -Times 1 -ParameterFilter { $TypeName -eq 'Microsoft.SqlServer.Management.Smo.ServerRole' } -Scope Context } } Context 'When both the parameters Members and MembersToInclude are assigned a value and ensure is set to Present' { It 'Should throw the correct error' { $testParameters = $mockDefaultParameters $testParameters += @{ Ensure = 'Present' ServerRoleName = $mockSqlServerRole Members = $mockEnumMemberNames MembersToInclude = $mockSqlServerLoginTree } $errorMessage = $script:localizedData.MembersToIncludeAndExcludeParamMustBeNull { Set-TargetResource @testParameters } | Should -Throw $errorMessage Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It } } Context 'When both the parameters Members and MembersToExclude are assigned a value and ensure is set to Present' { It 'Should throw the correct error' { $testParameters = $mockDefaultParameters $testParameters += @{ Ensure = 'Present' ServerRoleName = $mockSqlServerRole Members = $mockEnumMemberNames MembersToExclude = $mockSqlServerLoginTwo } $errorMessage = $script:localizedData.MembersToIncludeAndExcludeParamMustBeNull { Set-TargetResource @testParameters } | Should -Throw $errorMessage Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It } } Context 'When parameter MembersToInclude is assigned a value, parameter Members is not assigned a value, and ensure is set to Present' { It 'Should not thrown when calling the AddMember method' { $mockExpectedMemberToAdd = $mockSqlServerLoginTree $mockSqlServerLoginToAdd = $mockSqlServerLoginTree $testParameters = $mockDefaultParameters $testParameters += @{ Ensure = 'Present' ServerRoleName = $mockSqlServerRole MembersToInclude = $mockSqlServerLoginTree } { Set-TargetResource @testParameters } | Should -Not -Throw Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It } } Context 'When parameter MembersToInclude is assigned a value, parameter Members is not assigned a value, and ensure is set to Present' { It 'Should throw the correct error when calling the AddMember method' { $mockInvalidOperationForAddMemberMethod = $true $mockExpectedMemberToAdd = $mockSqlServerLoginTree $mockSqlServerLoginToAdd = $mockSqlServerLoginTree $testParameters = $mockDefaultParameters $testParameters += @{ Ensure = 'Present' ServerRoleName = $mockSqlServerRole MembersToInclude = $mockSqlServerLoginTree } $errorMessage = $script:localizedData.AddMemberServerRoleSetError ` -f $mockServerName, $mockInstanceName, $mockSqlServerRole, $mockSqlServerLoginTree { Set-TargetResource @testParameters } | Should -Throw $errorMessage Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It } } Context 'When parameter MembersToInclude is assigned a value, parameter Members is not assigned a value, and ensure is set to Present' { It 'Should throw the correct error when login does not exist' { $mockExpectedMemberToAdd = $mockSqlServerLoginTree $mockSqlServerLoginToAdd = $mockSqlServerLoginTree $testParameters = $mockDefaultParameters $testParameters += @{ Ensure = 'Present' ServerRoleName = $mockSqlServerRole MembersToInclude = 'KingJulian' } $errorMessage = $script:localizedData.LoginNotFound ` -f 'KingJulian', $mockServerName, $mockInstanceName { Set-TargetResource @testParameters } | Should -Throw $errorMessage Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It } } Context 'When parameter MembersToExclude is assigned a value, parameter Members is not assigned a value, and ensure is set to Present' { It 'Should not throw when calling the DropMember method' { $mockExpectedMemberToAdd = $mockSqlServerLoginTwo $mockSqlServerLoginToAdd = $mockSqlServerLoginTwo $testParameters = $mockDefaultParameters $testParameters += @{ Ensure = 'Present' ServerRoleName = $mockSqlServerRole MembersToExclude = $mockSqlServerLoginTwo } { Set-TargetResource @testParameters } | Should -Not -Throw Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It } } Context 'When parameter MembersToExclude is assigned a value, parameter Members is not assigned a value, and ensure is set to Present' { It 'Should throw the correct error when calling the DropMember method' { $mockInvalidOperationForDropMemberMethod = $true $mockExpectedMemberToDrop = $mockSqlServerLoginTwo $mockSqlServerLoginToDrop = $mockSqlServerLoginTwo $testParameters = $mockDefaultParameters $testParameters += @{ Ensure = 'Present' ServerRoleName = $mockSqlServerRole MembersToExclude = $mockSqlServerLoginTwo } $errorMessage = $script:localizedData.DropMemberServerRoleSetError ` -f $mockServerName, $mockInstanceName, $mockSqlServerRole, $mockSqlServerLoginTwo { Set-TargetResource @testParameters } | Should -Throw $errorMessage Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It } } Context 'When parameter MembersToExclude is assigned a value, parameter Members is not assigned a value, and ensure is set to Present' { It 'Should throw the correct error when login does not exist' { $mockEnumMemberNames = @('KingJulian', $mockSqlServerLoginOne, $mockSqlServerLoginTwo) $mockExpectedMemberToAdd = $mockSqlServerLoginTree $mockSqlServerLoginToAdd = $mockSqlServerLoginTree $testParameters = $mockDefaultParameters $testParameters += @{ Ensure = 'Present' ServerRoleName = $mockSqlServerRole MembersToExclude = 'KingJulian' } $errorMessage = $script:localizedData.LoginNotFound ` -f 'KingJulian', $mockServerName, $mockInstanceName { Set-TargetResource @testParameters } | Should -Throw $errorMessage Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It } } Context 'When parameter Members is assigned a value and ensure is set to Present' { It 'Should throw the correct error when login does not exist' { $mockExpectedMemberToAdd = $mockSqlServerLoginTree $mockSqlServerLoginToAdd = $mockSqlServerLoginTree $testParameters = $mockDefaultParameters $testParameters += @{ Ensure = 'Present' ServerRoleName = $mockSqlServerRole Members = @('KingJulian', $mockSqlServerLoginOne, $mockSqlServerLoginTree) } $errorMessage = $script:localizedData.LoginNotFound ` -f 'KingJulian', $mockServerName, $mockInstanceName { Set-TargetResource @testParameters } | Should -Throw $errorMessage Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It } } Context 'When Members parameter is set and ensure parameter is set to Present' { It 'Should not throw when calling both the AddMember and DropMember methods' { $mockExpectedMemberToAdd = $mockSqlServerLoginTree $mockSqlServerLoginToAdd = $mockSqlServerLoginTree $mockExpectedMemberToDrop = $mockSqlServerLoginTwo $mockSqlServerLoginToDrop = $mockSqlServerLoginTwo $testParameters = $mockDefaultParameters $testParameters += @{ Ensure = 'Present' ServerRoleName = $mockSqlServerRole Members = @($mockSqlServerLoginOne, $mockSqlServerLoginTree) } { Set-TargetResource @testParameters } | Should -Not -Throw Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It } } Assert-VerifiableMock } } } finally { Invoke-TestCleanup } |