Merge lp:~jelmer/brz/get-nested-tree into lp:brz

[Jelmer Vernooij]

Add ``Tree.get_nested_tree`` for retrieving a nested tree from another tree.

Add ``Tree.get_nested_tree`` for retrieving a nested tree.

[Martin Packman (gz)]

Looks good, thanks.

review: Approve

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

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

=== modified file 'breezy/bzr/inventorytree.py'
--- breezy/bzr/inventorytree.py	2019-06-22 12:07:42 +0000
+++ breezy/bzr/inventorytree.py	2019-07-07 16:28:18 +0000
@@ -51,6 +51,7 @@
 from ..tree import (
     FileTimestampUnavailable,
     InterTree,
+    MissingNestedTree,
     Tree,
     TreeChange,
     )
@@ -773,6 +774,10 @@
     def get_reference_revision(self, path):
         return self._path2ie(path).reference_revision
 
+    def get_nested_tree(self, path):
+        nested_revid = self.get_reference_revision(path)
+        raise MissingNestedTree(path)
+
     def get_root_id(self):
         if self.root_inventory.root:
             return self.root_inventory.root.file_id

=== modified file 'breezy/bzr/workingtree_4.py'
--- breezy/bzr/workingtree_4.py	2019-06-18 13:48:45 +0000
+++ breezy/bzr/workingtree_4.py	2019-07-07 16:28:18 +0000
@@ -78,6 +78,7 @@
 from ..tree import (
     FileTimestampUnavailable,
     InterTree,
+    MissingNestedTree,
     )
 from ..workingtree import (
     WorkingTree,
@@ -1758,6 +1759,13 @@
         path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
         return path_utf8.decode('utf8')
 
+    def get_nested_tree(self, path):
+        with self.lock_read():
+            nested_revid = self.get_reference_revision(path)
+            # TODO(jelmer): Attempt to open 'path' as a working tree, and see if we can find
+            # the referenced revision id in our memory?
+            raise MissingNestedTree(path)
+
     def iter_references(self):
         if not self._repo_supports_tree_reference:
             # When the repo doesn't support references, we will have nothing to

=== modified file 'breezy/git/tree.py'
--- breezy/git/tree.py	2019-06-21 17:49:36 +0000
+++ breezy/git/tree.py	2019-07-07 16:28:18 +0000
@@ -253,6 +253,7 @@
     def __init__(self, repository, revision_id):
         self._revision_id = revision_id
         self._repository = repository
+        self._submodules = None
         self.store = repository._git.object_store
         if not isinstance(revision_id, bytes):
             raise TypeError(revision_id)
@@ -273,12 +274,38 @@
             self._fileid_map = self.mapping.get_fileid_map(
                 self.store.__getitem__, self.tree)
 
-    def _get_nested_repository(self, path):
-        nested_repo_transport = self._repository.user_transport.clone(path)
+    def _submodule_info(self):
+        if self._submodules is None:
+            try:
+                with self.get_file('.gitmodules') as f:
+                    config = GitConfigFile.from_file(f)
+                    self._submodules = {
+                        path: (url, section)
+                        for path, url, section in parse_submodules(config)}
+            except errors.NoSuchFile:
+                self._submodules = {}
+        return self._submodules
+
+    def _get_submodule_repository(self, relpath):
+        if not isinstance(relpath, bytes):
+            raise TypeError(relpath)
+        try:
+            info = self._submodule_info()[relpath]
+        except KeyError:
+            nested_repo_transport = self._repository.user_transport.clone(relpath.decode('utf-8'))
+        else:
+            nested_repo_transport = self._repository.control_transport.clone(
+                posixpath.join('modules', info[0]))
         nested_controldir = _mod_controldir.ControlDir.open_from_transport(
             nested_repo_transport)
         return nested_controldir.find_repository()
 
+    def get_nested_tree(self, path):
+        encoded_path = path.encode('utf-8')
+        nested_repo = self._get_submodule_repository(encoded_path)
+        ref_rev = self.get_reference_revision(path)
+        return nested_repo.revision_tree(ref_rev)
+
     def supports_rename_tracking(self):
         return False
 
@@ -565,7 +592,7 @@
         """See RevisionTree.get_symlink_target."""
         (store, mode, hexsha) = self._lookup_path(path)
         if S_ISGITLINK(mode):
-            nested_repo = self._get_nested_repository(path)
+            nested_repo = self._get_submodule_repository(path.encode('utf-8'))
             return nested_repo.lookup_foreign_revision_id(hexsha)
         else:
             return None
@@ -590,7 +617,7 @@
         elif kind == 'symlink':
             return (kind, None, None, store[hexsha].data.decode('utf-8'))
         elif kind == 'tree-reference':
-            nested_repo = self._get_nested_repository(path)
+            nested_repo = self._get_submodule_repository(path.encode('utf-8'))
             return (kind, None, None,
                     nested_repo.lookup_foreign_revision_id(hexsha))
         else:

=== modified file 'breezy/tests/per_tree/test_tree.py'
--- breezy/tests/per_tree/test_tree.py	2019-06-22 12:07:42 +0000
+++ breezy/tests/per_tree/test_tree.py	2019-07-07 16:28:18 +0000
@@ -21,6 +21,7 @@
     revisiontree,
     tests,
     )
