LLDB Debuginfod usage tests (with fixes)

[kevinfrei]

This is a collection of tests for Debuginfod usage inside LLDB, with a fix or two for a couple issues that the tests exposed. I've included documentation for what the tests do as a markdown file that lives with the tests.

[github-actions]

⚠️ C/C++ code formatter, clang-format found issues in your code. ⚠️

You can test this locally with the following command:

git-clang-format --diff 3714f937b835c06c8c32ca4f3f61ba2317db2296 ea496707c03a093a70a746254a3ed81e2d4c3d78 -- lldb/test/API/debuginfod/Normal/main.c lldb/test/API/debuginfod/SplitDWARF/main.c lldb/test/Shell/Debuginfod/Inputs/main.c lldb/source/Plugins/SymbolVendor/ELF/SymbolVendorELF.cpp

View the diff from clang-format here.

diff --git a/lldb/test/API/debuginfod/Normal/main.c b/lldb/test/API/debuginfod/Normal/main.c
index 2cc7e1557f..4c7184609b 100644
--- a/lldb/test/API/debuginfod/Normal/main.c
+++ b/lldb/test/API/debuginfod/Normal/main.c
@@ -4,6 +4,4 @@ int func(int argc, const char *argv[]) {
   return (argc + 1) * (argv[argc][0] + 2);
 }
 
-int main(int argc, const char *argv[]) {
-  return func(0, argv);
-}
+int main(int argc, const char *argv[]) { return func(0, argv); }
diff --git a/lldb/test/API/debuginfod/SplitDWARF/main.c b/lldb/test/API/debuginfod/SplitDWARF/main.c
index 2cc7e1557f..4c7184609b 100644
--- a/lldb/test/API/debuginfod/SplitDWARF/main.c
+++ b/lldb/test/API/debuginfod/SplitDWARF/main.c
@@ -4,6 +4,4 @@ int func(int argc, const char *argv[]) {
   return (argc + 1) * (argv[argc][0] + 2);
 }
 
-int main(int argc, const char *argv[]) {
-  return func(0, argv);
-}
+int main(int argc, const char *argv[]) { return func(0, argv); }
diff --git a/lldb/test/Shell/Debuginfod/Inputs/main.c b/lldb/test/Shell/Debuginfod/Inputs/main.c
index 584eb11072..3a836b363c 100644
--- a/lldb/test/Shell/Debuginfod/Inputs/main.c
+++ b/lldb/test/Shell/Debuginfod/Inputs/main.c
@@ -1,10 +1,6 @@
 // A script to (re)create the .yaml files is in 'make-inputs'. If you make changes
 // you'll need to update the .note.gnu.buildid values in the tests, as the cache names
 
-int func(int argc, const char **argv) {
-  return (argc + 1) * (argv[argc][0] + 2);
-}
+int func(int argc, const char **argv) { return (argc + 1) * (argv[argc][0] + 2); }
 
-int main(int argc, const char *argv[]) {
-  return func(0, argv);
-}
+int main(int argc, const char *argv[]) { return func(0, argv); }

[JDevlieghere]

I'm wondering if shell test are really the best way to test this. For more complex scenarios like are being tested here, we generally prefer [1] API tests because they're more expressive and allow you to build more complicated test binaries with our Makefile system. Things like stripping a binary and generating split DWARF all seems like things that could be done that way, to avoid checking in a (yaml-ized) binary.

Did you consider/evaluate writing API tests for this?

[1] https://lldb.llvm.org/resources/test.html

[kevinfrei]

I'm wondering if shell test are really the best way to test this. For more complex scenarios like are being tested here, we generally prefer [1] API tests because they're more expressive and allow you to build more complicated test binaries with our Makefile system. Things like stripping a binary and generating split DWARF all seems like things that could be done that way, to avoid checking in a (yaml-ized) binary.

Did you consider/evaluate writing API tests for this?

[1] https://lldb.llvm.org/resources/test.html

The next addition (async support) requires API tests, so I figured getting some shell tests in place to do a more "user experience" kind of testing was reasonable, since there will be API-based tests coming. If you feel like moving this stuff to API tests wholesale is the right thing to do, I'm happy to go figure that out next week.

[github-actions]

⚠️ Python code formatter, darker found issues in your code. ⚠️

You can test this locally with the following command:

