Be flexible regarding executable extensions. NFC (#25960)

In particular, on windows, when looking for llvm / binaryen / emscripten
entry points allow them to end with the normal set of executable
extensions.

This allows folks use, for example, a clang.bat wrapper around clang and
also allows us to start using `emcc.exe` over `emcc.bat` at some point.
See #24858

The old `exe_suffix` helper still exists but is now moved to the test
framework.

Author: sbc100

test/browser_common.py

@@ -243,7 +243,7 @@ class FirefoxConfig:
   data_dir_flag = '-profile '
   default_flags = ('-new-instance', '-wait-for-browser')
   headless_flags = '-headless'
-  executable_name = utils.exe_suffix('firefox')
+  executable_name = common.exe_suffix('firefox')
 
   @staticmethod
   def configure(data_dir):

test/common.py

@@ -34,6 +34,7 @@
 from tools.shared import DEBUG, EMCC, EMXX, get_canonical_temp_dir
 from tools.utils import (
   WINDOWS,
+  exe_path_from_root,
   exit_with_error,
   path_from_root,
   read_binary,
@@ -77,13 +78,13 @@
 LAST_TEST = path_from_root('out/last_test.txt')
 PREVIOUS_TEST_RUN_RESULTS_FILE = path_from_root('out/previous_test_run_results.json')
 
-WEBIDL_BINDER = utils.bat_suffix(path_from_root('tools/webidl_binder'))
+WEBIDL_BINDER = exe_path_from_root('tools/webidl_binder')
 
-EMBUILDER = utils.bat_suffix(path_from_root('embuilder'))
-EMMAKE = utils.bat_suffix(path_from_root('emmake'))
-EMCMAKE = utils.bat_suffix(path_from_root('emcmake'))
-EMCONFIGURE = utils.bat_suffix(path_from_root('emconfigure'))
-EMRUN = utils.bat_suffix(utils.path_from_root('emrun'))
+EMBUILDER = exe_path_from_root('embuilder')
+EMMAKE = exe_path_from_root('emmake')
+EMCMAKE = exe_path_from_root('emcmake')
+EMCONFIGURE = exe_path_from_root('emconfigure')
+EMRUN = exe_path_from_root('emrun')
 WASM_DIS = os.path.join(building.get_binaryen_bin(), 'wasm-dis')
 LLVM_OBJDUMP = shared.llvm_tool_path('llvm-objdump')
 PYTHON = sys.executable
@@ -127,6 +128,10 @@ def copytree(src, dest):
   shutil.copytree(src, dest, dirs_exist_ok=True)
 
 
+def exe_suffix(cmd):
+  return cmd + '.exe' if WINDOWS else cmd
+
+
 def compiler_for(filename, force_c=False):
   if utils.suffix(filename) in ('.cc', '.cxx', '.cpp') and not force_c:
     return EMXX

test/test_other.py

@@ -48,6 +48,7 @@
   create_file,
   ensure_dir,
   env_modify,
+  exe_path_from_root,
   make_executable,
   path_from_root,
   test_file,
@@ -118,13 +119,13 @@
   write_file,
 )
 
-emmake = utils.bat_suffix(path_from_root('emmake'))
-emconfig = utils.bat_suffix(path_from_root('em-config'))
-emsize = utils.bat_suffix(path_from_root('emsize'))
-empath_split = utils.bat_suffix(path_from_root('empath-split'))
-emprofile = utils.bat_suffix(path_from_root('emprofile'))
-emstrip = utils.bat_suffix(path_from_root('emstrip'))
-emsymbolizer = utils.bat_suffix(path_from_root('emsymbolizer'))
+emmake = exe_path_from_root('emmake')
+emconfig = exe_path_from_root('em-config')
+emsize = exe_path_from_root('emsize')
+empath_split = exe_path_from_root('empath-split')
+emprofile = exe_path_from_root('emprofile')
+emstrip = exe_path_from_root('emstrip')
+emsymbolizer = exe_path_from_root('emsymbolizer')
 
 
 def is_bitcode(filename):

test/test_sanity.py

@@ -19,6 +19,7 @@
   create_file,
   ensure_dir,
   env_modify,
+  exe_suffix,
   make_executable,
   path_from_root,
   test_file,
@@ -101,7 +102,7 @@ def make_fake_clang(filename, version, targets='wasm32 - WebAssembly 32-bit'):
 
 # Return a new PATH that has no directories that would contain the given tool.
 def path_without_tool(env_path, tool_bin):
-  tool_bin = utils.exe_suffix(tool_bin)
+  tool_bin = exe_suffix(tool_bin)
   python_path = os.path.normpath(os.path.dirname(sys.executable))
 
   def ignore_path(p):
@@ -837,8 +838,7 @@ def test_bootstrap(self):
     self.assert_fail([EMCC, test_file('hello_world.c')], expected)
 
     # Running bootstrap.py should fix that
-    bootstrap = shared.bat_suffix(path_from_root('bootstrap'))
-    self.run_process([bootstrap])
+    self.run_process([utils.exe_path_from_root('bootstrap')])
 
     # Now the compiler should work again
     self.run_process([EMCC, test_file('hello_world.c')])
@@ -857,4 +857,4 @@ def test_bootstrap_without_em_config(self):
     env['PATH'] = path_without_tool(env['PATH'], 'clang')
 
     # Running bootstrap.py should not fail
-    self.run_process([shared.bat_suffix(path_from_root('bootstrap'))], env=env)
+    self.run_process([utils.exe_path_from_root('bootstrap')], env=env)

tools/building.py

@@ -1189,7 +1189,7 @@ def get_binaryen_feature_flags():
 
 
 def get_binaryen_version(bindir):
-  opt = os.path.join(bindir, utils.exe_suffix('wasm-opt'))
+  opt = utils.find_exe(bindir, 'wasm-opt')
   if not os.path.exists(opt):
     exit_with_error('binaryen executable not found (%s). Please check your binaryen installation' % opt)
   try:

tools/empath-split.py

@@ -98,7 +98,7 @@ def parse_args():
   if args.preserve_manifest:
     args.verbose = True
   if not args.wasm_split:
-    args.wasm_split = os.path.join(building.get_binaryen_bin(), utils.exe_suffix('wasm-split'))
+    args.wasm_split = utils.find_exe(building.get_binaryen_bin(), 'wasm-split')
 
   if '--manifest' in forwarded_args:
     parser.error('manifest file will be generated by this script and should not be given')

tools/maint/rebaseline_tests.py

@@ -79,7 +79,7 @@ def main():
       print('tree is not clean')
       return 1
 
-    subprocess.check_call([utils.bat_suffix(os.path.join('test', 'runner')), '--rebaseline', 'codesize'], cwd=root_dir)
+    subprocess.check_call([utils.exe_path_from_root('test/runner'), '--rebaseline', 'codesize'], cwd=root_dir)
 
   output = run(['git', 'status', '-uno', '--porcelain'])
   filenames = []

tools/shared.py

@@ -43,7 +43,7 @@
 
 from . import cache, config, diagnostics, filelock, tempfiles, utils
 from .settings import settings
-from .utils import bat_suffix, exit_with_error, memoize, path_from_root, safe_ensure_dirs
+from .utils import exe_path_from_root, exit_with_error, memoize, path_from_root, safe_ensure_dirs
 
 DEBUG_SAVE = DEBUG or int(os.environ.get('EMCC_DEBUG_SAVE', '0'))
 PRINT_SUBPROCS = int(os.getenv('EMCC_VERBOSE', '0'))
@@ -451,7 +451,7 @@ def llvm_tool_path_with_suffix(tool, suffix):
   if suffix:
     tool += '-' + suffix
   llvm_root = os.path.expanduser(config.LLVM_ROOT)
-  return os.path.join(llvm_root, utils.exe_suffix(tool))
+  return utils.find_exe(llvm_root, tool)
 
 
 # Some distributions ship with multiple llvm versions so they add
@@ -644,11 +644,11 @@ def init():
 LLVM_PROFDATA = llvm_tool_path('llvm-profdata')
 LLVM_COV = llvm_tool_path('llvm-cov')
 
-EMCC = bat_suffix(path_from_root('emcc'))
-EMXX = bat_suffix(path_from_root('em++'))
-EMAR = bat_suffix(path_from_root('emar'))
-EMRANLIB = bat_suffix(path_from_root('emranlib'))
-FILE_PACKAGER = bat_suffix(path_from_root('tools/file_packager'))
+EMCC = exe_path_from_root('emcc')
+EMXX = exe_path_from_root('em++')
+EMAR = exe_path_from_root('emar')
+EMRANLIB = exe_path_from_root('emranlib')
+FILE_PACKAGER = exe_path_from_root('tools/file_packager')
 # Windows .dll suffix is not included in this list, since those are never
 # linked to directly on the command line.
 DYLIB_EXTENSIONS = ['.dylib', '.so']

tools/utils.py

@@ -65,17 +65,26 @@ def path_from_root(*pathelems):
   return str(Path(__rootpath__, *pathelems))
 
 
+def exe_path_from_root(*pathelems):
+  return find_exe(path_from_root(*pathelems))
+
+
 def suffix(name):
   """Return the file extension"""
   return os.path.splitext(name)[1]
 
 
-def exe_suffix(cmd):
-  return cmd + '.exe' if WINDOWS else cmd
+def find_exe(*pathelems):
+  path = os.path.join(*pathelems)
 
+  if WINDOWS:
+    # Should we use PATHEXT environment variable here?
+    # For now, specify only enough extensions to find llvm / binaryen / emscripten executables.
+    for ext in ['.exe', '.bat']:
+      if os.path.isfile(path + ext):
+        return path + ext
 
-def bat_suffix(cmd):
-  return cmd + '.bat' if WINDOWS else cmd
+  return path
 
 
 def replace_suffix(filename, new_suffix):