git cl set-commit: for Gerrit + dry-run support.

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 817 matching lines @@
   """Returns current branch or None.
 
   For refs/heads/* branches, returns just last part. For others, full ref.
   """
   branchref = GetCurrentBranchRef()
   if branchref:
     return ShortBranchName(branchref)
   return None
 
 
+class _CQState(object):
+  """Enum for states of CL with respect to Commit Queue."""
+  NONE = 'none'
+  DRY_RUN = 'dry_run'
+  COMMIT = 'commit'
+
+  ALL_STATES = [NONE, DRY_RUN, COMMIT]
+
+
 class _ParsedIssueNumberArgument(object):
   def __init__(self, issue=None, patchset=None, hostname=None):
     self.issue = issue
     self.patchset = patchset
     self.hostname = hostname
 
   @property
   def valid(self):
     return self.issue is not None
 
@@ skipping 542 matching lines @@
         print
         print '--dependencies has been specified.'
         print 'All dependent local branches will be re-uploaded.'
         print
         # Remove the dependencies flag from args so that we do not end up in a
         # loop.
         orig_args.remove('--dependencies')
         ret = upload_branch_deps(self, orig_args)
     return ret
 
+  def SetCQState(self, new_state):
+    """Update the CQ state for latest patchset.
+
+    Issue must have been already uploaded and known.
+    """
+    assert new_state in _CQState.ALL_STATES
+    assert self.GetIssue()
+    return self._codereview_impl.SetCQState(new_state)
+
   # Forward methods to codereview specific implementation.
 
   def CloseIssue(self):
     return self._codereview_impl.CloseIssue()
 
   def GetStatus(self):
     return self._codereview_impl.GetStatus()
 
   def GetCodereviewServer(self):
     return self._codereview_impl.GetCodereviewServer()
@@ skipping 105 matching lines @@
 
     Arguments:
       force: whether to skip confirmation questions.
     """
     raise NotImplementedError()
 
   def CMDUploadChange(self, options, args, change):
     """Uploads a change to codereview."""
     raise NotImplementedError()
 
+  def SetCQState(self, new_state):
+    """Update the CQ state for latest patchset.
+
+    Issue must have been already uploaded and known.
+    """
+    raise NotImplementedError()
+
 
 class _RietveldChangelistImpl(_ChangelistCodereviewBase):
   def __init__(self, changelist, auth_config=None, rietveld_server=None):
     super(_RietveldChangelistImpl, self).__init__(changelist)
     assert settings, 'must be initialized in _ChangelistCodereviewBase'
     settings.GetDefaultServerUrl()
 
     self._rietveld_server = rietveld_server
     self._auth_config = auth_config
     self._props = None
@@ skipping 157 matching lines @@
   def GetCodereviewServerSetting(self):
     """Returns the git setting that stores this change's rietveld server."""
     branch = self.GetBranch()
     if branch:
       return 'branch.%s.rietveldserver' % branch
     return None
 
   def GetRieveldObjForPresubmit(self):
     return self.RpcServer()
 
+  def SetCQState(self, new_state):
+    props = self.GetIssueProperties()
+    if props.get('private'):
+      DieWithError('Cannot set-commit on private issue')
+
+    if new_state == _CQState.COMMIT:
+      self.SetFlag('commit', '1')
+    elif new_state == _CQState.NONE:
+      self.SetFlag('commit', '0')
+    else:
+      raise NotImplementedError()

[Sergiy Byelozyorov, 2016/04/13 17:15:02]

What about DRY_RUN?

[tandrii(chromium), 2016/04/13 17:17:16]

wasn't supported before, so whatever.

+
+
   def CMDPatchWithParsedIssue(self, parsed_issue_arg, reject, nocommit,
                               directory):
     # TODO(maruel): Use apply_issue.py
 
     # PatchIssue should never be called with a dirty tree.  It is up to the
     # caller to check this, but just in case we assert here since the
     # consequences of the caller not checking this could be dire.
     assert(not git_common.is_dirty_git_tree('apply'))
     assert(parsed_issue_arg.valid)
     self._changelist.issue = parsed_issue_arg.issue
@@ skipping 217 matching lines @@
         backup_file = open(backup_path, 'w')
         backup_file.write(change_desc.description)
         backup_file.close()
       raise
 
     if not self.GetIssue():
       self.SetIssue(issue)
     self.SetPatchset(patchset)
 
     if options.use_commit_queue:
-      self.SetFlag('commit', '1')
+      self.SetCQState(_CQState.COMMIT)
     return 0
 
 
 class _GerritChangelistImpl(_ChangelistCodereviewBase):
   def __init__(self, changelist, auth_config=None):
     # auth_config is Rietveld thing, kept here to preserve interface only.
     super(_GerritChangelistImpl, self).__init__(changelist)
     self._change_id = None
     # Lazily cached values.
     self._gerrit_server = None  # e.g. https://chromium-review.googlesource.com