darker --check --diff -r 3714f937b835c06c8c32ca4f3f61ba2317db2296...ea496707c03a093a70a746254a3ed81e2d4c3d78 lldb/test/API/debuginfod/Normal/TestDebuginfod.py lldb/test/API/debuginfod/SplitDWARF/TestDebuginfodDWP.py lldb/test/Shell/lit.cfg.py

View the diff from darker here.

--- API/debuginfod/Normal/TestDebuginfod.py	2024-03-07 17:36:44.000000 +0000
+++ API/debuginfod/Normal/TestDebuginfod.py	2024-03-07 17:39:39.339233 +0000
@@ -4,27 +4,30 @@
 
 import lldb
 import lldbsuite.test.lldbutil as lldbutil
 from lldbsuite.test.lldbtest import *
 
+
 def getUUID(aoutuuid):
     """
     Pull the 20 byte UUID out of the .note.gnu.build-id section that was dumped
     to a file already, as part of the build.
     """
     import struct
+
     with open(aoutuuid, "rb") as f:
         data = f.read(36)
         if len(data) != 36:
             return None
         header = struct.unpack_from("<4I", data)
         if len(header) != 4:
             return None
         # 4 element 'prefix', 20 bytes of uuid, 3 byte long string, 'GNU':
-        if header[0] != 4 or header[1] != 20 or header[2] != 3 or header[3] != 0x554e47:
+        if header[0] != 4 or header[1] != 20 or header[2] != 3 or header[3] != 0x554E47:
             return None
         return data[16:].hex()
+
 
 def config_test(local_files, uuid, debuginfo, executable):
     """
     Set up a test with local_files[] copied to a particular location
     so that we control which files are, or are not, found in the file system.
@@ -72,10 +75,11 @@
 # 2 - A stripped binary with a corresponding --only-keep-debug symbols file
 # 3 - A split binary with it's corresponding DWP file
 # 4 - A stripped, split binary with an unstripped binary and a DWP file
 # 5 - A stripped, split binary with an --only-keep-debug symbols file and a DWP file
 
+
 class DebugInfodTests(TestBase):
     # No need to try every flavor of debug inf.
     NO_DEBUG_INFO_TESTCASE = True
 
     def test_stuff(self):
@@ -90,13 +94,19 @@
         # Setup the fake DebugInfoD server.
         server_root = config_fake_debuginfod_server(self.uuid, self.dwp, self.debugbin)
 
         # Configure LLDB properly
         self.runCmd("settings set symbols.enable-external-lookup true")
-        self.runCmd("settings set plugin.symbol-locator.debuginfod.cache-path %s/cache" % server_root)
+        self.runCmd(
+            "settings set plugin.symbol-locator.debuginfod.cache-path %s/cache"
+            % server_root
+        )
         self.runCmd("settings clear plugin.symbol-locator.debuginfod.server-urls")
-        cmd = "settings insert-before plugin.symbol-locator.debuginfod.server-urls 0 file://%s" % server_root
+        cmd = (
+            "settings insert-before plugin.symbol-locator.debuginfod.server-urls 0 file://%s"
+            % server_root
+        )
         self.runCmd(cmd)
         print(cmd)
         # Check to see if the symbol file is properly loaded
         self.main_source_file = lldb.SBFileSpec("main.c")
         self.sample_test()
@@ -119,11 +129,14 @@
         addr = loc.GetAddress()
         self.assertTrue(addr and addr.IsValid(), "Loc address is valid")
         line_entry = addr.GetLineEntry()
         self.assertTrue(line_entry and line_entry.IsValid(), "Loc line entry is valid")
         self.assertEqual(line_entry.GetLine(), 18)
-        self.assertEqual(loc.GetLineEntry().GetFileSpec().GetFilename(), self.main_source_file.GetFilename())
+        self.assertEqual(
+            loc.GetLineEntry().GetFileSpec().GetFilename(),
+            self.main_source_file.GetFilename(),
+        )
 
     def sample_test_no_launch(self):
         """Same as above but doesn't launch a process."""
 
         target = self.createTestTarget()
--- API/debuginfod/SplitDWARF/TestDebuginfodDWP.py	2024-03-07 17:36:44.000000 +0000
+++ API/debuginfod/SplitDWARF/TestDebuginfodDWP.py	2024-03-07 17:39:39.375680 +0000
@@ -4,27 +4,30 @@
 
 import lldb
 import lldbsuite.test.lldbutil as lldbutil
 from lldbsuite.test.lldbtest import *
 
