[lldb/test] Add events listener helper function to lldbtest]

lldb/packages/Python/lldbsuite/test/lldbutil.py

@@ -1225,6 +1225,29 @@ def get_next_event():
             lldb.SBProcess.GetStateFromEvent(event),
             expected_state)
 
+def start_listening_from(broadcaster, event_mask):
+    """Creates a listener for a specific event mask and add it to the source broadcaster."""
+
+    listener = lldb.SBListener("lldb.test.listener")
+    broadcaster.AddListener(listener, event_mask)
+    return listener
+
+def fetch_next_event(test, listener, broadcaster, timeout=10):
+    """Fetch one event from the listener and return it if it matches the provided broadcaster.
+    Fails otherwise."""
+
+    event = lldb.SBEvent()
+
+    if listener.WaitForEvent(timeout, event):
+        if event.BroadcasterMatchesRef(broadcaster):
+            return event
+
+        test.fail("received event '%s' from unexpected broadcaster '%s'." %
+                  (event.GetDescription(), event.GetBroadcaster().GetName()))
+
+    test.fail("couldn't fetch an event before reaching the timeout.")
+
+
 # ===================================
 # Utility functions related to Frames
 # ===================================

lldb/test/API/functionalities/diagnostic_reporting/TestDiagnosticReporting.py

@@ -6,13 +6,18 @@
 import lldbsuite.test.lldbutil as lldbutil
 
 from lldbsuite.test.lldbtest import *
-from lldbsuite.test.eventlistener import EventListenerTestBase
 
-class TestDiagnosticReporting(EventListenerTestBase):
+class TestDiagnosticReporting(TestBase):
 
     mydir = TestBase.compute_mydir(__file__)
-    event_mask = lldb.SBDebugger.eBroadcastBitWarning | lldb.SBDebugger.eBroadcastBitError
-    event_data_extractor = lldb.SBDebugger.GetDiagnosticFromEvent
+
+    def setUp(self):
+        TestBase.setUp(self)
+
+        self.broadcaster = self.dbg.GetBroadcaster()
+        self.listener = lldbutil.start_listening_from(self.broadcaster,
+                                        lldb.SBDebugger.eBroadcastBitWarning |
+                                        lldb.SBDebugger.eBroadcastBitError)
 
     def test_dwarf_symbol_loading_diagnostic_report(self):
         """Test that we are able to fetch diagnostic events"""
@@ -24,13 +29,12 @@ def test_dwarf_symbol_loading_diagnostic_report(self):
         self.process = self.target.LoadCore(
             self.getBuildArtifact("minidump.core"))
 
-        self.assertEquals(len(self.events), 1)
-
-        diagnostic_event = self.events[0]
+        event = lldbutil.fetch_next_event(self, self.listener, self.broadcaster)
+        diagnostic_data = lldb.SBDebugger.GetDiagnosticFromEvent(event)
         self.assertEquals(
-            diagnostic_event.GetValueForKey("type").GetStringValue(100),
+            diagnostic_data.GetValueForKey("type").GetStringValue(100),
             "warning")
         self.assertEquals(
-            diagnostic_event.GetValueForKey("message").GetStringValue(100),
+            diagnostic_data.GetValueForKey("message").GetStringValue(100),
             "unable to retrieve process ID from minidump file, setting process ID to 1"
         )

lldb/test/API/functionalities/progress_reporting/TestProgressReporting.py

@@ -6,18 +6,27 @@
 import lldbsuite.test.lldbutil as lldbutil
 
 from lldbsuite.test.lldbtest import *
-from lldbsuite.test.eventlistener import EventListenerTestBase
 
 
-class TestProgressReporting(EventListenerTestBase):
+class TestProgressReporting(TestBase):
 
     mydir = TestBase.compute_mydir(__file__)
-    event_mask = lldb.SBDebugger.eBroadcastBitProgress
-    event_data_extractor = lldb.SBDebugger.GetProgressFromEvent
+
+    def setUp(self):
+        TestBase.setUp(self)
+        self.broadcaster = self.dbg.GetBroadcaster()
+        self.listener = lldbutil.start_listening_from(self.broadcaster,
+                                        lldb.SBDebugger.eBroadcastBitProgress)
 
     def test_dwarf_symbol_loading_progress_report(self):
         """Test that we are able to fetch dwarf symbol loading progress events"""
         self.build()
 
         lldbutil.run_to_source_breakpoint(self, 'break here', lldb.SBFileSpec('main.c'))
-        self.assertGreater(len(self.events), 0)
+
+        event = lldbutil.fetch_next_event(self, self.listener, self.broadcaster)
+        ret_args = lldb.SBDebugger.GetProgressFromEvent(event)
+        self.assertGreater(len(ret_args), 0)
+        message = ret_args[0]
+        self.assertGreater(len(message), 0)
+

lldb/test/API/functionalities/progress_reporting/swift_progress_reporting/TestSwiftProgressReporting.py

@@ -7,14 +7,16 @@
 
 from lldbsuite.test.lldbtest import *
 from lldbsuite.test.decorators import *
-from lldbsuite.test.eventlistener import EventListenerTestBase
 
-class TestSwiftProgressReporting(EventListenerTestBase):
+class TestSwiftProgressReporting(TestBase):
 
     mydir = TestBase.compute_mydir(__file__)
-    event_mask = lldb.SBDebugger.eBroadcastBitProgress
-    event_data_extractor = lldb.SBDebugger.GetProgressFromEvent
 
+    def setUp(self):
+        TestBase.setUp(self)
+        self.broadcaster = self.dbg.GetBroadcaster()
+        self.listener = lldbutil.start_listening_from(self.broadcaster,
+                                        lldb.SBDebugger.eBroadcastBitProgress)
     @swiftTest
     @skipIf(oslist=no_match(["macosx"]))
     def test_swift_progress_report(self):
@@ -31,14 +33,15 @@ def test_swift_progress_report(self):
         # Resolve variable to exercise the type-system
         self.runCmd("expr boo")
 
-        self.assertGreater(len(self.events), 0)
-
         beacons = [ "Loading Swift module",
                     "Caching Swift user imports from",
                     "Setting up Swift reflection for",
                     "Getting Swift compile unit imports for"]
 
-        for beacon in beacons:
-            filtered_events = list(filter(lambda event: beacon in event[0],
-                                          self.events))
-            self.assertGreater(len(filtered_events), 0)
+        while len(beacons):
+            event = lldbutil.fetch_next_event(self, self.listener, self.broadcaster)
+            ret_args = lldb.SBDebugger.GetProgressFromEvent(event)
+
+            for beacon in beacons:
+                if beacon in ret_args[0]:
+                    beacons.remove(beacon)