[lldb][unittest] Add call_once flag to initialize debugger

[chelcassanova]

I tried adding a new unit test to the core test
suite (#79533) but it broke the test suite on AArch64 Linux due to hitting an assertion for calling Debugger::Initialize more than once. When the unit test suite is invoked as a standalone binary the test suite state is shared, and Debugger::Initialize gets called in DiagnosticEventTest.cpp before being called in ProgressReportTest.cpp.

DiagnosticEventTest.cpp uses a call_once flag to initialize the debugger but it's local to that test. This commit adds a once_flag to TestUtilities so that Debugger::Initialize can be called once by the tests that use it.

[llvmbot]

@llvm/pr-subscribers-lldb

Author: Chelsea Cassanova (chelcassanova)

Changes

I tried adding a new unit test to the core test
suite (#79533) but it broke the test suite on AArch64 Linux due to hitting an assertion for calling Debugger::Initialize more than once. When the unit test suite is invoked as a standalone binary the test suite state is shared, and Debugger::Initialize gets called in DiagnosticEventTest.cpp before being called in ProgressReportTest.cpp.

DiagnosticEventTest.cpp uses a call_once flag to initialize the debugger but it's local to that test. This commit adds a once_flag to TestUtilities so that Debugger::Initialize can be called once by the tests that use it.

---

Full diff: https://github.com/llvm/llvm-project/pull/80786.diff

2 Files Affected:

• (modified) lldb/unittests/TestingSupport/TestUtilities.cpp (+1)
• (modified) lldb/unittests/TestingSupport/TestUtilities.h (+6-1)

diff --git a/lldb/unittests/TestingSupport/TestUtilities.cpp b/lldb/unittests/TestingSupport/TestUtilities.cpp
index 9e5523e487547..507241404c08d 100644
--- a/lldb/unittests/TestingSupport/TestUtilities.cpp
+++ b/lldb/unittests/TestingSupport/TestUtilities.cpp
@@ -19,6 +19,7 @@ using namespace lldb_private;
 
 extern const char *TestMainArgv0;
 
+std::once_flag TestUtilities::debugger_initialize_flag;
 std::string lldb_private::GetInputFilePath(const llvm::Twine &name) {
   llvm::SmallString<128> result = llvm::sys::path::parent_path(TestMainArgv0);
   llvm::sys::fs::make_absolute(result);
diff --git a/lldb/unittests/TestingSupport/TestUtilities.h b/lldb/unittests/TestingSupport/TestUtilities.h
index 811c4c1521269..99e569bfa5250 100644
--- a/lldb/unittests/TestingSupport/TestUtilities.h
+++ b/lldb/unittests/TestingSupport/TestUtilities.h
@@ -31,6 +31,11 @@
 namespace lldb_private {
 std::string GetInputFilePath(const llvm::Twine &name);
 
+class TestUtilities {
+  public:
+    static std::once_flag debugger_initialize_flag;
+};
+
 class TestFile {
 public:
   static llvm::Expected<TestFile> fromYaml(llvm::StringRef Yaml);
@@ -51,6 +56,6 @@ class TestFile {
 
   std::string Buffer;
 };
-}
+} // namespace lldb_private
 
 #endif

[github-actions]

✅ With the latest revision this PR passed the C/C++ code formatter.

[jasonmolenda]

Did you mean to include changes to DiagnosticEventTest.cpp and ProgressReportTest.cpp to use this new global?

[chelcassanova]

I did, I'm adding them as separate patches. DiagnosticEventTest.cpp could probably go here since it's a simple change but ProgressEventTest doesn't exist upstream yet since I had to revert it so I think that at least should be it's own PR.

[jasonmolenda]

LGTM.