mirror-llvm-project/lldb/test/API/macosx/find-dsym/deep-bundle/TestDeepBundle.py
Charles Zablit 67a20745d6
[lldb] Introduce the require decorator (#212753)
Currently, it is unclear if a test that is skipped is either:
- Unsupported because it will never run (macosx tests should not run on
Windows).
- Skipped because it's supposed to work but does not yet.
`@expectedFailure` is not always an option because a test might be
timing out and waiting 600s for it to fail is not acceptable.

This patch introduces 2 new decorators to differentiate those tests:
- `@requireX` meaning the tests require X to run (e.g `@requireDarwin`).
- `@requireNotX` meaning the tests requires anything but `X` to run (e.g
`@requireNotDarwin`).

In the tests results summary, this introduces a new category: `skipped`
tests:
- `@requireX` -> `UNSUPPORTED`
- `@skipIfX` -> `SKIPPED`

Here is how they can and cannot be stacked:

This will never run:
```py3
@requireDarwin
@requireWindows
def test():
    ...
```

This will not run on Linux, because `@requireWindows` is not satisfied.
```py3
@requireNotDarwin
@requireWindows
def test():
    ...
```

For "require Darwin or Windows", you need:
```py3
@requirePlatform(["darwin", "windows"])
def test():
    ...
```

For "require Darwin on ARM64 or Windows on ARM64", you need:
```py3
@requireARM64
@requirePlatform(["darwin", "windows"])
def test():
    ...
```

This patch also converts the tests in
`lldb/tests/API/{macosx,linux,windows}` to use these decorators. Patches
to convert the rest of the tests will follow.
2026-08-01 18:03:29 +02:00

89 lines
3 KiB
Python

"""Test that a dSYM can be found when a binary is in a deep bundle with multiple pathname components."""
from time import sleep
import lldb
from lldbsuite.test.decorators import *
from lldbsuite.test.lldbtest import *
from lldbsuite.test import lldbutil
exe_name = "deep-bundle" # must match Makefile
class DeepBundleTestCase(TestBase):
def setUp(self):
TestBase.setUp(self)
self.source = "main.c"
def tearDown(self):
# Destroy process before TestBase.tearDown()
self.dbg.GetSelectedTarget().GetProcess().Destroy()
# Call super's tearDown().
TestBase.tearDown(self)
@skipIfRemote
@requireDarwin
# This test is explicitly a dSYM test, it doesn't need to run for any other config.
@skipIf(debug_info=no_match(["dsym"]))
def test_attach_and_check_dsyms(self):
"""Test attach to binary, see if the framework dSYM is found"""
exe = self.getBuildArtifact(exe_name)
self.build()
# Use a file as a synchronization point between test and inferior.
pid_file_path = lldbutil.append_to_process_working_directory(
self, "token_pid_%d" % (int(os.getpid()))
)
self.addTearDownHook(
lambda: self.run_platform_command("rm %s" % (pid_file_path))
)
popen = self.spawnSubprocess(exe, [self.getBuildDir(), pid_file_path])
# Wait for the inferior to start up, dlopen a bundle, remove the bundle it linked in
pid = lldbutil.wait_for_file_on_target(self, pid_file_path)
# Since the library that was dlopen()'ed is now removed, lldb will need to find the
# binary & dSYM via target.exec-search-paths
settings_str = (
"settings set target.exec-search-paths "
+ self.get_process_working_directory()
+ "/hide.app"
)
self.runCmd(settings_str)
self.runCmd("process attach -p " + str(popen.pid))
target = self.dbg.GetSelectedTarget()
self.assertTrue(
target.IsValid(), "Should have a valid Target after attaching to process"
)
setup_complete = target.FindFirstGlobalVariable("setup_is_complete")
self.assertEqual(
setup_complete.GetValueAsUnsigned(),
1,
"Check that inferior process has completed setup",
)
# Find the bundle module, see if we found the dSYM too (they're both in "hide.app")
i = 0
found_module = False
while i < target.GetNumModules():
mod = target.GetModuleAtIndex(i)
if mod.GetFileSpec().GetFilename() == "MyFramework":
found_module = True
dsym_name = mod.GetSymbolFileSpec().GetFilename()
self.assertEqual(
dsym_name,
"MyFramework",
"Check that we found the dSYM for the bundle that was loaded",
)
i = i + 1
self.assertTrue(
found_module,
"Check that we found the framework loaded in lldb's image list",
)