mirror-llvm-project/lldb/test/API/macosx/debugserver-multimemread/TestDebugserverMultiMemRead.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

92 lines
3.6 KiB
Python

"""
Tests debugserver support for MultiMemRead.
"""
import lldb
from lldbsuite.test.decorators import *
from lldbsuite.test.lldbtest import *
from lldbsuite.test import lldbutil
@requireDarwin
@skipIfOutOfTreeDebugserver
class TestCase(TestBase):
def check_invalid_packet(self, packet_str):
reply = lldbutil.send_packet_get_reply(self, "packet_str")
self.assertEqual(reply, "E03")
def send_process_packet(self, packet_str):
return lldbutil.send_packet_get_reply(self, packet_str)
def test_packets(self):
self.build()
source_file = lldb.SBFileSpec("main.c")
target, process, thread, bkpt = lldbutil.run_to_source_breakpoint(
self, "break here", source_file
)
capabilities = lldbutil.get_qsupported_capabilities(self)
self.assertIn("MultiMemRead+", capabilities)
mem_address_var = thread.frames[0].FindVariable("memory")
self.assertTrue(mem_address_var)
mem_address = mem_address_var.GetValueAsUnsigned() + 42
# no ":"
self.check_invalid_packet("MultiMemRead")
# missing ranges
self.check_invalid_packet("MultiMemRead:")
# needs at least one range
self.check_invalid_packet("MultiMemRead:ranges:")
# needs at least one range
self.check_invalid_packet("MultiMemRead:ranges:,")
# a range is a pair of numbers
self.check_invalid_packet("MultiMemRead:ranges:10")
# a range is a pair of numbers
self.check_invalid_packet("MultiMemRead:ranges:10,")
# range list must end with ;
self.check_invalid_packet("MultiMemRead:ranges:10,2")
self.check_invalid_packet("MultiMemRead:ranges:10,2,")
self.check_invalid_packet("MultiMemRead:ranges:10,2,3")
# ranges are pairs of numbers.
self.check_invalid_packet("MultiMemRead:ranges:10,2,3;")
# unrecognized field
self.check_invalid_packet("MultiMemRead:ranges:10,2;blah:;")
# unrecognized field
self.check_invalid_packet("MultiMemRead:blah:;ranges:10,2;")
# Zero-length reads are ok.
reply = self.send_process_packet("MultiMemRead:ranges:0,0;")
self.assertEqual(reply, "0;")
# Debugserver is permissive with trailing commas.
reply = self.send_process_packet("MultiMemRead:ranges:10,2,;")
self.assertEqual(reply, "0;")
reply = self.send_process_packet(f"MultiMemRead:ranges:{mem_address:x},2,;")
self.assertEqual(reply, "2;ab")
reply = self.send_process_packet("MultiMemRead:ranges:10,2;")
self.assertEqual(reply, "0;")
reply = self.send_process_packet(f"MultiMemRead:ranges:{mem_address:x},0;")
self.assertEqual(reply, "0;")
reply = self.send_process_packet(f"MultiMemRead:ranges:{mem_address:x},2;")
self.assertEqual(reply, "2;ab")
reply = self.send_process_packet(
f"MultiMemRead:ranges:{mem_address:x},2,{mem_address+2:x},4;"
)
self.assertEqual(reply, "2,4;abcdef")
reply = self.send_process_packet(
f"MultiMemRead:ranges:{mem_address:x},2,{mem_address+2:x},4,{mem_address+6:x},8;"
)
self.assertEqual(reply, "2,4,8;abcdefghijklmn")
# Test zero length in the middle.
reply = self.send_process_packet(
f"MultiMemRead:ranges:{mem_address:x},2,{mem_address+2:x},0,{mem_address+6:x},8;"
)
self.assertEqual(reply, "2,0,8;abghijklmn")
# Test zero length in the end.
reply = self.send_process_packet(
f"MultiMemRead:ranges:{mem_address:x},2,{mem_address+2:x},4,{mem_address+6:x},0;"
)
self.assertEqual(reply, "2,4,0;abcdef")