Add minimal Gerrit support to 'git cl config' and 'git cl upload'

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."""
 
 import logging
@@ skipping 129 matching lines @@
   def __init__(self):
     self.default_server = None
     self.cc = None
     self.root = None
     self.is_git_svn = None
     self.svn_branch = None
     self.tree_status_url = None
     self.viewvc_url = None
     self.updated = False
     self.did_migrate_check = False
+    self.is_gerrit = None
 
   def LazyUpdateIfNeeded(self):
     """Updates the settings from a codereview.settings file, if available."""
     if not self.updated:
       cr_settings_file = FindCodereviewSettingsFile()
       if cr_settings_file:
         LoadCodereviewSettingsFromFile(cr_settings_file)
       self.updated = True
 
   def GetDefaultServerUrl(self, error_ok=False):
@@ skipping 97 matching lines @@
 
   def GetViewVCUrl(self):
     if not self.viewvc_url:
       self.viewvc_url = gclient_utils.UpgradeToHttps(
           self._GetConfig('rietveld.viewvc-url', error_ok=True))
     return self.viewvc_url
 
   def GetDefaultCCList(self):
     return self._GetConfig('rietveld.cc', error_ok=True)
 
+  def GetIsGerrit(self):
+    """Return true if this repo is assosiated with gerrit code review system."""
+    if self.is_gerrit is None:
+      self.is_gerrit = self._GetConfig('gerrit.host', error_ok=True)
+    return self.is_gerrit
+
   def _GetConfig(self, param, **kwargs):
     self.LazyUpdateIfNeeded()
     return RunGit(['config', param], **kwargs).strip()
 
 
 def CheckForMigration():
   """Migrate from the old issue format, if found.
 
   We used to store the branch<->issue mapping in a file in .git, but it's
   better to store it in the .git/config, since deleting a branch deletes that
@@ skipping 320 matching lines @@
     """Return the git setting that stores this change's most recent patchset."""
     return 'branch.%s.rietveldpatchset' % self.GetBranch()
 
   def _RietveldServer(self):
     """Returns the git setting that stores this change's rietveld server."""
     return 'branch.%s.rietveldserver' % self.GetBranch()
 
 
 def GetCodereviewSettingsInteractively():
   """Prompt the user for settings."""
+  # TODO(ukai): ask code review system is rietveld or gerrit?
   server = settings.GetDefaultServerUrl(error_ok=True)
   prompt = 'Rietveld server (host[:port])'
   prompt += ' [%s]' % (server or DEFAULT_SERVER)
   newserver = ask_for_data(prompt + ':')
   if not server and not newserver:
     newserver = DEFAULT_SERVER
   if newserver:
     newserver = gclient_utils.UpgradeToHttps(newserver)
     if newserver != server:
       RunGit(['config', 'rietveld.server', newserver])
@@ skipping 42 matching lines @@
       initial_text += '\nBUG='
     if '\nTEST=' not in self.description:
       initial_text += '\nTEST='
     initial_text = initial_text.rstrip('\n') + '\n'
     content = gclient_utils.RunEditor(initial_text, True)
     if not content:
       DieWithError('Running editor failed')
     content = re.compile(r'^#.*$', re.MULTILINE).sub('', content).strip()
     if not content:
       DieWithError('No CL description, aborting')
-    self._ParseDescription(content)
+    self.ParseDescription(content)
 
