Refactor ChangeInfo.Load() to make it easier to support mulitple format.

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 simplifies working with groups
 of files.
 """
 
 import getpass
 import os
 import random
 import re
 import string
 import subprocess
 import sys
 import tempfile
 import time
 from third_party import upload
 import urllib2
 
+try:
+  import simplejson as json
+except ImportError:
+  try:
+    import json
+    # Some versions of python2.5 have an incomplete json module.  Check to make
+    # sure loads exists.
+    # pylint: disable=W0104
+    json.loads
+  except (ImportError, AttributeError):
+    # Import the one included in depot_tools.
+    sys.path.append(os.path.join(os.path.dirname(__file__), 'third_party'))

[jochen (gone - plz use gerrit), 2010/10/29 18:29:33]

since this is part of depot_tools anyway, why not just always use that one?

[M-A Ruel, 2010/11/01 13:33:01]

I wanted to use the included copy at last resort but I agree it's no big deal
anyway. I just copied with trychange.py is doing already. It could changed in a
follow up review.

+    import simplejson as json
+
 import breakpad
 
 # gcl now depends on gclient.
 from scm import SVN
 import gclient_utils
 
 __version__ = '1.2'
 
 
 CODEREVIEW_SETTINGS = {
@@ skipping 277 matching lines @@
     """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([
-        "%d, %d, %s" % (self.issue, self.patchset, needs_upload),
-        "\n".join([f[0] + f[1] for f in self.GetFiles()]),
-        self.description])
+    data = json.dumps({
+          'issue': self.issue,
+          'patchset': self.patchset,
+          'needs_upload': self.NeedsUpload(),
+          'files': self.GetFiles(),
+          'description': self.description,
+        }, sort_keys=True, indent=2)
     gclient_utils.FileWrite(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 100 matching lines @@
     """
     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,
                         needs_upload=False)
     content = gclient_utils.FileRead(info_file, 'r')
     save = False
     try:
-      values = ChangeInfo._LoadOldFormat(content)
+      values = ChangeInfo._LoadNewFormat(content)
     except ValueError:
-      ErrorExit(
-          ('Changelist file %s is corrupt.\n'
-           'Either run "gcl delete %s" or manually edit the file') % (
-              info_file, changename))
+      try:
+        values = ChangeInfo._LoadOldFormat(content)
+        save = True
+      except ValueError:
+        ErrorExit(
+            ('Changelist file %s is corrupt.\n'
+            'Either run "gcl delete %s" or manually edit the file') % (
+                info_file, changename))
     files = values['files']
     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
@@ skipping 26 matching lines @@
       values['patchset'] = int(items[1])
     if len(items) > 2:
       values['needs_upload'] = (items[2] == "dirty")
     for line in split_data[1].splitlines():
       status = line[:7]
       filename = line[7:]
       values['files'].append((status, filename))
     values['description'] = split_data[2]
     return values
 
+  @staticmethod
+  def _LoadNewFormat(content):
+    return json.loads(content)
+
 
 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):
@@ skipping 843 matching lines @@
     if e.code != 500:
       raise
     print >> sys.stderr, (
         'AppEngine is misbehaving and returned HTTP %d, again. Keep faith '
         'and retry or visit go/isgaeup.\n%s') % (e.code, str(e))
     return 1
 
 
 if __name__ == "__main__":
   sys.exit(main(sys.argv[1:]))