baeec066d9
* Add support <Suppress> in Get-WinEvent -FilterHashtable 1. Add support <Suppress> 2. Refacrtoring BuildStructuredQueryFromHashTable() to use StringBuilder 3. Add tests * Changelog
155 lines
8.4 KiB
PowerShell
155 lines
8.4 KiB
PowerShell
Describe 'Get-WinEvent' -Tags "CI" {
|
|
BeforeAll {
|
|
if ( ! $IsWindows )
|
|
{
|
|
$origDefaults = $PSDefaultParameterValues.Clone()
|
|
$PSDefaultParameterValues['it:skip'] = $true
|
|
}
|
|
}
|
|
AfterAll {
|
|
if ( ! $IsWindows ){
|
|
$global:PSDefaultParameterValues = $origDefaults
|
|
}
|
|
}
|
|
Context "Get-WinEvent ListProvider parameter" {
|
|
It 'Get-WinEvent can list the providers' {
|
|
$result = Get-WinEvent -listprovider * -erroraction ignore
|
|
$result | should not BeNullOrEmpty
|
|
}
|
|
It 'Get-WinEvent can get a provider by name' {
|
|
$providers = Get-WinEvent -listprovider * -erroraction ignore
|
|
$result = Get-WinEvent -listprovider ($providers[0].name)
|
|
$result | should not BeNullOrEmpty
|
|
}
|
|
|
|
}
|
|
Context "Get-WinEvent can retrieve events" {
|
|
# for this set of tests we need to have a provider which has multiple events
|
|
BeforeAll {
|
|
if ( ! $IsWindows ) { return }
|
|
$foundEvents = $false
|
|
$providers = Get-WinEvent -listprovider * -erroraction ignore
|
|
foreach($provider in $providers) {
|
|
$events = Get-WinEvent -provider $provider.name -erroraction ignore
|
|
if ( $events.Count -gt 2 ) {
|
|
$providerForTests = $provider
|
|
$foundEvents = $true
|
|
break
|
|
}
|
|
}
|
|
}
|
|
It 'Get-WinEvent can get events from a provider' {
|
|
# we sample the first 20 results, as this could be very large
|
|
$results = Get-WinEvent -provider $providerForTests.Name -max 20
|
|
foreach($event in $results ) {
|
|
$event.providername | should be $providerForTests.name
|
|
}
|
|
}
|
|
It 'Get-WinEvent can get events via logname' {
|
|
$results = get-winevent -logname $providerForTests.LogLinks.LogName -MaxEvents 10
|
|
$results | should not BeNullOrEmpty
|
|
}
|
|
It 'Get-WinEvent can use the simplest of filters' {
|
|
$filter = @{ ProviderName = $providerForTests.Name }
|
|
$testEvents = Get-WinEvent -filterhashtable $filter
|
|
$testEvents.Count | should be $events.Count
|
|
}
|
|
It 'Get-WinEvent can use a filter which includes two items' {
|
|
$filter = @{ ProviderName = $providerForTests.Name; Id = $events[0].Id}
|
|
$results = Get-WinEvent -filterHashtable $filter
|
|
$results | Should not BeNullOrEmpty
|
|
}
|
|
It 'Get-WinEvent can retrieve event via XmlQuery' {
|
|
$level = $events[0].Level
|
|
$logname = $providerForTests.loglinks.logname
|
|
$filter = "<QueryList><Query><Select Path='${logname}'>*[System[Level=${level}]]</Select></Query></QueryList>"
|
|
$results = Get-WinEvent -filterXml $filter -max 3
|
|
$results | should Not BeNullOrEmpty
|
|
}
|
|
It 'Get-WinEvent can retrieve event via XPath' {
|
|
$level = $events[0].Level
|
|
$logname = $providerForTests.loglinks.logname
|
|
$xpathFilter = "*[System[Level=$level]]"
|
|
$results = Get-WinEvent -logname $logname -filterXPath $xpathFilter -max 3
|
|
$results | should Not BeNullOrEmpty
|
|
}
|
|
|
|
}
|
|
Context "Get-WinEvent UserData Queries" {
|
|
It 'Get-WinEvent can retrieve events with UserData queries using FilterXml' {
|
|
# this relies on apriori knowledge about the log file
|
|
# the provided log file has been edited to remove MS PII, so we must use -ea silentlycontinue
|
|
$eventLogFile = [io.path]::Combine($PSScriptRoot, "assets", "Saved-Events.evtx")
|
|
$filter = "<QueryList><Query><Select Path='file://$eventLogFile'>*[UserData/*/Param2='Windows x64']</Select></Query></QueryList>"
|
|
$results = Get-WinEvent -FilterXml $filter -ea silentlycontinue
|
|
@($results).Count | Should be 1
|
|
$results.RecordId | should be 10
|
|
}
|
|
It 'Get-WinEvent can retrieve events with UserData queries using FilterHashtable (one value)' {
|
|
# this relies on apriori knowledge about the log file
|
|
# the provided log file has been edited to remove MS PII, so we must use -ea silentlycontinue
|
|
$eventLogFile = [io.path]::Combine($PSScriptRoot, "assets", "Saved-Events.evtx")
|
|
$filter = @{ path = "$eventLogFile"; Param2 = "Windows x64"}
|
|
$results = Get-WinEvent -filterHashtable $filter -ea silentlycontinue
|
|
@($results).Count | Should be 1
|
|
$results.RecordId | should be 10
|
|
}
|
|
It 'Get-WinEvent can retrieve events with UserData queries using FilterHashtable (array of values)' {
|
|
# this relies on apriori knowledge about the log file
|
|
# the provided log file has been edited to remove MS PII, so we must use -ea silentlycontinue
|
|
$eventLogFile = [io.path]::Combine($PSScriptRoot, "assets", "Saved-Events.evtx")
|
|
$filter = @{ path = "$eventLogFile"; DriverName = "Remote Desktop Easy Print", "Microsoft enhanced Point and Print compatibility driver" }
|
|
$results = Get-WinEvent -filterHashtable $filter -ea silentlycontinue
|
|
@($results).Count | Should be 2
|
|
($results.RecordId -contains 9) | should be $true
|
|
($results.RecordId -contains 11) | should be $true
|
|
}
|
|
It 'Get-WinEvent can retrieve events with UserData queries using FilterHashtable (multiple named params)' {
|
|
# this relies on apriori knowledge about the log file
|
|
# the provided log file has been edited to remove MS PII, so we must use -ea silentlycontinue
|
|
$eventLogFile = [io.path]::Combine($PSScriptRoot, "assets", "Saved-Events.evtx")
|
|
$filter = @{ path = "$eventLogFile"; PackageAware="Not package aware"; DriverName = "Remote Desktop Easy Print", "Microsoft enhanced Point and Print compatibility driver" }
|
|
$results = Get-WinEvent -filterHashtable $filter -ea silentlycontinue
|
|
@($results).Count | Should be 2
|
|
($results.RecordId -contains 9) | should be $true
|
|
($results.RecordId -contains 11) | should be $true
|
|
}
|
|
It 'Get-WinEvent can retrieve events with UserData queries using FilterXPath' {
|
|
# this relies on apriori knowledge about the log file
|
|
# the provided log file has been edited to remove MS PII, so we must use -ea silentlycontinue
|
|
$eventLogFile = [io.path]::Combine($PSScriptRoot, "assets", "Saved-Events.evtx")
|
|
$filter = "*/UserData/*/Param2='Windows x64'"
|
|
$results = Get-WinEvent -path $eventLogFile -filterXPath $filter -ea silentlycontinue
|
|
@($results).Count | Should be 1
|
|
$results.RecordId | should be 10
|
|
}
|
|
}
|
|
Context "Get-WinEvent Queries with SuppressHashFilter" {
|
|
It 'Get-WinEvent can suppress events by Id' {
|
|
# this relies on apriori knowledge about the log file
|
|
# the provided log file has been edited to remove MS PII, so we must use -ea silentlycontinue
|
|
$eventLogFile = [io.path]::Combine($PSScriptRoot, "assets", "Saved-Events.evtx")
|
|
$filter = @{ path = "$eventLogFile"}
|
|
$results = Get-WinEvent -filterHashtable $filter -ea silentlycontinue
|
|
$filterSuppress = @{ path = "$eventLogFile"; SuppressHashFilter=@{Id=370}}
|
|
$resultsSuppress = Get-WinEvent -filterHashtable $filterSuppress -ea silentlycontinue
|
|
@($results).Count | Should be 3
|
|
@($resultsSuppress).Count | Should be 2
|
|
}
|
|
It 'Get-WinEvent can suppress events by UserData' {
|
|
# this relies on apriori knowledge about the log file
|
|
# the provided log file has been edited to remove MS PII, so we must use -ea silentlycontinue
|
|
$eventLogFile = [io.path]::Combine($PSScriptRoot, "assets", "Saved-Events.evtx")
|
|
$filter = @{ path = "$eventLogFile"}
|
|
$results = Get-WinEvent -filterHashtable $filter -ea silentlycontinue
|
|
$filterSuppress = @{ path = "$eventLogFile"; SuppressHashFilter=@{Param2 = "Windows x64"}}
|
|
$resultsSuppress = Get-WinEvent -filterHashtable $filterSuppress -ea silentlycontinue
|
|
@($results).Count | Should be 3
|
|
@($resultsSuppress).Count | Should be 2
|
|
}
|
|
}
|
|
It 'can query a System log' {
|
|
Get-WinEvent -LogName System -MaxEvents 1 | Should Not BeNullOrEmpty
|
|
}
|
|
}
|