xWinEventLog

1.3.0.0

WinEvent.Tests.ps1

    <#
    .NOTES
        
#>

Import-Module $PSScriptRoot\DSCResources\MSFT_xWinEventLog\MSFT_xWinEventLog.psm1 -Prefix WinEventLog -Force

#Getting initial Value for Capi2 Log so we can test the ability to set Isenabled to False
#and then set it back to its original value when we're done
$Capi2Log = Get-WinEvent -ListLog 'Microsoft-Windows-CAPI2/Operational'
if($Capi2Log.IsEnabled){
    $Capi2Log.IsEnabled = $false
    $Capi2Log.SaveChanges()
}

Describe 'WinEventLog Get-TargetResource'{
    
    Mock Get-WinEvent -ModuleName MSFT_xWinEventLog {
        $properties = @{
            MaximumSizeInBytes = '999'
            IsEnabled = $true
            LogMode = 'Test'
            LogFilePath = 'c:\logs\test.evtx'
            SecurityDescriptor = 'TestDescriptor'
        }
        
        Write-Output (New-Object -TypeName PSObject -Property $properties)   
    }

    $results = Get-WinEventLogTargetResource 'Application'

    It 'Should return an hashtable'{
        $results.GetType().Name | Should Be 'HashTable'
    }

    It 'Should return a Hashtable name is Application'{
        $results.LogName = 'Application'
    }

    It 'Should return a Hashatable with the MaximumSizeInBytes is 999'{
        $results.MaximumSizeInBytes | Should Be '999'
    }

    It 'Should return a Hashtable where IsEnabled is true'{
        $results.IsEnabled | should Be $true
    }

    It 'Should return a HashTable where LogMode is Test' {
        $results.LogMode | Should Be 'Test'
    }

    It 'Should return a HashTable where LogFilePath is c:\logs\test.evtx' {
        $results.LogFilePath | Should Be 'c:\logs\test.evtx'
    }

    It 'Should return a HashTable where SecurityDescriptor is TestDescriptor'{
        $results.SecurityDescriptor | Should Be 'TestDescriptor'
    }
}

Describe 'WinEventLog Test-TargetResource'{
    
    Mock Get-WinEvent -ModuleName MSFT_xWinEventLog {
        $properties = @{
            MaximumSizeInBytes = '5111808'
            IsEnabled = $true
            LogMode = 'Circular'
            LogFilePath = 'c:\logs\test.evtx'
            SecurityDescriptor = 'TestDescriptor'
        }
        
        Write-Output (New-Object -TypeName PSObject -Property $properties)   
    }

    $params = @{
        LogName = 'Application'
        MaximumSizeInBytes = '5111808'
        LogMode = 'Circular'
        IsEnabled = $true
        LogFilePath = 'c:\logs\test.evtx'
        SecurityDescriptor = 'TestDescriptor'
    }
    
   
    It 'should return true when all properties match does not match'{
        $testResults = Test-WinEventLogTargetResource @params
        $testResults | Should Be $True
    }
    
    It 'should return false when MaximumSizeInBytes does not match'{
        $testResults = Test-WinEventLogTargetResource -LogName 'Application' -MaximumSizeInBytes '1' -IsEnabled $true -SecurityDescriptor 'TestDescriptor' -LogMode 'Circular' -LogFilePath 'c:\logs\test.evtx'
        $testResults | Should Be $False
    }

    It 'should return false when LogMode does not match'{
        $testResults = Test-WinEventLogTargetResource -LogName 'Application' -MaximumSizeInBytes '5111808' -IsEnabled $true -SecurityDescriptor 'TestDescriptor' -LogMode 'AutoBackup' -LogFilePath 'c:\logs\test.evtx'
        $testResults | Should Be $false
    }

    It 'should return false when IsEnabled does not match'{
        $testResults = Test-WinEventLogTargetResource -LogName 'Application' -MaximumSizeInBytes '5111808' -IsEnabled $false -SecurityDescriptor 'TestDescriptor' -LogMode 'Circular' -LogFilePath 'c:\logs\test.evtx'
        $testResults | Should Be $false
    }

    It 'Should return false when SecurityDescriptor does not match'{
        $testResults = Test-WinEventLogTargetResource -LogName 'Application' -MaximumSizeInBytes '5111808' -IsEnabled $true -SecurityDescriptor 'TestDescriptorFail' -LogMode 'Circular' -LogFilePath 'c:\logs\test.evtx'
        $testResults | Should Be $false    
    }

    It 'Should return false when LogFilePath does not match'{
        $testResults = Test-WinEventLogTargetResource -LogName 'Application' -MaximumSizeInBytes '5111808' -IsEnabled $true -SecurityDescriptor 'TestDescriptor' -LogMode 'Circular' -LogFilePath 'c:\logs\wrongfile.evtx'
        $testResults | Should Be $false    
    }

    It 'Should call Get-WinEventLog' {
        Assert-MockCalled Get-WinEvent -ModuleName MSFT_xWinEventLog -Exactly 6
    }
}

