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

[Jelmer Vernooij]

Add utility methods for using quilt.

[James Westby (james-w)]

87 + :param quilt: Whether to be quiet (quilt stderr not to terminal)

muscle memory I think :-)

I think there's no tests for tree_unapply_patches?

However, it looks good to me.

Thanks,

James

review: Approve

[Jelmer Vernooij (jelmer)]

> I think there's no tests for tree_unapply_patches?
I've added two while landing this.

Thanks, as always, for the quick reviews!

=== modified file 'merge_quilt.py'
--- merge_quilt.py	2011-12-20 14:44:17 +0000
+++ merge_quilt.py	2012-01-02 19:24:23 +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 19:24:23 +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 19:24:23 +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 19:24:23 +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"))