Added patchset persistence in gcl, this is necessary to implement a presubmit queue.

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
@@ skipping 230 matching lines @@
 def WriteFile(filename, contents):
   """Overwrites the file with the given contents."""
   file = open(filename, 'w')
   file.write(contents)
   file.close()
 
 
 class ChangeInfo(object):
   """Holds information about a changelist.
 
-    issue: the Rietveld issue number, of "" if it hasn't been uploaded yet.
+    name: change name.
+    issue: the Rietveld issue number or 0 if it hasn't been uploaded yet.
+    patchset: the Rietveld latest patchset number or 0.
     description: the description.
     files: a list of 2 tuple containing (status, filename) of changed files,
            with paths being relative to the top repository directory.
   """
-  def __init__(self, name="", issue="", description="", files=None):
+
+  _SEPARATOR = "\n-----\n"
+  # The info files have the following format:
+  # issue_id, patchset\n   (, patchset is optional)
+  # _SEPARATOR\n
+  # filepath1\n
+  # filepath2\n
+  # .
+  # .
+  # filepathn\n
+  # _SEPARATOR\n
+  # description
+
+  def __init__(self, name, issue, patchset, description, files):
     self.name = name
-    self.issue = issue
+    self.issue = int(issue)
+    self.patchset = int(patchset)
     self.description = description
     if files is None:
       files = []
     self.files = files
     self.patch = None
 
   def FileList(self):
     """Returns a list of files."""
     return [file[1] for file in self.files]
 
   def _NonDeletedFileList(self):
     """Returns a list of files in this change, not including deleted files."""
     return [file[1] for file in self.files if not file[0].startswith("D")]
 
   def _AddedFileList(self):
     """Returns a list of files added in this change."""
     return [file[1] for file in self.files if file[0].startswith("A")]
 
   def Save(self):
     """Writes the changelist information to disk."""
-    data = SEPARATOR.join([self.issue,
-                          "\n".join([f[0] + f[1] for f in self.files]),
-                          self.description])
+    data = ChangeInfo._SEPARATOR.join([
+        "%d, %d" % (self.issue, self.patchset),
+        "\n".join([f[0] + f[1] for f in self.files]),
+        self.description])
     WriteFile(GetChangelistInfoFile(self.name), data)
 
   def Delete(self):
     """Removes the changelist information from disk."""
     os.remove(GetChangelistInfoFile(self.name))
 
   def CloseIssue(self):
     """Closes the Rietveld issue for this changelist."""
     data = [("description", self.description),]
     ctype, body = upload.EncodeMultipartFormData(data, [])
@@ skipping 79 matching lines @@
       if (definition != "" and
           (line == "{" or line.startswith(" ") or line.startswith("\t"))):
         definition += line
 
       # A flush-left line starts a new possible function definition.
       elif not line.startswith(" ") and not line.startswith("\t"):
         definition = line
 
     return False
 
