Add rietveld member to ChangeInfo and use this value to contact rietveld.

gcl.py

 #!/usr/bin/python
 # Copyright (c) 2010 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.
 """
 
@@ skipping 256 matching lines @@
 class ChangeInfo(object):
   """Holds information about a changelist.
 
     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.
     local_root: Local root directory
+    rietveld: rietveld server for this change
   """
-
+  # Kept for unit test support. This is for the old format, it's deprecated.
   _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, local_root,
-               needs_upload=False):
+               rietveld, 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
+    self.rietveld = rietveld
+    if not self.rietveld:
+      # Set the default value.
+      self.rietveld = GetCodeReviewSetting('CODE_REVIEW_SERVER')
 
   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."""
@@ skipping 17 matching lines @@
     return [f[1] for f in self.GetFiles() if f[0].startswith("A")]
 
   def Save(self):
     """Writes the changelist information to disk."""
     data = json.dumps({
           'issue': self.issue,
           'patchset': self.patchset,
           'needs_upload': self.NeedsUpload(),
           'files': self.GetFiles(),
           'description': self.description,
+          'rietveld': self.rietveld,
         }, 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, [])
-    SendToRietveld("/%d/close" % self.issue, body, ctype)
+    self.SendToRietveld('/%d/close' % self.issue, body, ctype)
 
   def UpdateRietveldDescription(self):
     """Sets the description for an issue on Rietveld."""
     data = [("description", self.description),]
     ctype, body = upload.EncodeMultipartFormData(data, [])
-    SendToRietveld("/%d/description" % self.issue, body, ctype)
+    self.SendToRietveld('/%d/description' % self.issue, body, ctype)
+
+  def GetIssueDescription(self):
+    """Returns the issue description from Rietveld."""
+    return self.SendToRietveld('/%d/description' % self.issue)
+
+  def PrimeLint(self):
+    """Do background work on Rietveld to lint the file so that the results are
+    ready when the issue is viewed."""
+    if self.issue and self.patchset:
+      self.SendToRietveld('/lint/issue%s_%s' % (self.issue, self.patchset),
+          timeout=1)
+
+  def SendToRietveld(self, request_path, payload=None,
+                    content_type="application/octet-stream", timeout=None):
+    """Send a POST/GET to Rietveld.  Returns the response body."""
+    if not self.rietveld:
+      ErrorExit(CODEREVIEW_SETTINGS_FILE_NOT_FOUND)
+    def GetUserCredentials():
+      """Prompts the user for a username and password."""
+      email = upload.GetEmail('Email (login for uploading to %s)' %
+          self.rietveld)
+      password = getpass.getpass('Password for %s: ' % email)
+      return email, password
+    rpc_server = upload.HttpRpcServer(self.rietveld,
+                                      GetUserCredentials,
+                                      save_cookies=True)
+    try:
+      return rpc_server.Send(request_path, payload, content_type, timeout)
+    except urllib2.URLError:
+      if timeout is None:
+        ErrorExit('Error accessing url %s' % request_path)
+      else:
+        return None
 
   def MissingTests(self):
     """Returns True if the change looks like it needs unit tests but has none.
 
     A change needs unit tests if it contains any new source files or methods.
     """
     SOURCE_SUFFIXES = [".cc", ".cpp", ".c", ".m", ".mm"]
     # Ignore third_party entirely.
     files = [f for f in self._NonDeletedFileList()
              if f.find("third_party") == -1]
@@ skipping 78 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, rietveld=None,
                         needs_upload=False)
     content = gclient_utils.FileRead(info_file, 'r')
     save = False
     try:
       values = ChangeInfo._LoadNewFormat(content)
     except ValueError:
       try:
         values = ChangeInfo._LoadOldFormat(content)
         save = True
       except ValueError:
@@ skipping 10 matching lines @@
           # 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, values['issue'], values['patchset'],
                              values['description'], files,
-                             local_root, values['needs_upload'])
+                             local_root, values.get('rietveld'),
+                             values['needs_upload'])
     if save:
       change_info.Save()
     return change_info
 
   @staticmethod
   def _LoadOldFormat(content):
+    # 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
     split_data = content.split(ChangeInfo._SEPARATOR, 2)
     if len(split_data) != 3:
       raise ValueError('Bad change format')
     values = {
       'issue': 0,
       'patchset': 0,
       'needs_upload': False,
       'files': [],
     }
     items = split_data[0].split(', ')
@@ skipping 23 matching lines @@
 
 
 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,
