Add a split test case of progress with a total and without a total ending on finalize

Author: Jlalond

lldb/source/API/SBProgress.cpp

@@ -50,9 +50,11 @@ void SBProgress::Increment(uint64_t amount, const char *description) {
 }
 
 void SBProgress::Finalize() {
-  if (!m_opaque_up)
-    return;
-
+  // The lldb_private::Progress object is designed to be RAII and send the end
+  // progress event when it gets destroyed. So force our contained object to be
+  // destroyed and send the progress end event. Clearing this object also allows
+  // all other methods to quickly return without doing any work if they are
+  // called after this method.
   m_opaque_up.reset();
 }
 

lldb/test/API/python_api/sbprogress/TestSBProgress.py

@@ -37,7 +37,7 @@ def test_with_external_bit_set(self):
         event.GetDescription(stream)
         self.assertIn("Step 3", stream.GetData())
 
-    def test_progress_finalize(self):
+    def test_progress_finalize_non_deterministic_progress(self):
         """Test SBProgress finalize sends the progressEnd event"""
 
         progress = lldb.SBProgress("Test SBProgress", "Test finalize", self.dbg)
@@ -50,3 +50,19 @@ def test_progress_finalize(self):
         stream = lldb.SBStream()
         event.GetDescription(stream)
         self.assertIn("type = end", stream.GetData())
+
+    def test_progress_finalize_deterministic_progress(self):
+        """Test SBProgress finalize sends the progressEnd event"""
+
+        progress = lldb.SBProgress("Test SBProgress", "Test finalize", 13, self.dbg)
+        listener = lldb.SBListener("Test listener")
+        broadcaster = self.dbg.GetBroadcaster()
+        broadcaster.AddListener(listener, lldb.eBroadcastBitExternalProgressCategory)
+        event = lldb.SBEvent()
+        progress.Finalize()
+        self.assertTrue(listener.WaitForEvent(5, event))
+        stream = lldb.SBStream()
+        event.GetDescription(stream)
+        # Note even for progresses with a total, the total isn't
+        # sent in the end message.
+        self.assertIn("type = end", stream.GetData())