Merge lp:~jelmer/brz/detect-local-wt into lp:brz

[Jelmer Vernooij]

Remove WorkingTree.find_trees, simplify detection of subtrees.

Remove unused WorkingTree.find_trees method.

Only detect .bzr subtrees in Bzr workingtrees and .git subtrees in Git workingtrees.

[Jelmer Vernooij (jelmer)]

review: Approve

[The Breezy Bot (the-breezy-bot)]

Running landing tests failed
https://ci.breezy-vcs.org/job/brz/job/brz-land/321/

[The Breezy Bot (the-breezy-bot)]

Running landing tests failed
https://ci.breezy-vcs.org/job/brz/job/brz-land/323/

=== modified file 'breezy/bzr/bzrdir.py'
--- breezy/bzr/bzrdir.py	2018-11-18 19:48:57 +0000
+++ breezy/bzr/bzrdir.py	2019-06-03 21:45:42 +0000
@@ -662,23 +662,6 @@
     def control_transport(self):
         return self.transport
 
-    def is_control_filename(self, filename):
-        """True if filename is the name of a path which is reserved for bzrdir's.
-
-        :param filename: A filename within the root transport of this bzrdir.
-
-        This is true IF and ONLY IF the filename is part of the namespace
-        reserved for bzr control dirs. Currently this is the '.bzr' directory
-        in the root of the root_transport.
-        """
-        # this might be better on the BzrDirFormat class because it refers to
-        # all the possible bzrdir disk formats.
-        # This method is tested via the workingtree is_control_filename tests-
-        # it was extracted from WorkingTree.is_control_filename. If the
-        # method's contract is extended beyond the current trivial
-        # implementation, please add new tests for it to the appropriate place.
-        return filename == '.bzr' or filename.startswith('.bzr/')
-
     def _cloning_metadir(self):
         """Produce a metadir suitable for cloning with.
 
@@ -1469,6 +1452,24 @@
         BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
                                        recommend_upgrade=recommend_upgrade, basedir=basedir)
 
+    @classmethod
+    def is_control_filename(klass, filename):
+        """True if filename is the name of a path which is reserved for bzrdir's.
+
+        :param filename: A filename within the root transport of this bzrdir.
+
+        This is true IF and ONLY IF the filename is part of the namespace
+        reserved for bzr control dirs. Currently this is the '.bzr' directory
+        in the root of the root_transport.
+        """
+        # this might be better on the BzrDirFormat class because it refers to
+        # all the possible bzrdir disk formats.
+        # This method is tested via the workingtree is_control_filename tests-
+        # it was extracted from WorkingTree.is_control_filename. If the
+        # method's contract is extended beyond the current trivial
+        # implementation, please add new tests for it to the appropriate place.
+        return filename == '.bzr' or filename.startswith('.bzr/')
+
 
 class BzrDirMetaFormat1(BzrDirFormat):
     """Bzr meta control format 1
 
=== modified file 'breezy/bzr/workingtree.py'
--- breezy/bzr/workingtree.py	2018-12-11 00:51:46 +0000
+++ breezy/bzr/workingtree.py	2019-06-03 21:45:42 +0000
@@ -126,6 +126,7 @@
 
         self._control_files = _control_files
         self._detect_case_handling()
+        self._setup_directory_is_tree_reference()
 
         if _inventory is None:
             # This will be acquired on lock_read() or lock_write()
@@ -160,7 +161,33 @@
         else:
             self.case_sensitive = False
 
