[lldb][test] Add check for Xcode binutils version to test-runner

[Michael137]

Summary

Some tests in LLDB require the use of binutils tools. On Darwin,
we need to use the tools that ship with Xcode. Otherwise we risk
crashing in unpredictable ways.

This patch adds a check for this and bails early if the user has
a non-Xcode binutils in their path before the Xcode ones.

[tschuett]

lldb/packages/Python/lldbsuite/test/dotest.py

889

Did you mean xcrun -f strip?

[Michael137]

lldb/packages/Python/lldbsuite/test/dotest.py

889

yup! good catch

[Michael137]

My preference would be to check explicitly whether the tool is from the xcode toolchain. But the tools dont really have a distinguishable version (in fact the strip from Xcode doesnt have a version commandline flag. Perhaps that’s deliberate and a good way to disambiguate homebrew vs xcode?)

Another option would be to check that homebrew/binutils only appears after xcode in the user path

[aprantl]

Should we put something like

#if DARWIN
STRIP=$(shell xcrun -find strip)
#else
STRIP=strip
#fi

in Makefile.rules instead?

lldb/packages/Python/lldbsuite/test/dotest.py

889

I would use xcrun -find strip for more clarity

lldb/packages/Python/lldbsuite/test/dotest.py

 
 def checkForkVForkSupport():
     from lldbsuite.test import lldbplatformutil
 
     platform = lldbplatformutil.getPlatform()
     if platform not in ["freebsd", "linux", "netbsd"]:
         configuration.skip_categories.append("fork")
 
+def checkDarwinBinutilsPath():
+    from lldbsuite.test import lldbplatformutil
+
+    if not lldbplatformutil.platformIsDarwin():
+        return
+
+    cmd = ["strip", "--version"]
+    process = subprocess.Popen(
+        cmd,
+        stdout=subprocess.PIPE,
+        stderr=subprocess.STDOUT)
+    cmd_output = process.stdout.read()
+    output_str = cmd_output.decode("utf-8")
+    if "GNU strip (GNU Binutils)" in output_str:
+        print("""
+The tool 'strip' in your path is not the one from the Xcode
+toolchain. Please make sure the Xcode tools are before any
+other tools in your path. Run `xcode -f strip` for the correct
+toolchain path.
+Exiting...
+        """)
+        sys.exit(0)
 
 def run_suite():
     # On MacOS X, check to make sure that domain for com.apple.DebugSymbols defaults
     # does not exist before proceeding to running the test suite.
     if sys.platform.startswith("darwin"):
         checkDsymForUUIDIsNotOn()
 
     # Start the actions by first parsing the options while setting up the test
def run_suite():
 
     checkLibcxxSupport()
     checkLibstdcxxSupport()
     checkWatchpointSupport()
     checkDebugInfoSupport()
     checkDebugServerSupport()
     checkObjcSupport()
     checkForkVForkSupport()
+    checkDarwinBinutilsPath()
 
     skipped_categories_list = ", ".join(configuration.skip_categories)
     print("Skipping the following test categories: {}".format(configuration.skip_categories))
 
     for testdir in configuration.testdirs:
         for (dirpath, dirnames, filenames) in os.walk(testdir):
             visit('Test', dirpath, filenames)