+from breezy.tree import MissingNestedTree
 from breezy.bzr import (
     workingtree_4,
     )
@@ -82,14 +83,11 @@
 
     def create_nested(self):
         work_tree = self.make_branch_and_tree('wt')
-        work_tree.lock_write()
-        try:
+        with work_tree.lock_write():
             self.skip_if_no_reference(work_tree)
             subtree = self.make_branch_and_tree('wt/subtree')
             subtree.commit('foo')
             work_tree.add_reference(subtree)
-        finally:
-            work_tree.unlock()
         tree = self._convert_tree(work_tree)
         self.skip_if_no_reference(tree)
         return tree, subtree
@@ -110,6 +108,15 @@
             [u'subtree'],
             list(tree.iter_references()))
 
+    def test_get_nested_tree(self):
+        tree, subtree = self.create_nested()
+        try:
+            changes = subtree.changes_from(tree.get_nested_tree('subtree'))
+            self.assertFalse(changes.has_changed())
+        except MissingNestedTree:
+            # Also okay.
+            pass
+
     def test_get_root_id(self):
         # trees should return some kind of root id; it can be none
         tree = self.make_branch_and_tree('tree')

=== modified file 'breezy/tree.py'
--- breezy/tree.py	2019-06-22 11:16:17 +0000
+++ breezy/tree.py	2019-07-07 16:28:18 +0000
@@ -61,6 +61,14 @@
         self.path = path
 
 
+class MissingNestedTree(errors.BzrError):
+
+    _fmt = "The nested tree for %(path)s can not be resolved."""
+
+    def __init__(self, path):
+        self.path = path
+
+
 class TreeEntry(object):
     """An entry that implements the minimum interface used by commands.
     """
@@ -349,6 +357,15 @@
                 if entry.kind == 'tree-reference':
                     yield path
 
+    def get_nested_tree(self, path):
+        """Open the nested tree at the specified path.
+
+        :param path: Path from which to resolve tree reference.
+        :return: A Tree object for the nested tree
+        :raise MissingNestedTree: If the nested tree can not be resolved
+        """
+        raise NotImplementedError(self.get_nested_tree)
+
     def kind(self, path):
         raise NotImplementedError("Tree subclass %s must implement kind"
                                   % self.__class__.__name__)

=== modified file 'doc/en/release-notes/brz-3.1.txt'
--- doc/en/release-notes/brz-3.1.txt	2019-07-07 16:21:24 +0000
+++ doc/en/release-notes/brz-3.1.txt	2019-07-07 16:28:18 +0000
@@ -84,6 +84,9 @@
 * New ``Tree.get_transform`` method for getting a ``TreeTransform``
   object. (Jelmer Vernooij)
 
+* New ``Tree.get_nested_tree`` method for retrieving a nested tree.
+  (Jelmer Vernooij)
+
 Internals
 *********