src/llvm-project/lldb/test/API/functionalities/paths/TestPaths.py

"""
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):
    @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() == "macosx":
            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.assertSuccess(info_sd.GetAsJSON(stream))
        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")