Files
clang-p2996/lldb/test/API/functionalities/paths/TestPaths.py
Lawrence D'Anna bbef51eb43 [lldb] make it easier to find LLDB's python
It is surprisingly difficult to write a simple python script that
can reliably `import lldb` without failing, or crashing.   I'm
currently resorting to convolutions like this:

    def find_lldb(may_reexec=False):
		if prefix := os.environ.get('LLDB_PYTHON_PREFIX'):
			if os.path.realpath(prefix) != os.path.realpath(sys.prefix):
				raise Exception("cannot import lldb.\n"
					f"  sys.prefix should be: {prefix}\n"
					f"  but it is: {sys.prefix}")
		else:
			line1, line2 = subprocess.run(
				['lldb', '-x', '-b', '-o', 'script print(sys.prefix)'],
				encoding='utf8', stdout=subprocess.PIPE,
				check=True).stdout.strip().splitlines()
			assert line1.strip() == '(lldb) script print(sys.prefix)'
			prefix = line2.strip()
			os.environ['LLDB_PYTHON_PREFIX'] = prefix

		if sys.prefix != prefix:
			if not may_reexec:
				raise Exception(
					"cannot import lldb.\n" +
					f"  This python, at {sys.prefix}\n"
					f"  does not math LLDB's python at {prefix}")
			os.environ['LLDB_PYTHON_PREFIX'] = prefix
			python_exe = os.path.join(prefix, 'bin', 'python3')
			os.execl(python_exe, python_exe, *sys.argv)

		lldb_path = subprocess.run(['lldb', '-P'],
			check=True, stdout=subprocess.PIPE,
				encoding='utf8').stdout.strip()

		sys.path = [lldb_path] + sys.path

This patch aims to replace all that with:

  #!/usr/bin/env lldb-python
  import lldb
  ...

... by adding the following features:

* new command line option: --print-script-interpreter-info.  This
   prints language-specific information about the script interpreter
   in JSON format.

* new tool (unix only): lldb-python which finds python and exec's it.

Reviewed By: JDevlieghere

Differential Revision: https://reviews.llvm.org/D112973
2021-11-10 10:33:34 -08:00

80 lines
3.1 KiB
Python

"""
Test some lldb command abbreviations.
"""
import lldb
import os
import sys
import json
from lldbsuite.test.decorators import *
from lldbsuite.test.lldbtest import *
from lldbsuite.test import lldbutil
from lldbsuite.test import lldbplatformutil
class TestPaths(TestBase):
mydir = TestBase.compute_mydir(__file__)
@no_debug_info_test
def test_paths(self):
'''Test to make sure no file names are set in the lldb.SBFileSpec objects returned by lldb.SBHostOS.GetLLDBPath() for paths that are directories'''
dir_path_types = [lldb.ePathTypeLLDBShlibDir,
lldb.ePathTypeSupportExecutableDir,
lldb.ePathTypeHeaderDir,
lldb.ePathTypePythonDir,
lldb.ePathTypeLLDBSystemPlugins,
lldb.ePathTypeLLDBUserPlugins,
lldb.ePathTypeLLDBTempSystemDir,
lldb.ePathTypeClangDir]
for path_type in dir_path_types:
f = lldb.SBHostOS.GetLLDBPath(path_type)
# No directory path types should have the filename set
self.assertIsNone(f.GetFilename())
shlib_dir = lldb.SBHostOS.GetLLDBPath(lldb.ePathTypeLLDBShlibDir).GetDirectory()
if lldbplatformutil.getHostPlatform() == 'windows':
filenames = ['liblldb.dll']
elif lldbplatformutil.getHostPlatform() == 'darwin':
filenames = ['LLDB', 'liblldb.dylib']
else:
filenames = ['liblldb.so']
self.assertTrue(any([os.path.exists(os.path.join(shlib_dir, f)) for f in
filenames]), "shlib_dir = " + shlib_dir)
@no_debug_info_test
def test_interpreter_info(self):
info_sd = self.dbg.GetScriptInterpreterInfo(self.dbg.GetScriptingLanguage("python"))
self.assertTrue(info_sd.IsValid())
stream = lldb.SBStream()
self.assertTrue(info_sd.GetAsJSON(stream).Success())
info = json.loads(stream.GetData())
prefix = info['prefix']
self.assertEqual(os.path.realpath(sys.prefix), os.path.realpath(prefix))
self.assertEqual(
os.path.realpath(os.path.join(info['lldb-pythonpath'], 'lldb')),
os.path.realpath(os.path.dirname(lldb.__file__)))
self.assertTrue(os.path.exists(info['executable']))
self.assertEqual(info['language'], 'python')
@no_debug_info_test
def test_directory_doesnt_end_with_slash(self):
current_directory_spec = lldb.SBFileSpec(os.path.curdir)
current_directory_string = current_directory_spec.GetDirectory()
self.assertNotEqual(current_directory_string[-1:], '/')
@skipUnlessPlatform(["windows"])
@no_debug_info_test
def test_windows_double_slash(self):
'''Test to check the path with double slash is handled correctly '''
# Create a path and see if lldb gets the directory and file right
fspec = lldb.SBFileSpec("C:\\dummy1\\dummy2//unknown_file", True)
self.assertEqual(
os.path.normpath(
fspec.GetDirectory()),
os.path.normpath("C:/dummy1/dummy2"))
self.assertEqual(fspec.GetFilename(), "unknown_file")