+  @staticmethod
+  def Load(changename, fail_on_not_found=True, update_status=False):
+    """Gets information about a changelist.
 
-SEPARATOR = "\n-----\n"
-# The info files have the following format:
-# issue_id\n
-# SEPARATOR\n
-# filepath1\n
-# filepath2\n
-# .
-# .
-# filepathn\n
-# SEPARATOR\n
-# description
+    Args:
+      fail_on_not_found: if True, this function will quit the program if the
+        changelist doesn't exist.
+      update_status: if True, the svn status will be updated for all the files
+        and unchanged files will be removed.
+
+    Returns: a ChangeInfo object.
+    """
+    info_file = GetChangelistInfoFile(changename)
+    if not os.path.exists(info_file):
+      if fail_on_not_found:
+        ErrorExit("Changelist " + changename + " not found.")
+      return ChangeInfo(changename)
+    split_data = ReadFile(info_file).split(ChangeInfo._SEPARATOR, 2)
+    if len(split_data) != 3:
+      ErrorExit("Changelist file %s is corrupt" % info_file)
+    items = split_data[0].split(',')
+    issue = 0
+    patchset = 0
+    if items[0]:
+      issue = int(items[0])
+    if len(items) > 1:
+      patchset = int(items[1])
+    files = []
+    for line in split_data[1].splitlines():
+      status = line[:7]
+      file = line[7:]
+      files.append((status, file))
+    description = split_data[2]
+    save = False
+    if update_status:
+      for file in files:
+        filename = os.path.join(GetRepositoryRoot(), file[1])
+        status_result = gclient.CaptureSVNStatus(filename)
+        if not status_result or not status_result[0][0]:
+          # File has been reverted.
+          save = True
+          files.remove(file)
+          continue
+        status = status_result[0][0]
+        if status != file[0]:
+          save = True
+          files[files.index(file)] = (status, file[1])
+    change_info = ChangeInfo(changename, issue, patchset, description, files)
+    if save:
+      change_info.Save()
+    return change_info
 
 
 def GetChangelistInfoFile(changename):
   """Returns the file that stores information about a changelist."""
   if not changename or re.search(r'[^\w-]', changename):
     ErrorExit("Invalid changelist name: " + changename)
   return os.path.join(GetChangesDir(), changename)
 
 
 def LoadChangelistInfoForMultiple(changenames, fail_on_not_found=True,
                                   update_status=False):
   """Loads many changes and merge their files list into one pseudo change.
 
   This is mainly usefull to concatenate many changes into one for a 'gcl try'.
   """
   changes = changenames.split(',')
-  aggregate_change_info = ChangeInfo(name=changenames)
+  aggregate_change_info = ChangeInfo(changenames, 0, 0, '', None)
   for change in changes:
-    aggregate_change_info.files += LoadChangelistInfo(change,
-                                                      fail_on_not_found,
-                                                      update_status).files
+    aggregate_change_info.files += ChangeInfo.Load(change, fail_on_not_found,
+                                                   update_status).files
   return aggregate_change_info
 
 
-def LoadChangelistInfo(changename, fail_on_not_found=True,
-                       update_status=False):
-  """Gets information about a changelist.
-
-  Args:
-    fail_on_not_found: if True, this function will quit the program if the
-      changelist doesn't exist.
-    update_status: if True, the svn status will be updated for all the files
-      and unchanged files will be removed.
-
-  Returns: a ChangeInfo object.
-  """
-  info_file = GetChangelistInfoFile(changename)
-  if not os.path.exists(info_file):
-    if fail_on_not_found:
-      ErrorExit("Changelist " + changename + " not found.")
-    return ChangeInfo(changename)
-  data = ReadFile(info_file)
-  split_data = data.split(SEPARATOR, 2)
-  if len(split_data) != 3:
-    os.remove(info_file)
-    ErrorExit("Changelist file %s was corrupt and deleted" % info_file)
-  issue = split_data[0]
-  files = []
-  for line in split_data[1].splitlines():
-    status = line[:7]
-    file = line[7:]
-    files.append((status, file))
-  description = split_data[2]
-  save = False
-  if update_status:
-    for file in files:
-      filename = os.path.join(GetRepositoryRoot(), file[1])
-      status_result = gclient.CaptureSVNStatus(filename)
-      if not status_result or not status_result[0][0]:
-        # File has been reverted.
-        save = True
-        files.remove(file)
-        continue
-      status = status_result[0][0]
-      if status != file[0]:
-        save = True
-        files[files.index(file)] = (status, file[1])
-  change_info = ChangeInfo(changename, issue, description, files)
-  if save:
-    change_info.Save()
-  return change_info
-
-
 def GetCLs():
   """Returns a list of all the changelists in this repository."""
   cls = os.listdir(GetChangesDir())
   if CODEREVIEW_SETTINGS_FILE in cls:
     cls.remove(CODEREVIEW_SETTINGS_FILE)
   return cls
 
 
 def GenerateChangeName():
   """Generate a random changelist name."""
