Factor out Changelist GetStatus() for eventual use by other tools

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
@@ skipping 821 matching lines @@
     return presubmit_support.GitChange(
         name,
         description,
         absroot,
         files,
         issue,
         patchset,
         author,
         upstream=upstream_branch)
 
+  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 one of the following keywords:
+      * 'error'   - error from review tool (including deleted issues)
+      * 'unsent'  - not sent for review
+      * 'waiting' - waiting for review
+      * 'reply'   - waiting for owner to reply to review
+      * 'lgtm'    - LGTM from at least one approved reviewer
+      * 'commit'  - in the commit queue
+      * 'closed'  - closed
+    """
+    if not self.GetIssue():
+      return None
+
+    try:
+      props = self.GetIssueProperties()
+    except urllib2.HTTPError:
+      return 'error'
+
+    if props.get('closed'):
+      # Issue is closed.
+      return 'closed'
+    if props.get('commit'):
+      # Issue is in the commit queue.
+      return 'commit'
+
+    try:
+      reviewers = self.GetApprovingReviewers()
+    except urllib2.HTTPError:
+      return 'error'
+
+    if reviewers:
+      # Was LGTM'ed.
+      return 'lgtm'
+
+    messages = props.get('messages') or []
+
+    if not messages:
+      # No message was sent.
+      return 'unsent'
+    if messages[-1]['sender'] != props.get('owner_email'):
+      # Non-LGTM reply from non-owner
+      return 'reply'
+    return 'waiting'
+
   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.RpcServer())
     except presubmit_support.PresubmitFailure, e:
       DieWithError(
@@ skipping 359 matching lines @@
   if not args:
     print("Current base-url:")
     return RunGit(['config', 'branch.%s.base-url' % branch],
                   error_ok=False).strip()
   else:
     print("Setting base-url to %s" % args[0])
     return RunGit(['config', 'branch.%s.base-url' % branch, args[0]],
                   error_ok=False).strip()
 
 
+def color_for_status(status):
+  """Maps a Changelist status to color, for CMDstatus and other tools."""
+  if not status or status == 'error':
+    return Fore.WHITE
+  return {
+    'unsent': Fore.RED,
+    'waiting': Fore.BLUE,
+    'reply': Fore.YELLOW,
+    'lgtm': Fore.GREEN,
+    'commit': Fore.MAGENTA,
+    'closed': Fore.CYAN,
+  }[status]

[iannucci, 2014/09/10 22:44:30]

why not just put error in here and then just do

return {
  ...
}.get(status, Fore.WHITE)

[jsbell, 2014/09/11 17:27:55]

Done.

+
+
 def CMDstatus(parser, args):
   """Show status of changelists.
 
   Colors are used to tell the state of the CL unless --fast is used:
     - Red      not sent for review or broken
     - Blue     waiting for review
     - Yellow   waiting for you to reply to review
     - Green    LGTM'ed
     - Magenta  in the commit queue
     - Cyan     was committed, branch can be deleted
@@ skipping 38 matching lines @@
   # Adhoc thread pool to request data concurrently.
   output = Queue.Queue()
 
   # Silence upload.py otherwise it becomes unweldly.
   upload.verbosity = 0
 
   if not options.fast:
     def fetch(b):
       """Fetches information for an issue and returns (branch, issue, color)."""
       c = Changelist(branchref=b)
+      status = c.GetStatus()
+      color = color_for_status(status)
       i = c.GetIssueURL()
-      props = {}
-      r = None
-      if i:
-        try:
-          props = c.GetIssueProperties()
-          r = c.GetApprovingReviewers() if i else None
-        except urllib2.HTTPError:
-          # The issue probably doesn't exist anymore.
-          i += ' (broken)'
 
-      msgs = props.get('messages') or []
+      if not status or status == 'error':
+        # The issue probably doesn't exist anymore.
+        i += ' (broken)'
 
-      if not i:
-        color = Fore.WHITE
-      elif props.get('closed'):
-        # Issue is closed.
-        color = Fore.CYAN
-      elif props.get('commit'):
-        # Issue is in the commit queue.
-        color = Fore.MAGENTA
-      elif r:
-        # Was LGTM'ed.
-        color = Fore.GREEN
-      elif not msgs:
-        # No message was sent.
-        color = Fore.RED
-      elif msgs[-1]['sender'] != props.get('owner_email'):
-        color = Fore.YELLOW
-      else:
-        color = Fore.BLUE
       output.put((b, i, color))
 
     # Process one branch synchronously to work through authentication, then
     # spawn threads to process all the other branches in parallel.
     if branches:
       fetch(branches[0])
     threads = [
       threading.Thread(target=fetch, args=(b,)) for b in branches[1:]]
     for t in threads:
       t.daemon = True
@@ skipping 1517 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:]))