gclient: print a warning if a dep would get deleted or moved in the future

gclient_scm.py

 # Copyright (c) 2012 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.
 
 """Gclient-specific SCM-specific operations."""
 
+# TODO(borenet): Uncomment this once SCMWrapper._DeleteOrMove is enabled.
+#import errno

[iannucci, 2014/04/04 00:49:54]

Probably should just leave these comments out and have them standing by in
another CL.

[borenet, 2014/04/07 14:24:02]

Done.

 import logging
 import os
 import posixpath
 import re
 import shlex
 import sys
 import tempfile
 import traceback
 import urlparse
 
 import download_from_google_storage
 import gclient_utils
 import scm
+# TODO(borenet): Uncomment this once SCMWrapper._DeleteOrMove is enabled.
+#import shutil
 import subprocess2
 
 
 THIS_FILE_PATH = os.path.abspath(__file__)
 
 GSUTIL_DEFAULT_PATH = os.path.join(
     os.path.dirname(os.path.abspath(__file__)),
     'third_party', 'gsutil', 'gsutil')
 
 
@@ skipping 128 matching lines @@
 
     actual_remote_url = self.GetActualRemoteURL()
     if actual_remote_url:
       return (gclient_utils.SplitUrlRevision(actual_remote_url)[0].rstrip('/')
               == gclient_utils.SplitUrlRevision(self.url)[0].rstrip('/'))
     else:
       # This may occur if the self.checkout_path exists but does not contain a
       # valid git or svn checkout.
       return False
 
+  # TODO(borenet): Remove this once SCMWrapper._DeleteOrMove is enabled.
+  # pylint: disable=R0201
+  def _DeleteOrMove(self, force):
+    """Delete the checkout directory or move it out of the way.
+
+    Args:
+        force: bool; if True, delete the directory. Otherwise, just move it.
+    """
+    # TODO(borenet): Uncomment the below implementation once we're sure nobody
+    # will trigger it accidentally.
+    gclient_utils.AddWarning('WARNING: Upcoming changes would cause %s to be '

[iannucci, 2014/04/04 00:49:54]

Prep the cl to turn this feature on, and mention it in the warning message.

[borenet, 2014/04/07 14:24:02]

Done.

+                             'deleted or moved to the side. This is intended '
+                             'to ease changes to DEPS in the future. If you '
+                             'are seeing this warning and haven\'t changed the '
+                             'DEPS file, please contact borenet@ immediately.'
+                             % self.checkout_path)
+#     if force:
+#       print('_____ Conflicting directory found in %s. Removing.'
+#             % self.checkout_path)
+#       gclient_utils.rmtree(self.checkout_path)
+#     else:
+#       bad_scm_dir = os.path.join(self._root_dir, '_bad_scm',
+#                                  os.path.dirname(self.relpath))
+# 
+#       try:
+#         os.makedirs(bad_scm_dir)
+#       except OSError as e:
+#         if e.errno != errno.EEXIST:
+#           raise
+# 
+#       dest_path = tempfile.mkdtemp(
+#           prefix=os.path.basename(self.relpath),
+#           dir=bad_scm_dir)
+#       print('_____ Conflicting directory found in %s. Moving to %s.'
+#             % (self.checkout_path, dest_path))
+#       gclient_utils.AddWarning('Conflicting directory %s moved to %s.'
+#                                % (self.checkout_path, dest_path))
+#       shutil.move(self.checkout_path, dest_path)
+
 
 class GitWrapper(SCMWrapper):
   """Wrapper for Git"""
   name = 'git'
   remote = 'origin'
 
   cache_dir = None
 
   def __init__(self, url=None, root_dir=None, relpath=None):
     """Removes 'git+' fake prefix from git URL."""
@@ skipping 141 matching lines @@
       # For compatibility with old naming, translate 'origin' to 'refs/heads'
       revision = revision.replace(self.remote + '/', 'refs/heads/')
       rev_type = "branch"
     else:
       # hash is also a tag, only make a distinction at checkout
       rev_type = "hash"
 
     if (not os.path.exists(self.checkout_path) or
         (os.path.isdir(self.checkout_path) and
          not os.path.exists(os.path.join(self.checkout_path, '.git')))):