@@ skipping 18 matching lines @@
   """
   files = {}
 
   # Since the files are normalized to the root folder of the repositary, figure
   # out what we need to add to the paths.
   dir_prefix = os.getcwd()[len(GetRepositoryRoot()):].strip(os.sep)
 
   # Get a list of all files in changelists.
   files_in_cl = {}
   for cl in GetCLs():
-    change_info = LoadChangelistInfo(cl)
+    change_info = ChangeInfo.Load(cl)
     for status, filename in change_info.files:
       files_in_cl[filename] = change_info.name
 
   # Get all the modified files.
   status_result = gclient.CaptureSVNStatus(None)
   for line in status_result:
     status = line[0]
     filename = line[1]
     if status[0] == "?":
       continue
@@ skipping 37 matching lines @@
     return rpc_server.Send(request_path, payload, content_type, timeout)
   except urllib2.URLError, e:
     if timeout is None:
       ErrorExit("Error accessing url %s" % request_path)
     else:
       return None
 
 
 def GetIssueDescription(issue):
   """Returns the issue description from Rietveld."""
-  return SendToRietveld("/" + issue + "/description")
+  return SendToRietveld("/%d/description" % issue)
 
 
 def Opened():
   """Prints a list of modified files in the current directory down."""
   files = GetModifiedFiles()
   cl_keys = files.keys()
   cl_keys.sort()
   for cl_name in cl_keys:
     if cl_name:
       note = ""
-      if len(LoadChangelistInfo(cl_name).files) != len(files[cl_name]):
+      if len(ChangeInfo.Load(cl_name).files) != len(files[cl_name]):
         note = " (Note: this changelist contains files outside this directory)"
       print "\n--- Changelist " + cl_name + note + ":"
     for file in files[cl_name]:
       print "".join(file)
 
 
 def Help(argv=None):
   if argv:
     if argv[0] == 'try':
       TryChange(None, ['--help'], swallow_exception=False)
@@ skipping 170 matching lines @@
   if change_info.issue:  # Uploading a new patchset.
     found_message = False
     for arg in args:
       if arg.startswith("--message") or arg.startswith("-m"):
         found_message = True
         break
 
     if not found_message:
       upload_arg.append("--message=''")
 
-    upload_arg.append("--issue=" + change_info.issue)
+    upload_arg.append("--issue=%d" % change_info.issue)
   else: # First time we upload.
     handle, desc_file = tempfile.mkstemp(text=True)
     os.write(handle, change_info.description)
     os.close(handle)
 
     cc_list = GetCodeReviewSetting("CC_LIST")
     if cc_list:
       upload_arg.append("--cc=" + cc_list)
     upload_arg.append("--description_file=" + desc_file + "")
     if change_info.description:
@@ skipping 10 matching lines @@
   # shows the correct base.
   previous_cwd = os.getcwd()
   os.chdir(GetRepositoryRoot())
 
   # If we have a lot of files with long paths, then we won't be able to fit
   # the command to "svn diff".  Instead, we generate the diff manually for
   # each file and concatenate them before passing it to upload.py.
   if change_info.patch is None:
     change_info.patch = GenerateDiff(change_info.FileList())
   issue, patchset = upload.RealMain(upload_arg, change_info.patch)
-  if issue and issue != change_info.issue:
-    change_info.issue = issue
+  if issue and patchset:
+    change_info.issue = int(issue)
+    change_info.patchset = int(patchset)
     change_info.Save()
 
   if desc_file:
     os.remove(desc_file)
 
   # Do background work on Rietveld to lint the file so that the results are
   # ready when the issue is viewed.
   SendToRietveld("/lint/issue%s_%s" % (issue, patchset), timeout=0.5)
 
   # Once uploaded to Rietveld, send it to the try server.
   if not no_try:
     try_on_upload = GetCodeReviewSetting('TRY_ON_UPLOAD')
     if try_on_upload and try_on_upload.lower() == 'true':
-      # Use the local diff.
-      args = [
-        "--issue", change_info.issue,
-        "--patchset", patchset,
-      ]
+      trychange_args = []
       if clobber:
-        args.append('--clobber')
-      TryChange(change_info, args, swallow_exception=True)
+        trychange_args.append('--clobber')
+      TryChange(change_info, trychange_args, swallow_exception=True)
 
   os.chdir(previous_cwd)
 
 
 def PresubmitCL(change_info):
   """Reports what presubmit checks on the change would report."""
   if not change_info.FileList():
     print "Nothing to presubmit check, changelist is empty."
     return
 
   print "*** Presubmit checks for UPLOAD would report: ***"
   DoPresubmitChecks(change_info, committing=False)
 
   print "\n\n*** Presubmit checks for COMMIT would report: ***"
   DoPresubmitChecks(change_info, committing=True)
 
 
 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.")
 
   if change_info:
     trychange_args = ['--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)
     trychange.TryChange(trychange_args,
                         file_list=change_info.FileList(),
                         swallow_exception=swallow_exception,
                         prog='gcl try')
   else:
     trychange.TryChange(args,
                         file_list=None,
                         swallow_exception=swallow_exception,
                         prog='gcl try')
@@ skipping 18 matching lines @@
   # you'll get "svn: Cannot non-recursively commit a directory deletion of a
   # directory with child nodes". Yay...
   commit_cmd = ["svn", "commit"]
   filename = ''
   if change_info.issue:
     # Get the latest description from Rietveld.
     change_info.description = GetIssueDescription(change_info.issue)
 
   commit_message = change_info.description.replace('\r\n', '\n')
   if change_info.issue:
-    commit_message += ('\nReview URL: http://%s/%s' %
+    commit_message += ('\nReview URL: http://%s/%d' %
                        (GetCodeReviewSetting("CODE_REVIEW_SERVER"),
                         change_info.issue))
 
   handle, commit_filename = tempfile.mkstemp(text=True)
   os.write(handle, commit_message)
   os.close(handle)
 
   handle, targets_filename = tempfile.mkstemp(text=True)
   os.write(handle, "\n".join(change_info.FileList()))
   os.close(handle)
@@ skipping 139 matching lines @@
                                                input_stream=sys.stdin,
                                                default_presubmit=root_presubmit)
   if not result:
     print "\nPresubmit errors, can't continue (use --no_presubmit to bypass)"
   return result
 
 
 def Changes():
   """Print all the changelists and their files."""
   for cl in GetCLs():
-    change_info = LoadChangelistInfo(cl, True, True)
+    change_info = ChangeInfo.Load(cl, True, True)
     print "\n--- Changelist " + change_info.name + ":"
     for file in change_info.files:
       print "".join(file)
 
 
 def main(argv=None):
   if argv is None:
     argv = sys.argv
 
   if len(argv) == 1:
@@ skipping 53 matching lines @@
   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, True, True)
   else:
-    change_info = LoadChangelistInfo(changename, fail_on_not_found, True)
+    change_info = ChangeInfo.Load(changename, fail_on_not_found, True)
 
   if command == "change":
     if (len(argv) == 4):
       filename = argv[3]
       f = open(filename, 'rU')
       override_description = f.read()
       f.close()
     else:
       override_description = None
     Change(change_info, override_description)
@@ skipping 21 matching lines @@
     # the files. This allows commands such as 'gcl diff xxx' to work.
     args =["svn", command]
     root = GetRepositoryRoot()
     args.extend([os.path.join(root, x) for x in change_info.FileList()])
     RunShell(args, True)
   return 0
 
 
 if __name__ == "__main__":
   sys.exit(main())