SecurityPolicyDsc

2.5.0.0

Tests/Unit/MSFT_UserRightsAssignment.tests.ps1


$script:dscModuleName    = 'SecurityPolicyDsc' 
$script:dscResourceName  = 'MSFT_UserRightsAssignment'

#region HEADER
$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

# Begin Testing
try
{
    #region Pester Tests

    InModuleScope $script:DSCResourceName {

            $testParameters = [PSObject]@{
                Policy   = 'Access_Credential_Manager_as_a_trusted_caller'
                Identity = 'contoso\TestUser1'
            }

            $mockGetUSRPolicyResult = [PSObject]@{
                Constant = 'SeTrustedCredManAccessPrivilege'
                Identity = 'testUser1','contoso\TestUser2'
                FriendlyName = $testParameters.Policy
            }

            $mockUSRDoesNotExist = [PSObject]@{
                Policy   = 'SeTrustedCredManAccessPrivilege'
                Identity = 'contoso\testUser3','contoso\TestUser2'
                PolicyFriendlyName = $testParameters.Policy
            }

            $mockUSRDoesExist = [PSObject]@{
                Policy   = 'SeTrustedCredManAccessPrivilege'
                Identity = @('contoso\testUser1','contoso\TestUser2')
                PolicyFriendlyName = $testParameters.Policy
            }

            $mockNullIdentity = [PSObject] @{
                Policy   = 'SeTrustedCredManAccessPrivilege'
                Identity = $null
            }

        #endregion

        #region Function Get-TargetResource
        Describe "Get-TargetResource" {  
            Context 'Identity should match on Policy' {
                Mock -CommandName Get-UserRightPolicy -MockWith {return @($testParameters)}
                Mock -CommandName Test-TargetResource -MockWith {$false}

                It 'Should not match Identity' {
                    $result = Get-TargetResource @testParameters
                    $result.Identity | Should Be $testParameters.Identity
                }

                It 'Should call expected Mocks' {
                    Assert-MockCalled -CommandName Get-UserRightPolicy -Exactly 1
                }
            }
        }
        #endregion

        #region Function Test-TargetResource
        Describe "Test-TargetResource" {
            Context 'Identity does exist and should' {

                Mock -CommandName Get-UserRightPolicy -MockWith {$mockUSRDoesExist}
                Mock -CommandName Test-IdentityIsNull -MockWith {$false}
                Mock -CommandName ConvertTo-LocalFriendlyName -MockWith {'contoso\testuser1'}

                It 'Should return true' {
                    $testResult = Test-TargetResource @testParameters
                    $testResult | Should Be $true
                }

                It 'Should call expected mocks' {
                    Assert-MockCalled -CommandName Get-UserRightPolicy -Exactly 1
                    Assert-MockCalled -CommandName Test-IdentityIsNull -Exactly 1
                }
            }

            Context 'Identity does not exist' {
                Mock -CommandName Get-UserRightPolicy -MockWith {$mockUSRDoesNotExist}
                Mock -CommandName ConvertTo-LocalFriendlyName -MockWith {'contoso\testUser1'}
                It 'Shoud return false' {
                   $testResult = Test-TargetResource @testParameters
                   $testResult | Should be $false
                }
            }

            Context 'Identity does not exist but should' {
                Mock -CommandName Get-UserRightPolicy -MockWith {}
                Mock -CommandName ConvertTo-LocalFriendlyName -MockWith {'contoso\testUser1'}

                It 'Should return false' {
                    $testResult = Test-TargetResource @testParameters
                    $testResult | Should Be $false
                }

                It 'Should call expected mocks' {
                    Assert-MockCalled -CommandName Get-UserRightPolicy -Exactly 1
                } 
            }

            Context 'Identity is NULL and should be' {
                It 'Should return true' {
                    Mock -CommandName Get-UserRightPolicy -MockWith {$mockNullIdentity}
                    $testResult = Test-TargetResource -Policy Access_Credential_Manager_as_a_trusted_caller -Identity ""
                    $testResult | Should be $true
                }

                It 'Should return false' {
                    Mock -CommandName Get-UserRightPolicy -MockWith {$mockGetUSRPolicyResult}
                    $testResult = Test-TargetResource -Policy Access_Credential_Manager_as_a_trusted_caller -Identity ""
                    $testResult | Should be $false
                }
            }

            Context 'Tests for when Identity is a local account or SID' {
                $mockGetUSRPolicyResult = $mockGetUSRPolicyResult.Clone()          

                It 'Should return True when a SID is used for Identity' {

                    $mockGetUSRPolicyResult.Identity = "BUILTIN\Administrators"
                    Mock -CommandName Get-UserRightPolicy -MockWith {$mockGetUSRPolicyResult}
                    $testResult = Test-TargetResource -Policy 'Access_Credential_Manager_as_a_trusted_caller' -Identity "*S-1-5-32-544"
                    $testResult | Should be $true
                }
            }
        }
        #endregion
        #region Function Set-TargetResource
        Describe "Set-TargetResource" {
            Context 'Identity does not exist but should' {
                Mock -CommandName Invoke-Secedit -MockWith {}
                Mock -CommandName Test-TargetResource -MockWith {$true}
                Mock -CommandName Get-Content -ParameterFilter {$Path -match "Secedit-OutPut.txt"} -MockWith {"Tasked Failed"}             
                Mock -CommandName ConvertTo-LocalFriendlyName -MockWith {'contoso\testuser1'}
                
                It 'Should not throw' { 
                    {Set-TargetResource @testParameters} | Should Not Throw
                }

                It 'Should throw when set fails' {
                    Mock Test-TargetResource -MockWith {$false}  
                    {Set-TargetResource @testParameters} | Should Throw $script:localizedData.TaskFail
                }

                It 'Should call expected mocks' {
                    Assert-MockCalled -CommandName Invoke-Secedit -Exactly 2
                    Assert-MockCalled -CommandName Test-TargetResource -Exactly 2
                }
            }

            Context 'Identity is NULL' {
                It 'Should not throw' {
                    Mock -CommandName Invoke-Secedit -MockWith {}
                    Mock -CommandName Test-TargetResource -MockWith {$true}            
                    $setParameters = @{
                        Policy = 'Access_Credential_Manager_as_a_trusted_caller'
                        Identity = ""
                    }               
                    {Set-TargetResource @setParameters} | Should Not Throw
                }

                It 'Should call expected mocks' {
                    Assert-MockCalled -CommandName Invoke-Secedit
                    Assert-MockCalled -CommandName Test-TargetResource                    
                }
            }
        }
        #endregion
        #region Function Get-UserRightPolicy
        Describe "Get-UserRightPolicy" {
            Mock -CommandName Get-UserRightConstant -MockWith { 'SeTrustedCredManAccessPrivilege' }
            Mock -CommandName Get-SecurityPolicy   -MockWith { @{'SeTrustedCredManAccessPrivilege' = "foo" }}

            $getUsrResult = Get-UserRightPolicy -Name 'Access_Credential_Manager_as_a_trusted_caller'

            It 'Should match policy' {
                $getUsrResult.Constant | Should Be 'SeTrustedCredManAccessPrivilege'
            }
            It 'Should match PolicyFriendlyName' {
                $getUsrResult.FriendlyName | Should be 'Access_Credential_Manager_as_a_trusted_caller'
            }
            It 'Should match Identity' {
                $getUsrResult.Identity | Should be 'foo'
            }
            It 'Should call expected mocks' {
                Assert-MockCalled -CommandName Get-UserRightConstant
                Assert-MockCalled -CommandName Get-SecurityPolicy
            }
        }

        Describe 'Get-UserRightConstant' {

            $constant = Get-UserRightConstant -Policy 'Access_Credential_Manager_as_a_trusted_caller'
            It 'Should match policy' {
                $constant | Should Be 'SeTrustedCredManAccessPrivilege'
            }
        }
        #endregion
    }
    #endregion
}
finally
{
    #region FOOTER
    Restore-TestEnvironment -TestEnvironment $TestEnvironment
    #endregion
}