Implement git cl lint.

git_cl.py

 #!/usr/bin/env python
 # Copyright (c) 2012 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.
 
 # Copyright (C) 2008 Evan Martin <martine@danga.com>
 
 """A git-command for integrating reviews on Rietveld."""
 
 from distutils.version import LooseVersion
@@ skipping 33 matching lines @@
 import owners_finder
 
 __version__ = '1.0'
 
 DEFAULT_SERVER = 'https://codereview.appspot.com'
 POSTUPSTREAM_HOOK_PATTERN = '.git/hooks/post-cl-%s'
 DESCRIPTION_BACKUP_FILE = '~/.git_cl_description_backup'
 GIT_INSTRUCTIONS_URL = 'http://code.google.com/p/chromium/wiki/UsingGit'
 CHANGE_ID = 'Change-Id:'
 
+# Valid extensions for files we want to lint.
+DEFAULT_LINT_REGEX = r"(.*\.cpp|.*\.cc|.*\.h)"
+DEFAULT_LINT_IGNORE_REGEX = r"$^"
+
 # Shortcut since it quickly becomes redundant.
 Fore = colorama.Fore
 
 # Initialized in main()
 settings = None
 
 
 def DieWithError(message):
   print >> sys.stderr, message
   sys.exit(1)
@@ skipping 351 matching lines @@
     if self.is_gerrit is None:
       self.is_gerrit = self._GetConfig('gerrit.host', error_ok=True)
     return self.is_gerrit
 
   def GetGitEditor(self):
     """Return the editor specified in the git config, or None if none is."""
     if self.git_editor is None:
       self.git_editor = self._GetConfig('core.editor', error_ok=True)
     return self.git_editor or None
 
+  def GetLintRegex(self):
+    return (self._GetRietveldConfig('cpplint-regex', error_ok=True) or
+            DEFAULT_LINT_REGEX)
+
+  def GetLintIgnoreRegex(self):
+    return (self._GetRietveldConfig('cpplint-ignore-regex', error_ok=True) or
+            DEFAULT_LINT_IGNORE_REGEX)
+
   def _GetRietveldConfig(self, param, **kwargs):
     return self._GetConfig('rietveld.' + param, **kwargs)
 
   def _GetConfig(self, param, **kwargs):
     self.LazyUpdateIfNeeded()
     return RunGit(['config', param], **kwargs).strip()
 
 
 def ShortBranchName(branch):
   """Convert a name like 'refs/heads/foo' to just 'foo'."""
@@ skipping 601 matching lines @@
       RunGit(['config', '--unset-all', fullname], error_ok=unset_error_ok)
 
   SetProperty('server', 'CODE_REVIEW_SERVER')
   # Only server setting is required. Other settings can be absent.
   # In that case, we ignore errors raised during option deletion attempt.
   SetProperty('cc', 'CC_LIST', unset_error_ok=True)
   SetProperty('private', 'PRIVATE', unset_error_ok=True)
   SetProperty('tree-status-url', 'STATUS', unset_error_ok=True)
   SetProperty('viewvc-url', 'VIEW_VC', unset_error_ok=True)
   SetProperty('bug-prefix', 'BUG_PREFIX', unset_error_ok=True)
+  SetProperty('cpplint-regex', 'LINT_REGEX', unset_error_ok=True)
+  SetProperty('cpplint-ignore-regex', 'LINT_IGNORE_REGEX', unset_error_ok=True)
 
   if 'GERRIT_HOST' in keyvals:
     RunGit(['config', 'gerrit.host', keyvals['GERRIT_HOST']])
 
   if 'PUSH_URL_CONFIG' in keyvals and 'ORIGIN_URL_CONFIG' in keyvals:
     #should be of the form
     #PUSH_URL_CONFIG: url.ssh://gitrw.chromium.org.pushinsteadof
     #ORIGIN_URL_CONFIG: http://src.chromium.org/git
     RunGit(['config', keyvals['PUSH_URL_CONFIG'],
             keyvals['ORIGIN_URL_CONFIG']])
