5bb742b10d
This patch introduce a new feature that allows the users to save their debugging session's transcript (commands + outputs) to a file. It differs from the reproducers since it doesn't require to capture a session preemptively and replay the reproducer file in lldb. The user can choose the save its session manually using the session save command or automatically by setting the interpreter.save-session-on-quit on their init file. To do so, the patch adds a Stream object to the CommandInterpreter that will hold the input command from the IOHandler and the CommandReturnObject output and error. This way, that stream object accumulates passively all the interactions throughout the session and will save them to disk on demand. The user can specify a file path where the session's transcript will be saved. However, it is optional, and when it is not provided, lldb will create a temporary file name according to the session date and time. rdar://63347792 Differential Revision: https://reviews.llvm.org/D82155 Signed-off-by: Med Ismail Bennani <medismail.bennani@gmail.com>
75 lines
2.2 KiB
Python
75 lines
2.2 KiB
Python
"""
|
|
Test the session save feature
|
|
"""
|
|
|
|
import lldb
|
|
from lldbsuite.test.decorators import *
|
|
from lldbsuite.test.lldbtest import *
|
|
from lldbsuite.test import lldbutil
|
|
|
|
|
|
class SessionSaveTestCase(TestBase):
|
|
|
|
mydir = TestBase.compute_mydir(__file__)
|
|
|
|
def raw_transcript_builder(self, cmd, res):
|
|
raw = "(lldb) " + cmd + "\n"
|
|
if res.GetOutputSize():
|
|
raw += res.GetOutput()
|
|
if res.GetErrorSize():
|
|
raw += res.GetError()
|
|
return raw
|
|
|
|
|
|
@skipIfWindows
|
|
@skipIfReproducer
|
|
@no_debug_info_test
|
|
def test_session_save(self):
|
|
raw = ""
|
|
interpreter = self.dbg.GetCommandInterpreter()
|
|
|
|
settings = [
|
|
'settings set interpreter.echo-commands true',
|
|
'settings set interpreter.echo-comment-commands true',
|
|
'settings set interpreter.stop-command-source-on-error false'
|
|
]
|
|
|
|
for setting in settings:
|
|
interpreter.HandleCommand(setting, lldb.SBCommandReturnObject())
|
|
|
|
inputs = [
|
|
'# This is a comment', # Comment
|
|
'help session', # Valid command
|
|
'Lorem ipsum' # Invalid command
|
|
]
|
|
|
|
for cmd in inputs:
|
|
res = lldb.SBCommandReturnObject()
|
|
interpreter.HandleCommand(cmd, res)
|
|
raw += self.raw_transcript_builder(cmd, res)
|
|
|
|
self.assertTrue(interpreter.HasCommands())
|
|
self.assertTrue(len(raw) != 0)
|
|
|
|
# Check for error
|
|
cmd = 'session save /root/file'
|
|
interpreter.HandleCommand(cmd, res)
|
|
self.assertFalse(res.Succeeded())
|
|
raw += self.raw_transcript_builder(cmd, res)
|
|
|
|
import tempfile
|
|
tf = tempfile.NamedTemporaryFile()
|
|
output_file = tf.name
|
|
|
|
res = lldb.SBCommandReturnObject()
|
|
interpreter.HandleCommand('session save ' + output_file, res)
|
|
self.assertTrue(res.Succeeded())
|
|
raw += self.raw_transcript_builder(cmd, res)
|
|
|
|
with open(output_file, "r") as file:
|
|
content = file.read()
|
|
# Exclude last line, since session won't record it's own output
|
|
lines = raw.splitlines()[:-1]
|
|
for line in lines:
|
|
self.assertIn(line, content)
|