-                                     needs_upload=False)
+                                     rietveld=None, 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 60 matching lines @@
 
   See docstring of GetModifiedFiles for information about path of files and
   which directories are scanned.
   """
   modified_files = GetModifiedFiles()
   if "" not in modified_files:
     return []
   return modified_files[""]
 
 
-def SendToRietveld(request_path, payload=None,
-                   content_type="application/octet-stream", timeout=None):
-  """Send a POST/GET to Rietveld.  Returns the response body."""
-  server = GetCodeReviewSetting("CODE_REVIEW_SERVER")
-  if not server:
-    ErrorExit(CODEREVIEW_SETTINGS_FILE_NOT_FOUND)
-  def GetUserCredentials():
-    """Prompts the user for a username and password."""
-    email = upload.GetEmail("Email (login for uploading to %s)" % server)
-    password = getpass.getpass("Password for %s: " % email)
-    return email, password
-  rpc_server = upload.HttpRpcServer(server,
-                                    GetUserCredentials,
-                                    save_cookies=True)
-  try:
-    return rpc_server.Send(request_path, payload, content_type, timeout)
-  except urllib2.URLError:
-    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("/%d/description" % issue)
-
-
 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)
@@ skipping 120 matching lines @@
   if not OptionallyDoPresubmitChecks(change_info, False, args):
     return 1
   no_watchlists = (FilterFlag(args, "--no_watchlists") or
                    FilterFlag(args, "--no-watchlists"))
 
   # Map --send-mail to --send_mail
   if FilterFlag(args, "--send-mail"):
     args.append("--send_mail")
 
   upload_arg = ["upload.py", "-y"]
-  server = GetCodeReviewSetting("CODE_REVIEW_SERVER")
-  if not server:
-    ErrorExit(CODEREVIEW_SETTINGS_FILE_NOT_FOUND)
-  upload_arg.append("--server=%s" % server)
+  upload_arg.append("--server=%s" % change_info.rietveld)
   upload_arg.extend(args)
 
   desc_file = ""
   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
 
@@ skipping 30 matching lines @@
         subject = subject + "..."
       upload_arg.append("--message=" + subject)
 
     if GetCodeReviewSetting("PRIVATE") == "True":
       upload_arg.append("--private")
 
   # Change the current working directory before calling upload.py so that it
   # shows the correct base.
   previous_cwd = os.getcwd()
   os.chdir(change_info.GetLocalRoot())
-
   # 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.GetFileNames())
   issue, patchset = upload.RealMain(upload_arg, change_info.patch)
   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)
-
-  # Move back before considering try, so GetCodeReviewSettings is
-  # consistent.
+  change_info.PrimeLint()
   os.chdir(previous_cwd)
-
   print "*** Upload does not submit a try; use gcl try to submit a try. ***"
-
   return 0
 
 
 @need_change
 def CMDpresubmit(change_info):
   """Runs presubmit checks on the change.
 
   The actual presubmit code is implemented in presubmit_support.py and looks
   for PRESUBMIT.py files."""
   if not change_info.GetFiles():
@@ skipping 51 matching lines @@
   # 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:
     # Get the latest description from Rietveld.
-    change_info.description = GetIssueDescription(change_info.issue)
+    change_info.description = change_info.GetIssueDescription()
 
   commit_message = change_info.description.replace('\r\n', '\n')
   if change_info.issue:
-    server = GetCodeReviewSetting("CODE_REVIEW_SERVER")
-    if not server:
-      ErrorExit(CODEREVIEW_SETTINGS_FILE_NOT_FOUND)
+    server = change_info.rietveld
     if not server.startswith("http://") and not server.startswith("https://"):
       server = "http://" + server
     commit_message += ('\nReview URL: %s/%d' % (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.GetFileNames()))
@@ skipping 46 matching lines @@
     if not os.path.isfile(args[1]):
       ErrorExit('The change "%s" doesn\'t exist.' % args[1])
     f = open(args[1], 'rU')
     override_description = f.read()
     f.close()
   else:
     override_description = None
 
   if change_info.issue and not change_info.NeedsUpload():
     try:
-      description = GetIssueDescription(change_info.issue)
+      description = change_info.GetIssueDescription()
     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)
   else:
     if override_description:
@@ skipping 87 matching lines @@
   Checks all the files in the changelist for possible style violations.
   """
   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())
-
   # Process cpplints arguments if any.
   filenames = cpplint.ParseArguments(args + change_info.GetFileNames())
 
   white_list = GetCodeReviewSetting("LINT_REGEX")
   if not white_list:
     white_list = DEFAULT_LINT_REGEX
   white_regex = re.compile(white_list)
   black_list = GetCodeReviewSetting("LINT_IGNORE_REGEX")
   if not black_list:
     black_list = DEFAULT_LINT_IGNORE_REGEX
@@ skipping 246 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:]))