Read-DbaAuditFile / Read-DbaXEFile / Watch-DbaXESession - Refactoring and bugfixing (#9720)

Author: andreasjordan

public/Read-DbaAuditFile.ps1

@@ -82,23 +82,23 @@ function Read-DbaAuditFile {
                 }
             }
 
-            $accessible = Test-Path -Path $currentFile
-            $whoami = whoami
+            # $currentFile is only the base filename and must be expanded using a wildcard
+            $fileNames = (Get-ChildItem -Path ($currentFile -replace '\.sqlaudit$', '*.sqlaudit') | Sort-Object CreationTime).FullName
+            $enum = @( )
+            foreach ($fileName in $fileNames) {
+                $accessible = Test-Path -Path $fileName
+                $whoami = whoami
+                if (-not $accessible) {
+                    Stop-Function -Continue -Message "$fileName cannot be accessed from $($env:COMPUTERNAME). Does $whoami have access?"
+                }
 
-            if (-not $accessible) {
-                if ($file.Status -eq "Stopped") { continue }
-                Stop-Function -Continue -Message "$currentFile cannot be accessed from $($env:COMPUTERNAME). Does $whoami have access?"
+                $enum += Read-XEvent -FileName $fileName
             }
 
             if ($Raw) {
-                return (SqlServer.XEvent\Read-SqlXEvent -FileName $currentfile)
+                return $enum
             }
 
-            # use the SqlServer.XEvent\Read-SqlXEvent cmdlet from Microsoft
-            # because the underlying Class uses Tasks
-            # which is hard to handle in PowerShell
-
-            $enum = SqlServer.XEvent\Read-SqlXEvent -FileName $currentfile
             $newcolumns = ($enum.Fields.Name | Select-Object -Unique)
 
             $actions = ($enum.Actions.Name | Select-Object -Unique)

public/Read-DbaXEFile.ps1

@@ -94,10 +94,6 @@ function Read-DbaXEFile {
                     Stop-Function -Message "$file cannot be accessed from $($env:COMPUTERNAME)." -Continue
                 }
 
-                # use the SqlServer\Read-SqlXEvent cmdlet from Microsoft
-                # because the underlying Class uses Tasks
-                # which is hard to handle in PowerShell
-
                 if ($Raw) {
                     try {
                         Read-XEvent -FileName $file

public/Watch-DbaXESession.ps1

@@ -80,7 +80,7 @@ function Watch-DbaXESession {
             $sessionname = $xesession.Name
             Write-Message -Level Verbose -Message "Watching $sessionname on $($server.Name)."
 
-            if (-not $xesession.IsRunning -and -not $xesession.IsRunning) {
+            if (-not $xesession.IsRunning) {
                 Stop-Function -Message "$($xesession.Name) is not running on $($server.Name)" -Continue
             }
 
@@ -103,13 +103,10 @@ function Watch-DbaXESession {
 
             try {
                 if ($raw) {
-                    return (SqlServer.XEvent\Read-SqlXEvent -ConnectionString $server.ConnectionContext.ConnectionString -SessionName $sessionname -ErrorAction Stop)
+                    return (Read-XEvent -ConnectionString $server.ConnectionContext.ConnectionString -SessionName $sessionname -ErrorAction Stop)
                 }
 
-                # use the SqlServer.XEvent\Read-SqlXEvent cmdlet from Microsoft
-                # because the underlying Class uses Tasks
-                # which is hard to handle in PowerShell
-                SqlServer.XEvent\Read-SqlXEvent -ConnectionString $server.ConnectionContext.ConnectionString -SessionName $sessionname -ErrorAction Stop | ForEach-Object -Process {
+                Read-XEvent -ConnectionString $server.ConnectionContext.ConnectionString -SessionName $sessionname -ErrorAction Stop | ForEach-Object -Process {
 
                     $hash = [ordered]@{ }
 

tests/Read-DbaAuditFile.Tests.ps1

@@ -43,12 +43,12 @@ Describe "$CommandName Integration Tests" -Tag "IntegrationTests" {
     }
     Context "Verifying command output" {
         It "returns some results" {
-            $results = Get-DbaInstanceAudit -SqlInstance $TestConfig.instance2 -Audit LoginAudit | Read-DbaAuditFile -Raw -WarningAction SilentlyContinue
-            [System.Linq.Enumerable]::Count($results) -gt 1 | Should Be $true
+            $results = Get-DbaInstanceAudit -SqlInstance $TestConfig.instance2 -Audit LoginAudit | Read-DbaAuditFile -Raw
+            $results | Should -Not -BeNullOrEmpty
         }
         It "returns some results" {
             $results = Get-DbaInstanceAudit -SqlInstance $TestConfig.instance2 -Audit LoginAudit | Read-DbaAuditFile | Select-Object -First 1
-            $results.server_principal_name | Should -Not -Be $null
+            $results.server_principal_name | Should -Not -BeNullOrEmpty
         }
     }
 }

tests/Read-DbaXEFile.Tests.ps1

@@ -16,14 +16,13 @@ Describe "$CommandName Unit Tests" -Tag 'UnitTests' {
 
 Describe "$CommandName Integration Tests" -Tags "IntegrationTests" {
     Context "Verifying command output" {
-        # THIS WORKS, I SWEAR
         It "returns some results" {
-            $results = Get-DbaXESession -SqlInstance $TestConfig.instance2 | Read-DbaXEFile -Raw -WarningAction SilentlyContinue
-            [System.Linq.Enumerable]::Count($results) -gt 1 | Should Be $true
+            $results = Get-DbaXESession -SqlInstance $TestConfig.instance2 | Read-DbaXEFile -Raw
+            $results | Should -Not -BeNullOrEmpty
         }
         It "returns some results" {
-            $results = Get-DbaXESession -SqlInstance $TestConfig.instance2 | Read-DbaXEFile -WarningAction SilentlyContinue
-            $results.Count -gt 1 | Should Be $true
+            $results = Get-DbaXESession -SqlInstance $TestConfig.instance2 | Read-DbaXEFile
+            $results | Should -Not -BeNullOrEmpty
         }
     }
 }

tests/Watch-DbaXESession.Tests.ps1

@@ -13,12 +13,19 @@ Describe "$CommandName Unit Tests" -Tag 'UnitTests' {
     }
 }
 
-# This command is special and runs infinitely so don't actually try to run it
 Describe "$CommandName Integration Tests" -Tags "IntegrationTests" {
     Context "Command functions as expected" {
-        It "warns if SQL instance version is not supported" {
-            $results = Watch-DbaXESession -SqlInstance $TestConfig.instance1 -Session system_health -WarningAction SilentlyContinue -WarningVariable versionwarn
-            $versionwarn -join '' -match "SQL Server version 11 required" | Should Be $true
+        BeforeAll {
+            Stop-DbaXESession -SqlInstance $TestConfig.instance2 -Session system_health -EnableException -Confirm:$false
+        }
+        AfterAll {
+            Start-DbaXESession -SqlInstance $TestConfig.instance2 -Session system_health -EnableException -Confirm:$false
+        }
+
+        # This command is special and runs infinitely so don't actually try to run it
+        It "warns if XE session is not running" {
+            $results = Watch-DbaXESession -SqlInstance $TestConfig.instance2 -Session system_health -WarningAction SilentlyContinue -WarningVariable warn
+            $warn | Should -Match 'system_health is not running'
         }
     }
 }

tests/pester.groups.ps1

@@ -39,8 +39,6 @@ $TestsRunGroups = @{
         # tests that fail because the command does not work
         'Copy-DbaDbCertificate',
         'Export-DbaDacPackage',
-        'Read-DbaAuditFile',
-        'Read-DbaXEFile',
         # takes too long
         'Install-DbaSqlWatch',
         'Uninstall-DbaSqlWatch',