Merge lp:~jelmer/bzr/post-tree-build-hook into lp:bzr

[Jelmer Vernooij]

Add post_build_tree hook to MutableTree.

Add a post_tree_build hook, useful for bzr-builddeb.

[Martin Packman (gz)]

Three callsites and one test worried me, but now I see it's a per_workingtree one, so ideal.

review: Approve

[Jelmer Vernooij (jelmer)]

sent to pqm by email

[Jelmer Vernooij (jelmer)]

sent to pqm by email

=== modified file 'bzrlib/mutabletree.py'
--- bzrlib/mutabletree.py	2011-12-19 13:23:58 +0000
+++ bzrlib/mutabletree.py	2012-01-06 19:50:29 +0000
@@ -520,6 +520,9 @@
             "called with a bzrlib.mutabletree.PostCommitHookParams object. "
             "The mutable tree the commit was performed on is available via "
             "the mutable_tree attribute of that object.", (2, 0))
+        self.add_hook('post_build_tree',
+            "Called after a completely new tree is built. The hook is "
+            "called with the tree as its only argument.", (2, 5))
 
 
 # install the default hooks into the MutableTree class.

=== modified file 'bzrlib/plugins/weave_fmt/workingtree.py'
--- bzrlib/plugins/weave_fmt/workingtree.py	2011-12-19 13:23:58 +0000
+++ bzrlib/plugins/weave_fmt/workingtree.py	2012-01-06 19:50:29 +0000
@@ -30,6 +30,7 @@
     xml5,
     )
 from bzrlib.decorators import needs_read_lock
+from bzrlib.mutabletree import MutableTree
 from bzrlib.transport.local import LocalTransport
 from bzrlib.workingtree import (
     WorkingTreeFormat,
@@ -113,6 +114,8 @@
             parent_trees = [(revision_id, basis_tree)]
         wt.set_parent_trees(parent_trees)
         transform.build_tree(basis_tree, wt)
+        for hook in MutableTree.hooks['post_build_tree']:
+            hook(wt)
         return wt
 
     def __init__(self):

=== modified file 'bzrlib/tests/per_workingtree/test_workingtree.py'
--- bzrlib/tests/per_workingtree/test_workingtree.py	2011-12-16 17:34:46 +0000
+++ bzrlib/tests/per_workingtree/test_workingtree.py	2012-01-06 19:50:29 +0000
@@ -37,6 +37,7 @@
     PathsNotVersionedError,
     )
 from bzrlib.inventory import Inventory
+from bzrlib.mutabletree import MutableTree
 from bzrlib.osutils import pathjoin, getcwd, has_symlinks
 from bzrlib.tests import (
     features,
@@ -451,6 +452,23 @@
             revision_id='a')
         self.assertEqual(['a'], made_tree.get_parent_ids())
 
+    def test_post_build_tree_hook(self):
+        calls = []
+        def track_post_build_tree(tree):
+            calls.append(tree.last_revision())
+        source = self.make_branch_and_tree('source')
+        source.commit('a', rev_id='a', allow_pointless=True)
+        source.commit('b', rev_id='b', allow_pointless=True)
+        self.build_tree(['new/'])
+        made_control = self.bzrdir_format.initialize('new')
+        source.branch.repository.clone(made_control)
+        source.branch.clone(made_control)
+        MutableTree.hooks.install_named_hook("post_build_tree",
+            track_post_build_tree, "Test")
+        made_tree = self.workingtree_format.initialize(made_control,
+            revision_id='a')
+        self.assertEqual(['a'], calls)
+
     def test_update_sets_last_revision(self):
         # working tree formats from the meta-dir format and newer support
         # setting the last revision on a tree independently of that on the

=== modified file 'bzrlib/workingtree_3.py'
--- bzrlib/workingtree_3.py	2011-12-19 19:15:58 +0000
+++ bzrlib/workingtree_3.py	2012-01-06 19:50:29 +0000
@@ -36,6 +36,7 @@
     )
 from bzrlib.lockable_files import LockableFiles
 from bzrlib.lockdir import LockDir
+from bzrlib.mutabletree import MutableTree
 from bzrlib.transport.local import LocalTransport
 from bzrlib.workingtree import (
     InventoryWorkingTree,
@@ -227,6 +228,8 @@
             else:
                 wt.set_parent_trees([(revision_id, basis_tree)])
             transform.build_tree(basis_tree, wt)
+            for hook in MutableTree.hooks['post_build_tree']:
+                hook(wt)
         finally:
             # Unlock in this order so that the unlock-triggers-flush in
             # WorkingTree is given a chance to fire.

=== modified file 'bzrlib/workingtree_4.py'
--- bzrlib/workingtree_4.py	2011-12-19 19:15:58 +0000
+++ bzrlib/workingtree_4.py	2012-01-06 19:50:29 +0000
@@ -57,7 +57,10 @@
 from bzrlib.lock import LogicalLockResult
 from bzrlib.lockable_files import LockableFiles
 from bzrlib.lockdir import LockDir
-from bzrlib.mutabletree import needs_tree_write_lock
+from bzrlib.mutabletree import (
+    MutableTree,
+    needs_tree_write_lock,
+    )
 from bzrlib.osutils import (
     file_kind,
     isdir,
@@ -1544,6 +1547,8 @@
                 transform.build_tree(basis, wt, accelerator_tree,
                                      hardlink=hardlink,
                                      delta_from_tree=delta_from_tree)
+                for hook in MutableTree.hooks['post_build_tree']:
+                    hook(wt)
             finally:
                 basis.unlock()
         finally:

=== modified file 'doc/en/release-notes/bzr-2.5.txt'
--- doc/en/release-notes/bzr-2.5.txt	2012-01-05 16:03:11 +0000
+++ doc/en/release-notes/bzr-2.5.txt	2012-01-06 19:50:29 +0000
@@ -178,6 +178,9 @@
   which contains the branch from which the ``other_tree``
   was obtained, if any. (Jelmer Vernooij)
 
+* MutableTree now has a hook ``post_build_tree`` which is called after
+  a new mutable tree has been created. (Jelmer Vernooij, #912765)
+
 * New HPSS call ``BzrDir.checkout_metadir``. (Jelmer Vernooij, #894459)
 
 * New HPSS call ``VersionedFileRepository.get_inventories``,