[lldb/test] Do a better job at setting (DY)LD_LIBRARY_PATH

[labath]

Summary

registerSharedLibrariesWithTarget was setting the library path
environment variable to the process build directory, but the function is
also accepting libraries in other directories (in which case they won't
be found automatically).

This patch makes the function set the path variable correctly for these
libraries too. This enables us to remove the code for setting the path
variable in TestWeakSymbols.py, which was working only accidentally --
it was relying on the fact that

launch_info.SetEnvironmentEntries(..., append=True)

would not overwrite the path variable it has set, but that is going to
change with D83306.

[labath]

Any thoughts on this? It should fix the failures from D83306...

[friss]

The lldbtest.py part LGTM, but I'm failing to see how this interacts with TestWeakSymbols.py? IIRC, registerSharedLibraryWithTarget is an API we call explicitly in the tests, but I don't see it called here.

[labath]

In D83552#2162555, @friss wrote:

The lldbtest.py part LGTM, but I'm failing to see how this interacts with TestWeakSymbols.py? IIRC, registerSharedLibraryWithTarget is an API we call explicitly in the tests, but I don't see it called here.

It gets called from run_to_source_breakpoint, keying off of the extra_images argument.

[friss]

In D83552#2162782, @labath wrote:

In D83552#2162555, @friss wrote:

The lldbtest.py part LGTM, but I'm failing to see how this interacts with TestWeakSymbols.py? IIRC, registerSharedLibraryWithTarget is an API we call explicitly in the tests, but I don't see it called here.

It gets called from run_to_source_breakpoint, keying off of the extra_images argument.

Which I added... Thanks!

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

def registerSharedLibrariesWithTarget(self, target, shlibs):
         '''
         if not shlibs or not self.platformContext:
             return None
 
         shlib_environment_var = self.platformContext.shlib_environment_var
         shlib_prefix = self.platformContext.shlib_prefix
         shlib_extension = '.' + self.platformContext.shlib_extension
 
-        working_dir = self.get_process_working_directory()
-        environment = ['%s=%s' % (shlib_environment_var, working_dir)]
+        dirs = []
         # Add any shared libraries to our target if remote so they get
         # uploaded into the working directory on the remote side
         for name in shlibs:
             # The path can be a full path to a shared library, or a make file name like "Foo" for
             # "libFoo.dylib" or "libFoo.so", or "Foo.so" for "Foo.so" or "libFoo.so", or just a
             # basename like "libFoo.so". So figure out which one it is and resolve the local copy
             # of the shared library accordingly
             if os.path.isfile(name):
                 local_shlib_path = name  # name is the full path to the local shared library
             else:
                 # Check relative names
                 local_shlib_path = os.path.join(
                     self.getBuildDir(), shlib_prefix + name + shlib_extension)
                 if not os.path.exists(local_shlib_path):
                     local_shlib_path = os.path.join(
                         self.getBuildDir(), name + shlib_extension)
                     if not os.path.exists(local_shlib_path):
                         local_shlib_path = os.path.join(self.getBuildDir(), name)
 
                 # Make sure we found the local shared library in the above code
                 self.assertTrue(os.path.exists(local_shlib_path))
 
+
             # Add the shared library to our target
             shlib_module = target.AddModule(local_shlib_path, None, None, None)
             if lldb.remote_platform:
                 # We must set the remote install location if we want the shared library
                 # to get uploaded to the remote target
                 remote_shlib_path = lldbutil.append_to_process_working_directory(self,
                     os.path.basename(local_shlib_path))
                 shlib_module.SetRemoteInstallFileSpec(
                     lldb.SBFileSpec(remote_shlib_path, False))
+                dir_to_add = self.get_process_working_directory()
+            else:
+                dir_to_add = os.path.dirname(local_shlib_path)
+
+            if dir_to_add not in dirs:
+                dirs.append(dir_to_add)
 
-        return environment
+        env_value = self.platformContext.shlib_path_separator.join(dirs)
+        return ['%s=%s' % (shlib_environment_var, env_value)]
 
     def registerSanitizerLibrariesWithTarget(self, target):
         runtimes = []
         for m in target.module_iter():
             libspec = m.GetFileSpec()
             if "clang_rt" in libspec.GetFilename():
                 runtimes.append(os.path.join(libspec.GetDirectory(),
                                              libspec.GetFilename()))

lldb/test/API/commands/expression/weak_symbols/TestWeakSymbols.py

def run_weak_var_check (self, weak_varname, present):
         self.assertEqual(value.GetValueAsSigned(), correct_value, "Didn't change present_weak_int correctly.")
         
     def do_test(self):
         hidden_dir = os.path.join(self.getBuildDir(), "hidden")
         hidden_dylib = os.path.join(hidden_dir, "libdylib.dylib")
 
         launch_info = lldb.SBLaunchInfo(None)
         launch_info.SetWorkingDirectory(self.getBuildDir())
-        # We have to point to the hidden directory to pick up the
-        # version of the dylib without the weak symbols:
-        env_expr = self.platformContext.shlib_environment_var + "=" + hidden_dir
-        launch_info.SetEnvironmentEntries([env_expr], True)
 
         (self.target, _, thread, _) = lldbutil.run_to_source_breakpoint(
                                               self, "Set a breakpoint here",
                                               self.main_source_file,
                                               launch_info = launch_info,
                                               extra_images = [hidden_dylib])
         # First we have to import the Dylib module so we get the type info
         # for the weak symbol.  We need to add the source dir to the module