Rebase and refactor SBProgress, add positive and negative test cases

Author: Jlalond

lldb/source/API/SBProgress.cpp

@@ -10,24 +10,26 @@
 #include "lldb/Core/Progress.h"
 #include "lldb/Utility/Instrumentation.h"
 
-#include "Utils.h"
-
 using namespace lldb;
 
 SBProgress::SBProgress(const char *title, const char *details,
                        SBDebugger &debugger) {
   LLDB_INSTRUMENT_VA(this, title, details, debugger);
 
   m_opaque_up = std::make_unique<lldb_private::Progress>(
-      title, details, std::nullopt, debugger.get());
+      title, details, /*total=*/std::nullopt, debugger.get(),
+      /*minimum_report_time=*/std::nullopt,
+      lldb_private::Progress::Origin::eExternal);
 }
 
 SBProgress::SBProgress(const char *title, const char *details,
                        uint64_t total_units, SBDebugger &debugger) {
   LLDB_INSTRUMENT_VA(this, title, details, total_units, debugger);
 
   m_opaque_up = std::make_unique<lldb_private::Progress>(
-      title, details, total_units, debugger.get());
+      title, details, total_units, debugger.get(),
+      /*minimum_report_time=*/std::nullopt,
+      lldb_private::Progress::Origin::eExternal);
 }
 
 SBProgress::~SBProgress() = default;

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

@@ -0,0 +1,36 @@
+"""Test the SBProgress API."""
+
+import lldb
+from lldbsuite.test.lldbtest import *
+
+
+class SBProgressTestCase(TestBase):
+
+    def test_with_external_bit_set(self):
+        """Test SBProgress events are listened to when the external bit is set."""
+
+        progress = lldb.SBProgress("Test SBProgress", "Test progress", self.dbg)
+        listener = lldb.SBListener("Test listener")
+        broadcaster = self.dbg.GetBroadcaster()
+        broadcaster.AddListener(listener, lldb.eBroadcastBitExternalProgress)
+        event = lldb.SBEvent()
+
+        expected_string = "Test progress first increment"
+        progress.Increment(1, expected_string)
+        self.assertTrue(listener.PeekAtNextEvent(event))
+        stream = lldb.SBStream()
+        event.GetDescription(stream)
+        self.assertTrue(expected_string in stream.GetData())
+
+    def test_without_external_bit_set(self):
+        """Test SBProgress events are not listened to on the internal progress bit."""
+
+        progress = lldb.SBProgress("Test SBProgress", "Test progress", self.dbg)
+        listener = lldb.SBListener("Test listener")
+        broadcaster = self.dbg.GetBroadcaster()
+        broadcaster.AddListener(listener, lldb.eBroadcastBitProgress)
+        event = lldb.SBEvent()
+
+        expected_string = "Test progress first increment"
+        progress.Increment(1, expected_string)
+        self.assertFalse(listener.PeekAtNextEvent(event))