Adding helpers to the module event test to improve readability.

Author: ashgti

lldb/test/API/tools/lldb-dap/module-event/TestDAP_module_event.py

@@ -8,45 +8,51 @@
 
 
 class TestDAP_module_event(lldbdap_testcase.DAPTestCaseBase):
+    def lookup_module_id(self, name):
+        """Returns the identifier for the first module event starting with the given name."""
+        for event in self.dap_server.module_events:
+            if self.get_dict_value(event, ["body", "module", "name"]).startswith(name):
+                return self.get_dict_value(event, ["body", "module", "id"])
+        self.fail(f"No module events matching name={name}")
+
+    def module_events(self, id):
+        """Finds all module events by identifier."""
+        return [
+            event
+            for event in self.dap_server.module_events
+            if self.get_dict_value(event, ["body", "module", "id"]) == id
+        ]
+
+    def module_reasons(self, events):
+        """Returns the list of 'reason' values from the given events."""
+        return [event["body"]["reason"] for event in events]
+
     @skipIfWindows
     def test_module_event(self):
+        """
+        Test that module events are fired on target load and when the list of
+        dynamic libraries updates while running.
+        """
         program = self.getBuildArtifact("a.out")
         self.build_and_launch(program)
+        # We can analyze the order of events after the process exits.
         self.continue_to_exit()
 
-        # Module 'remove' events will only contain the 'id' not the 'name',
-        # first lookup the module id to find all the events.
-        a_out_id = next(
-            e
-            for e in self.dap_server.module_events
-            if e["body"]["module"]["name"] == "a.out"
-        )["body"]["module"]["id"]
-        a_out_events = [
-            e
-            for e in self.dap_server.module_events
-            if e["body"]["module"]["id"] == a_out_id
-        ]
+        a_out_id = self.lookup_module_id("a.out")
+        a_out_events = self.module_events(id=a_out_id)
 
         self.assertIn(
             "new",
-            [e["body"]["reason"] for e in a_out_events],
+            self.module_reasons(a_out_events),
             "Expected a.out to load during the debug session.",
         )
 
-        libother_id = next(
-            e
-            for e in self.dap_server.module_events
-            if e["body"]["module"]["name"].startswith("libother.")
-        )["body"]["module"]["id"]
-        libother_events = [
-            e
-            for e in self.dap_server.module_events
-            if e["body"]["module"]["id"] == libother_id
-        ]
-
-        self.assertTrue(libother_events, "Expected libother to produce module events.")
+        libother_id = self.lookup_module_id(
+            "libother."  # libother.so or libother.dylib based on OS.
+        )
+        libother_events = self.module_events(id=libother_id)
         self.assertEqual(
-            [e["body"]["reason"] for e in libother_events],
+            self.module_reasons(libother_events),
             ["new", "removed"],
             "Expected libother to be loaded then unloaded during the debug session.",
         )