Describe 'WinEventLog Set-TargetResource'{
    BeforeAll {
        New-EventLog -LogName 'Pester' -Source 'PesterTest'
        $Log = Get-WinEvent -ListLog 'Pester'
        $Log.LogMode = 'Circular'
        $Log.SaveChanges()
        New-Item -Path "$env:SystemDrive\tmp" -ItemType Directory -Force | Out-Null
        
    }
    
    Context 'When set is called and actual value does not match expected value'{

        It 'Should update MaximumSizeInBytes' {
            Set-WinEventLogTargetResource -LogName 'Pester' -MaximumSizeInBytes '5111800'
            (Get-WinEvent -ListLog 'Pester').MaximumSizeInBytes | Should Be '5111800'  
        }

        It 'Should update the LogMode'{
            Set-WinEventLogTargetResource -LogName 'Pester' -LogMode 'AutoBackup'
            (Get-WinEvent -ListLog 'Pester').LogMode | Should Be 'AutoBackup'        
        }
        
        It 'Should update IsEnabled to false' {
            Set-WinEventLogTargetResource -LogName 'Microsoft-Windows-CAPI2/Operational' -IsEnabled $false
            (Get-WinEvent -ListLog 'Microsoft-Windows-CAPI2/Operational').IsEnabled | Should Be $false
        }

        It 'Should update SecurityDescriptor' {
            Set-WinEventLogTargetResource -LogName 'Pester' -SecurityDescriptor 'O:BAG:SYD:(A;;0x7;;;BA)(A;;0x7;;;SO)(A;;0x3;;;IU)(A;;0x3;;;SU)(A;;0x3;;;S-1-5-3)(A;;0x3;;;S-1-5-33)(A;;0x1;;;S-1-5-32-573)' 
            (Get-WinEvent -ListLog 'Pester').SecurityDescriptor = 'O:BAG:SYD:(A;;0x7;;;BA)(A;;0x7;;;SO)(A;;0x3;;;IU)(A;;0x3;;;SU)(A;;0x3;;;S-1-5-3)(A;;0x3;;;S-1-5-33)(A;;0x1;;;S-1-5-32-573)' 
        }

        It 'Should update the LogFilePath'{
            Set-WinEventLogTargetResource -LogName 'Pester' -LogFilePath 'c:\tmp\test.evtx'
            (Get-WinEvent -ListLog 'Pester').LogFilePath | Should Be 'c:\tmp\test.evtx'
        }
    }

    
    
    #Setting up mocks to validate code is never called... not sure if this is good practice
    Mock -CommandName Set-MaximumSizeInBytes -ModuleName MSFT_xWinEventLog -MockWith {
        return $true
    }
    
    Mock -CommandName Set-LogMode -ModuleName MSFT_xWinEventLog -MockWith {
        return $true
    }

    Mock -CommandName Set-SecurityDescriptor -ModuleName MSFT_xWinEventLog -MockWith {
        return $true
    }

    Mock -CommandName Set-IsEnabled -ModuleName MSFT_xWinEventLog -MockWith {
        return $true
    }

    Mock -CommandName Set-LogFilePath -ModuleName MSFT_xWinEventLog -MockWith {
        return $true
    }

    Context 'When desired value matches property'{

         $Log = Get-WinEvent -ListLog 'Pester'
         Set-WinEventLogTargetResource -LogName $Log.LogName -SecurityDescriptor $log.SecurityDescriptor -LogMode $log.LogMode -IsEnabled $log.IsEnabled 
        
        It 'Should not call Set-MaximumSizeInBytes'{
            Assert-MockCalled -CommandName Set-MaximumSizeInBytes -ModuleName MSFT_xWinEventLog -Exactly 0
        }

        It 'Should not call Set-LogMode' {
            Assert-MockCalled -CommandName Set-LogMode -ModuleName MSFT_xWinEventLog -Exactly 0
        }

        It 'Should not call Set-SecurityDescriptor'{
            Assert-MockCalled -CommandName Set-SecurityDescriptor -ModuleName MSFT_xWinEventLog -Exactly 0
        }

        It 'Should not call Set-IsEnabled'{
            Assert-MockCalled -CommandName Set-IsEnabled -ModuleName MSFT_xWinEventLog -Exactly 0
        }

        It 'Should not call Set-LogFilePath'{
            Assert-MockCalled -CommandName Set-LogFilePath -ModuleName MSFT_xWinEventLog -Exactly 0
        }
    }

    AfterAll {
        Remove-EventLog -LogName 'Pester'
        
        $log = Get-WinEvent -ListLog 'Microsoft-Windows-CAPI2/Operational'
        $log.IsEnabled = $Capi2Log.IsEnabled
        $log.SaveChanges()
        Remove-Item -Path "$env:SystemDrive\tmp" -Recurse -Force -ErrorAction SilentlyContinue
    }
}