Merge lp:~jelmer/bzr-builddeb/auto-apply-quilt into lp:bzr-builddeb

[Jelmer Vernooij]

Automatically apply patches for 3.0 (quilt) packages in 'bzr bd' or 'bzr bd-do'.

[lp:~jelmer/bzr-builddeb/auto-apply-quilt]

685. By Jelmer Vernooij on 2012-01-02

Fix changelog.

Unmerged revisions

=== modified file 'builder.py'
--- builder.py	2009-12-01 17:14:15 +0000
+++ builder.py	2012-01-02 22:04:32 +0000
@@ -28,10 +28,13 @@
                     NoSourceDirError,
                     BuildFailedError,
                     )
+from bzrlib.plugins.builddeb.quilt import quilt_push_all
 from bzrlib.plugins.builddeb.util import (
-        get_parent_dir,
-        subprocess_setup,
-        )
+    get_parent_dir,
+    tree_get_source_format,
+    subprocess_setup,
+    FORMAT_3_0_QUILT,
+    )
 
 
 class DebBuild(object):
@@ -71,8 +74,20 @@
             if self.use_existing:
                 raise NoSourceDirError
 
-    def export(self):
+    def export(self, apply_quilt_patches=True):
         self.distiller.distill(self.target_dir)
+        if apply_quilt_patches:
+            self._apply_quilt_patches()
+
+    def _apply_quilt_patches(self):
+        if not os.path.isfile(os.path.join(self.target_dir, "debian/patches/series")):
+            return
+        format_path = os.path.join(self.target_dir, "debian/source/format")
+        if not os.path.isfile(format_path):
+            return
+        with file(format_path, 'r') as f:
+            if f.read().strip() == FORMAT_3_0_QUILT:
+                quilt_push_all(os.path.abspath(self.target_dir))
 
     def build(self):
         """This builds the package using the supplied command."""
 
=== modified file 'cmds.py'
--- cmds.py	2012-01-02 18:01:36 +0000
+++ cmds.py	2012-01-02 22:04:32 +0000
@@ -82,6 +82,48 @@
     type=str)
 
 
