Destroy svn_utils.py.

checkout.py

 # coding=utf8
 # 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.
 """Manages a project checkout.
 
 Includes support for svn, git-svn and git.
 """
 
 import logging
 import os
 import re
 import subprocess
 import tempfile
 
+# From depot_tools
+import gclient_utils
+import scm
+
 import patch
 import subprocess2
-import svn_utils
 
 
 def get_code_review_setting(path, key,
     codereview_settings_file='codereview.settings'):
   """Parses codereview.settings and return the value for the key if present.
 
   Don't cache the values in case the file is changed."""
   settings = {}
   try:
     settings_file = open(os.path.join(path, codereview_settings_file), 'r')
@@ skipping 16 matching lines @@
 class CheckoutBase(object):
   def __init__(self, root_dir, project_name):
     self.root_dir = root_dir
     self.project_name = project_name
     self.project_path = os.path.join(self.root_dir, self.project_name)
 
   def get_settings(self, key):
     return get_code_review_setting(self.project_path, key)
 
 
-class SvnCheckout(CheckoutBase):
+class SvnMixIn(object):
+  """MixIn class to add svn commands common to both svn and git-svn clients."""
+  # These members need to be set by the subclass.
+  commit_user = None
+  commit_pwd = None
+  svn_url = None
+  project_path = None
+
+  def _check_call_svn(self, args, **kwargs):
+    """Runs svn and throws an exception if the command failed."""
+    kwargs.setdefault('cwd', self.project_path)
+    return subprocess2.check_call(
+        ['svn'] + args + ['--no-auth-cache', '--non-interactive'], **kwargs)
+
+  def _capture_svn(self, args, **kwargs):

[Dirk Pranke, 2010/12/22 23:18:10]

This is only used by SvnCheckout, right? If so, I would move it there to
minimize confusion.

[M-A Ruel, 2010/12/23 17:19:49]

Ok, I'll move it in a later change otherwise it creates a few conflicts in the
next changes.

+    """Runs svn and throws an exception if the command failed.
+
+     Returns the output.
+    """
+    kwargs.setdefault('cwd', self.project_path)
+    if self.commit_user:
+      args = args + [
+          '--username', self.commit_user, '--password', self.commit_pwd]
+    cmd = ['svn'] + args + ['--no-auth-cache', '--non-interactive']
+    return subprocess2.check_capture(cmd, **kwargs)
+
+  @staticmethod
+  def _parse_svn_info(output, key):
+    """Returns value for key from svn info output.
+
+    Case insensitive.
+    """
+    values = {}
+    for line in output.splitlines(False):
+      if not line:
+        continue
+      k, v = line.split(':', 1)
+      k = k.strip().lower()
+      v = v.strip()
+      assert not k in values
+      values[k] = v
+    return values.get(key, None)
+
+  def _update_committer(self, revision, new_author):
+    """Changes the author of a commit a posteriori.
+
+    This is necessary since the actual commit is done with a "commit-bot"
+    credential but the original patch author needs to be assigned authorship
+    of the revision.
+    """
+    self._check_call_svn(
+        ['propset', '--revprop', 'svn:author',
+        '-r', revision,
+        new_author,
+        '--username', self.commit_user,
+        '--password', self.commit_pwd,
+        self.svn_url])
+
+
+class SvnCheckout(CheckoutBase, SvnMixIn):
   """Manages a subversion checkout.
 
   Commit is not fully implemented yet. Reimplementing all the commands is
   slightly complex, svn add with history needs to be done with svn
   copy/rename/move and the situation quickly becomes harder when directories are
   moved.
   """
   def __init__(self, root_dir, project_name, commit_user, commit_pwd, svn_url):
     super(SvnCheckout, self).__init__(root_dir, project_name)
     self.commit_user = commit_user
     self.commit_pwd = commit_pwd
     self.svn_url = svn_url
     assert bool(self.commit_user) == bool(self.commit_pwd)
     assert bool(self.svn_url)
 
   def prepare(self):
     """Creates the initial checkouts for the repo."""
     # Will checkout if the directory is not present.
     logging.info('Checking out %s in %s' %
         (self.project_name, self.project_path))
-    return svn_utils.revert(
-        self.svn_url,
-        self.project_path,
-        self.commit_user,
-        self.commit_pwd)
+    return self._revert()
 
   def apply_patch(self, patch_data):
     """Applies a patch."""
     try:
       patch.apply_patch(self.project_path, patch_data)
       return True
     except subprocess.CalledProcessError, e:
       if e.returncode == 1:
         return False
       raise
 
   def commit(self, commit_message, user):
     """Commits a patch."""
     logging.info('Committing patch for %s' % user)
     assert self.commit_user
     assert self.commit_pwd
     handle, commit_filename = tempfile.mkstemp(text=True)
     os.write(handle, commit_message)
     os.close(handle)
     try:
-      output = svn_utils.capture_svn([
-          'commit',
-          '--username', self.commit_user,
-          '--password', self.commit_pwd,
-          '--file', commit_filename],
-          cwd=self.project_path)
+      output = self._capture_svn(['commit', '--file', commit_filename])
       revision = re.compile(
           r'.*?\nCommitted revision (\d+)',
           re.DOTALL).match(output).group(1)
       # Fix the committer.
-      svn_utils.update_committer(
-          self.svn_url, revision, self.commit_user, self.commit_pwd, user,
-          self.project_path)
+      self._update_committer(revision, user)
     finally:
       os.remove(commit_filename)
     return int(revision)
 
+  def _revert(self):
+    """Reverts local modifications or checks out if the directory is not
+    present.
+    """
+    flags = ['--ignore-externals']
+    if not os.path.isdir(self.project_path):
+      logging.info('Directory %s is not present, checking it out.' %
+          self.project_path)
+      self._check_call_svn(['checkout', self.svn_url, self.project_path] +
+          flags, cwd=None)
+    else:
+      for file_status in scm.SVN.CaptureStatus(self.project_path):
+        file_path = os.path.join(self.project_path, file_status[1])
+        if file_status[0][0] == 'X':
+          # Ignore externals.
+          logging.info('Ignoring external %s' % file_path)
+          continue
+
+        logging.info('%s%s' % (file_status[0], file_status[1]))
+
+        if file_status[0].isspace():
+          raise EnvironmentError(
+              'No idea what is the status of %s.\n'
+              'You just found a bug in gclient, please ping '
+              'maruel@chromium.org ASAP!' % file_path)
+
+        # svn revert is really stupid. It fails on inconsistent line-endings,
+        # on switched directories, etc. So take no chance and delete everything!
+        try:
+          if not os.path.exists(file_path):
+            pass
+          elif os.path.isfile(file_path) or os.path.islink(file_path):
+            logging.info('os.remove(%s)' % file_path)
+            os.remove(file_path)
+          elif os.path.isdir(file_path):
+            logging.info('gclient_utils.RemoveDirectory(%s)' % file_path)
+            gclient_utils.RemoveDirectory(file_path)
+          else:
+            logging.error('no idea what is %s.\nYou just found a bug in gclient'
+                          ', please ping maruel@chromium.org ASAP!' % file_path)
+        except EnvironmentError:
+          logging.error('Failed to remove %s.' % file_path)
+
+      # Revive files that were deleted above.
+      self._check_call_svn(['update', '--force'] + flags)
+
+    out = self._capture_svn(['info', '.'])
+    return int(self._parse_svn_info(out, 'revision'))
+
 
 class GitCheckoutBase(CheckoutBase):
   """Base class for git checkout. Not to be used as-is."""
   def __init__(self, root_dir, project_name, remote_branch):
     super(GitCheckoutBase, self).__init__(root_dir, project_name)
     # There is no reason to not hardcode it.
     self.remote = 'origin'
     self.remote_branch = remote_branch
     self.working_branch = 'working_branch'
 
@@ skipping 22 matching lines @@
   def _call_git(self, args, **kwargs):
     """Like check_call but doesn't throw on failure."""
     kwargs.setdefault('cwd', self.project_path)
     return subprocess2.call(['git'] + args, **kwargs)
 
   def _check_capture_git(self, args, **kwargs):
     kwargs.setdefault('cwd', self.project_path)
     return subprocess2.check_capture(['git'] + args, **kwargs)
 
 
-class GitSvnCheckoutBase(GitCheckoutBase):
+class GitSvnCheckoutBase(GitCheckoutBase, SvnMixIn):
   """Base class for git-svn checkout. Not to be used as-is."""
   def __init__(self,
       root_dir, project_name, remote_branch,
       commit_user, commit_pwd,
-      svn_repo, trunk):
+      svn_url, trunk):
     """trunk is optional."""
     super(GitSvnCheckoutBase, self).__init__(
         root_dir, project_name + '.git', remote_branch)
     self.commit_user = commit_user
     self.commit_pwd = commit_pwd
-    self.svn_repo = svn_repo
+    # svn_url in this case is the root of the svn repository.
+    self.svn_url = svn_url
     self.trunk = trunk
 
   def prepare(self):
     """Resets the git repository in a clean state."""
     self._check_call_git(['checkout', 'master', '--force'])
     self._check_call_git(['svn', 'rebase'])
     self._call_git(['branch', '-D', self.working_branch])
     return int(self._git_svn_info('revision'))
 
   def _git_svn_info(self, key):