-  def _ParseDescription(self, description):
+  def ParseDescription(self, description):
     """Updates the list of reviewers and subject from the description."""
     if not description:
       self.description = description
       return
 
     self.description = description.strip('\n') + '\n'
     self.subject = description.split('\n', 1)[0]
     # Retrieves all reviewer lines
     regexp = re.compile(r'^\s*(TBR|R)=(.+)$', re.MULTILINE)
     self.reviewers = ','.join(
@@ skipping 34 matching lines @@
     else:
       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('tree-status-url', 'STATUS', unset_error_ok=True)
   SetProperty('viewvc-url', 'VIEW_VC', unset_error_ok=True)
 
+  if 'GERRIT_HOST' in keyvals and 'GERRIT_PORT' in keyvals:
+    RunGit(['config', 'gerrit.host', keyvals['GERRIT_HOST']])
+    RunGit(['config', 'gerrit.port', keyvals['GERRIT_PORT']])
+    # Install the standard commit-msg hook.
+    RunCommand(['scp', '-p', '-P', keyvals['GERRIT_PORT'],
+                '%s:hooks/commit-msg' % keyvals['GERRIT_HOST'],
+                os.path.join(settings.GetRoot(),
+                             '.git', 'hooks', 'commit-msg')])
+
   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']])
 
 
 @usage('[repo root containing codereview.settings]')
 def CMDconfig(parser, args):
@@ skipping 120 matching lines @@
   else:
     # Default to diffing against the "upstream" branch.
     base_branch = cl.GetUpstreamBranch()
 
   cl.RunHook(committing=not options.upload, upstream_branch=base_branch,
              may_prompt=False, verbose=options.verbose,
              author=None)
   return 0
 
 
-@usage('[args to "git diff"]')
-def CMDupload(parser, args):
-  """upload the current changelist to codereview"""
-  parser.add_option('--bypass-hooks', action='store_true', dest='bypass_hooks',
-                    help='bypass upload presubmit hook')
-  parser.add_option('-f', action='store_true', dest='force',
-                    help="force yes to questions (don't prompt)")
-  parser.add_option('-m', dest='message', help='message for patch')
-  parser.add_option('-r', '--reviewers',
-                    help='reviewer email addresses')
-  parser.add_option('--cc',
-                    help='cc email addresses')
-  parser.add_option('--send-mail', action='store_true',
-                    help='send email to reviewer immediately')
-  parser.add_option("--emulate_svn_auto_props", action="store_true",
-                    dest="emulate_svn_auto_props",
-                    help="Emulate Subversion's auto properties feature.")
-  parser.add_option("--desc_from_logs", action="store_true",
-                    dest="from_logs",
-                    help="""Squashes git commit logs into change description and
-                            uses message as subject""")
-  parser.add_option('-c', '--use-commit-queue', action='store_true',
-                    help='tell the commit queue to commit this patchset')
-  (options, args) = parser.parse_args(args)
+def GerritUpload(options, args, cl):
+  """upload the current branch to gerrit."""
+  # We assume the remote called "origin" is the one we want.
+  # It is probably not worthwhile to support different workflows.
+  remote = 'origin'
+  branch = 'master'
+  if options.target_branch:
+    branch = options.target_branch
 
-  # Make sure index is up-to-date before running diff-index.
-  RunGit(['update-index', '--refresh', '-q'], error_ok=True)
-  if RunGit(['diff-index', 'HEAD']):
-    print 'Cannot upload with a dirty tree.  You must commit locally first.'
+  log_desc = CreateDescriptionFromLog(args)
+  if options.reviewers:
+    log_desc += '\nR=' + options.reviewers
+  change_desc = ChangeDescription(options.message, log_desc,
+                                  options.reviewers)
+  change_desc.ParseDescription(log_desc)
+  if change_desc.IsEmpty():
+    print "Description is empty; aborting."
     return 1
 
-  cl = Changelist()
-  if args:
-    base_branch = args[0]
-  else:
-    # Default to diffing against the "upstream" branch.
-    base_branch = cl.GetUpstreamBranch()
-    args = [base_branch + "..."]
+  receive_options = []
+  cc = cl.GetCCList().split(',')
+  if options.cc:
+    cc += options.cc.split(',')
+  cc = filter(None, cc)
+  if cc:
+    receive_options += ['--cc=' + email for email in cc]
+  if change_desc.reviewers:
+    reviewers = filter(None, change_desc.reviewers.split(','))
+    if reviewers:
+      receive_options += ['--reviewer=' + email for email in reviewers]
 
-  if not options.bypass_hooks:
-    hook_results = cl.RunHook(committing=False, upstream_branch=base_branch,
-                              may_prompt=not options.force,
-                              verbose=options.verbose,
-                              author=None)
-    if not hook_results.should_continue():
-      return 1
-    if not options.reviewers and hook_results.reviewers:
-      options.reviewers = hook_results.reviewers
+  git_command = ['push']
+  if receive_options:
+    git_command.append('--receive-pack="git receive-pack %s"' %
+                       ' '.join(receive_options))
+  git_command += [remote, 'HEAD:refs/for/' + branch]
+  RunGit(git_command)
+  # TODO(ukai): parse Change-Id: and set issue number?
+  return 0
 
-  # --no-ext-diff is broken in some versions of Git, so try to work around
-  # this by overriding the environment (but there is still a problem if the
-  # git config key "diff.external" is used).
-  env = os.environ.copy()
-  if 'GIT_EXTERNAL_DIFF' in env:
-    del env['GIT_EXTERNAL_DIFF']
-  subprocess2.call(
-      ['git', 'diff', '--no-ext-diff', '--stat', '-M'] + args, env=env)
 
+def RietveldUpload(options, args, cl):
+  """upload the patch to rietveld."""
   upload_args = ['--assume_yes']  # Don't ask about untracked files.
   upload_args.extend(['--server', cl.GetRietveldServer()])
   if options.emulate_svn_auto_props:
     upload_args.append('--emulate_svn_auto_props')
   if options.from_logs and not options.message:
     print 'Must set message for subject line if using desc_from_logs'
     return 1
 
   change_desc = None
 
@@ skipping 61 matching lines @@
 
   if not cl.GetIssue():
     cl.SetIssue(issue)
   cl.SetPatchset(patchset)
 
   if options.use_commit_queue:
     cl.SetFlag('commit', '1')
   return 0
 
 
+@usage('[args to "git diff"]')
+def CMDupload(parser, args):
+  """upload the current changelist to codereview"""
+  parser.add_option('--bypass-hooks', action='store_true', dest='bypass_hooks',
+                    help='bypass upload presubmit hook')
+  parser.add_option('-f', action='store_true', dest='force',
+                    help="force yes to questions (don't prompt)")
+  parser.add_option('-m', dest='message', help='message for patch')
+  parser.add_option('-r', '--reviewers',
+                    help='reviewer email addresses')
+  parser.add_option('--cc',
+                    help='cc email addresses')
+  parser.add_option('--send-mail', action='store_true',
+                    help='send email to reviewer immediately')
+  parser.add_option("--emulate_svn_auto_props", action="store_true",
+                    dest="emulate_svn_auto_props",
+                    help="Emulate Subversion's auto properties feature.")
+  parser.add_option("--desc_from_logs", action="store_true",
+                    dest="from_logs",
+                    help="""Squashes git commit logs into change description and
+                            uses message as subject""")
+  parser.add_option('-c', '--use-commit-queue', action='store_true',
+                    help='tell the commit queue to commit this patchset')
+  if settings.GetIsGerrit():
+    parser.add_option('--target_branch', dest='target_branch', default='master',
+                      help='target branch to upload')
+  (options, args) = parser.parse_args(args)
+
+  # Make sure index is up-to-date before running diff-index.
+  RunGit(['update-index', '--refresh', '-q'], error_ok=True)
+  if RunGit(['diff-index', 'HEAD']):
+    print 'Cannot upload with a dirty tree.  You must commit locally first.'
+    return 1
+
+  cl = Changelist()
+  if args:
+    # TODO(ukai): is it ok for gerrit case?
+    base_branch = args[0]
+  else:
+    # Default to diffing against the "upstream" branch.
+    base_branch = cl.GetUpstreamBranch()
+    args = [base_branch + "..."]
+
+  if not options.bypass_hooks:
+    hook_results = cl.RunHook(committing=False, upstream_branch=base_branch,
+                              may_prompt=not options.force,
+                              verbose=options.verbose,
+                              author=None)
+    if not hook_results.should_continue():
+      return 1
+    if not options.reviewers and hook_results.reviewers:
+      options.reviewers = hook_results.reviewers
+
+  # --no-ext-diff is broken in some versions of Git, so try to work around
+  # this by overriding the environment (but there is still a problem if the
+  # git config key "diff.external" is used).
+  env = os.environ.copy()
+  if 'GIT_EXTERNAL_DIFF' in env:
+    del env['GIT_EXTERNAL_DIFF']
+  subprocess2.call(
+      ['git', 'diff', '--no-ext-diff', '--stat', '-M'] + args, env=env)
+
+  if settings.GetIsGerrit():
+    return GerritUpload(options, args, cl)
+  return RietveldUpload(options, args, cl)
+
+
 def SendUpstream(parser, args, cmd):
   """Common code for CmdPush and CmdDCommit
 
   Squashed commit into a single.
   Updates changelog with metadata (e.g. pointer to review).
   Pushes/dcommits the code upstream.
   Updates review and closes.
   """
   parser.add_option('--bypass-hooks', action='store_true', dest='bypass_hooks',
                     help='bypass upload presubmit hook')
@@ skipping 207 matching lines @@
                     help='allow failed patches and spew .rej files')
   parser.add_option('-n', '--no-commit', action='store_true', dest='nocommit',
                     help="don't commit after patch applies")
   (options, args) = parser.parse_args(args)
   if len(args) != 1:
     parser.print_help()
     return 1
   issue_arg = args[0]
 
   # TODO(maruel): Use apply_issue.py
+  # TODO(ukai): use gerrit-cherry-pick for gerrit repository?
 
   if re.match(r'\d+', issue_arg):
     # Input is an issue id.  Figure out the URL.
     issue = issue_arg
     patch_data = Changelist().GetPatchSetDiff(issue)
   else:
     # Assume it's a URL to the patch. Default to https.
     issue_url = gclient_utils.UpgradeToHttps(issue_arg)
     match = re.match(r'.*?/issue(\d+)_\d+.diff', issue_url)
     if not match:
@@ skipping 186 matching lines @@
              'and retry or visit go/isgaeup.\n%s') % (e.code, str(e)))
 
   # Not a known command. Default to help.
   GenUsage(parser, 'help')
   return CMDhelp(parser, argv)
 
 
 if __name__ == '__main__':
   fix_encoding.fix_encoding()
   sys.exit(main(sys.argv[1:]))