#!/usr/bin/env python2.7 # Copyright (c) 2013 - present Facebook, Inc. # All rights reserved. # # This source code is licensed under the BSD style license found in the # LICENSE file in the root directory of this source tree. An additional grant # of patent rights can be found in the PATENTS file in the same directory. from __future__ import absolute_import from __future__ import division from __future__ import print_function from __future__ import unicode_literals import argparse import json import logging import os import shutil import stat import subprocess import sys import tempfile import time import zipfile from inferlib import config, issues, utils DEFAULT_BUCK_OUT = os.path.join(utils.decode(os.getcwd()), 'buck-out') DEFAULT_BUCK_OUT_GEN = os.path.join(DEFAULT_BUCK_OUT, 'gen') INFER_JSON_REPORT = os.path.join(config.BUCK_INFER_OUT, config.JSON_REPORT_FILENAME) INFER_SCRIPT = """\ #!/usr/bin/env {python_executable} import subprocess import sys cmd = {infer_command} + ['--', 'javac'] + sys.argv[1:] subprocess.check_call(cmd) """ def prepare_build(args): """Creates script that redirects javac calls to infer and a local buck configuration that tells buck to use that script. """ infer_options = ['--buck'] if args.java_jar_compiler is not None: infer_options += [ '--java-jar-compiler', args.java_jar_compiler, ] # Create a temporary directory as a cache for jar files. infer_cache_dir = os.path.join(args.infer_out, 'cache') if not os.path.isdir(infer_cache_dir): os.mkdir(infer_cache_dir) infer_options += ['--infer-cache', infer_cache_dir] temp_files = [infer_cache_dir] try: infer_command = [utils.get_cmd_in_bin_dir('infer')] + infer_options except subprocess.CalledProcessError as e: logging.error('Could not find infer') raise e # make sure INFER_ANALYSIS is set when buck is called logging.info('Setup Infer analysis mode for Buck: export INFER_ANALYSIS=1') os.environ['INFER_ANALYSIS'] = '1' # Create a script to be called by buck infer_script = None with tempfile.NamedTemporaryFile(delete=False, prefix='infer_', suffix='.py', dir='.') as infer_script: logging.info('Creating %s' % infer_script.name) infer_script.file.write( utils.encode(INFER_SCRIPT.format( python_executable=sys.executable, infer_command=infer_command))) st = os.stat(infer_script.name) os.chmod(infer_script.name, st.st_mode | stat.S_IEXEC) temp_files += [infer_script.name] return temp_files, infer_script.name def get_normalized_targets(targets): """ Use buck to convert a list of input targets/aliases into a set of the (transitive) target deps for all inputs""" # this expands the targets passed on the command line, then filters away # targets that are not Java/Android. you need to change this if you # care about something other than Java/Android TARGET_TYPES = "kind('android_library|java_library', deps('%s'))" BUCK_GET_JAVA_TARGETS = ['buck', 'query', TARGET_TYPES] buck_cmd = BUCK_GET_JAVA_TARGETS + targets try: targets = filter( lambda line: len(line) > 0, subprocess.check_output(buck_cmd).decode().strip().split('\n')) return targets except subprocess.CalledProcessError as e: logging.error('Error while expanding targets with {0}'.format( buck_cmd)) raise e class NotFoundInJar(Exception): pass def load_json_report(opened_jar): try: return json.loads(opened_jar.read(INFER_JSON_REPORT).decode()) except KeyError: raise NotFoundInJar def get_output_jars(targets): if len(targets) == 0: return [] else: audit_output = subprocess.check_output( ['buck', 'audit', 'classpath'] + targets) classpath_jars = audit_output.strip().split('\n') return filter(os.path.isfile, classpath_jars) def collect_results(args, start_time, targets): """Walks through buck-gen, collects results for the different buck targets and stores them in in args.infer_out/results.csv. """ all_json_rows = set() for path in get_output_jars(targets): try: with zipfile.ZipFile(path) as jar: json_rows = load_json_report(jar) for row in json_rows: all_json_rows.add(json.dumps(row)) except NotFoundInJar: pass except zipfile.BadZipfile: logging.warn('Bad zip file %s', path) json_report = os.path.join(args.infer_out, config.JSON_REPORT_FILENAME) with open(json_report, 'w') as report: json_string = '[' json_string += ','.join(all_json_rows) json_string += ']' report.write(json_string) report.flush() bugs_out = os.path.join(args.infer_out, config.BUGS_FILENAME) issues.print_and_save_errors(args.infer_out, args.project_root, json_report, bugs_out, args.pmd_xml) def cleanup(temp_files): """Removes the temporary infer files. """ for file in temp_files: try: logging.info('Removing %s' % file) if os.path.isdir(file): shutil.rmtree(file) else: os.unlink(file) except IOError: logging.error('Could not remove %s' % file) parser = argparse.ArgumentParser() parser.add_argument('--build-report', metavar='PATH', type=utils.decode) parser.add_argument('--deep', action='store_true') parser.add_argument('--keep-going', action='store_true') parser.add_argument('--load-limit', '-L') parser.add_argument('--no-cache', action='store_true') parser.add_argument('--profile', action='store_true') parser.add_argument('--shallow', action='store_true') parser.add_argument('--num-threads', '-j', metavar='N') parser.add_argument('--verbose', '-v', metavar='N', type=int) parser.add_argument('targets', nargs='*', metavar='target', help='Build targets to analyze') class UnsuportedBuckCommand(Exception): pass def parse_buck_command(args): build_keyword = 'build' if build_keyword in args and len(args[args.index(build_keyword):]) > 1: next_index = args.index(build_keyword) + 1 buck_args = args[next_index:] parsed_args = parser.parse_args(buck_args) base_cmd_without_targets = [p for p in buck_args if p not in parsed_args.targets] buck_build_command = ['buck', build_keyword] if not parsed_args.deep: buck_build_command.append('--deep') base_cmd = buck_build_command + base_cmd_without_targets return base_cmd, parsed_args else: raise UnsuportedBuckCommand(args) class Wrapper: def __init__(self, infer_args, buck_cmd): self.timer = utils.Timer(logging.info) # The reactive mode is not yet supported if infer_args.reactive: sys.stderr.write( 'Reactive is not supported for Java Buck project. Exiting.\n') sys.exit(1) self.infer_args = infer_args self.timer.start('Computing library targets') base_cmd, buck_args = parse_buck_command(buck_cmd) self.buck_args = buck_args self.normalized_targets = get_normalized_targets( buck_args.targets) # write targets to file to avoid passing too many command line args with tempfile.NamedTemporaryFile(delete=False, prefix='targets_') as targets_file: targets_file.write('\n'.join(self.normalized_targets)) self.buck_cmd = base_cmd + ['@%s' % targets_file.name] self.timer.stop('%d targets computed', len(self.normalized_targets)) def _collect_results(self, start_time): self.timer.start('Collecting results ...') collect_results(self.infer_args, start_time, self.normalized_targets) self.timer.stop('Done') def run(self): temp_files = [] start_time = time.time() try: logging.info('Starting the analysis') if not os.path.isdir(self.infer_args.infer_out): os.mkdir(self.infer_args.infer_out) self.timer.start('Preparing build ...') temp_files2, infer_script = prepare_build(self.infer_args) temp_files += temp_files2 self.timer.stop('Build prepared') if len(self.normalized_targets) == 0: logging.info('Nothing to analyze') else: self.timer.start('Running Buck ...') javac_config = [ '--config', 'tools.javac=' + infer_script, '--config', 'client.id=infer.java', '--config', 'java.abi_generation_mode=class'] buck_cmd = self.buck_cmd + javac_config subprocess.check_call(buck_cmd) self.timer.stop('Buck finished') self._collect_results(start_time) return os.EX_OK except KeyboardInterrupt as e: self.timer.stop('Exiting') sys.exit(0) except subprocess.CalledProcessError as e: if self.buck_args.keep_going: print('Buck failed, but continuing the analysis ' 'because --keep-going was passed') self._collect_results(start_time) return os.EX_OK raise e finally: cleanup(temp_files)