build/android/gyp/lint.py

   1 #!/usr/bin/env python
   2 #
   3 # Copyright (c) 2013 The Chromium Authors. All rights reserved.
   4 # Use of this source code is governed by a BSD-style license that can be
   5 # found in the LICENSE file.
   6
   7 """Runs Android's lint tool."""
   8
   9
  10 import optparse
  11 import os
  12 import sys
  13 from xml.dom import minidom
  14
  15 from util import build_utils
  16
  17
  18 _SRC_ROOT = os.path.abspath(os.path.join(os.path.dirname(__file__),
  19                                          '..', '..', '..'))
  20
  21
  22 def _RunLint(lint_path, config_path, processed_config_path, manifest_path,
  23              result_path, product_dir, sources, jar_path):
  24
  25   def _RelativizePath(path):
  26     """Returns relative path to top-level src dir.
  27
  28     Args:
  29       path: A path relative to cwd.
  30     """
  31     return os.path.relpath(os.path.abspath(path), _SRC_ROOT)
  32
  33   def _ProcessConfigFile():
  34     if not build_utils.IsTimeStale(processed_config_path, [config_path]):
  35       return
  36
  37     with open(config_path, 'rb') as f:
  38       content = f.read().replace(
  39           'PRODUCT_DIR', _RelativizePath(product_dir))
  40
  41     with open(processed_config_path, 'wb') as f:
  42       f.write(content)
  43
  44   def _ProcessResultFile():
  45     with open(result_path, 'rb') as f:
  46       content = f.read().replace(
  47           _RelativizePath(product_dir), 'PRODUCT_DIR')
  48
  49     with open(result_path, 'wb') as f:
  50       f.write(content)
  51
  52   def _ParseAndShowResultFile():
  53     dom = minidom.parse(result_path)
  54     issues = dom.getElementsByTagName('issue')
  55     print >> sys.stderr
  56     for issue in issues:
  57       issue_id = issue.attributes['id'].value
  58       message = issue.attributes['message'].value
  59       location_elem = issue.getElementsByTagName('location')[0]
  60       path = location_elem.attributes['file'].value
  61       line = location_elem.getAttribute('line')
  62       if line:
  63         error = '%s:%s %s: %s [warning]' % (path, line, message, issue_id)
  64       else:
  65         # Issues in class files don't have a line number.
  66         error = '%s %s: %s [warning]' % (path, message, issue_id)
  67       print >> sys.stderr, error
  68       for attr in ['errorLine1', 'errorLine2']:
  69         error_line = issue.getAttribute(attr)
  70         if error_line:
  71           print >> sys.stderr, error_line
  72     return len(issues)
  73
  74   with build_utils.TempDir() as temp_dir:
  75     _ProcessConfigFile()
  76
  77     cmd = [
  78         _RelativizePath(lint_path), '-Werror', '--exitcode', '--showall',
  79         '--config', _RelativizePath(processed_config_path),
  80         '--classpath', _RelativizePath(jar_path),
  81         '--xml', _RelativizePath(result_path),
  82     ]
  83
  84     # There may be multiple source files with the same basename (but in
  85     # different directories). It is difficult to determine what part of the path
  86     # corresponds to the java package, and so instead just link the source files
  87     # into temporary directories (creating a new one whenever there is a name
  88     # conflict).
  89     src_dirs = []
  90     def NewSourceDir():
  91       new_dir = os.path.join(temp_dir, str(len(src_dirs)))
  92       os.mkdir(new_dir)
  93       src_dirs.append(new_dir)
  94       cmd.extend(['--sources', _RelativizePath(new_dir)])
  95       return new_dir
  96
  97     def PathInDir(d, src):
  98       return os.path.join(d, os.path.basename(src))
  99
 100     for src in sources:
 101       src_dir = None
 102       for d in src_dirs:
 103         if not os.path.exists(PathInDir(d, src)):
 104           src_dir = d
 105           break
 106       if not src_dir:
 107         src_dir = NewSourceDir()
 108       os.symlink(os.path.abspath(src), PathInDir(src_dir, src))
 109
 110     cmd.append(_RelativizePath(os.path.join(manifest_path, os.pardir)))
 111
 112     if os.path.exists(result_path):
 113       os.remove(result_path)
 114
 115     try:
 116       build_utils.CheckOutput(cmd, cwd=_SRC_ROOT)
 117     except build_utils.CalledProcessError as e:
 118       # There is a problem with lint usage
 119       if not os.path.exists(result_path):
 120         print 'Something is wrong:'
 121         print e
 122         return 0
 123
 124       # There are actual lint issues
 125       else:
 126         try:
 127           num_issues = _ParseAndShowResultFile()
 128         except Exception:
 129           print 'Lint created unparseable xml file...'
 130           print 'File contents:'
 131           with open(result_path) as f:
 132             print f.read()
 133           return 0
 134
 135         _ProcessResultFile()
 136         msg = ('\nLint found %d new issues.\n'
 137                ' - For full explanation refer to %s\n'
 138                ' - Wanna suppress these issues?\n'
 139                '    1. Read comment in %s\n'
 140                '    2. Run "python %s %s"\n' %
 141                (num_issues,
 142                 _RelativizePath(result_path),
 143                 _RelativizePath(config_path),
 144                 _RelativizePath(os.path.join(_SRC_ROOT, 'build', 'android',
 145                                              'lint', 'suppress.py')),
 146                 _RelativizePath(result_path)))
 147         print >> sys.stderr, msg
 148         # Lint errors do not fail the build.
 149         return 0
 150
 151   return 0
 152
 153
 154 def main():
 155   parser = optparse.OptionParser()
 156   build_utils.AddDepfileOption(parser)
 157   parser.add_option('--lint-path', help='Path to lint executable.')
 158   parser.add_option('--config-path', help='Path to lint suppressions file.')
 159   parser.add_option('--processed-config-path',
 160                     help='Path to processed lint suppressions file.')
 161   parser.add_option('--manifest-path', help='Path to AndroidManifest.xml')
 162   parser.add_option('--result-path', help='Path to XML lint result file.')
 163   parser.add_option('--product-dir', help='Path to product dir.')
 164   parser.add_option('--src-dirs', help='Directories containing java files.')
 165   parser.add_option('--java-files', help='Paths to java files.')
 166   parser.add_option('--jar-path', help='Jar file containing class files.')
 167   parser.add_option('--stamp', help='Path to touch on success.')
 168   parser.add_option('--enable', action='store_true',
 169                     help='Run lint instead of just touching stamp.')
 170
 171   options, _ = parser.parse_args()
 172
 173   build_utils.CheckOptions(
 174       options, parser, required=['lint_path', 'config_path',
 175                                  'processed_config_path', 'manifest_path',
 176                                  'result_path', 'product_dir',
 177                                  'jar_path'])
 178
 179   rc = 0
 180
 181   if options.enable:
 182     sources = []
 183     if options.src_dirs:
 184       src_dirs = build_utils.ParseGypList(options.src_dirs)
 185       sources = build_utils.FindInDirectories(src_dirs, '*.java')
 186     elif options.java_files:
 187       sources = build_utils.ParseGypList(options.java_files)
 188     else:
 189       print 'One of --src-dirs or --java-files must be specified.'
 190       return 1
 191     rc = _RunLint(options.lint_path, options.config_path,
 192                   options.processed_config_path,
 193                   options.manifest_path, options.result_path,
 194                   options.product_dir, sources, options.jar_path)
 195
 196   if options.depfile:
 197     build_utils.WriteDepfile(
 198         options.depfile,
 199         build_utils.GetPythonDependencies())
 200
 201   if options.stamp and not rc:
 202     build_utils.Touch(options.stamp)
 203
 204   return rc
 205
 206
 207 if __name__ == '__main__':
 208   sys.exit(main())