Avoid losing CL description during Rietveld outage....

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 252 matching lines @@
   # 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, local_root):
+  def __init__(self, name, issue, patchset, description, files, local_root,
+               needs_upload=False):
     self.name = name
     self.issue = int(issue)
     self.patchset = int(patchset)
     self.description = description
     if files is None:
       files = []
     self._files = files
     self.patch = None
     self._local_root = local_root
+    self.needs_upload = needs_upload
+
+  def NeedsUpload(self):
+    return self.needs_upload
 
   def GetFileNames(self):
     """Returns the list of file names included in this change."""
     return [f[1] for f in self._files]
 
   def GetFiles(self):
     """Returns the list of files included in this change with their status."""
     return self._files
 
   def GetLocalRoot(self):
     """Returns the local repository checkout root directory."""
     return self._local_root
 
   def Exists(self):
     """Returns True if this change already exists (i.e., is not new)."""
     return (self.issue or self.description or self._files)
 
   def _NonDeletedFileList(self):
     """Returns a list of files in this change, not including deleted files."""
     return [f[1] for f in self.GetFiles()
             if not f[0].startswith("D")]
 
   def _AddedFileList(self):
     """Returns a list of files added in this change."""
     return [f[1] for f in self.GetFiles() if f[0].startswith("A")]
 
   def Save(self):
     """Writes the changelist information to disk."""
+    if self.NeedsUpload():
+      needs_upload = "dirty"
+    else:
+      needs_upload = "clean"
     data = ChangeInfo._SEPARATOR.join([

[M-A Ruel, 2009/11/22 18:06:10]

We should have used json or pickle right at the start... :(

-        "%d, %d" % (self.issue, self.patchset),
+        "%d, %d, %s" % (self.issue, self.patchset, needs_upload),
         "\n".join([f[0] + f[1] for f in self.GetFiles()]),
         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."""
@@ skipping 97 matching lines @@
         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, 0, 0, '', None, local_root)
+      return ChangeInfo(changename, 0, 0, '', None, local_root,
+                        needs_upload=False)
     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(',')
+    items = split_data[0].split(', ')
     issue = 0
     patchset = 0
+    needs_upload = False
     if items[0]:
       issue = int(items[0])
     if len(items) > 1:
       patchset = int(items[1])
+    if len(items) > 2:
+      needs_upload = (items[2] == "dirty")
     files = []
     for line in split_data[1].splitlines():
       status = line[:7]
       filename = line[7:]
       files.append((status, filename))
     description = split_data[2]
     save = False
     if update_status:
       for item in files:
         filename = os.path.join(local_root, item[1])
         status_result = SVN.CaptureStatus(filename)
         if not status_result or not status_result[0][0]:
           # File has been reverted.
           save = True
           files.remove(item)
           continue
         status = status_result[0][0]
         if status != item[0]:
           save = True
           files[files.index(item)] = (status, item[1])
     change_info = ChangeInfo(changename, issue, patchset, description, files,
-                             local_root)
+                             local_root, needs_upload)
     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, local_root, fail_on_not_found,
                                   update_status):
   """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(changenames, 0, 0, '', None, local_root)
+  aggregate_change_info = ChangeInfo(changenames, 0, 0, '', None, local_root,
+                                     needs_upload=False)
   for change in changes:
     aggregate_change_info._files += ChangeInfo.Load(change,
                                                     local_root,
                                                     fail_on_not_found,
                                                     update_status).GetFiles()
   return aggregate_change_info
 
 
 def GetCLs():
   """Returns a list of all the changelists in this repository."""
@@ skipping 479 matching lines @@
               "directory.")
 
   if (len(args) == 1):
     filename = args[0]
     f = open(filename, 'rU')
     override_description = f.read()
     f.close()
   else:
     override_description = None
 
-  if change_info.issue:
+  if change_info.issue and not change_info.NeedsUpload():
     try:
       description = GetIssueDescription(change_info.issue)
     except urllib2.HTTPError, err:
       if err.code == 404:
         # The user deleted the issue in Rietveld, so forget the old issue id.
         description = change_info.description
         change_info.issue = 0
         change_info.Save()
       else:
         ErrorExit("Error getting the description from Rietveld: " + err)
@@ skipping 36 matching lines @@
   result = ReadFile(filename)
   os.remove(filename)
 
   if not result:
     return
 
   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
-    if change_info.issue:
-      # Update the Rietveld issue with the new description.
-      change_info.UpdateRietveldDescription()
+    change_info.needs_upload = True
 
   new_cl_files = []
   for line in cl_files_text.splitlines():
     if not len(line):
       continue
     if line.startswith("---"):
       break
     status = line[:7]
     filename = line[7:]
     new_cl_files.append((status, filename))
 
   if (not len(change_info._files)) and (not change_info.issue) and \
       (not len(new_description) and (not new_cl_files)):
     ErrorExit("Empty changelist not saved")
 
   change_info._files = new_cl_files
   change_info.Save()
   if svn_info.get('URL', '').startswith('http:'):
     Warn("WARNING: Creating CL in a read-only checkout.  You will not be "
          "able to commit it!")
 
   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()
+
+
 # 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):
   """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.")
@@ skipping 183 matching lines @@
       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())