Merge lp:~jelmer/bzr-builddeb/quilt-hooks into lp:bzr-builddeb

[Jelmer Vernooij]

Add hooks for merge to unapply patches before merging.

This means that if there are conflicting patches that are being merged, only the patch files will end up with conflicts - the working tree is kept clean.

[lp:~jelmer/bzr-builddeb/quilt-hooks]

680. By Jelmer Vernooij on 2012-01-02

Automatically unapply patches before merge operations.
LP: #815854

[James Westby (james-w)]

Woop, thanks a lot for this one!

10 + if getattr(merger, "_no_quilt_unapplying", False):

Is that to avoid recursion?

This looks good. I'm interested to know how well it works :-)

Thanks,

James

[James Westby (james-w)]

review: Approve

[Jelmer Vernooij (jelmer)]

> Woop, thanks a lot for this one!
>
> 10 + if getattr(merger, "_no_quilt_unapplying", False):
>
> Is that to avoid recursion?
Yep. I found out the hard way :)

> This looks good. I'm interested to know how well it works :-)
Thanks, me too.

=== modified file '__init__.py'
--- __init__.py	2012-01-02 18:18:55 +0000
+++ __init__.py	2012-01-02 22:09:26 +0000
@@ -191,6 +191,53 @@
     return db.tag_name(changelog.version)
 
 
+def pre_merge(merger):
+    pre_merge_fix_ancestry(merger)
+    if getattr(merger, "_no_quilt_unapplying", False):
+        return
+    pre_merge_quilt(merger)
+
+
+def pre_merge_quilt(merger):
+    if (merger.this_tree.path2id("debian/patches") is None and
+        merger.base_tree.path2id("debian/patches") is None):
+        return
+    import shutil
+    from bzrlib import trace
+    from bzrlib.plugins.builddeb.errors import QuiltUnapplyError
+    from bzrlib.plugins.builddeb.quilt import QuiltError
+    from bzrlib.plugins.builddeb.merge_quilt import tree_unapply_patches
+    trace.note("Unapplying quilt patches to prevent spurious conflicts")
+    merger._quilt_tempdirs = []
+    try:
+        merger.this_tree, this_dir = tree_unapply_patches(merger.this_tree, merger.this_branch)
+    except QuiltError, e:
+        shutil.rmtree(this_dir)
+        raise QuiltUnapplyError("this", e.msg)
+    else:
+        merger._quilt_tempdirs.append(this_dir)
+    try:
+        merger.base_tree, base_dir = tree_unapply_patches(merger.base_tree, merger.this_branch)
+    except QuiltError, e:
+        shutil.rmtree(base_dir)
+        raise QuiltUnapplyError("base", e.msg)
+    else:
+        merger._quilt_tempdirs.append(base_dir)
+    try:
+        merger.other_tree, other_dir = tree_unapply_patches(merger.other_tree, merger.other_branch)
+    except QuiltError, e:
+        shutil.rmtree(other_dir)
+        raise QuiltUnapplyError("other", e.msg)
+    else:
+        merger._quilt_tempdirs.append(other_dir)
+
+
+def post_merge_quilt_cleanup(merger):
+    import shutil
+    for dir in getattr(merger, "_quilt_tempdirs", []):
+        shutil.rmtree(dir)
+
+
 def pre_merge_fix_ancestry(merger):
     from bzrlib.plugins.builddeb.config import BUILD_TYPE_NATIVE
     from bzrlib.plugins.builddeb.util import debuild_config
@@ -210,6 +257,7 @@
         fix_ancestry_as_needed(merger.this_tree, merger.other_branch,
             source_revid=merger.other_tree.get_revision_id())
 
+
 try:
     from bzrlib.hooks import install_lazy_named_hook
 except ImportError: # Compatibility with bzr < 2.4
@@ -258,8 +306,12 @@
          "Automatically determine tag names from Debian version")
     install_lazy_named_hook(
         "bzrlib.merge", "Merger.hooks",
-        "pre_merge", pre_merge_fix_ancestry,
-        "Fix the branch ancestry prior to a merge")
+        'pre_merge', pre_merge,
+        'Debian quilt patch (un)applying and ancestry fixing')
+    install_lazy_named_hook(
+        "bzrlib.merge", "Merger.hooks",
+        'post_merge', post_merge_quilt_cleanup,
+        'Cleaning up quilt temporary directories')
 
 try:
     from bzrlib.revisionspec import revspec_registry

