Prompt to delete pending edits before changing the Gerrit CL description.

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 __future__ import print_function
@@ skipping 1375 matching lines @@
     return presubmit_support.GitChange(
         name,
         description,
         absroot,
         files,
         issue,
         patchset,
         author,
         upstream=upstream_branch)
 
-  def UpdateDescription(self, description):
+  def UpdateDescription(self, force, description):

[tandrii(chromium), 2016/09/07 13:33:39]

light suggestion: i'd add force=False as second argument.

[dsansome, 2016/09/08 07:07:17]

Done.

     self.description = description
-    return self._codereview_impl.UpdateDescriptionRemote(description)
+    return self._codereview_impl.UpdateDescriptionRemote(force, description)
 
   def RunHook(self, committing, may_prompt, verbose, change):
     """Calls sys.exit() if the hook fails; returns a HookResults otherwise."""
     try:
       return presubmit_support.DoPresubmitChecks(change, committing,
           verbose=verbose, output_stream=sys.stdout, input_stream=sys.stdin,
           default_presubmit=None, may_prompt=may_prompt,
           rietveld_obj=self._codereview_impl.GetRieveldObjForPresubmit(),
           gerrit_obj=self._codereview_impl.GetGerritObjForPresubmit())
     except presubmit_support.PresubmitFailure as e:
@@ skipping 187 matching lines @@
 
   def GetRieveldObjForPresubmit(self):
     # This is an unfortunate Rietveld-embeddedness in presubmit.
     # For non-Rietveld codereviews, this probably should return a dummy object.
     raise NotImplementedError()
 
   def GetGerritObjForPresubmit(self):
     # None is valid return value, otherwise presubmit_support.GerritAccessor.
     return None
 
-  def UpdateDescriptionRemote(self, description):
+  def UpdateDescriptionRemote(self, force, description):
     """Update the description on codereview site."""
     raise NotImplementedError()
 
   def CloseIssue(self):
     """Closes the issue."""
     raise NotImplementedError()
 
   def GetApprovingReviewers(self):
     """Returns a list of reviewers approving the change.
 
@@ skipping 174 matching lines @@
         break
 
     if not messages:
       # No message was sent.
       return 'unsent'
     if messages[-1]['sender'] != props.get('owner_email'):
       # Non-LGTM reply from non-owner and not CQ bot.
       return 'reply'
     return 'waiting'
 
-  def UpdateDescriptionRemote(self, description):
+  def UpdateDescriptionRemote(self, force, description):
     return self.RpcServer().update_description(
         self.GetIssue(), self.description)
 
   def CloseIssue(self):
     return self.RpcServer().close_issue(self.GetIssue())
 
   def SetFlag(self, flag, value):
     return self.SetFlags({flag: value})
 
   def SetFlags(self, flags):
@@ skipping 475 matching lines @@
   def GetMostRecentPatchset(self):
     data = self._GetChangeDetail(['CURRENT_REVISION'])
     return data['revisions'][data['current_revision']]['_number']
 
   def FetchDescription(self):
     data = self._GetChangeDetail(['CURRENT_REVISION'])
     current_rev = data['current_revision']
     url = data['revisions'][current_rev]['fetch']['http']['url']
     return gerrit_util.GetChangeDescriptionFromGitiles(url, current_rev)
 
-  def UpdateDescriptionRemote(self, description):
+  def UpdateDescriptionRemote(self, force, description):
+    if gerrit_util.HasPendingChangeEdit(self._GetGerritHost(), self.GetIssue()):
+      if not force:
+        ask_for_data(
+            'The description cannot be modified while the issue has a pending '
+            'unpublished\nedit.  Either publish the edit in the Gerrit web UI '

[tandrii(chromium), 2016/09/07 13:33:39]

nit: i prefer not avoid manual text wrapping (ie no '\n' on this line)

[dsansome, 2016/09/08 07:07:17]

Done.

+            'or delete it.\n\n'
+            'Press Enter to delete the unpublished edit, Ctrl+C to abort.')
+
+      gerrit_util.DeletePendingChangeEdit(self._GetGerritHost(),
+                                          self.GetIssue())
     gerrit_util.SetCommitMessage(self._GetGerritHost(), self.GetIssue(),
                                  description)
 
   def CloseIssue(self):
     gerrit_util.AbandonChange(self._GetGerritHost(), self.GetIssue(), msg='')
 
   def GetApprovingReviewers(self):
     """Returns a list of reviewers approving the change.
 
     Note: not necessarily committers.
@@ skipping 1292 matching lines @@
 
 
 @subcommand.usage('[codereview url or issue id]')
 def CMDdescription(parser, args):
   """Brings up the editor for the current CL's description."""
   parser.add_option('-d', '--display', action='store_true',
                     help='Display the description instead of opening an editor')
   parser.add_option('-n', '--new-description',
                     help='New description to set for this issue (- for stdin, '
                          '+ to load from local commit HEAD)')
+  parser.add_option('-f', '--force', action='store_true',
+                    help='Delete any unpublished Gerrit edits for this issue '
+                         'without prompting')
 
   _add_codereview_select_options(parser)
   auth.add_auth_options(parser)
   options, args = parser.parse_args(args)
   _process_codereview_select_options(parser, options)
 
   target_issue = None
   if len(args) > 0:
     target_issue = ParseIssueNumberArgument(args[0])
     if not target_issue.valid:
@@ skipping 28 matching lines @@
     elif text == '+':
       base_branch = cl.GetCommonAncestorWithUpstream()
       change = cl.GetChange(base_branch, None, local_description=True)
       text = change.FullDescriptionText()
 
     description.set_description(text)
   else:
     description.prompt()
 
   if cl.GetDescription() != description.description:
-    cl.UpdateDescription(description.description)
+    cl.UpdateDescription(options.force, description.description)
   return 0
 
 
 def CreateDescriptionFromLog(args):
   """Pulls out the commit log to use as a base for the CL description."""
   log_args = []
   if len(args) == 1 and not args[0].endswith('.'):
     log_args = [args[0] + '..']
   elif len(args) == 1 and args[0].endswith('...'):
     log_args = [args[0][:-1]]
@@ skipping 562 matching lines @@
     to_pending = ' to pending queue' if pushed_to_pending else ''
     viewvc_url = settings.GetViewVCUrl()
     if not to_pending:
       if viewvc_url and revision:
         change_desc.append_footer(
             'Committed: %s%s' % (viewvc_url, revision))
       elif revision:
         change_desc.append_footer('Committed: %s' % (revision,))
     print('Closing issue '
           '(you may be prompted for your codereview password)...')
-    cl.UpdateDescription(change_desc.description)
+    cl.UpdateDescription(False, change_desc.description)
     cl.CloseIssue()
     props = cl.GetIssueProperties()
     patch_num = len(props['patchsets'])
     comment = "Committed patchset #%d (id:%d)%s manually as %s" % (
         patch_num, props['patchsets'][-1], to_pending, revision)
     if options.bypass_hooks:
       comment += ' (tree was closed).' if GetTreeStatus() == 'closed' else '.'
     else:
       comment += ' (presubmit successful).'
     cl.RpcServer().add_comment(cl.GetIssue(), comment)
@@ skipping 1008 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)