Refactor gcl.py to use a similar pattern for every commands.

gcl.py

 #!/usr/bin/python
 # Copyright (c) 2006-2009 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.
 
 """Wrapper script around Rietveld's upload.py that groups files into
 changelists."""
 
 import getpass
 import os
 import random
 import re
 import shutil
 import string
 import subprocess
 import sys
 import tempfile
 import time
 from third_party import upload
 import urllib2
 
+__pychecker__ = 'unusednames=breakpad'
 import breakpad
+__pychecker__ = ''
 
 # gcl now depends on gclient.
 from scm import SVN
 import gclient_utils
 
 __version__ = '1.1.3'
 
 
 CODEREVIEW_SETTINGS = {
   # Ideally, we want to set |CODE_REVIEW_SERVER| to a generic server like
@@ skipping 19 matching lines @@
 
 # Filename where we store repository specific information for gcl.
 CODEREVIEW_SETTINGS_FILE = "codereview.settings"
 
 # Warning message when the change appears to be missing tests.
 MISSING_TEST_MSG = "Change contains new or modified methods, but no new tests!"
 
 # Global cache of files cached in GetCacheDir().
 FILES_CACHE = {}
 
+# Valid extensions for files we want to lint.
+DEFAULT_LINT_REGEX = r"(.*\.cpp|.*\.cc|.*\.h)"
+DEFAULT_LINT_IGNORE_REGEX = r"$^"
+
+
 def CheckHomeForFile(filename):
   """Checks the users home dir for the existence of the given file.  Returns
   the path to the file if it's there, or None if it is not.
   """
   home_vars = ['HOME']
   if sys.platform in ('cygwin', 'win32'):
     home_vars.append('USERPROFILE')
   for home_var in home_vars:
     home = os.getenv(home_var)
     if home != None:
@@ skipping 509 matching lines @@
       ErrorExit("Error accessing url %s" % request_path)
     else:
       return None
 
 
 def GetIssueDescription(issue):
   """Returns the issue description from Rietveld."""
   return SendToRietveld("/%d/description" % issue)
 
 
-def Opened(show_unknown_files):
-  """Prints a list of modified files in the current directory down."""
+def ListFiles(show_unknown_files):
   files = GetModifiedFiles()
   cl_keys = files.keys()
   cl_keys.sort()
   for cl_name in cl_keys:
     if not cl_name:
       continue
     note = ""
     change_info = ChangeInfo.Load(cl_name, GetRepositoryRoot(),
                                   fail_on_not_found=True, update_status=False)
     if len(change_info.GetFiles()) != len(files[cl_name]):
       note = " (Note: this changelist contains files outside this directory)"
     print "\n--- Changelist " + cl_name + note + ":"
     for filename in files[cl_name]:
       print "".join(filename)
   if show_unknown_files:
     unknown_files = UnknownFiles([])
   if (files.get('') or (show_unknown_files and len(unknown_files))):
     print "\n--- Not in any changelist:"
     for item in files.get('', []):
       print "".join(item)
     if show_unknown_files:
       for filename in unknown_files:
         print "?      %s" % filename
+  return 0
 
 
-def Help(argv=None):
-  if argv:
-    if argv[0] == 'try':
+def CMDopened(argv):
+  """Lists modified files in the current directory down."""
+  __pychecker__ = 'unusednames=argv'
+  return ListFiles(False)
+
+
+def CMDstatus(argv):
+  """Lists modified and unknown files in the current directory down."""
+  __pychecker__ = 'unusednames=argv'
+  return ListFiles(True)
+
+
+def CMDhelp(argv=None):
+  """Prints this help or help for the given command."""
+  if len(argv) > 2:
+    if argv[2] == 'try':
       TryChange(None, ['--help'], swallow_exception=False)
-      return
-    if argv[0] == 'upload':
+      return 0
+    if argv[2] == 'upload':
       upload.RealMain(['upload.py', '--help'])
-      return
+      return 0
 
   print (
 """GCL is a wrapper for Subversion that simplifies working with groups of files.
 version """ + __version__ + """
 
 Basic commands:
 -----------------------------------------
    gcl change change_name
       Add/remove files to a changelist. Only scans the current directory and
       subdirectories.
@@ skipping 54 matching lines @@
       of changenames.
       --> Use 'gcl help try' for more information!
 
    gcl deleteempties
       Deletes all changelists that have no files associated with them. Careful,
       you can lose your descriptions.
 
    gcl help [command]
       Print this help menu, or help for the given command if it exists.
 """)
+  return 0
+
 
 def GetEditor():
   editor = os.environ.get("SVN_EDITOR")
   if not editor:
     editor = os.environ.get("EDITOR")
 
   if not editor:
     if sys.platform.startswith("win"):
       editor = "notepad"
     else:
       editor = "vi"
 
   return editor
 
 
 def GenerateDiff(files, root=None):
   return SVN.GenerateDiff(files, root=root)
 
 
 def OptionallyDoPresubmitChecks(change_info, committing, args):
   if FilterFlag(args, "--no_presubmit") or FilterFlag(args, "--force"):
     return True
   return DoPresubmitChecks(change_info, committing, True)
 
 
-def UploadCL(change_info, args):
+def CMDupload(change_info, args):
   if not change_info.GetFiles():
     print "Nothing to upload, changelist is empty."
     return
   if not OptionallyDoPresubmitChecks(change_info, False, args):
     return
   # Might want to support GetInfoDir()/GetRepositoryRoot() like
   # CheckHomeForFile() so the skip of tries can be per tree basis instead
   # of user global.
   no_try = FilterFlag(args, "--no_try") or \
            FilterFlag(args, "--no-try") or \
@@ skipping 95 matching lines @@
   if not no_try:
     try_on_upload = GetCodeReviewSetting('TRY_ON_UPLOAD')
     if try_on_upload and try_on_upload.lower() == 'true':
       trychange_args = []
       if clobber:
         trychange_args.append('--clobber')
       TryChange(change_info, trychange_args, swallow_exception=True)
 
 
 
-def PresubmitCL(change_info):
-  """Reports what presubmit checks on the change would report."""
+def CMDpresubmit(change_info, argv):
+  """Runs presubmit checks on the change."""
+  __pychecker__ = 'unusednames=argv'
   if not change_info.GetFiles():
     print "Nothing to presubmit check, changelist is empty."
-    return
+    return 0
 
   print "*** Presubmit checks for UPLOAD would report: ***"
-  DoPresubmitChecks(change_info, False, False)
+  result = DoPresubmitChecks(change_info, False, False)
 
   print "\n*** Presubmit checks for COMMIT would report: ***"
-  DoPresubmitChecks(change_info, True, False)
+  result &= DoPresubmitChecks(change_info, True, False)
+  return not result
 
 
 def TryChange(change_info, args, swallow_exception):
   """Create a diff file of change_info and send it to the try server."""
   try:
     import trychange
   except ImportError:
     if swallow_exception:
       return
     ErrorExit("You need to install trychange.py to use the try server.")
 
   trychange_args = []
   if change_info:
     trychange_args.extend(['--name', change_info.name])
     if change_info.issue:
       trychange_args.extend(["--issue", str(change_info.issue)])
     if change_info.patchset:
       trychange_args.extend(["--patchset", str(change_info.patchset)])
     trychange_args.extend(args)
     file_list = change_info.GetFileNames()
   else:
     trychange_args.extend(args)
     file_list = None
   trychange.TryChange(trychange_args,
                       file_list=file_list,
                       swallow_exception=swallow_exception,
                       prog='gcl try')
 
 
-def Commit(change_info, args):
+def CMDcommit(change_info, args):
   if not change_info.GetFiles():
     print "Nothing to commit, changelist is empty."
-    return
+    return 1
   if not OptionallyDoPresubmitChecks(change_info, True, args):
-    return
+    return 1
 
   # We face a problem with svn here: Let's say change 'bleh' modifies
   # svn:ignore on dir1\. but another unrelated change 'pouet' modifies
   # dir1\foo.cc. When the user `gcl commit bleh`, foo.cc is *also committed*.
   # The only fix is to use --non-recursive but that has its issues too:
   # Let's say if dir1 is deleted, --non-recursive must *not* be used otherwise
   # you'll get "svn: Cannot non-recursively commit a directory deletion of a
   # directory with child nodes". Yay...
   commit_cmd = ["svn", "commit"]
   if change_info.issue:
@@ skipping 28 matching lines @@
 
     if change_info.issue:
       revision = re.compile(".*?\nCommitted revision (\d+)",
                             re.DOTALL).match(output).group(1)
       viewvc_url = GetCodeReviewSetting("VIEW_VC")
       change_info.description = change_info.description + '\n'
       if viewvc_url:
         change_info.description += "\nCommitted: " + viewvc_url + revision
       change_info.CloseIssue()
   os.chdir(previous_cwd)
+  return 0
 
 
-def Change(change_info, args):
+def CMDchange(change_info, args):
   """Creates/edits a changelist."""
   silent = FilterFlag(args, "--silent")
 
   # Verify the user is running the change command from a read-write checkout.
   svn_info = SVN.CaptureInfo('.')
   if not svn_info:
     ErrorExit("Current checkout is unversioned.  Please retry with a versioned "
               "directory.")
 
   if (len(args) == 1):
@@ skipping 48 matching lines @@
   os.write(handle, text)
   os.close(handle)
 
   if not silent:
     os.system(GetEditor() + " " + filename)
 
   result = gclient_utils.FileRead(filename, 'r')
   os.remove(filename)
 
   if not result:
-    return
+    return 0
 
   split_result = result.split(separator1, 1)
   if len(split_result) != 2:
     ErrorExit("Don't modify the text starting with ---!\n\n" + result)
 
   # Update the CL description if it has changed.
   new_description = split_result[0]
   cl_files_text = split_result[1]
   if new_description != description or override_description:
     change_info.description = new_description
@@ skipping 21 matching lines @@
 
   print change_info.name + " changelist saved."
   if change_info.MissingTests():
     Warn("WARNING: " + MISSING_TEST_MSG)
 
   # Update the Rietveld issue.
   if change_info.issue and change_info.NeedsUpload():
     change_info.UpdateRietveldDescription()
     change_info.needs_upload = False
     change_info.Save()
+  return 0
 
 
-# Valid extensions for files we want to lint.
-DEFAULT_LINT_REGEX = r"(.*\.cpp|.*\.cc|.*\.h)"
-DEFAULT_LINT_IGNORE_REGEX = r"$^"
-
-def Lint(change_info, args):
+def CMDlint(change_info, args):
   """Runs cpplint.py on all the files in |change_info|"""
   try:
     import cpplint
   except ImportError:
     ErrorExit("You need to install cpplint.py to lint C++ files.")
 
   # Change the current working directory before calling lint so that it
   # shows the correct base.
   previous_cwd = os.getcwd()
   os.chdir(change_info.GetLocalRoot())
@@ skipping 13 matching lines @@
     if white_regex.match(filename):
       if black_regex.match(filename):
         print "Ignoring file %s" % filename
       else:
         cpplint.ProcessFile(filename, cpplint._cpplint_state.verbose_level)
     else:
       print "Skipping file %s" % filename
 
   print "Total errors found: %d\n" % cpplint._cpplint_state.error_count
   os.chdir(previous_cwd)
+  return 1
 
 
 def DoPresubmitChecks(change_info, committing, may_prompt):
   """Imports presubmit, then calls presubmit.DoPresubmitChecks."""
   # Need to import here to avoid circular dependency.
   import presubmit_support
   root_presubmit = GetCachedFile('PRESUBMIT.py', use_root=True)
   change = presubmit_support.SvnChange(change_info.name,
                                        change_info.description,
                                        change_info.GetLocalRoot(),
                                        change_info.GetFiles(),
                                        change_info.issue,
                                        change_info.patchset)
   result = presubmit_support.DoPresubmitChecks(change=change,
                                                committing=committing,
                                                verbose=False,
                                                output_stream=sys.stdout,
                                                input_stream=sys.stdin,
                                                default_presubmit=root_presubmit,
                                                may_prompt=may_prompt)
   if not result and may_prompt:
     print "\nPresubmit errors, can't continue (use --no_presubmit to bypass)"
   return result
 
 
-def Changes():
-  """Print all the changelists and their files."""
+def CMDchanges(argv):
+  """Lists all the changelists and their files."""
+  __pychecker__ = 'unusednames=argv'
   for cl in GetCLs():
     change_info = ChangeInfo.Load(cl, GetRepositoryRoot(), True, True)
     print "\n--- Changelist " + change_info.name + ":"
     for filename in change_info.GetFiles():
       print "".join(filename)
+  return 0
 
 
-def DeleteEmptyChangeLists():
+def CMDdeleteempties(argv):
   """Delete all changelists that have no files."""
+  __pychecker__ = 'unusednames=argv'
   print "\n--- Deleting:"
   for cl in GetCLs():
     change_info = ChangeInfo.Load(cl, GetRepositoryRoot(), True, True)
     if not len(change_info._files):
       print change_info.name
       change_info.Delete()
+  return 0
+
+
+def CMDnothave(argv):
+  """Lists files unknown to Subversion."""
+  __pychecker__ = 'unusednames=argv'
+  for filename in UnknownFiles(argv[2:]):
+    print "?      " + "".join(filename)
+  return 0
+
+
+def CMDdiff(argv):
+  """Diffs all files in the changelist."""
+  __pychecker__ = 'unusednames=argv'
+  files = GetFilesNotInCL()
+  print GenerateDiff([x[1] for x in files])
+  return 0
+
+
+def CMDsettings(argv):
+  """Prints code review settings."""
+  __pychecker__ = 'unusednames=argv'
+  # Force load settings
+  GetCodeReviewSetting("UNKNOWN");
+  del CODEREVIEW_SETTINGS['__just_initialized']
+  print '\n'.join(("%s: %s" % (str(k), str(v))
+                    for (k,v) in CODEREVIEW_SETTINGS.iteritems()))
+  return 0
+
+
+def CMDdescription(change_info, argv):
+  """Prints the description of the specified change to stdout."""
+  __pychecker__ = 'unusednames=argv'
+  print change_info.description
+  return 0
+
+
+def CMDdelete(change_info, argv):
+  """Deletes a changelist."""
+  __pychecker__ = 'unusednames=argv'
+  change_info.Delete()
+  return 0
+
+
+def CMDtry(change_info, argv):
+  """Sends the change to the tryserver so a trybot can do a test run on your
+  code.
+
+  To send multiple changes as one path, use a comma-separated list of
+  changenames. Use 'gcl help try' for more information!"""
+  # When the change contains no file, send the "changename" positional
+  # argument to trychange.py.
+  __pychecker__ = 'unusednames=argv'
+  if change_info.GetFiles():
+    args = argv[3:]
+  else:
+    change_info = None
+    args = argv[2:]
+  TryChange(change_info, args, swallow_exception=False)
+  return 0
+
+
+def CMDrename(argv):
+  """Renames an existing change."""
+  if len(argv) != 4:
+    ErrorExit("Usage: gcl rename <old-name> <new-name>.")
+  src, dst = argv[2:4]
+  src_file = GetChangelistInfoFile(src)
+  if not os.path.isfile(src_file):
+    ErrorExit("Change '%s' does not exist." % src)
+  dst_file = GetChangelistInfoFile(dst)
+  if os.path.isfile(dst_file):
+    ErrorExit("Change '%s' already exists; pick a new name." % dst)
+  os.rename(src_file, dst_file)
+  print "Change '%s' renamed '%s'." % (src, dst)
+  return 0
 
 
 def main(argv=None):
+  __pychecker__ = 'maxreturns=0'
   if argv is None:
     argv = sys.argv
 
   if len(argv) == 1:
-    Help()
-    return 0;
+    return CMDhelp()
 
   try:
     # Create the directories where we store information about changelists if it
     # doesn't exist.
     if not os.path.exists(GetInfoDir()):
       os.mkdir(GetInfoDir())
     if not os.path.exists(GetChangesDir()):
       os.mkdir(GetChangesDir())
     if not os.path.exists(GetCacheDir()):
       os.mkdir(GetCacheDir())
   except gclient_utils.Error:
     # Will throw an exception if not run in a svn checkout.
     pass
 
   # Commands that don't require an argument.
   command = argv[1]
-  if command == "opened" or command == "status":
-    Opened(command == "status")
-    return 0
+  if command == "opened":
+    return CMDopened(argv)
+  if command == "status":
+    return CMDstatus(argv)
   if command == "nothave":
-    __pychecker__ = 'no-returnvalues'
-    for filename in UnknownFiles(argv[2:]):
-      print "?      " + "".join(filename)
-    return 0
+    return CMDnothave(argv)
   if command == "changes":
-    Changes()
-    return 0
+    return CMDchanges(argv)
   if command == "help":
-    Help(argv[2:])
-    return 0
+    return CMDhelp(argv)
   if command == "diff" and len(argv) == 2:
-    files = GetFilesNotInCL()
-    print GenerateDiff([x[1] for x in files])
-    return 0
+    return CMDdiff(argv)
   if command == "settings":
-    # Force load settings
-    GetCodeReviewSetting("UNKNOWN");
-    del CODEREVIEW_SETTINGS['__just_initialized']
-    print '\n'.join(("%s: %s" % (str(k), str(v))
-                     for (k,v) in CODEREVIEW_SETTINGS.iteritems()))
-    return 0
+    return CMDsettings(argv)
   if command == "deleteempties":
-    DeleteEmptyChangeLists()
-    return 0
-
+    return CMDdeleteempties(argv)
   if command == "rename":
-    if len(argv) != 4:
-      ErrorExit("Usage: gcl rename <old-name> <new-name>.")
-    src, dst = argv[2:4]
-    src_file = GetChangelistInfoFile(src)
-    if not os.path.isfile(src_file):
-      ErrorExit("Change '%s' does not exist." % src)
-    dst_file = GetChangelistInfoFile(dst)
-    if os.path.isfile(dst_file):
-      ErrorExit("Change '%s' already exists; pick a new name." % dst)
-    os.rename(src_file, dst_file)
-    print "Change '%s' renamed '%s'." % (src, dst)
-    return 0
+    return CMDrename(argv)
   if command == "change":
     if len(argv) == 2:
       # Generate a random changelist name.
       changename = GenerateChangeName()
     elif argv[2] == '--force':
       changename = GenerateChangeName()
       # argv[3:] is passed to Change() as |args| later. Change() should receive
       # |args| which includes '--force'.
       argv.insert(2, changename)
     else:
       changename = argv[2]
   elif len(argv) == 2:
     ErrorExit("Need a changelist name.")
   else:
     changename = argv[2]
 
   # When the command is 'try' and --patchset is used, the patch to try
   # is on the Rietveld server. 'change' creates a change so it's fine if the
   # change didn't exist. All other commands require an existing change.
   fail_on_not_found = command != "try" and command != "change"
   if command == "try" and changename.find(',') != -1:
     change_info = LoadChangelistInfoForMultiple(changename, GetRepositoryRoot(),
                                                 True, True)
   else:
     change_info = ChangeInfo.Load(changename, GetRepositoryRoot(),
                                   fail_on_not_found, True)
 
   if command == "change":
-    Change(change_info, argv[3:])
+    return CMDchange(change_info, argv[3:])
   elif command == "description":
-    print change_info.description
+    return CMDdescription(change_info, argv[3:])
   elif command == "lint":
-    Lint(change_info, argv[3:])
+    return CMDlint(change_info, argv[3:])
   elif command == "upload":
-    UploadCL(change_info, argv[3:])
+    return CMDupload(change_info, argv[3:])
   elif command == "presubmit":
-    PresubmitCL(change_info)
+    return CMDpresubmit(change_info, argv[3:])
   elif command in ("commit", "submit"):
-    Commit(change_info, argv[3:])
+    return CMDcommit(change_info, argv[3:])
   elif command == "delete":
-    change_info.Delete()
+    return CMDdelete(change_info, argv[3:])
   elif command == "try":
-    # When the change contains no file, send the "changename" positional
-    # argument to trychange.py.
-    if change_info.GetFiles():
-      args = argv[3:]
-    else:
-      change_info = None
-      args = argv[2:]
-    TryChange(change_info, args, swallow_exception=False)
+    return CMDtry(change_info, argv)
   else:
     # Everything else that is passed into gcl we redirect to svn, after adding
     # the files. This allows commands such as 'gcl diff xxx' to work.
     if command == "diff" and not change_info.GetFileNames():
       return 0
     args =["svn", command]
     root = GetRepositoryRoot()
     args.extend([os.path.join(root, x) for x in change_info.GetFileNames()])
     RunShell(args, True)
   return 0
 
 
 if __name__ == "__main__":
   sys.exit(main())