clang-tidy: discover binaries in build dir

[keith]

Summary

This changes the clang-tidy script to discover binaries you've built
locally without having to pass them. This behavior currently depends on
python3, which based on a recent mailing list conversation, sounds like
an ok change.

[keith]

Remove py2 condition

[kastiglione]

I like it, though I'm not sure about the python3 requirement.

clang-tools-extra/clang-tidy/tool/run-clang-tidy.py

140

s/is not valid/could not be found/ ?

also I wonder the message needs both arg and name, wouldn't it be likely that arg contains name?

[keith]

Update failure message

[keith]

As far as the python3 conversation it appears based on this email thread https://lists.llvm.org/pipermail/llvm-dev/2021-January/148229.html and this documentation https://llvm.org/docs/GettingStarted.html#software that python3.6 is now required, so I think this is ok. There might be things relying on this, in which case I assume asking them to upgrade is an acceptable answer at this point.

clang-tools-extra/clang-tidy/tool/run-clang-tidy.py

140

Updated the error message, the original reason I went with something this vague is if the binary exists but isn't executable it will also hit this error, now I've added that to the message as well. I agree the name inclusion was an overoptimization

[kastiglione]

I guess wait until the dust on https://reviews.llvm.org/D101037 settles?

[keith]

Ping, it seems like https://reviews.llvm.org/D101037 is stalled but the docs at this point state py >=3.6 is required for working on llvm so I think we're good here https://llvm.org/docs/GettingStarted.html#software

[keith]

Rebase

clang-tools-extra/clang-tidy/tool/run-clang-tidy.py

-#!/usr/bin/env python
+#!/usr/bin/env python3
 #
 #===- run-clang-tidy.py - Parallel clang-tidy runner --------*- python -*--===#
 #
 # Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 # See https://llvm.org/LICENSE.txt for license information.
 # SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 #
 #===-----------------------------------------------------------------------===#

 
 from __future__ import print_function
 
 import argparse
 import glob
 import json
 import multiprocessing
 import os
+import queue
 import re
 import shutil
 import subprocess
 import sys
 import tempfile
 import threading
 import traceback
 
 try:
   import yaml
 except ImportError:
   yaml = None
 
-is_py2 = sys.version[0] == '2'
-
-if is_py2:
-    import Queue as queue
-else:
-    import queue as queue
-
 
 def find_compilation_database(path):
   """Adjusts the directory until a compilation database is found."""
   result = './'
   while not os.path.isfile(os.path.join(result, path)):
     if os.path.realpath(result) == '/':
       print('Error: could not find compilation database.')
       sys.exit(1)
if merged:
     output = {'MainSourceFile': '', mergekey: merged}
     with open(mergefile, 'w') as out:
       yaml.safe_dump(output, out)
   else:
     # Empty the file:
     open(mergefile, 'w').close()
 
 
-def check_clang_apply_replacements_binary(args):
-  """Checks if invoking supplied clang-apply-replacements binary works."""
-  try:
-    subprocess.check_call([args.clang_apply_replacements_binary, '--version'])
-  except:
-    print('Unable to run clang-apply-replacements. Is clang-apply-replacements '
-          'binary correctly specified?', file=sys.stderr)
-    traceback.print_exc()
-    sys.exit(1)
+
+def find_binary(arg, name, build_path):
+  """Get the path for a binary or exit"""
+  if arg:
+    if shutil.which(arg):
+      return arg
+    else:
+      raise SystemExit(
+        "error: passed binary '{}' was not found or is not executable"
+        .format(arg))
+
+  built_path = os.path.join(build_path, "bin", name)
+  binary = shutil.which(name) or shutil.which(built_path)
+  if binary:
+    return binary
+  else:
+    raise SystemExit(
+      "error: failed to find {} in $PATH or at {}"
+      .format(name, built_path))
 
 
-def apply_fixes(args, tmpdir):
+def apply_fixes(args, clang_apply_replacements_binary, tmpdir):
   """Calls clang-apply-fixes on a given directory."""
-  invocation = [args.clang_apply_replacements_binary]
+  invocation = [clang_apply_replacements_binary]
   if args.format:
     invocation.append('-format')
   if args.style:
     invocation.append('-style=' + args.style)
   invocation.append(tmpdir)
   subprocess.call(invocation)
 
 
-def run_tidy(args, tmpdir, build_path, queue, lock, failed_files):
+def run_tidy(args, clang_tidy_binary, tmpdir, build_path, queue, lock,
+             failed_files):
   """Takes filenames out of queue and runs clang-tidy on them."""
   while True:
     name = queue.get()