@@ skipping 302 matching lines @@
     log_args = [args[0] + '..']
   elif len(args) == 1 and args[0].endswith('...'):
     log_args = [args[0][:-1]]
   elif len(args) == 2:
     log_args = [args[0] + '..' + args[1]]
   else:
     log_args = args[:]  # Hope for the best!
   return RunGit(['log', '--pretty=format:%s\n\n%b'] + log_args)
 
 
+def CMDlint(parser, args):
+  """Runs cpplint on the current changelist."""
+  _, args = parser.parse_args(args)
+
+  # Access to a protected member _XX of a client class
+  # pylint: disable=W0212
+  try:
+    import cpplint
+    import cpplint_chromium
+  except ImportError:
+    print "You need to install cpplint.py to lint C++ files."

[iannucci, 2014/02/11 07:50:01]

No URL?

[Lei Zhang, 2014/02/11 07:58:04]

I just copied this over from gcl.py. I'll come up with a better message.
cpplint.py and cpplint_chromium.py are right there in depot_tools.

+    return 1
+
+  # Change the current working directory before calling lint so that it
+  # shows the correct base.
+  previous_cwd = os.getcwd()
+  os.chdir(settings.GetRoot())

[iannucci, 2014/02/11 07:50:01]

arg.... there's really no way to pass a base directory to ProcessFile? :(

changing cwd is my second least-favorite thing (right after using env vars to
pass state around).

[Lei Zhang, 2014/02/11 07:58:04]

Again, almost blindly copied over from gcl.py. It looks like there is a --root
argument. Will give it a try.

[Lei Zhang, 2014/02/11 22:20:52]

--root doesn't do what I think it does, so unless I go fix cpplint.py (which
comes from http://google-styleguide.googlecode.com/), I can't get it to print
chrome/browser/foo if I'm not in the root directory. Instead it will print
../rel_path/to/chrome/browser/foo.

+  try:
+    cl = Changelist()
+    change = cl.GetChange(cl.GetCommonAncestorWithUpstream(), None)
+    files = [f.LocalPath() for f in change.AffectedFiles()]
+
+    # Process cpplints arguments if any.
+    filenames = cpplint.ParseArguments(args + files)
+
+    white_regex = re.compile(settings.GetLintRegex())
+    black_regex = re.compile(settings.GetLintIgnoreRegex())
+    extra_check_functions = [cpplint_chromium.CheckPointerDeclarationWhitespace]
+    for filename in filenames:
+      if white_regex.match(filename):
+        if black_regex.match(filename):
+          print "Ignoring file %s" % filename
+        else:
+          cpplint.ProcessFile(filename, cpplint._cpplint_state.verbose_level,
+                              extra_check_functions)
+      else:
+        print "Skipping file %s" % filename
+  finally:
+    os.chdir(previous_cwd)
+  print "Total errors found: %d\n" % cpplint._cpplint_state.error_count
+  return 0

[iannucci, 2014/02/11 07:50:01]

this should probably return 0 iff cpplint._cpplint_state.error_count == 0 right?

[Lei Zhang, 2014/02/11 07:58:04]

Sure, I can do that. Strangely, gcl lint always returns 1.

+
+
 def CMDpresubmit(parser, args):
   """Runs presubmit tests on the current changelist."""
   parser.add_option('-u', '--upload', action='store_true',
                     help='Run upload hook instead of the push/dcommit hook')
   parser.add_option('-f', '--force', action='store_true',
                     help='Run checks even if tree is dirty')
   (options, args) = parser.parse_args(args)
 
   if not options.force and is_dirty_git_tree('presubmit'):
     print 'use --force to check even if tree is dirty.'
@@ skipping 1051 matching lines @@
         ('AppEngine is misbehaving and returned HTTP %d, again. Keep faith '
           'and retry or visit go/isgaeup.\n%s') % (e.code, str(e)))
 
 
 if __name__ == '__main__':
   # These affect sys.stdout so do it outside of main() to simplify mocks in
   # unit testing.
   fix_encoding.fix_encoding()
   colorama.init()
   sys.exit(main(sys.argv[1:]))