caio/clang-p2996
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add AllowRepeats to SBCommandInterpreterRunOptions. (#94786)

Browse Source 
This is useful if you have a transcript of a user session and want to
rerun those commands with RunCommandInterpreter. The same functionality
is also useful in testing.

I'm adding it primarily for the second reason. In a subsequent patch,
I'm adding the ability to Python based commands to provide their
"auto-repeat" command. Among other things, that will allow potentially
state destroying user commands to prevent auto-repeat. Testing this with
Shell or pexpect tests is not nearly as accurate or convenient as using
RunCommandInterpreter, but to use that I need to allow auto-repeat.

I think for consistency's sake, having interactive sessions always do
auto-repeats is the right choice, though that's a lightly held
opinion...
This commit is contained in:
jimingham
2024-06-07 17:05:29 -07:00
committed by GitHub
parent c8eff8788f
commit 435dd97461
6 changed files with 98 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

59
lldb/test/API/python_api/interpreter/TestRunCommandInterpreterAPI.py
View File

@@ -47,28 +47,66 @@ class CommandRunInterpreterAPICase(TestBase):
TestBase.setUp(self)
self.stdin_path = self.getBuildArtifact("stdin.txt")
self.stdout_path = self.getBuildArtifact("stdout.txt")
def run_commands_string(
self, command_string, options=lldb.SBCommandInterpreterRunOptions()
):
"""Run the commands in command_string through RunCommandInterpreter.
Returns (n_errors, quit_requested, has_crashed, result_string)."""
with open(self.stdin_path, "w") as input_handle:
input_handle.write("nonexistingcommand\nquit")
input_handle.write(command_string)
self.dbg.SetInputFile(open(self.stdin_path, "r"))
n_errors = 0
quit_requested = False
has_crashed = False
# No need to track the output
devnull = open(os.devnull, "w")
self.dbg.SetOutputFile(devnull)
self.dbg.SetErrorFile(devnull)
with open(self.stdin_path, "r") as in_fileH, open(
self.stdout_path, "w"
) as out_fileH:
self.dbg.SetInputFile(in_fileH)
self.dbg.SetOutputFile(out_fileH)
self.dbg.SetErrorFile(out_fileH)
n_errors, quit_requested, has_crashed = self.dbg.RunCommandInterpreter(
True, False, options, 0, False, False
)
result_string = None
with open(self.stdout_path, "r") as out_fileH:
result_string = out_fileH.read()
return (n_errors, quit_requested, has_crashed, result_string)
def test_run_session_with_error_and_quit(self):
"""Run non-existing and quit command returns appropriate values"""
n_errors, quit_requested, has_crashed = self.dbg.RunCommandInterpreter(
True, False, lldb.SBCommandInterpreterRunOptions(), 0, False, False
n_errors, quit_requested, has_crashed, _ = self.run_commands_string(
"nonexistingcommand\nquit\n"
)
self.assertGreater(n_errors, 0)
self.assertTrue(quit_requested)
self.assertFalse(has_crashed)
def test_allow_repeat(self):
"""Try auto-repeat of process launch - the command will fail and
the auto-repeat will fail because of no auto-repeat."""
options = lldb.SBCommandInterpreterRunOptions()
options.SetEchoCommands(False)
options.SetAllowRepeats(True)
n_errors, quit_requested, has_crashed, result_str = self.run_commands_string(
"process launch\n\n", options
)
self.assertEqual(n_errors, 2)
self.assertFalse(quit_requested)
self.assertFalse(has_crashed)
self.assertIn("invalid target", result_str)
self.assertIn("No auto repeat", result_str)
class SBCommandInterpreterRunOptionsCase(TestBase):
NO_DEBUG_INFO_TESTCASE = True
@@ -86,6 +124,7 @@ class SBCommandInterpreterRunOptionsCase(TestBase):
self.assertTrue(opts.GetPrintResults())
self.assertTrue(opts.GetPrintErrors())
self.assertTrue(opts.GetAddToHistory())
self.assertFalse(opts.GetAllowRepeats())
# Invert values
opts.SetStopOnContinue(not opts.GetStopOnContinue())
@@ -95,6 +134,7 @@ class SBCommandInterpreterRunOptionsCase(TestBase):
opts.SetPrintResults(not opts.GetPrintResults())
opts.SetPrintErrors(not opts.GetPrintErrors())
opts.SetAddToHistory(not opts.GetAddToHistory())
opts.SetAllowRepeats(not opts.GetAllowRepeats())
# Check the value changed
self.assertTrue(opts.GetStopOnContinue())
@@ -104,3 +144,4 @@ class SBCommandInterpreterRunOptionsCase(TestBase):
self.assertFalse(opts.GetPrintResults())
self.assertFalse(opts.GetPrintErrors())
self.assertFalse(opts.GetAddToHistory())
self.assertTrue(opts.GetAllowRepeats())