=== modified file 'debian/changelog'
--- debian/changelog	2012-01-02 18:01:36 +0000
+++ debian/changelog	2012-01-02 22:09:26 +0000
@@ -5,6 +5,8 @@
     commands like 'bzr bash-completion'. LP: #903650
   * Provide merge-package functionality as a hook for 'bzr merge'.
     LP: #486075, LP: #910900
+  * Automatically unapply patches before merge operations.
+    LP: #815854
 
  -- Jelmer Vernooij <[e-mail]>  Mon, 02 Jan 2012 17:57:33 +0100
 

=== modified file 'errors.py'
--- errors.py	2012-01-02 18:01:36 +0000
+++ errors.py	2012-01-02 22:09:26 +0000
@@ -235,3 +235,15 @@
 
     _fmt = ("Importing packages using source format 3.0 multiple tarballs "
             "is not yet supported.")
+
+
+class QuiltUnapplyError(BzrError):
+
+    _fmt = ("Unable to unapply quilt patches for %(kind)r tree: %(msg)s")
+
+    def __init__(self, kind, msg):
+        BzrError.__init__(self)
+        self.kind = kind
+        if msg.count("\n") == 1:
+            msg = msg.strip()
+        self.msg = msg

=== modified file 'merge_quilt.py'
--- merge_quilt.py	2012-01-02 22:09:26 +0000
+++ merge_quilt.py	2012-01-02 22:09:26 +0000
@@ -21,13 +21,24 @@
 """Quilt patch handling."""
 
 from __future__ import absolute_import
+
+import shutil
 import tempfile
+from bzrlib.revisiontree import RevisionTree
+from bzrlib import (
+    merge as _mod_merge,
+    trace,
+    )
 
-from bzrlib import trace
 from bzrlib.plugins.builddeb.quilt import quilt_pop_all
 
 
-def tree_unapply_patches(orig_tree):
+class NoUnapplyingMerger(_mod_merge.Merge3Merger):
+
+    _no_quilt_unapplying = True
+
+
+def tree_unapply_patches(orig_tree, orig_branch):
     """Return a tree with patches unapplied.
 
     :param tree: Tree from which to unapply quilt patches
@@ -41,7 +52,19 @@
         return orig_tree, None
 
     target_dir = tempfile.mkdtemp()
-    tree = orig_tree.branch.create_checkout(target_dir, lightweight=True)
-    trace.warning("Applying quilt patches for %r in %s", orig_tree, target_dir)
-    quilt_pop_all(working_dir=tree.basedir)
-    return tree, target_dir
+    try:
+        if isinstance(orig_tree, RevisionTree):
+            tree = orig_branch.create_checkout(target_dir, lightweight=True,
+                accelerator_tree=orig_tree, revision_id=orig_tree.get_revision_id())
+        else:
+            tree = orig_branch.create_checkout(target_dir, lightweight=True,
+                revision_id=orig_tree.last_revision(), accelerator_tree=orig_tree)
+            merger = _mod_merge.Merger.from_uncommitted(tree, orig_tree)
+            merger.merge_type = NoUnapplyingMerger
+            merger.do_merge()
+        trace.mutter("Applying quilt patches for %r in %s", orig_tree, target_dir)
+        quilt_pop_all(working_dir=tree.basedir)
+        return tree, target_dir
+    except:
+        shutil.rmtree(target_dir)
+        raise

=== modified file 'tests/test_merge_quilt.py'
--- tests/test_merge_quilt.py	2011-12-20 14:44:17 +0000
+++ tests/test_merge_quilt.py	2012-01-02 22:09:26 +0000
@@ -18,3 +18,25 @@
 #
 
 """Tests for the merge_quilt code."""
+
+from bzrlib.plugins.builddeb.tests import ExecutableFeature
+from bzrlib.plugins.builddeb.merge_quilt import quilt_pop_all
+
+from bzrlib.tests import TestCaseWithTransport
+
+quilt_feature = ExecutableFeature('quilt')
+
+
+class QuiltTests(TestCaseWithTransport):
+
+    _test_needs_features = [quilt_feature]
+
+    def test_push_all_empty(self):
+        source = self.make_branch_and_tree('source')
+        self.build_tree(['source/debian/', 'source/debian/patches/'])
+        self.build_tree_contents([
+            ("test.recipe", "# bzr-builder format 0.3 "
+             "deb-version 1\nsource 3\n"),
+            ("source/debian/patches/series", "\n")])
+        source.add(["debian", "debian/patches", "debian/patches/series"])
+        quilt_pop_all("source", quiet=True)