+      if (os.path.isdir(self.checkout_path) and
+          not os.path.exists(os.path.join(self.checkout_path, '.git'))):
+        self._DeleteOrMove(options.force)
       self._Clone(revision, url, options)
       self.UpdateSubmoduleConfig()
       if file_list is not None:
         files = self._Capture(['ls-files']).splitlines()
         file_list.extend([os.path.join(self.checkout_path, f) for f in files])
       if not verbose:
         # Make the output a little prettier. It's nice to have some whitespace
         # between projects when cloning.
         print('')
       return self._Capture(['rev-parse', '--verify', 'HEAD'])
 
     if not managed:
       self._UpdateBranchHeads(options, fetch=False)
       self.UpdateSubmoduleConfig()
       print ('________ unmanaged solution; skipping %s' % self.relpath)
       return self._Capture(['rev-parse', '--verify', 'HEAD'])
 
-    if not os.path.exists(os.path.join(self.checkout_path, '.git')):
-      raise gclient_utils.Error('\n____ %s%s\n'
-                                '\tPath is not a git repo. No .git dir.\n'
-                                '\tTo resolve:\n'
-                                '\t\trm -rf %s\n'
-                                '\tAnd run gclient sync again\n'
-                                % (self.relpath, rev_str, self.relpath))
-
     # See if the url has changed (the unittests use git://foo for the url, let
     # that through).
     current_url = self._Capture(['config', 'remote.%s.url' % self.remote])
     return_early = False
     # TODO(maruel): Delete url != 'git://foo' since it's just to make the
     # unit test pass. (and update the comment above)
     # Skip url auto-correction if remote.origin.gclient-auto-fix-url is set.
     # This allows devs to use experimental repos which have a different url
     # but whose branch(s) are the same as official repos.
-    if (current_url != url and
+    if (current_url.rstrip('/') != url.rstrip('/') and
         url != 'git://foo' and
         subprocess2.capture(
             ['git', 'config', 'remote.%s.gclient-auto-fix-url' % self.remote],
             cwd=self.checkout_path).strip() != 'False'):
       print('_____ switching %s to a new upstream' % self.relpath)
       # Make sure it's clean
       self._CheckClean(rev_str)
       # Switch over to the new upstream
       self._Run(['remote', 'set-url', self.remote, url], options)
       self._FetchAndReset(revision, file_list, options)
@@ skipping 643 matching lines @@
         filter_fn=SvnDiffFilterer(self.relpath).Filter)
 
   def update(self, options, args, file_list):
     """Runs svn to update or transparently checkout the working copy.
 
     All updated files will be appended to file_list.
 
     Raises:
       Error: if can't get URL for relative path.
     """
-    # Only update if git or hg is not controlling the directory.
-    git_path = os.path.join(self.checkout_path, '.git')
-    if os.path.exists(git_path):
-      print('________ found .git directory; skipping %s' % self.relpath)
-      return
-
+    # Only update if hg is not controlling the directory.
     hg_path = os.path.join(self.checkout_path, '.hg')
     if os.path.exists(hg_path):
       print('________ found .hg directory; skipping %s' % self.relpath)
       return
 
     if args:
       raise gclient_utils.Error("Unsupported argument(s): %s" % ",".join(args))
 
     # revision is the revision to match. It is None if no revision is specified,
     # i.e. the 'deps ain't pinned'.
@@ skipping 10 matching lines @@
         # Reconstruct the url.
         url = '%s@%s' % (url, revision)
         rev_str = ' at %s' % revision
       else:
         managed = False
         revision = None
     else:
       forced_revision = False
       rev_str = ''
 
+    exists = os.path.exists(self.checkout_path)
+    if exists and managed:
+      # Git is only okay if it's a git-svn checkout of the right repo.
+      if scm.GIT.IsGitSvn(self.checkout_path):
+        remote_url = scm.GIT.Capture(['config', '--local', '--get',
+                                      'svn-remote.svn.url'],
+                                     cwd=self.checkout_path).rstrip()
+        if remote_url.rstrip('/') == base_url.rstrip('/'):
+          print('\n_____ %s looks like a git-svn checkout. Skipping.'
+                % self.relpath)
+          return # TODO(borenet): Get the svn revision number?
+
     # Get the existing scm url and the revision number of the current checkout.
