Allow manual specification of the binary directory in check_clang_tidy.py

[zturner]

Summary

When you run the script from lit it starts in the right directory so it can find FileCheck and clang-tidy, but when you manually run check-clang-tidy.py from a command line it doesn't work unless you put yourself in the bin directory beforehand. This isn't always convenient, so allow specifying the bin directory as an option to check_clang_tidy.py

[alexfh]

Why is this change needed? What exactly doesn't work without it? I think, lit should take care of setting paths or changing directories appropriately.

test/clang-tidy/check_clang_tidy.py

check_clang_tidy.py [-resource-dir <resource-dir>] \
     <source-file> <check-name> <temp-file> \
     -- [optional clang-tidy arguments]
 
 Example:
   // RUN: %check_clang_tidy %s llvm-include-order %t -- -- -isystem %S/Inputs
 """
 
 import argparse
+import os
 import re
 import subprocess
 import sys
 
 
 def write_file(file_name, text):
   with open(file_name, 'w') as f:
     f.write(text)
     f.truncate()
 
 def main():
   parser = argparse.ArgumentParser()
   parser.add_argument('-resource-dir')
   parser.add_argument('input_file_name')
   parser.add_argument('check_name')
   parser.add_argument('temp_file_name')
+  parser.add_argument('--bin-dir', '-b', default='.', help='Directory containing clang-tidy and FileCheck executables')
 
   args, extra_args = parser.parse_known_args()
 
   resource_dir = args.resource_dir
   input_file_name = args.input_file_name
   check_name = args.check_name
   temp_file_name = args.temp_file_name
+  bin_dir = args.bin_dir
 
   extension = '.cpp'
   if (input_file_name.endswith('.c')):
     extension = '.c'
   if (input_file_name.endswith('.hpp')):
     extension = '.hpp'
   temp_file_name = temp_file_name + extension
 
def main():
   # checks.
   cleaned_test = re.sub('// *CHECK-[A-Z-]*:[^\r\n]*', '//', input_text)
 
   write_file(temp_file_name, cleaned_test)
 
   original_file_name = temp_file_name + ".orig"
   write_file(original_file_name, cleaned_test)
 
-  args = ['clang-tidy', temp_file_name, '-fix', '--checks=-*,' + check_name] + \
+  executable = os.path.join(bin_dir, 'clang-tidy')
+  args = [executable, temp_file_name, '-fix', '--checks=-*,' + check_name] + \
         clang_tidy_extra_args
   print('Running ' + repr(args) + '...')
   try:
     clang_tidy_output = \
         subprocess.check_output(args, stderr=subprocess.STDOUT).decode()
   except subprocess.CalledProcessError as e:
     print('clang-tidy failed:\n' + e.output.decode())
     raise
 
   print('------------------------ clang-tidy output -----------------------\n' +
         clang_tidy_output +
         '\n------------------------------------------------------------------')
 
   try:
     diff_output = subprocess.check_output(
         ['diff', '-u', original_file_name, temp_file_name],
         stderr=subprocess.STDOUT)
   except subprocess.CalledProcessError as e:
     diff_output = e.output
 
   print('------------------------------ Fixes -----------------------------\n' +
         diff_output.decode() +
         '\n------------------------------------------------------------------')
 
+  file_check_exe = os.path.join(bin_dir, 'FileCheck')
   if has_check_fixes:
     try:
       subprocess.check_output(
-          ['FileCheck', '-input-file=' + temp_file_name, input_file_name,
+          [file_check_exe, '-input-file=' + temp_file_name, input_file_name,
            '-check-prefix=CHECK-FIXES', '-strict-whitespace'],
           stderr=subprocess.STDOUT)
     except subprocess.CalledProcessError as e:
       print('FileCheck failed:\n' + e.output.decode())
       raise
 
   if has_check_messages:
     messages_file = temp_file_name + '.msg'
     write_file(messages_file, clang_tidy_output)
     try:
       subprocess.check_output(
-          ['FileCheck', '-input-file=' + messages_file, input_file_name,
+          [file_check_exe, '-input-file=' + messages_file, input_file_name,
            '-check-prefix=CHECK-MESSAGES',
            '-implicit-check-not={{warning|error}}:'],
           stderr=subprocess.STDOUT)
     except subprocess.CalledProcessError as e:
       print('FileCheck failed:\n' + e.output.decode())
       raise
 
 if __name__ == '__main__':
   main()