[build] ensure benchmark toolchain tests use the just built libraries (#38158)

The binaries would prefer the dylibs shipped in the OS to the ones just built -- employ `DYLD_LIBRARY_PATH` to pick up the latter instead.

The main purpose of this change is to unblock the generation of nightly
toolchains.

Addresses rdar://79788142

Author: edymtt

utils/build-presets.ini

@@ -1305,9 +1305,6 @@ mixin-preset=
 # SKIP LLDB TESTS (67923799)
 skip-test-lldb
 
-# SKIP testing benchmarks (79788142)
-skip-test-toolchain-benchmarks
-
 [preset: buildbot_osx_package,use_os_runtime]
 mixin-preset=
     buildbot_osx_package

utils/swift_build_support/swift_build_support/products/benchmarks.py

@@ -51,19 +51,31 @@ def build(self, host_target):
     def should_test(self, host_target):
         return self.args.test_toolchainbenchmarks
 
+    def _get_test_environment(self, host_target):
+        if platform.system() == 'Darwin':
+            # the resulting binaries would search first in /usr/lib/swift,
+            # we need to prefer the libraries we just built
+            return {'DYLD_LIBRARY_PATH': os.path.join(
+                _get_toolchain_path(host_target, self, self.args),
+                'usr', 'lib', 'swift', 'macosx')}
+
+        return None
+
     def test(self, host_target):
         """Just run a single instance of the command for both .debug and
            .release.
         """
         cmdline = ['--num-iters=1', 'XorLoop']
+        test_environment = self._get_test_environment(host_target)
+
         bench_Onone = os.path.join(self.build_dir, 'bin', 'Benchmark_Onone')
-        shell.call([bench_Onone] + cmdline)
+        shell.call([bench_Onone] + cmdline, env=test_environment)
 
         bench_O = os.path.join(self.build_dir, 'bin', 'Benchmark_O')
-        shell.call([bench_O] + cmdline)
+        shell.call([bench_O] + cmdline, env=test_environment)
 
         bench_Osize = os.path.join(self.build_dir, 'bin', 'Benchmark_Osize')
-        shell.call([bench_Osize] + cmdline)
+        shell.call([bench_Osize] + cmdline, env=test_environment)
 
     def should_install(self, host_target):
         return False
@@ -85,7 +97,11 @@ def get_dependencies(cls):
                 swiftpm.SwiftPM]
 
 
-def run_build_script_helper(host_target, product, args):
+def _get_toolchain_path(host_target, product, args):
+    # TODO check if we should prefer using product.install_toolchain_path
+    # this logic initially was inside run_build_script_helper
+    # and was factored out so it can be used in testing as well
+
     toolchain_path = swiftpm.SwiftPM.get_install_destdir(args,
                                                          host_target,
                                                          product.build_dir)
@@ -94,6 +110,12 @@ def run_build_script_helper(host_target, product, args):
         toolchain_path += \
             targets.darwin_toolchain_prefix(args.install_prefix)
 
+    return toolchain_path
+
+
+def run_build_script_helper(host_target, product, args):
+    toolchain_path = _get_toolchain_path(host_target, product, args)
+
     # Our source_dir is expected to be './$SOURCE_ROOT/benchmarks'. That is due
     # the assumption that each product is in its own build directory. This
     # product is not like that and has its package/tools instead in