+def _get_changelog_info(tree, last_version=None, package=None, distribution=None):
+    from bzrlib.plugins.builddeb.util import (
+        find_changelog,
+        find_last_distribution,
+        lookup_distribution,
+        )
+    from bzrlib.plugins.builddeb.errors import (
+        MissingChangelogError,
+        )
+    current_version = last_version
+    try:
+        (changelog, top_level) = find_changelog(tree, False, max_blocks=2)
+        if last_version is None:
+            current_version = changelog.version.upstream_version
+        if package is None:
+            package = changelog.package
+        if distribution is None:
+            distribution = find_last_distribution(changelog)
+            if distribution is not None:
+                note(gettext("Using distribution %s") % distribution)
+    except MissingChangelogError:
+        top_level = False
+        changelog = None
+    if distribution is None:
+        note("No distribution specified, and no changelog, "
+                "assuming 'debian'")
+        distribution = "debian"
+    if package is None:
+        raise BzrCommandError("You did not specify --package, and "
+                "there is no changelog from which to determine the "
+                "package name, which is needed to know the name to "
+                "give the .orig.tar.gz. Please specify --package.")
+    distribution = distribution.lower()
+    distribution_name = lookup_distribution(distribution)
+    if distribution_name is None:
+        raise BzrCommandError(gettext("Unknown target distribution: %s") \
+                    % distribution)
+    return (current_version, package, distribution, distribution_name,
+            changelog, top_level)
+
+
+
 class cmd_builddeb(Command):
     """Builds a Debian package from a branch.
 
@@ -633,46 +675,6 @@
         return self._fetch_tarball(package, version, orig_dir,
             locations, v3)
 
-    def _get_changelog_info(self, tree, last_version, package, distribution):
-        from bzrlib.plugins.builddeb.util import (
-            find_changelog,
-            find_last_distribution,
-            lookup_distribution,
-            )
-        from bzrlib.plugins.builddeb.errors import (
-            MissingChangelogError,
-            )
-        current_version = last_version
-        try:
-            (changelog, top_level) = find_changelog(tree, False, max_blocks=2)
-            if last_version is None:
-                current_version = changelog.version.upstream_version
-            if package is None:
-                package = changelog.package
-            if distribution is None:
-                distribution = find_last_distribution(changelog)
-                if distribution is not None:
-                    note(gettext("Using distribution %s") % distribution)
-        except MissingChangelogError:
-            top_level = False
-            changelog = None
-        if distribution is None:
-            note("No distribution specified, and no changelog, "
-                    "assuming 'debian'")
-            distribution = "debian"
-        if package is None:
-            raise BzrCommandError("You did not specify --package, and "
-                    "there is no changelog from which to determine the "
-                    "package name, which is needed to know the name to "
-                    "give the .orig.tar.gz. Please specify --package.")
-        distribution = distribution.lower()
-        distribution_name = lookup_distribution(distribution)
-        if distribution_name is None:
-            raise BzrCommandError(gettext("Unknown target distribution: %s") \
-                        % distribution)
-        return (current_version, package, distribution, distribution_name,
-                changelog, top_level)
-
     def run(self, location=None, upstream_branch=None, version=None,
             distribution=None, package=None,
             directory=".", revision=None, merge_type=None,
@@ -695,7 +697,7 @@
         from bzrlib.plugins.builddeb.util import (
             FORMAT_3_0_QUILT,
             FORMAT_3_0_NATIVE,
-            get_source_format,
+            tree_get_source_format,
             guess_build_type,
             tree_contains_upstream_source,
             )
@@ -710,7 +712,7 @@
                         "command.")
             config = debuild_config(tree, tree)
             (current_version, package, distribution, distribution_name,
-             changelog, top_level) = self._get_changelog_info(tree, last_version,
+             changelog, top_level) = _get_changelog_info(tree, last_version,
                  package, distribution)
             contains_upstream_source = tree_contains_upstream_source(tree)
             if changelog is None:
@@ -822,7 +824,7 @@
                             revisions=upstream_revisions)
                     else:
                         raise
-                source_format = get_source_format(tree)
+                source_format = tree_get_source_format(tree)
                 v3 = (source_format in [
                     FORMAT_3_0_QUILT, FORMAT_3_0_NATIVE])
                 tarball_filenames = self._get_tarballs(config, tree, package,
@@ -1160,10 +1162,25 @@
         from bzrlib.plugins.builddeb.hooks import run_hook
         from bzrlib.plugins.builddeb.util import (
             find_changelog,
+            guess_build_type,
+            tree_contains_upstream_source,
             )
         t = WorkingTree.open_containing('.')[0]
+        self.add_cleanup(t.lock_read().unlock)
         config = debuild_config(t, t)
-        if config.build_type != BUILD_TYPE_MERGE:
+        (current_version, package, distribution, distribution_name,
+         changelog, top_level) = _get_changelog_info(t)
+        contains_upstream_source = tree_contains_upstream_source(t)
+        if changelog is None:
+            changelog_version = None
+        else:
+            changelog_version = changelog.version
+        build_type = config.build_type
+        if build_type is None:
+            build_type = guess_build_type(t, changelog_version,
+                contains_upstream_source)
+
+        if build_type != BUILD_TYPE_MERGE:
             raise BzrCommandError(gettext("This command only works for merge "
                 "mode packages. See /usr/share/doc/bzr-builddeb"
                 "/user_manual/merge.html for more information."))
 
=== modified file 'debian/changelog'
--- debian/changelog	2012-01-02 18:01:36 +0000
+++ debian/changelog	2012-01-02 22:04:32 +0000
@@ -5,8 +5,13 @@
     commands like 'bzr bash-completion'. LP: #903650
   * Provide merge-package functionality as a hook for 'bzr merge'.
     LP: #486075, LP: #910900
+  * Automatically apply quilt patches. LP: #616791
+  * Automatically apply v3 quilt patches for 'bzr builddeb' and 'bzr bd-
+    do'. LP: #616791
+  * Automatically apply patches for 3.0 (quilt) packages in 'bzr bd-do'
+    and 'bzr bd'. LP: #616791
 
- -- Jelmer Vernooij <[e-mail]>  Mon, 02 Jan 2012 17:57:33 +0100
+ -- Jelmer Vernooij <[e-mail]>  Mon, 02 Jan 2012 23:02:44 +0100
 
 bzr-builddeb (2.8.0) unstable; urgency=low
 
 
=== modified file 'merge_quilt.py'
--- merge_quilt.py	2011-12-20 14:44:17 +0000
+++ merge_quilt.py	2012-01-02 22:04:32 +0000
@@ -21,3 +21,27 @@
 """Quilt patch handling."""
 
 from __future__ import absolute_import
+import tempfile
+
+from bzrlib import trace
+from bzrlib.plugins.builddeb.quilt import quilt_pop_all
+
+
+def tree_unapply_patches(orig_tree):
+    """Return a tree with patches unapplied.
+
+    :param tree: Tree from which to unapply quilt patches
+    :return: Tuple with tree and temp path.
+        The tree is a tree with unapplied patches; either a checkout of
+        tree or tree itself if there were no patches
+    """
+    series_file_id = orig_tree.path2id("debian/patches/series")
+    if series_file_id is None:
+        # No quilt patches
+        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
 
=== added file 'quilt.py'
--- quilt.py	1970-01-01 00:00:00 +0000
+++ quilt.py	2012-01-02 22:04:32 +0000
@@ -0,0 +1,151 @@
+#    quilt.py -- Quilt patch handling
+#    Copyright (C) 2011 Canonical Ltd.
+#
+#    This file is part of bzr-builddeb.
+#
+#    bzr-builddeb is free software; you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation; either version 2 of the License, or
+#    (at your option) any later version.
+#
+#    bzr-builddeb is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with bzr-builddeb; if not, write to the Free Software
+#    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+#
+
+"""Quilt patch handling."""
+
+from __future__ import absolute_import
+
+import errno
+import os
+import signal
+import subprocess
+from bzrlib import (
+    errors,
+    trace,
+    )
+
+
+class QuiltError(errors.BzrError):
+
+    _fmt = "An error (%(retcode)d) occurred running quilt: %(msg)s"
+
+    def __init__(self, retcode, msg):
+        self.retcode = retcode
+        self.msg = msg
+
+
+def run_quilt(args, working_dir, series_file=None, patches_dir=None, quiet=None):
+    """Run quilt.
+
+    :param args: Arguments to quilt
+    :param working_dir: Working dir
+    :param series_file: Optional path to the series file
+    :param patches_dir: Optional path to the patches
+    :param quilt: Whether to be quiet (quilt stderr not to terminal)
+    :raise QuiltError: When running quilt fails
+    """
+    def subprocess_setup():
+        signal.signal(signal.SIGPIPE, signal.SIG_DFL)
+    env = {}
+    if patches_dir is not None:
+        env["QUILT_PATCHES"] = patches_dir
+    else:
+        env["QUILT_PATCHES"] = os.path.join(working_dir, "debian", "patches")
+    if series_file is not None:
+        env["QUILT_SERIES"] = series_file
+    else:
+        env["QUILT_SERIES"] = os.path.join(env["QUILT_PATCHES"], "series")
+    # Hide output if -q is in use.
+    if quiet is None:
+        quiet = trace.is_quiet()
+    if quiet:
+        stderr =  subprocess.STDOUT
+    else:
+        stderr = subprocess.PIPE
+    command = ["quilt"] + args
+    trace.mutter("running: %r", command)
+    if not os.path.isdir(working_dir):
+        raise AssertionError("%s is not a valid directory" % working_dir)
+    try:
+        proc = subprocess.Popen(command, cwd=working_dir, env=env,
+                stdin=subprocess.PIPE, preexec_fn=subprocess_setup,
+                stdout=subprocess.PIPE, stderr=stderr)
+    except OSError, e:
+        if e.errno != errno.ENOENT:
+            raise
+        raise errors.BzrError("quilt is not installed, please install it")
+    output = proc.communicate()
+    if proc.returncode not in (0, 2):
+        raise QuiltError(proc.returncode, output[1])
+    if output[0] is None:
+        return ""
+    return output[0]
+
+
+def quilt_pop_all(working_dir, patches_dir=None, series_file=None, quiet=None):
+    """Pop all patches.
+
+    :param working_dir: Directory to work in
+    :param patches_dir: Optional patches directory
+    :param series_file: Optional series file
+    """
+    return run_quilt(["pop", "-a", "-v"], 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):
+    """Push all patches.
+
+    :param working_dir: Directory to work in
+    :param patches_dir: Optional patches directory
+    :param series_file: Optional series file
+    """
+    return run_quilt(["push", "-a", "-v"], 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):
+    """Find the list of applied quilt patches.
+
+    :param working_dir: Directory to work in
+    :param patches_dir: Optional patches directory
+    :param series_file: Optional series file
+    """
+    try:
+        return run_quilt(["applied"], working_dir=working_dir, patches_dir=patches_dir, series_file=series_file).splitlines()
+    except QuiltError, e:
+        if e.retcode == 1:
+            return []
+        raise
+
+
+def quilt_unapplied(working_dir, patches_dir=None, series_file=None):
+    """Find the list of unapplied quilt patches.
+
+    :param working_dir: Directory to work in
+    :param patches_dir: Optional patches directory
+    :param series_file: Optional series file
+    """
+    try:
+        return run_quilt(["unapplied"], working_dir=working_dir,
+                patches_dir=patches_dir, series_file=series_file).splitlines()
+    except QuiltError, e:
+        if e.retcode == 1:
+            return []
+        raise
+
+
+def quilt_series(working_dir, patches_dir=None, series_file=None):
+    """Find the list of patches.
+
+    :param working_dir: Directory to work in
+    :param patches_dir: Optional patches directory
+    :param series_file: Optional series file
+    """
+    return run_quilt(["series"], working_dir=working_dir, patches_dir=patches_dir, series_file=series_file).splitlines()
+
 
=== modified file 'tests/__init__.py'
--- tests/__init__.py	2011-12-20 14:44:17 +0000
+++ tests/__init__.py	2012-01-02 22:04:32 +0000
@@ -37,11 +37,13 @@
 from bzrlib.tests import TestUtil, multiply_tests
 try:
     from bzrlib.tests.features import (
+        ExecutableFeature,
         ModuleAvailableFeature,
         UnicodeFilenameFeature,
         )
 except ImportError: # bzr < 2.5
     from bzrlib.tests import (
+        ExecutableFeature,
         ModuleAvailableFeature,
         UnicodeFilenameFeature,
         )
@@ -135,6 +137,7 @@
             'test_merge_package',
             'test_merge_quilt',
             'test_merge_upstream',
+            'test_quilt',
             'test_repack_tarball_extra',
             'test_revspec',
             'test_source_distiller',
 
=== added file 'tests/test_quilt.py'
--- tests/test_quilt.py	1970-01-01 00:00:00 +0000
+++ tests/test_quilt.py	2012-01-02 22:04:32 +0000
@@ -0,0 +1,87 @@
+#    Copyright (C) 2011 Canonical Ltd
+#
+#    This file is part of bzr-builddeb.
+#
+#    bzr-builddeb is free software; you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation; either version 2 of the License, or
+#    (at your option) any later version.
+#
+#    bzr-builddeb is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with bzr-builddeb; if not, write to the Free Software
+#    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+#
+
+"""Tests for the quilt code."""
+
+import os
+
+from bzrlib.plugins.builddeb.tests import ExecutableFeature
+from bzrlib.plugins.builddeb.quilt import (
+    quilt_pop_all,
+    quilt_applied,
+    quilt_unapplied,
+    quilt_push_all,
+    quilt_series,
+    )
+
+from bzrlib.tests import TestCaseWithTransport
+
+quilt_feature = ExecutableFeature('quilt')
+
+TRIVIAL_PATCH = """--- /dev/null	2012-01-02 01:09:10.986490031 +0100
++++ a	2012-01-02 20:03:59.710666215 +0100
+@@ -0,0 +1 @@
++a
+"""
+
+class QuiltTests(TestCaseWithTransport):
+
+    _test_needs_features = [quilt_feature]
+
+    def make_empty_quilt_dir(self, path):
+        source = self.make_branch_and_tree(path)
+        self.build_tree([os.path.join(path, n) for n in ['debian/',
+            'debian/patches/']])
+        self.build_tree_contents([
+            (os.path.join(path, "debian/patches/series"), "\n")])
+        source.add(["debian", "debian/patches", "debian/patches/series"])
+        return source
+
+    def test_series_all_empty(self):
+        self.make_empty_quilt_dir("source")
+        self.assertEquals([], quilt_series("source"))
+
+    def test_series_all(self):
+        self.make_empty_quilt_dir("source")
+        self.build_tree_contents([
+            ("source/debian/patches/series", "patch1.diff\n"),
+            ("source/debian/patches/patch1.diff", TRIVIAL_PATCH)])
+        self.assertEquals(["patch1.diff"], quilt_series("source"))
+
+    def test_push_all_empty(self):
+        self.make_empty_quilt_dir("source")
+        quilt_push_all("source", quiet=True)
+
+    def test_poph_all_empty(self):
+        self.make_empty_quilt_dir("source")
+        quilt_pop_all("source", quiet=True)
+
+    def test_applied_empty(self):
+        self.make_empty_quilt_dir("source")
+        self.build_tree_contents([
+            ("source/debian/patches/series", "patch1.diff\n"),
+            ("source/debian/patches/patch1.diff", "foob ar")])
+        self.assertEquals([], quilt_applied("source"))
+
+    def test_unapplied(self):
+        self.make_empty_quilt_dir("source")
+        self.build_tree_contents([
+            ("source/debian/patches/series", "patch1.diff\n"),
+            ("source/debian/patches/patch1.diff", "foob ar")])
+        self.assertEquals(["patch1.diff"], quilt_unapplied("source"))
 
=== modified file 'tests/test_util.py'
--- tests/test_util.py	2011-09-09 13:20:42 +0000
+++ tests/test_util.py	2012-01-02 22:04:32 +0000
@@ -63,7 +63,6 @@
     _find_previous_upload,
     find_thanks,
     get_commit_info_from_changelog,
-    get_source_format,
     guess_build_type,
     lookup_distribution,
     move_file_if_different,
@@ -74,6 +73,7 @@
     suite_to_distribution,
     tarball_name,
     tree_contains_upstream_source,
+    tree_get_source_format,
     write_if_different,
     )
 
@@ -773,27 +773,27 @@
 
     def test_no_source_format_file(self):
         tree = self.make_branch_and_tree('.')
-        self.assertEquals("1.0", get_source_format(tree))
+        self.assertEquals("1.0", tree_get_source_format(tree))
 
     def test_source_format_newline(self):
         tree = self.make_branch_and_tree('.')
         self.build_tree_contents([("debian/", ), ("debian/source/",),
             ("debian/source/format", "3.0 (native)\n")])
         tree.add(["debian", "debian/source", "debian/source/format"])
-        self.assertEquals("3.0 (native)", get_source_format(tree))
+        self.assertEquals("3.0 (native)", tree_get_source_format(tree))
 
     def test_source_format(self):
         tree = self.make_branch_and_tree('.')
         self.build_tree_contents([("debian/",), ("debian/source/",),
             ("debian/source/format", "3.0 (quilt)")])
         tree.add(["debian", "debian/source", "debian/source/format"])
-        self.assertEquals("3.0 (quilt)", get_source_format(tree))
+        self.assertEquals("3.0 (quilt)", tree_get_source_format(tree))
 
     def test_source_format_file_unversioned(self):
         tree = self.make_branch_and_tree('.')
         self.build_tree_contents([("debian/",), ("debian/source/",),
             ("debian/source/format", "3.0 (quilt)")])
-        self.assertEquals("3.0 (quilt)", get_source_format(tree))
+        self.assertEquals("3.0 (quilt)", tree_get_source_format(tree))
 
 
 class GuessBuildTypeTests(TestCaseWithTransport):
 
=== modified file 'util.py'
--- util.py	2011-10-28 16:32:42 +0000
+++ util.py	2012-01-02 22:04:32 +0000
@@ -648,16 +648,17 @@
     return (len(present_files - packaging_files) > 0)
 
 
-def get_source_format(tree):
+def tree_get_source_format(tree):
     """Retrieve the source format name from a package.
 
     :param path: Path to the package
     :return: String with package format
     """
     filename = "debian/source/format"
-    if not tree.has_filename(filename):
+    file_id = tree.path2id(filename)
+    if file_id is None:
         return FORMAT_1_0
-    text = tree.get_file_text(tree.path2id(filename), filename)
+    text = tree.get_file_text(file_id, filename)
     return text.strip()
 
 
@@ -677,7 +678,7 @@
     :param contains_upstream_source: Whether this branch contains the upstream source.
     :return: A build_type value.
     """
-    source_format = get_source_format(tree)
+    source_format = tree_get_source_format(tree)
     if source_format in NATIVE_SOURCE_FORMATS:
         format_native = True
     elif source_format in NORMAL_SOURCE_FORMATS: