mirror-llvm-project/lldb/test/API/windows/thread/TestThreadName.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

39 lines
1.2 KiB
Python

"""
Test that lldb reports the Windows thread description set via SetThreadDescription.
"""
import lldb
from lldbsuite.test.decorators import *
from lldbsuite.test.lldbtest import *
from lldbsuite.test import lldbutil
class TestThreadName(TestBase):
@requireWindows
@skipIfWindows(windows_version=["<", "10.0.14393"])
def test_with_thread_description(self):
"""SBThread.GetName() reflects SetThreadDescription on Windows."""
self.build()
source = lldb.SBFileSpec("main.c")
_, process, thread, breakpoint = lldbutil.run_to_source_breakpoint(
self, "// break here", source
)
self.assertEqual(
breakpoint.GetNumLocations(),
2,
"expected breakpoints at both '// break here' markers",
)
# No thread name yet.
self.assertFalse(
thread.GetName(),
"thread should have no name before SetThreadDescription",
)
process.Continue()
self.assertEqual(process.GetState(), lldb.eStateStopped)
thread = lldbutil.get_stopped_thread(process, lldb.eStopReasonBreakpoint)
self.assertTrue(thread.IsValid(), "no thread stopped at breakpoint")
self.assertEqual(thread.GetName(), "ThreadName")