Merge lp:~jelmer/bzr-builddeb/quilt-tree-policy into lp:bzr-builddeb

[Jelmer Vernooij]

Add a hook and configuration setting that allows automatically applying patches after merges/pulls.

Together with my other changes, this makes it easy to always have patches
applied in the working tree, but unapplied in revisions (which helps with
merging).

[James Westby (james-w)]

What state does this leave things in if the quilt patches don't apply
after the operation?

Thanks,

James

review: Approve

=== modified file '__init__.py'
--- __init__.py	2012-01-05 18:53:13 +0000
+++ __init__.py	2012-01-06 13:45:28 +0000
@@ -210,6 +210,9 @@
     from bzrlib.plugins.builddeb.merge_quilt import tree_unapply_patches
     trace.note("Unapplying quilt patches to prevent spurious conflicts")
     merger._quilt_tempdirs = []
+    series_file_id = merger.working_tree.path2id("debian/patches/series")
+    if series_file_id is not None:
+        merger._old_quilt_series = merger.working_tree.get_file_lines(series_file_id)
     if merger.working_tree.path2id("debian/patches") is not None:
         quilt_pop_all(working_dir=merger.working_tree.basedir)
     try:
@@ -245,6 +248,14 @@
     import shutil
     for dir in getattr(merger, "_quilt_tempdirs", []):
         shutil.rmtree(dir)
+    from bzrlib.plugins.builddeb.util import debuild_config
+    config = debuild_config(merger.working_tree, merger.working_tree)
+    policy = config.quilt_tree_policy
+    if policy is None:
+        return
+    from bzrlib.plugins.builddeb.merge_quilt import post_process_quilt_patches
+    post_process_quilt_patches(
+            merger.working_tree, getattr(merger, "_old_quilt_series", []), policy)
 
 
 def pre_merge_fix_ancestry(merger):

=== modified file 'config.py'
--- config.py	2011-11-22 14:05:25 +0000
+++ config.py	2012-01-06 13:45:28 +0000
@@ -295,6 +295,9 @@
   commit_message_from_changelog = _bool_property('commit-message-from-changelog',
        "Whether the commit message should come from debian/changelog", default=False)
 
+  quilt_tree_policy = _opt_property('quilt-tree-policy',
+      "Whether to automatically apply/unapply quilt patches after tree operations")
+
 
 def _test():
   import doctest

=== modified file 'merge_quilt.py'
--- merge_quilt.py	2012-01-05 11:38:00 +0000
+++ merge_quilt.py	2012-01-06 13:45:28 +0000
@@ -31,7 +31,11 @@
     trace,
     )
 
-from bzrlib.plugins.builddeb.quilt import quilt_pop_all
+from bzrlib.plugins.builddeb.quilt import (
+    quilt_pop_all,
+    quilt_push,
+    quilt_pop,
+    )
 
 
 class NoUnapplyingMerger(_mod_merge.Merge3Merger):
@@ -86,3 +90,41 @@
     except:
         shutil.rmtree(target_dir)
         raise
+
+
+def post_process_quilt_patches(tree, old_patches, policy):
+    """(Un)apply patches after a merge.
+
+    :param tree: Working tree to work in
+    :param old_patches: List of patches applied before the operation (usually a merge)
+    """
+    new_patches = tree.get_file_lines(tree.path2id("debian/patches/series"))
+    applied_file_id = tree.path2id(".pc/applied-patches")
+    if applied_file_id is not None:
+        applied_patches = tree.get_file_lines(applied_file_id, ".pc/applied-patches")
+    else:
+        applied_patches = []
+    if policy == "applied":
+        to_apply = []
+        for p in new_patches:
+            if p in old_patches:
+                continue
+            if not p in applied_patches:
+                to_apply.append(p)
+        if to_apply == []:
+            return
+        trace.note("Applying %d quilt patches.", to_apply)
+        for p in to_apply:
+            quilt_push(tree.basedir, p)
+    elif policy == "unapplied":
+        to_unapply = []
+        for p in new_patches:
+            if p in old_patches:
+                continue
+            if p in applied_patches:
+                to_unapply.append(p)
+        if to_unapply == []:
+            return
+        trace.note("Unapplying %d quilt patches", to_unapply)
+        for p in to_unapply:
+            quilt_pop(tree.basedir, p)

