Task 42205: Cleanup orphaned XEvents sessions

- Using an xUnit Collection Fixture to run the cleanup.

Author: paulmedynski

src/Microsoft.Data.SqlClient/tests/ManualTests/TracingTests/XEventsTracingTest.cs

@@ -13,44 +13,59 @@
 
 namespace Microsoft.Data.SqlClient.ManualTesting.Tests
 {
-    public class XEventsTracingTest
+    // XEvent sessions may become orphaned on the Azure SQL Server, which leads to poor performance
+    // (query timeouts, deadlocks, etc) over time.  This fixture is instantiated once per test run
+    // and drops these orphaned sessions as part of every run to help mitigate this issue.
+    public class XEventCleaner
     {
-        private readonly string _testName;
-
-        public XEventsTracingTest(ITestOutputHelper outputHelper)
+        public XEventCleaner()
         {
-            _testName = DataTestUtility.CurrentTestName(outputHelper);
-        }
+            if (DataTestUtility.AreConnStringsSetup() &&
+                DataTestUtility.IsNotAzureSynapse() &&
+                DataTestUtility.IsNotManagedInstance())
+            {
+                using SqlConnection connection = new(DataTestUtility.TCPConnectionString);
+                connection.Open();
 
-        // XEvent sessions may become orphaned on the Azure SQL Server, which leads to poor
-        // performance (query timeouts, deadlocks, etc) over time.  This test drops these orphaned
-        // sessions as part of every run to help mitigate this issue.
-        [ConditionalFact(
-            typeof(DataTestUtility),
-            nameof(DataTestUtility.AreConnStringsSetup),
-            nameof(DataTestUtility.IsNotAzureSynapse),
-            nameof(DataTestUtility.IsNotManagedInstance))]
-        public void CleanupOrphanedXEventSessions()
-        {
-            using SqlConnection connection = new(DataTestUtility.TCPConnectionString);
-            connection.Open();
+                using SqlCommand command = new(
+                    """
+                    DECLARE @sql NVARCHAR(MAX) = N'';
+
+                    -- Identify orphaned event sessions and generate DROP commands.
+                    SELECT @sql += N'DROP EVENT SESSION [' + s.name + N'] ON DATABASE;' + CHAR(13) + CHAR(10)
+                    FROM sys.database_event_sessions s
+                    LEFT JOIN sys.dm_xe_database_sessions t ON s.name = t.name
+                    WHERE t.name IS NULL;
 
-            using SqlCommand command = new(
-                """
-                DECLARE @sql NVARCHAR(MAX) = N'';
+                    -- Execute the generated commands
+                    EXEC sys.sp_executesql @sql;
+                    """,
+                    connection);
+
+                int rowsAffected = command.ExecuteNonQuery();
+
+                if (rowsAffected > 0)
+                {
+                    Console.WriteLine($"Dropped {rowsAffected} orphaned XEvent sessions.");
+                }
+            }
+        }
+    }
 
-                -- Identify orphaned event sessions and generate DROP commands.
-                SELECT @sql += N'DROP EVENT SESSION [' + s.name + N'] ON DATABASE;' + CHAR(13) + CHAR(10)
-                FROM sys.database_event_sessions s
-                LEFT JOIN sys.dm_xe_database_sessions t ON s.name = t.name
-                WHERE t.name IS NULL;
+    // This empty class is required by xUnit to tie the cleaner to the test classes.
+    [CollectionDefinition("XEventCleaner")]
+    public class XEventCleanerCollection : ICollectionFixture<XEventCleaner>
+    {
+    }
 
-                -- Execute the generated commands
-                EXEC sys.sp_executesql @sql;
-                """,
-                connection);
+    [Collection("XEventCleaner")]
+    public class XEventsTracingTest
+    {
+        private readonly string _testName;
 
-            command.ExecuteNonQuery();
+        public XEventsTracingTest(ITestOutputHelper outputHelper)
+        {
+            _testName = DataTestUtility.CurrentTestName(outputHelper);
         }
 
         [Trait("Category", "flaky")]