Merge lp:~bialix/bzr/2.1-clean-tree-bzrdir into lp:bzr/2.1

[Alexander Belchenko]

``bzr clean-tree`` should not delete nested bzrdirs. (bialix, #572098)

This is backport of the patch https://code.launchpad.net/~bialix/bzr/clean-tree-bzrdir/+merge/24479

[Alexander Belchenko (bialix)]

I've received mail from lp, it says:

Launchpad encountered an error during the following operation: generating the diff for a merge proposal. The source branch has no revisions.

What I'm doing wrong?

[Vincent Ladeuil (vila)]

I think the email is just another fallout from maverick branches creation. The diff looks fine as did the change.

review: Approve

[Andrew Bennetts (spiv)]

I don't think you did anything wrong, I think that was a Launchpad bug stemming from the (now fixed) delays in pulling and scanning branches.

=== modified file 'NEWS'
--- NEWS	2010-04-30 08:13:34 +0000
+++ NEWS	2010-05-05 01:45:38 +0000
@@ -13,6 +13,10 @@
 Bug Fixes
 *********
 
+* ``bzr clean-tree`` should not delete nested bzrdirs. Required for proper
+  support of bzr-externals and scmproj plugins.
+  (Alexander Belchenko, bug #572098)
+
 * ``bzr switch`` does not die if a ConfigurableFileMerger is used.
   (Aaron Bentley, #559436)
 

=== modified file 'bzrlib/clean_tree.py'
--- bzrlib/clean_tree.py	2009-03-23 14:59:43 +0000
+++ bzrlib/clean_tree.py	2010-05-05 01:45:38 +0000
@@ -20,6 +20,7 @@
 import shutil
 import sys
 
+from bzrlib import bzrdir, errors
 from bzrlib.osutils import has_symlinks, isdir
 from bzrlib.trace import note
 from bzrlib.workingtree import WorkingTree
@@ -53,11 +54,14 @@
     try:
         deletables = list(iter_deletables(tree, unknown=unknown,
             ignored=ignored, detritus=detritus))
+        deletables = _filter_out_nested_bzrdirs(deletables)
         if len(deletables) == 0:
             note('Nothing to delete.')
             return 0
         if not no_prompt:
             for path, subp in deletables:
+                # FIXME using print is very bad idea
+                # clean_tree should accept to_file argument to write the output
                 print subp
             val = raw_input('Are you sure you wish to delete these [y/N]?')
             if val.lower() not in ('y', 'yes'):
@@ -68,6 +72,27 @@
         tree.unlock()
 
 
+def _filter_out_nested_bzrdirs(deletables):
+    result = []
+    for path, subp in deletables:
+        # bzr won't recurse into unknowns/ignored directories by default
+        # so we don't pay a penalty for checking subdirs of path for nested
+        # bzrdir.
+        # That said we won't detect the branch in the subdir of non-branch
+        # directory and therefore delete it. (worth to FIXME?)
+        if isdir(path):
+            try:
+                bzrdir.BzrDir.open(path)
+            except errors.NotBranchError:
+                result.append((path,subp))
+            else:
+                # TODO may be we need to notify user about skipped directories?
+                pass
+        else:
+            result.append((path,subp))
+    return result
+
+
 def delete_items(deletables, dry_run=False):
     """Delete files in the deletables iterable"""
     has_deleted = False

=== modified file 'bzrlib/tests/blackbox/test_clean_tree.py'
--- bzrlib/tests/blackbox/test_clean_tree.py	2009-03-23 14:59:43 +0000
+++ bzrlib/tests/blackbox/test_clean_tree.py	2010-05-05 01:45:38 +0000
@@ -21,6 +21,7 @@
 
 import os
 
+from bzrlib import ignores
 from bzrlib.tests import TestCaseWithTransport
 
 
@@ -62,3 +63,18 @@
         self.failIfExists('name')
         self.failIfExists('name~')
         self.failIfExists('name.pyc')
+
+    def test_clean_tree_nested_bzrdir(self):
+        # clean-tree should not blindly delete nested bzrdirs (branches)
+        # bug https://bugs.launchpad.net/bzr/+bug/572098
+        # so it will play well with scmproj/bzr-externals plugins.
+        wt1 = self.make_branch_and_tree('.')
+        wt2 = self.make_branch_and_tree('foo')
+        wt3 = self.make_branch_and_tree('bar')
+        ignores.tree_ignores_add_patterns(wt1, ['./foo'])
+        self.run_bzr(['clean-tree', '--unknown', '--force'])
+        self.failUnlessExists('foo')
+        self.failUnlessExists('bar')
+        self.run_bzr(['clean-tree', '--ignored', '--force'])
+        self.failUnlessExists('foo')
+        self.failUnlessExists('bar')