-    invocation = get_tidy_invocation(name, args.clang_tidy_binary, args.checks,
+    invocation = get_tidy_invocation(name, clang_tidy_binary, args.checks,
                                      tmpdir, build_path, args.header_filter,
                                      args.allow_enabling_alpha_checkers,
                                      args.extra_arg, args.extra_arg_before,
                                      args.quiet, args.config)
 
     proc = subprocess.Popen(invocation, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
     output, err = proc.communicate()
     if proc.returncode != 0:
       failed_files.append(name)
     with lock:
       sys.stdout.write(' '.join(invocation) + '\n' + output.decode('utf-8'))
       if len(err) > 0:
         sys.stdout.flush()
         sys.stderr.write(err.decode('utf-8'))
     queue.task_done()
 
 
 def main():
   parser = argparse.ArgumentParser(description='Runs clang-tidy over all files '
                                    'in a compilation database. Requires '
                                    'clang-tidy and clang-apply-replacements in '
-                                   '$PATH.')
+                                   '$PATH or in your build directory.')
   parser.add_argument('-allow-enabling-alpha-checkers',
                       action='store_true', help='allow alpha checkers from '
                                                 'clang-analyzer.')
   parser.add_argument('-clang-tidy-binary', metavar='PATH',
-                      default='clang-tidy',
                       help='path to clang-tidy binary')
   parser.add_argument('-clang-apply-replacements-binary', metavar='PATH',
-                      default='clang-apply-replacements',
                       help='path to clang-apply-replacements binary')
   parser.add_argument('-checks', default=None,
                       help='checks filter, when not specified, use clang-tidy '
                       'default')
   parser.add_argument('-config', default=None,
                       help='Specifies a configuration in YAML/JSON format: '
                       '  -config="{Checks: \'*\', '
                       '                       CheckOptions: [{key: x, '
def main():
   db_path = 'compile_commands.json'
 
   if args.build_path is not None:
     build_path = args.build_path
   else:
     # Find our database
     build_path = find_compilation_database(db_path)
 
+  clang_tidy_binary = find_binary(args.clang_tidy_binary, "clang-tidy",
+                                  build_path)
+
+  tmpdir = None
+  if args.fix or (yaml and args.export_fixes):
+    clang_apply_replacements_binary = find_binary(
+      args.clang_apply_replacements_binary, "clang-apply-replacements",
+      build_path)
+    tmpdir = tempfile.mkdtemp()
+
   try:
-    invocation = [args.clang_tidy_binary, '-list-checks']
+    invocation = [clang_tidy_binary, '-list-checks']
     if args.allow_enabling_alpha_checkers:
       invocation.append('-allow-enabling-analyzer-alpha-checkers')
     invocation.append('-p=' + build_path)
     if args.checks:
       invocation.append('-checks=' + args.checks)
     invocation.append('-')
     if args.quiet:
       # Even with -quiet we still want to check if we can call clang-tidy.
def main():
   database = json.load(open(os.path.join(build_path, db_path)))
   files = [make_absolute(entry['file'], entry['directory'])
            for entry in database]
 
   max_task = args.j
   if max_task == 0:
     max_task = multiprocessing.cpu_count()
 
-  tmpdir = None
-  if args.fix or (yaml and args.export_fixes):
-    check_clang_apply_replacements_binary(args)
-    tmpdir = tempfile.mkdtemp()
-
   # Build up a big regexy filter from all command line arguments.
   file_name_re = re.compile('|'.join(args.files))
 
   return_code = 0
   try:
     # Spin up a bunch of tidy-launching threads.
     task_queue = queue.Queue(max_task)
     # List of files with a non-zero return code.
     failed_files = []
     lock = threading.Lock()
     for _ in range(max_task):
       t = threading.Thread(target=run_tidy,
-                           args=(args, tmpdir, build_path, task_queue, lock, failed_files))
+                           args=(args, clang_tidy_binary, tmpdir, build_path,
+                                 task_queue, lock, failed_files))
       t.daemon = True
       t.start()
 
     # Fill the queue with files.
     for name in files:
       if file_name_re.search(name):
         task_queue.put(name)
 
if yaml and args.export_fixes:
     except:
       print('Error exporting fixes.\n', file=sys.stderr)
       traceback.print_exc()
       return_code=1
 
   if args.fix:
     print('Applying fixes ...')
     try:
-      apply_fixes(args, tmpdir)
+      apply_fixes(args, clang_apply_replacements_binary, tmpdir)
     except:
       print('Error applying fixes.\n', file=sys.stderr)
       traceback.print_exc()
       return_code = 1
 
   if tmpdir:
     shutil.rmtree(tmpdir)
   sys.exit(return_code)
 
 
 if __name__ == '__main__':
   main()