git cl: add plumbing command to get metadata about CLs in machine-readable form

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 1430 matching lines @@
     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 IsOpen(self):
+    return self._codereview_impl.IsOpen()
+
+  def GetCQState(self):
+    state = self._codereview_impl.GetCQState()
+    assert state in _CQState.ALL_STATES
+    return state
+
   def GetCodereviewServer(self):
     return self._codereview_impl.GetCodereviewServer()
 
   def GetApprovingReviewers(self):
     return self._codereview_impl.GetApprovingReviewers()
 
   def GetMostRecentPatchset(self):
     return self._codereview_impl.GetMostRecentPatchset()
 
   def __getattr__(self, attr):
@@ skipping 15 matching lines @@
     return getattr(self._changelist, attr)
 
   def GetStatus(self):
     """Apply a rough heuristic to give a simple summary of an issue's review
     or CQ status, assuming adherence to a common workflow.
 
     Returns None if no issue for this branch, or specific string keywords.
     """
     raise NotImplementedError()
 
+  def IsOpen(self):
+    """Returns True iff the issue is open."""
+    raise NotImplementedError()
+
+  def GetCQState(self):
+    """Returns CQ state (see _CQState)."""
+    raise NotImplementedError()
+
   def GetCodereviewServer(self):
     """Returns server URL without end slash, like "https://codereview.com"."""
     raise NotImplementedError()
 
   def FetchDescription(self):
     """Fetches and returns description from the codereview server."""
     raise NotImplementedError()
 
   def GetCodereviewServerSetting(self):
     """Returns git config setting for the codereview server."""
@@ skipping 178 matching lines @@
       * 'closed'  - closed
     """
     if not self.GetIssue():
       return None
 
     try:
       props = self.GetIssueProperties()
     except urllib2.HTTPError:
       return 'error'
 
-    if props.get('closed'):
-      # Issue is closed.
+    if not self.IsOpen():
       return 'closed'
-    if props.get('commit') and not props.get('cq_dry_run', False):
-      # Issue is in the commit queue.
+    if self.GetCQState() == _CQState.COMMIT:
       return 'commit'
 
     try:
       reviewers = self.GetApprovingReviewers()
     except urllib2.HTTPError:
       return 'error'
 
     if reviewers:
       # Was LGTM'ed.
       return 'lgtm'
@@ skipping 13 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 IsOpen(self, props=None):
+    if not props:
+      props = self.GetIssueProperties()
+    return not props.get('closed')
+
+  def GetCQState(self, props=None):
+    if not props:
+      props = self.GetIssueProperties()
+    if props.get('commit') and not props.get('cq_dry_run'):
+      return _CQState.COMMIT
+    if props.get('cq_dry_run'):
+      return _CQState.DRY_RUN
+    return _CQState.NONE
+
   def UpdateDescriptionRemote(self, 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})
 
@@ skipping 452 matching lines @@
       * 'closed'   - abandoned
     """
     if not self.GetIssue():
       return None
 
     try:
       data = self._GetChangeDetail(['DETAILED_LABELS', 'CURRENT_REVISION'])
     except httplib.HTTPException:
       return 'error'
 
-    if data['status'] in ('ABANDONED', 'MERGED'):
+    if not self.IsOpen(data=data):
       return 'closed'
 
-    cq_label = data['labels'].get('Commit-Queue', {})
-    if cq_label:
-      # Vote value is a stringified integer, which we expect from 0 to 2.
-      vote_value = cq_label.get('value', '0')
-      vote_text = cq_label.get('values', {}).get(vote_value, '')
-      if vote_text.lower() == 'commit':
-        return 'commit'
+    if self.GetCQState(data=data) == _CQState.COMMIT:
+      return 'commit'
 
     lgtm_label = data['labels'].get('Code-Review', {})
     if lgtm_label:
       if 'rejected' in lgtm_label:
         return 'not lgtm'
       if 'approved' in lgtm_label:
         return 'lgtm'
 
     if not data.get('reviewers', {}).get('REVIEWER', []):
       return 'unsent'
 
     messages = data.get('messages', [])
     if messages:
       owner = data['owner'].get('_account_id')
       last_message_author = messages[-1].get('author', {}).get('_account_id')
       if owner != last_message_author:
         # Some reply from non-owner.
         return 'reply'
 
     return 'waiting'
 
+  def IsOpen(self, data=None):
+    if not data:
+      data = self._GetChangeDetail(['DETAILED_LABELS', 'CURRENT_REVISION'])
+    return data['status'] not in ('ABANDONED', 'MERGED')
+
+  def GetCQState(self, data=None):
+    if not data:
+      data = self._GetChangeDetail(['DETAILED_LABELS', 'CURRENT_REVISION'])
+    cq_label = data['labels'].get('Commit-Queue', {})
+    if cq_label:
+      # Vote value is a stringified integer, which we expect from 0 to 2.
+      vote_value = cq_label.get('value', '0')
+      vote_text = cq_label.get('values', {}).get(vote_value, '')
+      if vote_text.lower() == 'commit':
+        return _CQState.COMMIT
+      if vote_test.lower() == 'dry run':
+        return _CQState.DRY_RUN
+    return _CQState.NONE
+
   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)
 
@@ skipping 2817 matching lines @@
 def CMDlol(parser, args):
   # This command is intentionally undocumented.
   print(zlib.decompress(base64.b64decode(
       'eNptkLEOwyAMRHe+wupCIqW57v0Vq84WqWtXyrcXnCBsmgMJ+/SSAxMZgRB6NzE'
       'E2ObgCKJooYdu4uAQVffUEoE1sRQLxAcqzd7uK2gmStrll1ucV3uZyaY5sXyDd9'
       'JAnN+lAXsOMJ90GANAi43mq5/VeeacylKVgi8o6F1SC63FxnagHfJUTfUYdCR/W'
       'Ofe+0dHL7PicpytKP750Fh1q2qnLVof4w8OZWNY')))
   return 0
 
 
+def CMDplumbing(parser, args):
+  """Returns info about the CL in machine-readable form."""
+  parser.add_option('--json', help='Path to output JSON file')
+
+  auth.add_auth_options(parser)
+
+  _add_codereview_select_options(parser)
+  options, args = parser.parse_args(args)
+  _process_codereview_select_options(parser, options)
+
+  auth_config = auth.extract_auth_config_from_options(options)
+
+  cl = Changelist(auth_config=auth_config, codereview=options.forced_codereview)
+
+  result = {
+    'open': cl.IsOpen(),
+    'commit_queue': cl.GetCQState(),
+  }
+
+  if options.json:
+    with open(options.json, 'w') as f:
+      json.dump(result, f)
+  else:
+    print(json.dumps(result, sort_keys=True, indent=4))
+
+  return 0
+
+
 class OptionParser(optparse.OptionParser):
   """Creates the option parse and add --verbose support."""
   def __init__(self, *args, **kwargs):
     optparse.OptionParser.__init__(
         self, *args, prog='git cl', version=__version__, **kwargs)
     self.add_option(
         '-v', '--verbose', action='count', default=0,
         help='Use 2 times for more debugging info')
 
   def parse_args(self, args=None, values=None):
@@ skipping 31 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)