-    return svn_utils.parse_svn_info(
+    return self._parse_svn_info(
         self._check_capture_git(['svn', 'info']), key)
 
   def commit(self, commit_message, user):
     """Commits a patch."""
     logging.info('Committing patch for %s' % user)
     # Fix the commit message.
     super(GitSvnCheckoutBase, self).commit(commit_message, user)
     # Commit with git svn dcommit, then use svn directly to update the
     # committer on the revision.
     self._check_call_git_svn(['dcommit', '--rmdir', '--find-copies-harder'])
     revision = int(self._git_svn_info('revision'))
     # Fix the committer.
-    svn_utils.update_committer(
-        self.svn_repo, revision, self.commit_user, self.commit_pwd, user,
-        self.project_path)
+    self._update_committer(revision, user)
     return revision
 
   def _cache_svn_auth(self):
     """Caches the svn credentials. It is necessary since git-svn doesn't prompt
     for it."""
     if not self.commit_user:
       return
     logging.info('Caching svn credentials for %s' % self.commit_user)
     subprocess2.check_call(
-        ['svn', 'ls', self.svn_repo,
+        ['svn', 'ls', self.svn_url,
           '--username', self.commit_user,
           '--password', self.commit_pwd,
           '--non-interactive'])
 
   def _check_call_git_svn(self, args, **kwargs):
     """Handles svn authentication while calling git svn."""
     args = ['svn'] + args
     if self.commit_user:
       args = args + ['--username', self.commit_user, '--no-auth-cache']
     return self._check_call_git(args, stdin=self.commit_pwd, **kwargs)
 
 
 class GitSvnPremadeCheckout(GitSvnCheckoutBase):
   """Manages a git-svn clone made out from an initial git-svn seed.
 
   This class is very similar to GitSvnCheckout but is faster to bootstrap
   because it starts right off with an existing git-svn clone.
   """
   def __init__(self,
       root_dir, project_name, remote_branch,
       commit_user, commit_pwd,
-      svn_repo, trunk, git_url):
+      svn_url, trunk, git_url):
     super(GitSvnPremadeCheckout, self).__init__(
         root_dir, project_name, remote_branch,
         commit_user, commit_pwd,
-        svn_repo, trunk)
+        svn_url, trunk)
     self.git_url = git_url
 
   def prepare(self):
     """Creates the initial checkout for the repo."""
     if not os.path.isdir(self.project_path):
       logging.info('Checking out %s in %s' %
           (self.project_name, self.project_path))
       assert self.remote == 'origin'
       self._check_call_git(
           ['clone', self.git_url, self.project_name],
           cwd=self.root_dir)
       self._check_call_git(
           ['svn', 'init',
            '--prefix', self.remote + '/',
            '-T', self.trunk,
-           self.svn_repo])
+           self.svn_url])
       self._check_call_git_svn(['fetch'])
     super(GitSvnPremadeCheckout, self).prepare()
     return int(self._git_svn_info('revision'))
 
 
 class GitSvnCheckout(GitSvnCheckoutBase):
   """Manages a git-svn clone.
 
   Using git-svn hides some of the complexity of using a svn checkout.
   """
   def __init__(self,
       root_dir, project_name,
       commit_user, commit_pwd,
-      svn_repo, trunk):
+      svn_url, trunk):
     super(GitSvnCheckout, self).__init__(
         root_dir, project_name, 'trunk',
         commit_user, commit_pwd,
-        svn_repo, trunk)
+        svn_url, trunk)
 
   def prepare(self):
     """Creates the initial checkout for the repo."""
     if not os.path.isdir(self.project_path):
       logging.info('Checking out %s in %s' %
           (self.project_name, self.project_path))
       # TODO: Create a shallow clone.
       self._check_call_git_svn(
           ['clone',
            '--prefix', self.remote + '/',
            '-T', self.trunk,
-           self.svn_repo, self.project_path],
+           self.svn_url, self.project_path],
           cwd=self.root_dir)
     super(GitSvnCheckout, self).prepare()
     return int(self._git_svn_info('revision'))
 
 
 class ReadOnlyCheckout(object):
   """Converts a checkout into a read-only one."""
   def __init__(self, checkout):
     self.checkout = checkout
 
@@ skipping 11 matching lines @@
         user, message))
     return 'FAKE'
 
   @property
   def project_name(self):
     return self.checkout.project_name
 
   @property
   def project_path(self):
     return self.checkout.project_path