AzureDevOpsHelpers

1.0.37

Public/TestHelpers/Test.ErrorLogs.Tests.ps1

#Requires -Version 5.0
#Requires -Modules @{ ModuleName="Pester"; ModuleVersion="3.4.0" }
$ErrorActionPreference = "Stop";
Set-StrictMode -Version 'Latest'

$sut = (Split-Path -Leaf $MyInvocation.MyCommand.Path) -replace '\.Tests\.ps1', '.psm1'
$module = Import-Module "$PSScriptRoot\$sut" -Force -PassThru
$moduleName = $module.Name


InModuleScope $moduleName {
    Describe 'CheckEventViewerForErrors' -Tags 'Unit' {
        $fakeSource = 'NonExistentSource'
        $logSource = "Pester"
        $time = Get-Date
        
        BeforeAll {            
            Mock `
                -CommandName Get-EventLog `
                -MockWith { throw $(New-Object System.Exception) } `
                -ParameterFilter { ($Source -eq $fakeSource) -and ($LogName -eq 'Application') }
            
            Mock `
                -CommandName Get-EventLog `
                -MockWith { return @{ TimeGenerated = $time; EntryType = 'Error' } } `
                -ParameterFilter { $LogName -eq $logSource -and $LogName -eq 'Application' }                
        }
        It 'returns $false when there are no entries found' {
            # Arrange
            $expected = $false
            # Act
            [bool] $actual = CheckEventViewerForErrors -logSource $fakeSource -dateGreaterThanFilter $time
            # Assert
            $actual | Should Be $expected
            Assert-MockCalled -CommandName Get-EventLog
        }    
        It 'returns $true when there are entries for the source but no errors' {
            # Arrange
            $expected = $true                
            # Act
            [bool] $actual = CheckEventViewerForErrors -logSource $logSource -dateGreaterThanFilter $time
            # Assert
            $actual | Should Be $expected
            Assert-MockCalled -CommandName Get-EventLog
        }    
        It 'returns $false when there are error entries for the source' {
            # Arrange
            $expected = $false                
            # Act
            [bool] $actual = CheckEventViewerForErrors -logSource $logSource -dateGreaterThanFilter $time.AddDays(-1)
            # Assert
            $actual | Should Be $expected
        }
    }    
}


Describe 'CheckEventViewerForErrors' -Tags 'Integration' {
    BeforeEach {
        $logSource = "Pester"
        if ($null -eq (Get-EventLog -LogName Application -Source $logSource -ErrorAction SilentlyContinue)) {
            New-EventLog -Source $logSource -LogName Application 
        }
    }
    It 'returns $false when there are no entries found' {
        # Arrange
        [bool] $expected = $false    
        # Act
        [bool] $actual = CheckEventViewerForErrors -logSource 'NonExistentSource' -dateGreaterThanFilter (Get-Date)
        # Assert
        $actual | Should Be $expected
    }
    It 'returns $true when there are entries for the source but no errors' {
        # Arrange
        [bool] $expected = $true    
        Write-EventLog -LogName Application -Source $logSource -Message 'Log for test' -EntryType Information -EventId 0 
        # Act
        [bool] $actual = CheckEventViewerForErrors -logSource $logSource -dateGreaterThanFilter (Get-Date)
        # Assert
        $actual | Should Be $expected
    }
    It 'returns $false when there are error entries for the source' {
        # Arrange
        [bool] $expected = $true    
        Write-EventLog -LogName Application -Source $logSource -Message 'Log for test' -EntryType Error -EventId 0 
        # Act
        [bool] $actual = CheckEventViewerForErrors -logSource $logSource -dateGreaterThanFilter (Get-Date)
        # Assert
        $actual | Should Be $expected
    }
}