[Android] Add lint as a gyp action.

build/android/lint/suppress.py

+#!/usr/bin/env python
+#
+# Copyright (c) 2013 The Chromium Authors. All rights reserved.
+# Use of this source code is governed by a BSD-style license that can be
+# found in the LICENSE file.
+
+"""Add all generated lint_result.xml files to suppressions.xml"""
+
+
+import collections
+import optparse
+import os
+import sys
+from xml.dom import minidom
+
+_BUILD_ANDROID_DIR = os.path.join(os.path.dirname(__file__), '..')
+sys.path.append(_BUILD_ANDROID_DIR)
+
+from pylib import constants
+
+
+_THIS_FILE = os.path.abspath(__file__)
+_CONFIG_PATH = os.path.join(os.path.dirname(_THIS_FILE), 'suppressions.xml')
+_RESULT_FILE_NAME = 'lint_result.xml'
+_DOC = (
+    '\nSTOP! It looks like you want to suppress some lint errors:\n'
+    '- Have you tried identifing the offending patch?\n'
+    '  Ask the author for a fix and/or revert the patch.\n'
+    '- It is preferred to add suppressions in the code instead of\n'
+    '  sweeping it under the rug here. See:\n\n'
+    '    http://developer.android.com/tools/debugging/improving-w-lint.html\n'
+    '\n'
+    'Still reading?\n'
+    '- You can edit this file manually to suppress an issue\n'
+    '  globally if it is not applicable to the project.\n'
+    '- You can also automatically add issues found so for in the\n'
+    '  build process by running:\n\n'
+    '    ' + os.path.relpath(_THIS_FILE, constants.DIR_SOURCE_ROOT) + '\n\n'
+    '  which will generate this file (Comments are not preserved).\n'
+)
+
+
+_Issue = collections.namedtuple('Issue', ['severity', 'paths'])
+
+
+def _ParseConfigFile(config_path):
+  print 'Parsing %s' % config_path
+  issues_dict = {}
+  dom = minidom.parse(config_path)
+  for issue in dom.getElementsByTagName('issue'):
+    issue_id = issue.attributes['id'].value
+    severity = issue.getAttribute('severity')
+    paths = set(
+        [p.attributes['path'].value for p in
+         issue.getElementsByTagName('ignore')])
+    issues_dict[issue_id] = _Issue(severity, paths)
+  return issues_dict
+
+
+def _ParseAndMergeResultFile(result_path, issues_dict):
+  print 'Parsing and merging %s' % result_path
+  dom = minidom.parse(result_path)
+  for issue in dom.getElementsByTagName('issue'):
+    issue_id = issue.attributes['id'].value
+    severity = issue.attributes['severity'].value
+    path = issue.getElementsByTagName('location')[0].attributes['file'].value
+    if issue_id not in issues_dict:
+      issues_dict[issue_id] = _Issue(severity, set())
+    issues_dict[issue_id].paths.add(path)
+
+
+def _WriteConfigFile(config_path, issues_dict):
+  new_dom = minidom.getDOMImplementation().createDocument(None, 'lint', None)
+  top_element = new_dom.documentElement
+  top_element.appendChild(new_dom.createComment(_DOC))
+  for issue_id in sorted(issues_dict.keys()):
+    severity = issues_dict[issue_id].severity
+    paths = issues_dict[issue_id].paths
+    issue = new_dom.createElement('issue')
+    issue.attributes['id'] = issue_id
+    if severity:
+      issue.attributes['severity'] = severity
+    if severity == 'ignore':
+      print 'Warning: [%s] is suppressed globally.' % issue_id
+    else:
+      for path in sorted(paths):
+        ignore = new_dom.createElement('ignore')
+        ignore.attributes['path'] = path
+        issue.appendChild(ignore)
+    top_element.appendChild(issue)
+
+  with open(config_path, 'w') as f:
+    f.write(new_dom.toprettyxml(indent='  ', encoding='utf-8'))
+  print 'Updated %s' % config_path
+
+
+def _Suppress(config_path):
+  issues_dict = _ParseConfigFile(config_path)
+
+  for dirpath, _, files in os.walk(constants.GetOutDirectory()):

[newt (away), 2013/12/03 00:54:16]

Can we just pass in the path to lint_result.xml instead of walking the out
directory? This seems a bit too magical to me (i.e. difficult for developers to
understand what's happening without reading the source) and could lead to weird
results if there's a stale lint_result.xml in the out directory from another
Java target that failed to build a while back.

[frankf, 2013/12/03 01:13:03]

Yes, there is a trade-off here. With your suggestion, the develop needs to look
up the exact path from the log. On the other hand, you could have stale
lint_result.xml as you suggest (but it's erring on the safe side). Another con
with current solution is figuring out the out directory path which is always
error prone. I'm open to this suggestion.

On 2013/12/03 00:54:16, newt wrote:

[newt (away), 2013/12/03 02:01:00]

I'd suggest that if lint.py fails, it print out the exact suppress.py command to
run. E.g.:

    > lint.py

    Lint failed with 7 warnings:
      Main.java NewApi: blah blah

    To suppress these warnings, run
      suppress.py --lint-result-path out/Debug/blah/blah/lint_result.xml

+    for f in files:
+      if f == _RESULT_FILE_NAME:
+        _ParseAndMergeResultFile(os.path.join(dirpath, f), issues_dict)
+
+  _WriteConfigFile(config_path, issues_dict)
+
+
+def main(argv):
+  parser = optparse.OptionParser()

[newt (away), 2013/12/03 00:54:16]

duplicate line

[frankf, 2013/12/04 23:29:31]

Done.

+  parser = optparse.OptionParser()
+  parser.add_option('--release', action='store_true',
+                    help='Whether this is a Release build.')
+  options, _ = parser.parse_args()
+
+  if options.release:
+    constants.SetBuildType('Release')
+  else:
+    constants.SetBuildType('Debug')
+
+  _Suppress(_CONFIG_PATH)
+
+
+if __name__ == '__main__':
+  sys.exit(main(sys.argv))