-        self._setup_directory_is_tree_reference()
+    def _setup_directory_is_tree_reference(self):
+        if self._branch.repository._format.supports_tree_reference:
+            self._directory_is_tree_reference = \
+                self._directory_may_be_tree_reference
+        else:
+            self._directory_is_tree_reference = \
+                self._directory_is_never_tree_reference
+
+    def _directory_is_never_tree_reference(self, relpath):
+        return False
+
+    def _directory_may_be_tree_reference(self, relpath):
+        # as a special case, if a directory contains control files then
+        # it's a tree reference, except that the root of the tree is not
+        return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
+        # TODO: We could ask all the control formats whether they
+        # recognize this directory, but at the moment there's no cheap api
+        # to do that.  Since we probably can only nest bzr checkouts and
+        # they always use this name it's ok for now.  -- mbp 20060306
+        #
+        # FIXME: There is an unhandled case here of a subdirectory
+        # containing .bzr but not a branch; that will probably blow up
+        # when you try to commit it.  It might happen if there is a
+        # checkout in a subdirectory.  This can be avoided by not adding
+        # it.  mbp 20070306
+
+
 
     def _serialize(self, inventory, out_file):
         xml5.serializer_v5.write_inventory(
 
=== modified file 'breezy/controldir.py'
--- breezy/controldir.py	2018-11-12 01:41:38 +0000
+++ breezy/controldir.py	2019-06-03 21:45:42 +0000
@@ -152,7 +152,7 @@
         this in the future - for instance to make bzr talk with svn working
         trees.
         """
-        raise NotImplementedError(self.is_control_filename)
+        return self._format.is_control_filename(filename)
 
     def needs_format_conversion(self, format=None):
         """Return true if this controldir needs convert_format run on it.
@@ -1246,6 +1246,22 @@
         """
         raise NotImplementedError(self.supports_transport)
 
+    @classmethod
+    def is_control_filename(klass, filename):
+        """True if filename is the name of a path which is reserved for
+        controldirs.
+
+        :param filename: A filename within the root transport of this
+            controldir.
+
+        This is true IF and ONLY IF the filename is part of the namespace reserved
+        for bzr control dirs. Currently this is the '.bzr' directory in the root
+        of the root_transport. it is expected that plugins will need to extend
+        this in the future - for instance to make bzr talk with svn working
+        trees.
+        """
+        raise NotImplementedError(self.is_control_filename)
+
 
 class Prober(object):
     """Abstract class that can be used to detect a particular kind of
@@ -1461,8 +1477,13 @@
 
 def is_control_filename(filename):
     """Check if filename is used for control directories."""
-    # TODO(jelmer): Allow registration by other VCSes
-    return filename == '.bzr'
+    # TODO(jelmer): Instead, have a function that returns all control
+    # filenames.
+    for key, format in format_registry.items():
+        if format().is_control_filename(filename):
+            return True
+    else:
+        return False
 
 
 class RepositoryAcquisitionPolicy(object):
 
=== modified file 'breezy/git/dir.py'
--- breezy/git/dir.py	2019-03-18 04:31:21 +0000
+++ breezy/git/dir.py	2019-06-03 21:45:42 +0000
@@ -401,6 +401,11 @@
             raise brz_errors.NotBranchError(path=transport.base)
         return external_url.startswith("file:")
 
+    def is_control_filename(self, filename):
+        return (filename == '.git'
+                or filename.startswith('.git/')
+                or filename.startswith('.git\\'))
+
 
 class BareLocalGitControlDirFormat(LocalGitControlDirFormat):
 
@@ -410,6 +415,9 @@
     def get_format_description(self):
         return "Local Git Repository (bare)"
 
+    def is_control_filename(self, filename):
+        return False
+
 
 class LocalGitDir(GitDir):
     """An adapter to the '.git' dir used by git."""
@@ -443,11 +451,6 @@
             self.transport = transport.clone('.git')
         self._mode_check_done = None
 
-    def is_control_filename(self, filename):
-        return (filename == '.git'
-                or filename.startswith('.git/')
-                or filename.startswith('.git\\'))
-
     def _get_symref(self, ref):
         ref_chain, unused_sha = self._git.refs.follow(ref)
         if len(ref_chain) == 1:
 
=== modified file 'breezy/git/workingtree.py'
--- breezy/git/workingtree.py	2019-02-05 04:00:02 +0000
+++ breezy/git/workingtree.py	2019-06-03 21:45:42 +0000
@@ -568,8 +568,7 @@
                     except OSError as e:
                         if e.errno == errno.ENOENT:
                             raise errors.NoSuchFile(fullpath)
-                    if (kind == 'directory' and f != '' and
-                            os.path.exists(os.path.join(fullpath, '.git'))):
+                    if f != '' and self._directory_is_tree_reference(f):
                         kind = 'tree-reference'
                     kinds[pos] = kind
 
 
=== modified file 'breezy/tests/test_controldir.py'
--- breezy/tests/test_controldir.py	2018-11-11 04:08:32 +0000
+++ breezy/tests/test_controldir.py	2019-06-03 21:45:42 +0000
@@ -241,7 +241,7 @@
 
     def test_is_bzrdir(self):
         self.assertTrue(controldir.is_control_filename('.bzr'))
+        self.assertTrue(controldir.is_control_filename('.git'))
 
     def test_is_not_bzrdir(self):
-        self.assertFalse(controldir.is_control_filename('.git'))
         self.assertFalse(controldir.is_control_filename('bla'))
 
=== modified file 'breezy/tests/test_workingtree.py'
--- breezy/tests/test_workingtree.py	2018-11-12 01:41:38 +0000
+++ breezy/tests/test_workingtree.py	2019-06-03 21:45:42 +0000
@@ -452,18 +452,6 @@
         tree.auto_resolve()
 
 
-class TestFindTrees(TestCaseWithTransport):
-
-    def test_find_trees(self):
-        self.make_branch_and_tree('foo')
-        self.make_branch_and_tree('foo/bar')
-        # Sticking a tree inside a control dir is heinous, so let's skip it
-        self.make_branch_and_tree('foo/.bzr/baz')
-        self.make_branch('qux')
-        trees = workingtree.WorkingTree.find_trees('.')
-        self.assertEqual(2, len(list(trees)))
-
-
 class TestStoredUncommitted(TestCaseWithTransport):
 
     def store_uncommitted(self):
 
=== modified file 'breezy/workingtree.py'
--- breezy/workingtree.py	2019-02-14 22:18:59 +0000
+++ breezy/workingtree.py	2019-06-03 21:45:42 +0000
@@ -43,7 +43,6 @@
 
 from breezy import (
     conflicts as _mod_conflicts,
-    controldir,
     errors,
     filters as _mod_filters,
     merge,
@@ -57,6 +56,13 @@
     )
 """)
 
+from .controldir import (
+    ControlComponent,
+    ControlComponentFormatRegistry,
+    ControlComponentFormat,
+    ControlDir,
+    ControlDirFormat,
+    )
 from . import (
     osutils,
     )
@@ -78,7 +84,7 @@
     _fmt = "This format does not support shelving changes."
 
 
-class WorkingTree(mutabletree.MutableTree, controldir.ControlComponent):
+class WorkingTree(mutabletree.MutableTree, ControlComponent):
     """Working copy tree.
 
     :ivar basedir: The root of the tree on disk. This is a unicode path object
@@ -198,7 +204,7 @@
         """
         if path is None:
             path = osutils.getcwd()
-        control = controldir.ControlDir.open(path, _unsupported=_unsupported)
+        control = ControlDir.open(path, _unsupported=_unsupported)
         return control.open_workingtree(unsupported=_unsupported)
 
     @staticmethod
@@ -216,7 +222,7 @@
         """
         if path is None:
             path = osutils.getcwd()
-        control, relpath = controldir.ControlDir.open_containing(path)
+        control, relpath = ControlDir.open_containing(path)
         return control.open_workingtree(), relpath
 
     @staticmethod
@@ -294,24 +300,6 @@
         """
         return WorkingTree.open(path, _unsupported=True)
 
-    @staticmethod
-    def find_trees(location):
-        def list_current(transport):
-            return [d for d in transport.list_dir('')
-                    if not controldir.is_control_filename(d)]
-
-        def evaluate(controldir):
-            try:
-                tree = controldir.open_workingtree()
-            except errors.NoWorkingTree:
-                return True, None
-            else:
-                return True, tree
-        t = transport.get_transport(location)
-        iterator = controldir.ControlDir.find_controldirs(t, evaluate=evaluate,
-                                                          list_current=list_current)
-        return [tr for tr in iterator if tr is not None]
-
     def __repr__(self):
         return "<%s of %s>" % (self.__class__.__name__,
                                getattr(self, 'basedir', None))
@@ -729,31 +717,8 @@
     def subsume(self, other_tree):
         raise NotImplementedError(self.subsume)
 
-    def _setup_directory_is_tree_reference(self):
-        if self._branch.repository._format.supports_tree_reference:
-            self._directory_is_tree_reference = \
-                self._directory_may_be_tree_reference
-        else:
-            self._directory_is_tree_reference = \
-                self._directory_is_never_tree_reference
-
-    def _directory_is_never_tree_reference(self, relpath):
-        return False
-
-    def _directory_may_be_tree_reference(self, relpath):
-        # as a special case, if a directory contains control files then
-        # it's a tree reference, except that the root of the tree is not
-        return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
-        # TODO: We could ask all the control formats whether they
-        # recognize this directory, but at the moment there's no cheap api
-        # to do that.  Since we probably can only nest bzr checkouts and
-        # they always use this name it's ok for now.  -- mbp 20060306
-        #
-        # FIXME: There is an unhandled case here of a subdirectory
-        # containing .bzr but not a branch; that will probably blow up
-        # when you try to commit it.  It might happen if there is a
-        # checkout in a subdirectory.  This can be avoided by not adding
-        # it.  mbp 20070306
+    def _directory_is_tree_reference(self, relpath):
+        raise NotImplementedError(self._directory_is_tree_reference)
 
     def extract(self, path, format=None):
         """Extract a subtree from this tree.
@@ -1373,7 +1338,7 @@
             return next(self.get_canonical_paths([path]))
 
 
-class WorkingTreeFormatRegistry(controldir.ControlComponentFormatRegistry):
+class WorkingTreeFormatRegistry(ControlComponentFormatRegistry):
     """Registry for working tree formats."""
 
     def __init__(self, other_registry=None):
@@ -1402,7 +1367,7 @@
 format_registry = WorkingTreeFormatRegistry()
 
 
-class WorkingTreeFormat(controldir.ControlComponentFormat):
+class WorkingTreeFormat(ControlComponentFormat):
     """An encapsulation of the initialization and open routines for a format.
 
     Formats provide three things: