git cl: update Gerrit todos and small nits.

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 and Gerrit."""
 
 from distutils.version import LooseVersion
@@ skipping 860 matching lines @@
       return tmp
   return fail_result
 
 
 class Changelist(object):
   """Changelist works with one changelist in local branch.
 
   Supports two codereview backends: Rietveld or Gerrit, selected at object
   creation.
 
-  Not safe for concurrent multi-{thread,process} use.
+  Notes:
+    * Not safe for concurrent multi-{thread,process} use.
+    * Caches values from current branch. Therefore, re-use after branch change
+      with care.
   """
 
   def __init__(self, branchref=None, issue=None, codereview=None, **kwargs):
     """Create a new ChangeList instance.
 
     If issue is given, the codereview must be given too.
 
     If `codereview` is given, it must be 'rietveld' or 'gerrit'.
     Otherwise, it's decided based on current configuration of the local branch,
     with default being 'rietveld' for backwards compatibility.
@@ skipping 1463 matching lines @@
       ref_to_push = RunGit(['commit-tree', tree, '-p', parent,
                             '-m', message]).strip()
     else:
       change_desc = ChangeDescription(
           options.message or CreateDescriptionFromLog(args))
       if not change_desc.description:
         DieWithError("Description is empty. Aborting...")
 
       if not git_footers.get_footer_change_id(change_desc.description):
         DownloadGerritHook(False)
-        change_desc.set_description(AddChangeIdToCommitMessage(options, args))
+        change_desc.set_description(self._AddChangeIdToCommitMessage(options,
+                                                                     args))
       ref_to_push = 'HEAD'
       parent = '%s/%s' % (gerrit_remote, branch)
       change_id = git_footers.get_footer_change_id(change_desc.description)[0]
 
     assert change_desc
     commits = RunGitSilent(['rev-list', '%s..%s' % (parent,
                                                     ref_to_push)]).splitlines()
     if len(commits) > 1:
       print('WARNING: This will upload %d commits. Run the following command '
             'to see which commits will be uploaded: ' % len(commits))
@@ skipping 49 matching lines @@
                         if m]
       if len(change_numbers) != 1:
         DieWithError(
           ('Created|Updated %d issues on Gerrit, but only 1 expected.\n'
            'Change-Id: %s') % (len(change_numbers), change_id))
       self.SetIssue(change_numbers[0])
       RunGit(['config', 'branch.%s.gerritsquashhash' % self.GetBranch(),
               ref_to_push])
     return 0
 
+  def _AddChangeIdToCommitMessage(self, options, args):
+    """Re-commits using the current message, assumes the commit hook is in
+    place.
+    """
+    log_desc = options.message or CreateDescriptionFromLog(args)
+    git_command = ['commit', '--amend', '-m', log_desc]
+    RunGit(git_command)
+    new_log_desc = CreateDescriptionFromLog(args)
+    if git_footers.get_footer_change_id(new_log_desc):
+      print 'git-cl: Added Change-Id to commit message.'
+      return new_log_desc
+    else:
+      print >> sys.stderr, 'ERROR: Gerrit commit-msg hook not available.'
 
 
 _CODEREVIEW_IMPLEMENTATIONS = {
   'rietveld': _RietveldChangelistImpl,
   'gerrit': _GerritChangelistImpl,
 }
 
 
 class ChangeDescription(object):
   """Contains a parsed form of the change description."""
@@ skipping 278 matching lines @@
   SetProperty(settings.GetViewVCUrl(), 'ViewVC URL', 'viewvc-url', True)
   SetProperty(settings.GetBugPrefix(), 'Bug Prefix', 'bug-prefix', False)
   SetProperty(settings.GetRunPostUploadHook(), 'Run Post Upload Hook',
               'run-post-upload-hook', False)
 
 @subcommand.usage('[repo root containing codereview.settings]')
 def CMDconfig(parser, args):
   """Edits configuration for this tree."""
 
   print('WARNING: git cl config works for Rietveld only.\n'
-        'For Gerrit, see http://crbug.com/579160.')
-  # TODO(tandrii): add Gerrit support as part of http://crbug.com/579160.
+        'For Gerrit, see http://crbug.com/603116.')
+  # TODO(tandrii): add Gerrit support as part of http://crbug.com/603116.
   parser.add_option('--activate-update', action='store_true',
                     help='activate auto-updating [rietveld] section in '
                          '.git/config')
   parser.add_option('--deactivate-update', action='store_true',
                     help='deactivate auto-updating [rietveld] section in '
                          '.git/config')
   options, args = parser.parse_args(args)
 
   if options.deactivate_update:
     RunGit(['config', 'rietveld.autoupdate', 'false'])
@@ skipping 328 matching lines @@
         continue
       print 'Branch for issue number %s: %s' % (
           issue, ', '.join(issue_branch_map.get(int(issue)) or ('None',)))
   else:
     cl = Changelist()
     if len(args) > 0:
       try:
         issue = int(args[0])
       except ValueError:
         DieWithError('Pass a number to set the issue or none to list it.\n'
-            'Maybe you want to run git cl status?')
+                     'Maybe you want to run git cl status?')
       cl.SetIssue(issue)
     print 'Issue number: %s (%s)' % (cl.GetIssue(), cl.GetIssueURL())
   return 0
 
 
 def CMDcomments(parser, args):
   """Shows or posts review comments for any changelist."""
   parser.add_option('-a', '--add-comment', dest='comment',
                     help='comment to add to an issue')
   parser.add_option('-i', dest='issue',
@@ skipping 159 matching lines @@
     base_branch = cl.GetCommonAncestorWithUpstream()
 
   cl.RunHook(
       committing=not options.upload,
       may_prompt=False,
       verbose=options.verbose,
       change=cl.GetChange(base_branch, None))
   return 0
 
 
-def AddChangeIdToCommitMessage(options, args):
-  """Re-commits using the current message, assumes the commit hook is in
-  place.
-  """
-  log_desc = options.message or CreateDescriptionFromLog(args)
-  git_command = ['commit', '--amend', '-m', log_desc]
-  RunGit(git_command)
-  new_log_desc = CreateDescriptionFromLog(args)
-  if git_footers.get_footer_change_id(new_log_desc):
-    print 'git-cl: Added Change-Id to commit message.'
-    return new_log_desc
-  else:
-    print >> sys.stderr, 'ERROR: Gerrit commit-msg hook not available.'
-
-
 def GenerateGerritChangeId(message):
   """Returns Ixxxxxx...xxx change id.
 
   Works the same way as
   https://gerrit-review.googlesource.com/tools/hooks/commit-msg
   but can be called on demand on all platforms.
 
   The basic idea is to generate git hash of a state of the tree, original commit
   message, author/committer info and timestamps.
   """
@@ skipping 1418 matching lines @@
 if __name__ == '__main__':
   # These affect sys.stdout so do it outside of main() to simplify mocks in
   # unit testing.
   fix_encoding.fix_encoding()
   setup_color.init()
   try:
     sys.exit(main(sys.argv[1:]))
   except KeyboardInterrupt:
     sys.stderr.write('interrupted\n')
     sys.exit(1)