+
 def getUUID(aoutuuid):
     """
     Pull the 20 byte UUID out of the .note.gnu.build-id section that was dumped
     to a file already, as part of the build.
     """
     import struct
+
     with open(aoutuuid, "rb") as f:
         data = f.read(36)
         if len(data) != 36:
             return None
         header = struct.unpack_from("<4I", data)
         if len(header) != 4:
             return None
         # 4 element 'prefix', 20 bytes of uuid, 3 byte long string, 'GNU':
-        if header[0] != 4 or header[1] != 20 or header[2] != 3 or header[3] != 0x554e47:
+        if header[0] != 4 or header[1] != 20 or header[2] != 3 or header[3] != 0x554E47:
             return None
         return data[16:].hex()
+
 
 def config_fake_debuginfod_server(uuid, debuginfo, executable):
     """
     Create a file-system 'hosted' debuginfod server for the given UUID.
     Make the filesystem look like:
@@ -35,32 +38,34 @@
     Returns the /tmp/<tmpdir> path
     """
     import os
     import shutil
     import tempfile
+
     tmpdir = tempfile.mkdtemp()
     uuiddir = os.path.join(tmpdir, "buildid", uuid)
     os.makedirs(uuiddir)
     os.makedirs(os.path.join(tmpdir, "cache"))
     # Move the files to the correct location for debuginfod to find
     if debuginfo:
         pass
-        #shutil.move(debuginfo, os.path.join(uuiddir, "debuginfo"))
+        # shutil.move(debuginfo, os.path.join(uuiddir, "debuginfo"))
 
     if executable:
         pass
-        #shutil.move(executable, os.path.join(uuiddir, "executable"))
+        # shutil.move(executable, os.path.join(uuiddir, "executable"))
 
     return tmpdir
 
 
 # Need to test 5 different scenarios:
 # 1 - A stripped binary with it's corresponding unstripped binary:
 # 2 - A stripped binary with a corresponding --only-keep-debug symbols file
 # 3 - A split binary with it's corresponding DWP file
 # 4 - A stripped, split binary with an unstripped binary and a DWP file
 # 5 - A stripped, split binary with an --only-keep-debug symbols file and a DWP file
+
 
 class DebugInfodTests(TestBase):
     # No need to try every flavor of debug inf.
     NO_DEBUG_INFO_TESTCASE = True
 
@@ -76,13 +81,19 @@
         # Setup the fake DebugInfoD server.
         server_root = config_fake_debuginfod_server(self.uuid, self.dwp, self.debugbin)
 
         # Configure LLDB properly
         self.runCmd("settings set symbols.enable-external-lookup true")
-        self.runCmd("settings set plugin.symbol-locator.debuginfod.cache-path %s/cache" % server_root)
+        self.runCmd(
+            "settings set plugin.symbol-locator.debuginfod.cache-path %s/cache"
+            % server_root
+        )
         self.runCmd("settings clear plugin.symbol-locator.debuginfod.server-urls")
-        cmd = "settings insert-before plugin.symbol-locator.debuginfod.server-urls 0 file://%s" % server_root
+        cmd = (
+            "settings insert-before plugin.symbol-locator.debuginfod.server-urls 0 file://%s"
+            % server_root
+        )
         self.runCmd(cmd)
         print(cmd)
         # Check to see if the symbol file is properly loaded
         self.main_source_file = lldb.SBFileSpec("main.c")
         self.sample_test()
@@ -105,11 +116,14 @@
         addr = loc.GetAddress()
         self.assertTrue(addr and addr.IsValid(), "Loc address is valid")
         line_entry = addr.GetLineEntry()
         self.assertTrue(line_entry and line_entry.IsValid(), "Loc line entry is valid")
         self.assertEqual(line_entry.GetLine(), 18)
-        self.assertEqual(loc.GetLineEntry().GetFileSpec().GetFilename(), self.main_source_file.GetFilename())
+        self.assertEqual(
+            loc.GetLineEntry().GetFileSpec().GetFilename(),
+            self.main_source_file.GetFilename(),
+        )
 
     def sample_test_no_launch(self):
         """Same as above but doesn't launch a process."""
 
         target = self.createTestTarget()