Author: Chelsea Cassanova Date: 2024-01-31T11:38:54-08:00 New Revision: 51e0d1b707a15dd3b96e0c4f1a29ca4dfc79cda0
URL: https://github.com/llvm/llvm-project/commit/51e0d1b707a15dd3b96e0c4f1a29ca4dfc79cda0 DIFF: https://github.com/llvm/llvm-project/commit/51e0d1b707a15dd3b96e0c4f1a29ca4dfc79cda0.diff LOG: [lldb][progress][NFC] Add unit test for progress reports (#79533) 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 and deletion. Added: lldb/unittests/Core/ProgressReportTest.cpp Modified: lldb/unittests/Core/CMakeLists.txt Removed: ################################################################################ diff --git a/lldb/unittests/Core/CMakeLists.txt b/lldb/unittests/Core/CMakeLists.txt index b3cddd150635b..d40c357e3f463 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 0000000000000..77222560d5702 --- /dev/null +++ b/lldb/unittests/Core/ProgressReportTest.cpp @@ -0,0 +1,124 @@ +//===-- 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" +#include "lldb/Host/HostInfo.h" +#include "lldb/Utility/Listener.h" +#include "gtest/gtest.h" +#include <thread> + +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(); } +}; + +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 and ended are broadcasted. + { + Progress progress1("Progress report 1", "Starting report 1"); + Progress progress2("Progress report 2", "Starting report 2"); + Progress progress3("Progress report 3", "Starting report 3"); + } + + // 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()); + + ASSERT_EQ(data->GetDetails(), "Starting report 1"); + ASSERT_FALSE(data->IsFinite()); + ASSERT_FALSE(data->GetCompleted()); + ASSERT_EQ(data->GetTotal(), Progress::kNonDeterministicTotal); + ASSERT_EQ(data->GetMessage(), "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 2"); + ASSERT_FALSE(data->IsFinite()); + ASSERT_FALSE(data->GetCompleted()); + ASSERT_EQ(data->GetTotal(), Progress::kNonDeterministicTotal); + 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->GetDetails(), "Starting report 3"); + ASSERT_FALSE(data->IsFinite()); + ASSERT_FALSE(data->GetCompleted()); + ASSERT_EQ(data->GetTotal(), Progress::kNonDeterministicTotal); + 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 + // destroyed in reverse order. + 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()); + 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"); +} _______________________________________________ lldb-commits mailing list lldb-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/lldb-commits
