[Lldb-commits] [lldb] [lldb][progress][NFC] Add unit test for progress reports (PR #79533)
Chelsea Cassanova via lldb-commits
lldb-commits at lists.llvm.org
Fri Jan 26 15:39:08 PST 2024
https://github.com/chelcassanova updated https://github.com/llvm/llvm-project/pull/79533
>From 9274bcd897cd3ecdb3a842bc72ee660ba335aa57 Mon Sep 17 00:00:00 2001
From: Chelsea Cassanova <chelsea_cassanova at apple.com>
Date: Thu, 25 Jan 2024 16:40:42 -0800
Subject: [PATCH 1/3] [lldb][progress][NFC] Add unit test for progress reports
This test is being added as a way to check the behaviour of how progress
events are broadcasted when reports are started and ended with the
current implementation of progress reports. Here we're mainly checking
and ensuring that the current behaviour is that progress events are
broadcasted individually and placed in the event queue in order of
their creation.
---
lldb/unittests/Core/CMakeLists.txt | 1 +
lldb/unittests/Core/ProgressReportTest.cpp | 105 +++++++++++++++++++++
2 files changed, 106 insertions(+)
create mode 100644 lldb/unittests/Core/ProgressReportTest.cpp
diff --git a/lldb/unittests/Core/CMakeLists.txt b/lldb/unittests/Core/CMakeLists.txt
index b3cddd150635b1..d40c357e3f463b 100644
--- a/lldb/unittests/Core/CMakeLists.txt
+++ b/lldb/unittests/Core/CMakeLists.txt
@@ -7,6 +7,7 @@ add_lldb_unittest(LLDBCoreTests
FormatEntityTest.cpp
MangledTest.cpp
ModuleSpecTest.cpp
+ ProgressReportTest.cpp
RichManglingContextTest.cpp
SourceLocationSpecTest.cpp
SourceManagerTest.cpp
diff --git a/lldb/unittests/Core/ProgressReportTest.cpp b/lldb/unittests/Core/ProgressReportTest.cpp
new file mode 100644
index 00000000000000..bdc168c9e077dd
--- /dev/null
+++ b/lldb/unittests/Core/ProgressReportTest.cpp
@@ -0,0 +1,105 @@
+#include "Plugins/Platform/MacOSX/PlatformMacOSX.h"
+#include "Plugins/Platform/MacOSX/PlatformRemoteMacOSX.h"
+#include "lldb/Core/Debugger.h"
+#include "lldb/Core/Progress.h"
+#include "lldb/Host/FileSystem.h"
+#include "lldb/Host/HostInfo.h"
+#include "lldb/Utility/Listener.h"
+#include "gtest/gtest.h"
+#include <thread>
+
+using namespace lldb;
+using namespace lldb_private;
+
+namespace {
+class ProgressReportTest : public ::testing::Test {
+public:
+ void SetUp() override {
+ FileSystem::Initialize();
+ HostInfo::Initialize();
+ PlatformMacOSX::Initialize();
+ Debugger::Initialize(nullptr);
+ }
+ void TearDown() override {
+ Debugger::Terminate();
+ PlatformMacOSX::Terminate();
+ HostInfo::Terminate();
+ FileSystem::Terminate();
+ }
+};
+} // namespace
+TEST_F(ProgressReportTest, TestReportCreation) {
+ std::chrono::milliseconds timeout(100);
+
+ // Set up the debugger, make sure that was done properly
+ ArchSpec arch("x86_64-apple-macosx-");
+ Platform::SetHostPlatform(PlatformRemoteMacOSX::CreateInstance(true, &arch));
+
+ DebuggerSP debugger_sp = Debugger::CreateInstance();
+ ASSERT_TRUE(debugger_sp);
+
+ // Get the debugger's broadcaster
+ Broadcaster &broadcaster = debugger_sp->GetBroadcaster();
+
+ // Create a listener, make sure it can receive events and that it's
+ // listening to the correct broadcast bit
+ ListenerSP listener_sp = Listener::MakeListener("progress-listener");
+
+ listener_sp->StartListeningForEvents(&broadcaster,
+ Debugger::eBroadcastBitProgress);
+ EXPECT_TRUE(
+ broadcaster.EventTypeHasListeners(Debugger::eBroadcastBitProgress));
+
+ EventSP event_sp;
+ const ProgressEventData *data;
+
+ // Scope this for RAII on the progress objects
+ // Create progress reports and check that their respective events for having
+ // started are broadcasted
+ {
+ Progress progress1("Progress report 1", "Starting report 1");
+ EXPECT_TRUE(listener_sp->GetEvent(event_sp, timeout));
+
+ data = ProgressEventData::GetEventDataFromEvent(event_sp.get());
+ ASSERT_EQ(data->GetDetails(), "Starting report 1");
+
+ Progress progress2("Progress report 2", "Starting report 2");
+ EXPECT_TRUE(listener_sp->GetEvent(event_sp, timeout));
+
+ data = ProgressEventData::GetEventDataFromEvent(event_sp.get());
+ ASSERT_EQ(data->GetDetails(), "Starting report 2");
+
+ Progress progress3("Progress report 3", "Starting report 3");
+ EXPECT_TRUE(listener_sp->GetEvent(event_sp, timeout));
+ ASSERT_TRUE(event_sp);
+
+ data = ProgressEventData::GetEventDataFromEvent(event_sp.get());
+ ASSERT_EQ(data->GetDetails(), "Starting report 3");
+
+ std::this_thread::sleep_for(timeout);
+ }
+
+ // Progress report objects should be destroyed at this point so
+ // get each report from the queue and check that they've been
+ // destroyed in reverse order
+ std::this_thread::sleep_for(timeout);
+ EXPECT_TRUE(listener_sp->GetEvent(event_sp, timeout));
+ data = ProgressEventData::GetEventDataFromEvent(event_sp.get());
+
+ ASSERT_EQ(data->GetTitle(), "Progress report 3");
+ ASSERT_TRUE(data->GetCompleted());
+
+ std::this_thread::sleep_for(timeout);
+ EXPECT_TRUE(listener_sp->GetEvent(event_sp, timeout));
+ data = ProgressEventData::GetEventDataFromEvent(event_sp.get());
+
+ ASSERT_EQ(data->GetTitle(), "Progress report 2");
+ ASSERT_TRUE(data->GetCompleted());
+
+ std::this_thread::sleep_for(timeout);
+ EXPECT_TRUE(listener_sp->GetEvent(event_sp, timeout));
+ data = ProgressEventData::GetEventDataFromEvent(event_sp.get());
+
+ ASSERT_EQ(data->GetTitle(), "Progress report 1");
+ ASSERT_TRUE(data->GetCompleted());
+}
>From a34bbf5dfe64bcde85a76e447006f3a87d283dbe Mon Sep 17 00:00:00 2001
From: Chelsea Cassanova <chelsea_cassanova at apple.com>
Date: Fri, 26 Jan 2024 11:08:11 -0800
Subject: [PATCH 2/3] Simplify set up, remove timeouts, add license
Uses `SubsystemRAII` to initialize the necessary platform and host
information. Since the debugger cannot be initialized with no
arguments (which is how `SubsystemRAII` will initialize everything), the
debugger will be initialized the usual way. Also removes the thread
timeouts and adds the LLVM license header.
---
lldb/unittests/Core/ProgressReportTest.cpp | 38 ++++++++++------------
1 file changed, 18 insertions(+), 20 deletions(-)
diff --git a/lldb/unittests/Core/ProgressReportTest.cpp b/lldb/unittests/Core/ProgressReportTest.cpp
index bdc168c9e077dd..7d66f45b196895 100644
--- a/lldb/unittests/Core/ProgressReportTest.cpp
+++ b/lldb/unittests/Core/ProgressReportTest.cpp
@@ -1,5 +1,14 @@
+//===-- ProgressReportTest.cpp --------------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
#include "Plugins/Platform/MacOSX/PlatformMacOSX.h"
#include "Plugins/Platform/MacOSX/PlatformRemoteMacOSX.h"
+#include "TestingSupport/SubsystemRAII.h"
#include "lldb/Core/Debugger.h"
#include "lldb/Core/Progress.h"
#include "lldb/Host/FileSystem.h"
@@ -11,23 +20,17 @@
using namespace lldb;
using namespace lldb_private;
-namespace {
class ProgressReportTest : public ::testing::Test {
-public:
- void SetUp() override {
- FileSystem::Initialize();
- HostInfo::Initialize();
- PlatformMacOSX::Initialize();
- Debugger::Initialize(nullptr);
- }
- void TearDown() override {
- Debugger::Terminate();
- PlatformMacOSX::Terminate();
- HostInfo::Terminate();
- FileSystem::Terminate();
- }
+ SubsystemRAII<FileSystem, HostInfo, PlatformMacOSX> subsystems;
+
+ // The debugger's initialization function can't be called with no arguments
+ // so calling it using SubsystemRAII will cause the test build to fail as
+ // SubsystemRAII will call Initialize with no arguments. As such we set it up
+ // here the usual way.
+ void SetUp() override { Debugger::Initialize(nullptr); }
+ void TearDown() override { Debugger::Terminate(); }
};
-} // namespace
+
TEST_F(ProgressReportTest, TestReportCreation) {
std::chrono::milliseconds timeout(100);
@@ -75,28 +78,23 @@ TEST_F(ProgressReportTest, TestReportCreation) {
data = ProgressEventData::GetEventDataFromEvent(event_sp.get());
ASSERT_EQ(data->GetDetails(), "Starting report 3");
-
- std::this_thread::sleep_for(timeout);
}
// Progress report objects should be destroyed at this point so
// get each report from the queue and check that they've been
// destroyed in reverse order
- std::this_thread::sleep_for(timeout);
EXPECT_TRUE(listener_sp->GetEvent(event_sp, timeout));
data = ProgressEventData::GetEventDataFromEvent(event_sp.get());
ASSERT_EQ(data->GetTitle(), "Progress report 3");
ASSERT_TRUE(data->GetCompleted());
- std::this_thread::sleep_for(timeout);
EXPECT_TRUE(listener_sp->GetEvent(event_sp, timeout));
data = ProgressEventData::GetEventDataFromEvent(event_sp.get());
ASSERT_EQ(data->GetTitle(), "Progress report 2");
ASSERT_TRUE(data->GetCompleted());
- std::this_thread::sleep_for(timeout);
EXPECT_TRUE(listener_sp->GetEvent(event_sp, timeout));
data = ProgressEventData::GetEventDataFromEvent(event_sp.get());
>From 3b490d6ef73ccccc7ab3e8e1985a2cb25bb72a2c Mon Sep 17 00:00:00 2001
From: Chelsea Cassanova <chelsea_cassanova at apple.com>
Date: Fri, 26 Jan 2024 15:33:38 -0800
Subject: [PATCH 3/3] Check all events outside of scope, use correct check for
total
Checks that the progress events were received in order of report
creation and deletion outside of the scope that the events were created
in, also checks for more information from the progress event data.
`IsFinite()` from DebuggerEvents would return true if the total was not
UINT64_MAX. Since we no longer use this to specify that an event has no
total this has been changed to check that the total is not 1.
---
lldb/include/lldb/Core/DebuggerEvents.h | 2 +-
lldb/unittests/Core/ProgressReportTest.cpp | 66 ++++++++++++++--------
2 files changed, 45 insertions(+), 23 deletions(-)
diff --git a/lldb/include/lldb/Core/DebuggerEvents.h b/lldb/include/lldb/Core/DebuggerEvents.h
index 4a27766e94e3aa..2c3fcd7069d5e9 100644
--- a/lldb/include/lldb/Core/DebuggerEvents.h
+++ b/lldb/include/lldb/Core/DebuggerEvents.h
@@ -39,7 +39,7 @@ class ProgressEventData : public EventData {
GetAsStructuredData(const Event *event_ptr);
uint64_t GetID() const { return m_id; }
- bool IsFinite() const { return m_total != UINT64_MAX; }
+ bool IsFinite() const { return m_total != 1; }
uint64_t GetCompleted() const { return m_completed; }
uint64_t GetTotal() const { return m_total; }
std::string GetMessage() const {
diff --git a/lldb/unittests/Core/ProgressReportTest.cpp b/lldb/unittests/Core/ProgressReportTest.cpp
index 7d66f45b196895..f62aeda341aced 100644
--- a/lldb/unittests/Core/ProgressReportTest.cpp
+++ b/lldb/unittests/Core/ProgressReportTest.cpp
@@ -21,18 +21,19 @@ using namespace lldb;
using namespace lldb_private;
class ProgressReportTest : public ::testing::Test {
- SubsystemRAII<FileSystem, HostInfo, PlatformMacOSX> subsystems;
-
- // The debugger's initialization function can't be called with no arguments
- // so calling it using SubsystemRAII will cause the test build to fail as
- // SubsystemRAII will call Initialize with no arguments. As such we set it up
- // here the usual way.
- void SetUp() override { Debugger::Initialize(nullptr); }
- void TearDown() override { Debugger::Terminate(); }
+ SubsystemRAII<FileSystem, HostInfo, PlatformMacOSX> subsystems;
+
+ // The debugger's initialization function can't be called with no arguments
+ // so calling it using SubsystemRAII will cause the test build to fail as
+ // SubsystemRAII will call Initialize with no arguments. As such we set it up
+ // here the usual way.
+ void SetUp() override { Debugger::Initialize(nullptr); }
+ void TearDown() override { Debugger::Terminate(); }
};
TEST_F(ProgressReportTest, TestReportCreation) {
std::chrono::milliseconds timeout(100);
+ const unsigned long long NO_TOTAL = 1;
// Set up the debugger, make sure that was done properly
ArchSpec arch("x86_64-apple-macosx-");
@@ -51,7 +52,7 @@ TEST_F(ProgressReportTest, TestReportCreation) {
listener_sp->StartListeningForEvents(&broadcaster,
Debugger::eBroadcastBitProgress);
EXPECT_TRUE(
- broadcaster.EventTypeHasListeners(Debugger::eBroadcastBitProgress));
+ broadcaster.EventTypeHasListeners(Debugger::eBroadcastBitProgress));
EventSP event_sp;
const ProgressEventData *data;
@@ -61,24 +62,39 @@ TEST_F(ProgressReportTest, TestReportCreation) {
// started are broadcasted
{
Progress progress1("Progress report 1", "Starting report 1");
- EXPECT_TRUE(listener_sp->GetEvent(event_sp, timeout));
+ Progress progress2("Progress report 2", "Starting report 2");
+ Progress progress3("Progress report 3", "Starting report 3");
+ }
- data = ProgressEventData::GetEventDataFromEvent(event_sp.get());
- ASSERT_EQ(data->GetDetails(), "Starting report 1");
+ // Start popping events from the queue, they should have been recevied
+ // in this order:
+ // Starting progress: 1, 2, 3
+ // Ending progress: 3, 2, 1
+ EXPECT_TRUE(listener_sp->GetEvent(event_sp, timeout));
+ data = ProgressEventData::GetEventDataFromEvent(event_sp.get());
- Progress progress2("Progress report 2", "Starting report 2");
- EXPECT_TRUE(listener_sp->GetEvent(event_sp, timeout));
+ ASSERT_EQ(data->GetDetails(), "Starting report 1");
+ ASSERT_FALSE(data->IsFinite());
+ ASSERT_FALSE(data->GetCompleted());
+ ASSERT_EQ(data->GetTotal(), NO_TOTAL);
+ ASSERT_EQ(data->GetMessage(), "Progress report 1: Starting report 1");
- data = ProgressEventData::GetEventDataFromEvent(event_sp.get());
- ASSERT_EQ(data->GetDetails(), "Starting report 2");
+ EXPECT_TRUE(listener_sp->GetEvent(event_sp, timeout));
+ data = ProgressEventData::GetEventDataFromEvent(event_sp.get());
- Progress progress3("Progress report 3", "Starting report 3");
- EXPECT_TRUE(listener_sp->GetEvent(event_sp, timeout));
- ASSERT_TRUE(event_sp);
+ ASSERT_EQ(data->GetDetails(), "Starting report 2");
+ ASSERT_FALSE(data->IsFinite());
+ ASSERT_FALSE(data->GetCompleted());
+ ASSERT_EQ(data->GetTotal(), NO_TOTAL);
+ ASSERT_EQ(data->GetMessage(), "Progress report 2: Starting report 2");
- data = ProgressEventData::GetEventDataFromEvent(event_sp.get());
- ASSERT_EQ(data->GetDetails(), "Starting report 3");
- }
+ EXPECT_TRUE(listener_sp->GetEvent(event_sp, timeout));
+ data = ProgressEventData::GetEventDataFromEvent(event_sp.get());
+ ASSERT_EQ(data->GetDetails(), "Starting report 3");
+ ASSERT_FALSE(data->IsFinite());
+ ASSERT_FALSE(data->GetCompleted());
+ ASSERT_EQ(data->GetTotal(), NO_TOTAL);
+ ASSERT_EQ(data->GetMessage(), "Progress report 3: Starting report 3");
// Progress report objects should be destroyed at this point so
// get each report from the queue and check that they've been
@@ -88,16 +104,22 @@ TEST_F(ProgressReportTest, TestReportCreation) {
ASSERT_EQ(data->GetTitle(), "Progress report 3");
ASSERT_TRUE(data->GetCompleted());
+ ASSERT_FALSE(data->IsFinite());
+ ASSERT_EQ(data->GetMessage(), "Progress report 3: Starting report 3");
EXPECT_TRUE(listener_sp->GetEvent(event_sp, timeout));
data = ProgressEventData::GetEventDataFromEvent(event_sp.get());
ASSERT_EQ(data->GetTitle(), "Progress report 2");
ASSERT_TRUE(data->GetCompleted());
+ ASSERT_FALSE(data->IsFinite());
+ ASSERT_EQ(data->GetMessage(), "Progress report 2: Starting report 2");
EXPECT_TRUE(listener_sp->GetEvent(event_sp, timeout));
data = ProgressEventData::GetEventDataFromEvent(event_sp.get());
ASSERT_EQ(data->GetTitle(), "Progress report 1");
ASSERT_TRUE(data->GetCompleted());
+ ASSERT_FALSE(data->IsFinite());
+ ASSERT_EQ(data->GetMessage(), "Progress report 1: Starting report 1");
}
More information about the lldb-commits
mailing list