@@ skipping 493 matching lines @@
     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 SetCQState(self, new_state):
+    """Sets the Commit-Queue label assuming canonical CQ config for Gerrit."""
+    # TODO(tandrii): maybe allow configurability in codereview.settings or by
+    # self-discovery of label config for this CL using REST API.
+    vote_map = {
+        _CQState.NONE:    0,
+        _CQState.DRY_RUN: 1,
+        _CQState.COMMIT : 2,
+    }
+    gerrit_util.SetReview(self._GetGerritHost(), self.GetIssue(),
+                          labels={'Commit-Queue': vote_map[new_state]})
+
 
 _CODEREVIEW_IMPLEMENTATIONS = {
   'rietveld': _RietveldChangelistImpl,
   'gerrit': _GerritChangelistImpl,
 }
 
 
 class ChangeDescription(object):
   """Contains a parsed form of the change description."""
   R_LINE = r'^[ \t]*(TBR|R)[ \t]*=[ \t]*(.*?)[ \t]*$'
@@ skipping 1596 matching lines @@
 
   print "The tree is %s" % status
   print
   print GetTreeStatusReason()
   if status != 'open':
     return 1
   return 0
 
 
 def CMDtry(parser, args):
-  """Triggers a try job through BuildBucket."""
+  """Triggers try jobs through BuildBucket."""
   group = optparse.OptionGroup(parser, "Try job options")
   group.add_option(
       "-b", "--bot", action="append",
       help=("IMPORTANT: specify ONE builder per --bot flag. Use it multiple "
             "times to specify multiple builders. ex: "
             "'-b win_rel -b win_layout'. See "
             "the try server waterfall for the builders name and the tests "
             "available."))
   group.add_option(
       "-m", "--master", default='',
@@ skipping 38 matching lines @@
   if bad_params:
     parser.error('Got properties with missing "=": %s' % bad_params)
 
   if args:
     parser.error('Unknown arguments: %s' % args)
 
   cl = Changelist(auth_config=auth_config)
   if not cl.GetIssue():
     parser.error('Need to upload first')
 
+  if cl.IsGerrit():
+    parser.error(
+        'Not yet supported for Gerrit (http://crbug.com/599931).\n'
+        'If your project has Commit Queue, dry run is a workaround:\n'
+        '  git cl set-commit --dry-run')
+  # Code below assumes Rietveld issue.
+  # TODO(tandrii): actually implement for Gerrit http://crbug.com/599931.
+
   props = cl.GetIssueProperties()
   if props.get('closed'):
     parser.error('Cannot send tryjobs for a closed CL')
 
   if props.get('private'):
     parser.error('Cannot use trybots with private issue')
 
   if not options.name:
     options.name = cl.GetBranch()
 
@@ skipping 201 matching lines @@
   if not issue_url:
     print >> sys.stderr, 'ERROR No issue to open'
     return 1
 
   webbrowser.open(issue_url)
   return 0
 
 
 def CMDset_commit(parser, args):
   """Sets the commit bit to trigger the Commit Queue."""
+  parser.add_option('-d', '--dry-run', action='store_true',
+                    help='trigger in dry run mode')
+  parser.add_option('-c', '--clear', action='store_true',
+                    help='stop CQ run, if any')
   auth.add_auth_options(parser)
   options, args = parser.parse_args(args)
   auth_config = auth.extract_auth_config_from_options(options)
   if args:
     parser.error('Unrecognized args: %s' % ' '.join(args))
+  if options.dry_run and options.clear:
+    parser.error('Make up your mind: both --dry-run and --clear not allowed')
+
   cl = Changelist(auth_config=auth_config)
-  props = cl.GetIssueProperties()
-  if props.get('private'):
-    parser.error('Cannot set commit on private issue')
-  cl.SetFlag('commit', '1')
+  if options.clear:
+    state = _CQState.CLEAR
+  elif options.dry_run:
+    state = _CQState.DRY_RUN
+  else:
+    state = _CQState.COMMIT
+  if not cl.GetIssue():
+    parser.error('Must upload the issue first')
+  cl.SetCQState(state)
   return 0
 
 
 def CMDset_close(parser, args):
   """Closes the issue."""
   auth.add_auth_options(parser)
   options, args = parser.parse_args(args)
   auth_config = auth.extract_auth_config_from_options(options)
   if args:
     parser.error('Unrecognized args: %s' % ' '.join(args))
@@ skipping 339 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)