run-clang-tidy: Report progress

[kfunk]

Summary

run-clang-tidy will now report the number of processed files as well as
the total number in the queue:

Example output:

[1/22] Running: clang-tidy -header-filter=^./.* -p=. .../src/icemon/src/fakemonitor.cc
[2/22] Running: clang-tidy -header-filter=^./.* -p=. .../src/icemon/src/hostinfo.cc
[3/22] Running: clang-tidy -header-filter=^./.* -p=. .../src/icemon/src/icecreammonitor.cc
[4/22] Running: clang-tidy -header-filter=^./.* -p=. .../src/icemon/src/job.cc

[Eugene.Zelenko]

I think will be good idea to introduce command line option to control progress display: turn it off, show in absolute numbers or percents.

[kfunk]

In D37479#861580, @Eugene.Zelenko wrote:

I think will be good idea to introduce command line option to control progress display: turn it off, show in absolute numbers or percents.

Honestly, I don't think this configurability is necessary. I'd like to keep that script here as simple as possible.

I'll wait for some more opinions.

[Eugene.Zelenko]

It'll be also nice to output progress in terminal when all messages will saved into file.

[alexfh]

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

155

1. Can we have these messages printed on the same line when run in a terminal? Progress display is better when it doesn't fill the whole terminal scrollback. Changing '\n' to '\r' should be a good start, but we also need to insure reasonable interaction with other messages.

2. The whole invocation may be quite a large line. Maybe just print the filename? (the rest would be repeated anyway)

[Eugene.Zelenko]

I think CMake output is good model for run-clang-tidy.

[florian.berchtold]

This looks like a cool feature, why is it blocked?

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

def apply_fixes(args, tmpdir):
   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):
+def run_tidy(args, tmpdir, build_path, total_file_count, queue):
   """Takes filenames out of queue and runs clang-tidy on them."""
   while True:
-    name = queue.get()
+    index, name = queue.get()
     invocation = get_tidy_invocation(name, args.clang_tidy_binary, args.checks,
                                      tmpdir, build_path, args.header_filter,
                                      args.extra_arg, args.extra_arg_before,
                                      args.quiet)
-    sys.stdout.write(' '.join(invocation) + '\n')
+    sys.stdout.write('[%s/%s] Running: %s' % (index+1, total_file_count, ' '.join(invocation) + '\n'))
     subprocess.call(invocation)
     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 '
def main():
   # Build up a big regexy filter from all command line arguments.
   file_name_re = re.compile('|'.join(args.files))
 
   try:
     # Spin up a bunch of tidy-launching threads.
     task_queue = queue.Queue(max_task)
     for _ in range(max_task):
       t = threading.Thread(target=run_tidy,
-                           args=(args, tmpdir, build_path, task_queue))
+                           args=(args, tmpdir, build_path, len(files), task_queue))
       t.daemon = True
       t.start()
 
     # Fill the queue with files.
+    index = 0
     for name in files:
       if file_name_re.search(name):
-        task_queue.put(name)
+        task_queue.put((index, name))
+        index += 1
 
     # Wait for all threads to be done.
     task_queue.join()
 
   except KeyboardInterrupt:
     # This is a sad hack. Unfortunately subprocess goes
     # bonkers with ctrl-c and we start forking merrily.
     print('\nCtrl-C detected, goodbye.')