=== modified file 'quilt.py'
--- quilt.py	2012-01-04 23:28:23 +0000
+++ quilt.py	2012-01-06 13:45:28 +0000
@@ -101,7 +101,20 @@
     :param patches_dir: Optional patches directory
     :param series_file: Optional series file
     """
-    return run_quilt(["pop", "-a"], working_dir=working_dir, patches_dir=patches_dir, series_file=series_file, quiet=quiet)
+    return run_quilt(["pop", "-a"], working_dir=working_dir,
+        patches_dir=patches_dir, series_file=series_file, quiet=quiet)
+
+
+def quilt_pop(working_dir, patch, patches_dir=None, series_file=None, quiet=None):
+    """Pop a patch.
+
+    :param working_dir: Directory to work in
+    :param patch: Patch to apply
+    :param patches_dir: Optional patches directory
+    :param series_file: Optional series file
+    """
+    return run_quilt(["pop", patch], working_dir=working_dir,
+        patches_dir=patches_dir, series_file=series_file, quiet=quiet)
 
 
 def quilt_push_all(working_dir, patches_dir=None, series_file=None, quiet=None):
@@ -111,7 +124,20 @@
     :param patches_dir: Optional patches directory
     :param series_file: Optional series file
     """
-    return run_quilt(["push", "-a"], working_dir=working_dir, patches_dir=patches_dir, series_file=series_file, quiet=quiet)
+    return run_quilt(["push", "-a"], working_dir=working_dir,
+            patches_dir=patches_dir, series_file=series_file, quiet=quiet)
+
+
+def quilt_push(working_dir, patch, patches_dir=None, series_file=None, quiet=None):
+    """Push a patch.
+
+    :param working_dir: Directory to work in
+    :param patch: Patch to push
+    :param patches_dir: Optional patches directory
+    :param series_file: Optional series file
+    """
+    return run_quilt(["push", patch], working_dir=working_dir,
+            patches_dir=patches_dir, series_file=series_file, quiet=quiet)
 
 
 def quilt_applied(working_dir, patches_dir=None, series_file=None):

=== modified file 'tests/test_merge_quilt.py'
--- tests/test_merge_quilt.py	2012-01-05 11:38:00 +0000
+++ tests/test_merge_quilt.py	2012-01-06 13:45:28 +0000
@@ -19,6 +19,7 @@
 
 """Tests for the merge_quilt code."""
 
+import os
 import shutil
 
 from bzrlib.hooks import install_lazy_named_hook
@@ -125,3 +126,61 @@
         # "a" should be unapplied again
         self.assertPathDoesNotExist("a/a")
         self.assertEquals(1, conflicts)
+
+    def test_auto_apply_patches_after_checkout(self):
+        self.enable_hooks()
+
+        tree_a = self.make_branch_and_tree('a')
+
+        self.build_tree(['a/debian/', 'a/debian/patches/'])
+        self.build_tree_contents([
+            ('a/debian/patches/series', 'patch1\n'),
+            ('a/debian/patches/patch1', TRIVIAL_PATCH)])
+        tree_a.smart_add([tree_a.basedir])
+        tree_a.commit('initial')
+
+        self.build_tree_contents([
+            (os.path.join(self.test_home_dir, ".bazaar/builddeb.conf"),
+                "[BUILDDEB]\nquilt-tree-policy = applied\n")])
+
+        tree_b = tree_a.branch.create_checkout("b")
+        self.expectFailure("patches not yet applied after checkout",
+            self.assertFileEqual, "a\n", "b/a")
+
+    def test_auto_apply_patches_after_update(self):
+        self.enable_hooks()
+
+        tree_a = self.make_branch_and_tree('a')
+        tree_b = tree_a.branch.create_checkout("b")
+
+        self.build_tree(['a/debian/', 'a/debian/patches/'])
+        self.build_tree_contents([
+            ('a/debian/patches/series', 'patch1\n'),
+            ('a/debian/patches/patch1', TRIVIAL_PATCH)])
+        tree_a.smart_add([tree_a.basedir])
+        tree_a.commit('initial')
+
+        self.build_tree(["b/.bzr-builddeb/"])
+        self.build_tree_contents([("b/.bzr-builddeb/local.conf", "[BUILDDEB]\nquilt-tree-policy = applied\n")])
+
+        tree_b.update()
+        self.assertFileEqual("a\n", "b/a")
+
+    def test_auto_unapply_patches_after_update(self):
+        self.enable_hooks()
+
+        tree_a = self.make_branch_and_tree('a')
+        tree_b = tree_a.branch.create_checkout("b")
+
+        self.build_tree(['a/debian/', 'a/debian/patches/'])
+        self.build_tree_contents([
+            ('a/debian/patches/series', 'patch1\n'),
+            ('a/debian/patches/patch1', TRIVIAL_PATCH)])
+        tree_a.smart_add([tree_a.basedir])
+        tree_a.commit('initial')
+
+        self.build_tree(["b/.bzr-builddeb/"])
+        self.build_tree_contents([("b/.bzr-builddeb/local.conf", "[BUILDDEB]\nquilt-tree-policy = unapplied\n")])
+
+        tree_b.update()
+        self.assertPathDoesNotExist("b/a")