[lldb] Use realpath to avoid issues with symlinks in source paths

[aadsm]

Summary

I was not able to sucessfully run TestDSYMSourcePathRemapping.py because the source mapping was using /tmp/ but the debugger was checking /private/tmp (which is a symlink to tmp). Maybe the debugger should realpath on it? Not sure but by making sure our tests always use the real path it avoids these kind of issues.

[clayborg]

Might be a better idea to realpath this once in the setup code instead of calling realpath thousands and thousands of times? Maybe we just santize "LLDB_TEST" and "LLDB_BUILD" one time with top level code like:

os.environ["LLDB_TEST"] = os.path.realpath(os.environ["LLDB_TEST"])
os.environ["LLDB_BUILD"] = os.path.realpath(os.environ["LLDB_BUILD"])

[aadsm]

Solve this at the failing test level. We can't be sure of the filename will end up in the debug info so we just add both keys to the mapping.

lldb/packages/Python/lldbsuite/test/macosx/DBGSourcePathRemapping/TestDSYMSourcePathRemapping.py

def build(self):
         # Create a plist.
         import subprocess
         dsym = self.getBuildArtifact('a.out.dSYM')
         uuid = subprocess.check_output(["/usr/bin/dwarfdump", "--uuid", dsym]
                                       ).decode("utf-8").split(" ")[1]
         import re
         self.assertTrue(re.match(r'[0-9a-fA-F-]+', uuid))
         plist = os.path.join(dsym, 'Contents', 'Resources', uuid + '.plist')
+        botdir_realpath = os.path.realpath(botdir)
         with open(plist, 'w') as f:
             f.write('<?xml version="1.0" encoding="UTF-8"?>\n')
             f.write('<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">\n')
             f.write('<plist version="1.0">\n')
             f.write('<dict>\n')
             f.write('  <key>DBGSourcePathRemapping</key>\n')
             f.write('  <dict>\n')
             f.write('    <key>' + botdir + '</key>\n')
             f.write('    <string>' + userdir + '</string>\n')
+            if botdir_realpath != botdir:
+                f.write('    <key>' + botdir_realpath + '</key>\n')
+                f.write('    <string>' + userdir + '</string>\n')
             f.write('  </dict>\n')
             f.write('</dict>\n')
             f.write('</plist>\n')
 
 
     @skipIf(debug_info=no_match("dsym"))
     def test(self):
         self.build()
 
         target, process, _, _ = lldbutil.run_to_name_breakpoint(
             self, 'main')
         self.expect("source list -n main", substrs=["Hello Absolute"])
         bkpt = target.BreakpointCreateByName('relative')
         lldbutil.continue_to_breakpoint(process, bkpt)
         self.expect("source list -n relative", substrs=["Hello Relative"])