-    exists = os.path.exists(self.checkout_path)
     if exists and managed:
       try:
         from_info = scm.SVN.CaptureLocalInfo(
             [], os.path.join(self.checkout_path, '.'))
       except (gclient_utils.Error, subprocess2.CalledProcessError):
-        if options.reset and options.delete_unversioned_trees:
-          print 'Removing troublesome path %s' % self.checkout_path
-          gclient_utils.rmtree(self.checkout_path)
-          exists = False
-        else:
-          msg = ('Can\'t update/checkout %s if an unversioned directory is '
-                 'present. Delete the directory and try again.')
-          raise gclient_utils.Error(msg % self.checkout_path)
+        self._DeleteOrMove(options.force)
+        exists = False
 
     BASE_URLS = {
         '/chrome/trunk/src': 'gs://chromium-svn-checkout/chrome/',
         '/blink/trunk': 'gs://chromium-svn-checkout/blink/',
     }
     WHITELISTED_ROOTS = [
         'svn://svn.chromium.org',
         'svn://svn-mirror.golo.chromium.org',
     ]
     if not exists:
@@ skipping 59 matching lines @@
 
       gclient_utils.safe_makedirs(os.path.dirname(self.checkout_path))
       # We need to checkout.
       command = ['checkout', url, self.checkout_path]
       command = self._AddAdditionalUpdateFlags(command, options, revision)
       self._RunAndGetFileList(command, options, file_list, self._root_dir)
       return self.Svnversion()
 
     if not managed:
       print ('________ unmanaged solution; skipping %s' % self.relpath)
-      return self.Svnversion()
+      if os.path.exists(os.path.join(self.checkout_path, '.svn')):
+        return self.Svnversion()
+      return
 
     if 'URL' not in from_info:
       raise gclient_utils.Error(
           ('gclient is confused. Couldn\'t get the url for %s.\n'
            'Try using @unmanaged.\n%s') % (
             self.checkout_path, from_info))
 
     # Look for locked directories.
     dir_info = scm.SVN.CaptureStatus(
         None, os.path.join(self.checkout_path, '.'))
@@ skipping 22 matching lines @@
               if d[0][0] == '!':
                 print 'You can pass --force to enable automatic removal.'
               raise e
 
     # Retrieve the current HEAD version because svn is slow at null updates.
     if options.manually_grab_svn_rev and not revision:
       from_info_live = scm.SVN.CaptureRemoteInfo(from_info['URL'])
       revision = str(from_info_live['Revision'])
       rev_str = ' at %s' % revision
 
-    if from_info['URL'] != base_url:
+    if from_info['URL'].rstrip('/') != base_url.rstrip('/'):
       # The repository url changed, need to switch.
       try:
         to_info = scm.SVN.CaptureRemoteInfo(url)
       except (gclient_utils.Error, subprocess2.CalledProcessError):
         # The url is invalid or the server is not accessible, it's safer to bail
         # out right now.
         raise gclient_utils.Error('This url is unreachable: %s' % url)
       can_switch = ((from_info['Repository Root'] != to_info['Repository Root'])
                     and (from_info['UUID'] == to_info['UUID']))
       if can_switch:
@@ skipping 215 matching lines @@
       new_command.append('--force')
       if command[0] != 'checkout' and scm.SVN.AssertVersion('1.6')[0]:
         new_command.extend(('--accept', 'theirs-conflict'))
     elif options.manually_grab_svn_rev:
       new_command.append('--force')
       if command[0] != 'checkout' and scm.SVN.AssertVersion('1.6')[0]:
         new_command.extend(('--accept', 'postpone'))
     elif command[0] != 'checkout' and scm.SVN.AssertVersion('1.6')[0]:
       new_command.extend(('--accept', 'postpone'))
     return new_command