Add a --squash option to Gerrit uploads.

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
 import base64
 import glob
 import json
 import logging
 import optparse
 import os
 import Queue
 import re
 import stat
 import sys
+import tempfile
 import textwrap
 import threading
 import urllib2
 import urlparse
 import webbrowser
 import zlib
 
 try:
   import readline  # pylint: disable=F0401,W0611
 except ImportError:
@@ skipping 75 matching lines @@
                                         env=GetNoGitPagerEnv(),
                                         stdout=subprocess2.PIPE,
                                         stderr=stderr)
     return code, out[0]
   except ValueError:
     # When the subprocess fails, it returns None.  That triggers a ValueError
     # when trying to unpack the return value into (out, code).
     return 1, ''
 
 
+def RunGitSilent(args):
+  """Returns stdout, suppresses stderr and ingores the return code."""
+  return RunGitWithCode(args, suppress_stderr=True)[1]
+
+
 def IsGitVersionAtLeast(min_version):
   prefix = 'git version '
   version = RunGit(['--version']).strip()
   return (version.startswith(prefix) and
       LooseVersion(version[len(prefix):]) >= LooseVersion(min_version))
 
 
 def ask_for_data(prompt):
   try:
     return raw_input(prompt)
@@ skipping 1500 matching lines @@
   if CHANGE_ID in new_log_desc:
     print 'git-cl: Added Change-Id to commit message.'
   else:
     print >> sys.stderr, 'ERROR: Gerrit commit-msg hook not available.'
 
 
 def GerritUpload(options, args, cl, change):
   """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'
+  gerrit_remote = 'origin'
   branch = 'master'
   if options.target_branch:
     branch = options.target_branch
 
   change_desc = ChangeDescription(
       options.message or CreateDescriptionFromLog(args))
   if not change_desc.description:
     print "Description is empty; aborting."
     return 1
-  if CHANGE_ID not in change_desc.description:
-    AddChangeIdToCommitMessage(options, args)
 
-  commits = RunGit(['rev-list', '%s/%s..' % (remote, branch)]).splitlines()
+  if options.squash:
+    # Try to get the message from a previous upload.
+    shadow_branch = 'refs/heads/git_cl_uploads/' + cl.GetBranch()
+    message = RunGitSilent(['show', '--format=%s\n\n%b', '-s', shadow_branch])
+    if not message:
+      if not options.force:
+        change_desc.prompt()
+
+      if CHANGE_ID not in change_desc.description:
+        # Run the commit-msg hook without modifying the head commit by writing
+        # the commit message to a temporary file and running the hook over it,
+        # then reading the file back in.
+        commit_msg_hook = os.path.join(settings.GetRoot(), '.git', 'hooks',
+                                       'commit-msg')
+        file_handle, msg_file = tempfile.mkstemp(text=True,
+                                                 prefix='commit_msg')
+        try:
+          with os.fdopen(file_handle, 'w') as fileobj:
+            fileobj.write(change_desc.description)
+          RunCommand([commit_msg_hook, msg_file])
+          change_desc.set_description(gclient_utils.FileRead(msg_file))
+        finally:
+          os.close(file_handle)

[M-A Ruel, 2015/02/13 18:53:55]

No, really after 1671, as on Windows, the handle will not have SHARED_* access
flags, which causes the RunCommand() to fail.

[Bernhard Bauer, 2015/02/13 19:00:51]

Oh, I see; I thought the problem was the remove(). Thanks for the explanation!

+          os.remove(msg_file)
+
+      if not change_desc.description:
+        print "Description is empty; aborting."
+        return 1
+
+      message = change_desc.description
+
+    remote, upstream_branch = cl.FetchUpstreamTuple(cl.GetBranch())
+    if remote is '.':
+      # If our upstream branch is local, we base our squashed commit on its
+      # squashed version.
+      parent = ('refs/heads/git_cl_uploads/' +
+                scm.GIT.ShortBranchName(upstream_branch))
+
+      # Verify that the upstream branch has been uploaded too, otherwise Gerrit
+      # will create additional CLs when uploading.
+      if (RunGitSilent(['rev-parse', upstream_branch + ':']) !=
+          RunGitSilent(['rev-parse', parent + ':'])):
+        print 'Upload upstream branch ' + upstream_branch + ' first.'
+        return 1
+    else:
+      parent = cl.GetCommonAncestorWithUpstream()
+
+    tree = RunGit(['rev-parse', 'HEAD:']).strip()
+    ref_to_push = RunGit(['commit-tree', tree, '-p', parent,
+                          '-m', message]).strip()
+  else:
+    if CHANGE_ID not in change_desc.description:
+      AddChangeIdToCommitMessage(options, args)
+    ref_to_push = 'HEAD'
+    parent = '%s/%s' % (gerrit_remote, branch)
+
+  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))
-    print('git log %s/%s..' % (remote, branch))
-    print('You can also use `git squash-branch` to squash these into a single'
+    print('git log %s..%s' % (parent, ref_to_push))
+    print('You can also use `git squash-branch` to squash these into a single '
           'commit.')
     ask_for_data('About to upload; enter to confirm.')
 
   if options.reviewers or options.tbr_owners:
     change_desc.update_reviewers(options.reviewers, options.tbr_owners, change)
 
   receive_options = []
   cc = cl.GetCCList().split(',')
   if options.cc:
     cc.extend(options.cc)
   cc = filter(None, cc)
   if cc:
     receive_options += ['--cc=' + email for email in cc]
   if change_desc.get_reviewers():
     receive_options.extend(
         '--reviewer=' + email for email in change_desc.get_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]
+  git_command += [gerrit_remote, ref_to_push + ':refs/for/' + branch]
   RunGit(git_command)
+
+  if options.squash:
+    head = RunGit(['rev-parse', 'HEAD']).strip()
+    RunGit(['update-ref', '-m', 'Uploaded ' + head, shadow_branch, ref_to_push])
+
   # TODO(ukai): parse Change-Id: and set issue number?
   return 0
 
 
 def GetTargetRef(remote, remote_branch, target_branch, pending_prefix):
   """Computes the remote branch ref to use for the CL.
 
   Args:
     remote (str): The git remote for the CL.
     remote_branch (str): The git remote branch for the CL.
     target_branch (str): The target branch specified by the user.
     pending_prefix (str): The pending prefix from the settings.
   """
   if not (remote and remote_branch):
     return None
-  
+
   if target_branch:
     # Cannonicalize branch references to the equivalent local full symbolic
     # refs, which are then translated into the remote full symbolic refs
     # below.
     if '/' not in target_branch:
       remote_branch = 'refs/remotes/%s/%s' % (remote, target_branch)
     else:
       prefix_replacements = (
         ('^((refs/)?remotes/)?branch-heads/', 'refs/remotes/branch-heads/'),
         ('^((refs/)?remotes/)?%s/' % remote,  'refs/remotes/%s/' % remote),
         ('^(refs/)?heads/',                   'refs/remotes/%s/' % remote),
       )
       match = None
       for regex, replacement in prefix_replacements:
         match = re.search(regex, target_branch)
         if match:
           remote_branch = target_branch.replace(match.group(0), replacement)
           break
       if not match:
         # This is a branch path but not one we recognize; use as-is.
         remote_branch = target_branch
   elif (not remote_branch.startswith('refs/remotes/branch-heads') and
         not remote_branch.startswith('refs/remotes/%s/refs' % remote)):
     # Default to master for refs that are not branches.
     remote_branch = 'refs/remotes/%s/master' % remote
-    
+
   # Create the true path to the remote branch.
   # Does the following translation:
   # * refs/remotes/origin/refs/diff/test -> refs/diff/test
   # * refs/remotes/origin/master -> refs/heads/master
   # * refs/remotes/branch-heads/test -> refs/branch-heads/test
   if remote_branch.startswith('refs/remotes/%s/refs/' % remote):
     remote_branch = remote_branch.replace('refs/remotes/%s/' % remote, '')
   elif remote_branch.startswith('refs/remotes/%s/' % remote):
     remote_branch = remote_branch.replace('refs/remotes/%s/' % remote,
                                           'refs/heads/')
@@ skipping 159 matching lines @@
                     help="Emulate Subversion's auto properties feature.")
   parser.add_option('-c', '--use-commit-queue', action='store_true',
                     help='tell the commit queue to commit this patchset')
   parser.add_option('--private', action='store_true',
                     help='set the review private (rietveld only)')
   parser.add_option('--target_branch',
                     '--target-branch',
                     metavar='TARGET',
                     help='Apply CL to remote ref TARGET.  ' +
                          'Default: remote branch head, or master')
+  parser.add_option('--squash', action='store_true',
+                    help='Squash multiple commits into one (Gerrit only)')
   parser.add_option('--email', default=None,
                     help='email address to use to connect to Rietveld')
   parser.add_option('--tbr-owners', dest='tbr_owners', action='store_true',
                     help='add a set of OWNERS to TBR')
 
   add_git_similarity(parser)
   (options, args) = parser.parse_args(args)
 
   if is_dirty_git_tree('upload'):
     return 1
@@ skipping 1065 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:]))