Refactor tests to be concise and add progresse end, add additional check to sbprogress description check

Author: Jlalond

lldb/source/API/SBProgress.cpp

@@ -41,7 +41,7 @@ void SBProgress::Increment(uint64_t amount, const char *description) {
   LLDB_INSTRUMENT_VA(amount, description);
 
   std::optional<std::string> description_opt;
-  if (description)
+  if (description && description[0])
     description_opt = description;
   m_opaque_up->Increment(amount, description_opt);
 }

lldb/test/API/tools/lldb-dap/progress/TestDAP_Progress.py

@@ -12,6 +12,41 @@
 
 
 class TestDAP_progress(lldbdap_testcase.DAPTestCaseBase):
+    def verify_progress_events(
+        self,
+        expected_title,
+        expected_message=None,
+        expected_not_in_message=None,
+        only_verify_first_update=False,
+    ):
+        self.dap_server.wait_for_event("progressEnd", 15)
+        self.assertTrue(len(self.dap_server.progress_events) > 0)
+        start_found = False
+        update_found = False
+        end_found = False
+        for event in self.dap_server.progress_events:
+            event_type = event["event"]
+            if "progressStart" in event_type:
+                title = event["body"]["title"]
+                self.assertIn(expected_title, title)
+                start_found = True
+            if "progressUpdate" in event_type:
+                message = event["body"]["message"]
+                print(f"Progress update: {message}")
+                if only_verify_first_update and update_found:
+                    continue
+                if expected_message is not None:
+                    self.assertIn(expected_message, message)
+                if expected_not_in_message is not None:
+                    self.assertNotIn(expected_not_in_message, message)
+                update_found = True
+            if "progressEnd" in event_type:
+                end_found = True
+
+        self.assertTrue(start_found)
+        self.assertTrue(update_found)
+        self.assertTrue(end_found)
+
     @skipIfWindows
     def test_output(self):
         program = self.getBuildArtifact("a.out")
@@ -30,28 +65,10 @@ def test_output(self):
             "`test-progress --total 3 --seconds 1", context="repl"
         )
 
-        self.dap_server.wait_for_event("progressEnd", 15)
-        # Expect at least a start, an update, and end event
-        # However because the underlying Progress instance is an RAII object and we can't guaruntee
-        # it's deterministic destruction in the python API, we verify just start and update
-        # otherwise this test could be flakey.
-        self.assertTrue(len(self.dap_server.progress_events) > 0)
-        start_found = False
-        update_found = False
-        for event in self.dap_server.progress_events:
-            event_type = event["event"]
-            if "progressStart" in event_type:
-                title = event["body"]["title"]
-                self.assertIn("Progress tester", title)
-                start_found = True
-            if "progressUpdate" in event_type:
-                message = event["body"]["message"]
-                print(f"Progress update: {message}")
-                self.assertNotIn("Progres tester", message)
-                update_found = True
-
-        self.assertTrue(start_found)
-        self.assertTrue(update_found)
+        self.verify_progress_events(
+            expected_title="Progress tester",
+            expected_not_in_message="Progress tester",
+        )
 
     @skipIfWindows
     def test_output_nodetails(self):
@@ -71,27 +88,10 @@ def test_output_nodetails(self):
             "`test-progress --total 3 --seconds 1 --no-details", context="repl"
         )
 
-        self.dap_server.wait_for_event("progressEnd", 15)
-        # Expect at least a start, an update, and end event
-        # However because the underlying Progress instance is an RAII object and we can't guaruntee
-        # it's deterministic destruction in the python API, we verify just start and update
-        # otherwise this test could be flakey.
-        self.assertTrue(len(self.dap_server.progress_events) > 0)
-        start_found = False
-        update_found = False
-        for event in self.dap_server.progress_events:
-            event_type = event["event"]
-            if "progressStart" in event_type:
-                title = event["body"]["title"]
-                self.assertIn("Progress tester", title)
-                start_found = True
-            if "progressUpdate" in event_type:
-                message = event["body"]["message"]
-                self.assertEqual("Initial Detail", message)
-                update_found = True
-
-        self.assertTrue(start_found)
-        self.assertTrue(update_found)
+        self.verify_progress_events(
+            expected_title="Progress tester",
+            expected_message="Initial Detail",
+        )
 
     @skipIfWindows
     def test_output_indeterminate(self):
@@ -109,30 +109,11 @@ def test_output_indeterminate(self):
         )
         self.dap_server.request_evaluate("`test-progress --seconds 1", context="repl")
 
-        self.dap_server.wait_for_event("progressEnd", 15)
-        # Expect at least a start, an update, and end event
-        # However because the underlying Progress instance is an RAII object and we can't guaruntee
-        # it's deterministic destruction in the python API, we verify just start and update
-        # otherwise this test could be flakey.
-        self.assertTrue(len(self.dap_server.progress_events) > 0)
-        start_found = False
-        update_found = False
-        for event in self.dap_server.progress_events:
-            event_type = event["event"]
-            if "progressStart" in event_type:
-                title = event["body"]["title"]
-                self.assertIn("Progress tester", title)
-                start_found = True
-            if "progressUpdate" in event_type:
-                message = event["body"]["message"]
-                print(f"Progress update: {message}")
-                # Check on the first update we set the initial detail.
-                if not update_found:
-                    self.assertEqual("Step 1", message)
-                update_found = True
-
-        self.assertTrue(start_found)
-        self.assertTrue(update_found)
+        self.verify_progress_events(
+            expected_title="Progress tester",
+            expected_message="Step 1",
+            only_verify_first_update=True,
+        )
 
     @skipIfWindows
     def test_output_nodetails_indeterminate(self):
@@ -152,26 +133,8 @@ def test_output_nodetails_indeterminate(self):
             "`test-progress --seconds 1 --no-details", context="repl"
         )
 
-        self.dap_server.wait_for_event("progressEnd", 15)
-        # Expect at least a start, an update, and end event
-        # However because the underlying Progress instance is an RAII object and we can't guaruntee
-        # it's deterministic destruction in the python API, we verify just start and update
-        # otherwise this test could be flakey.
-        self.assertTrue(len(self.dap_server.progress_events) > 0)
-        start_found = False
-        update_found = False
-        for event in self.dap_server.progress_events:
-            event_type = event["event"]
-            if "progressStart" in event_type:
-                title = event["body"]["title"]
-                self.assertIn("Progress tester", title)
-                start_found = True
-            if "progressUpdate" in event_type:
-                message = event["body"]["message"]
-                # Check on the first update we set the initial detail.
-                if not update_found:
-                    self.assertEqual("Initial Indeterminate Detail", message)
-                update_found = True
-
-        self.assertTrue(start_found)
-        self.assertTrue(update_found)
+        self.verify_progress_events(
+            expected_title="Progress tester",
+            expected_message="Initial Indeterminate Detail",
+            only_verify_first_update=True,
+        )