Merge lp:~jelmer/bzr-builder/force-native into lp:bzr-builder

[Jelmer Vernooij]

Add a --force-native option to "bzr dailydeb".

This option will apply all quilt patches and update the debian/source/format directory if the package is currently in the "3.0 (quilt)" format.

[James Westby (james-w)]

Hi,

Thanks for doing this, it is fairly unobtrusive and solves a common problem,
so I'm happy to have it.

70 + f.write("3.0 (native)")

Should that have a newline?

75 +def force_native_format(working_tree_path):

Should this die if it doesn't recognise the format marker?

93 + Option("force-native",
94 + help="Force the source package format to be native."),

Should this be an option? I can't really think of a reason why people
wouldn't want this. Is it just being conservative? Maybe have the option,
but invert the default?

Thanks,

James

[Jelmer Vernooij (jelmer)]

On Tue, 2010-12-07 at 16:56 +0000, James Westby wrote:
> Thanks for doing this, it is fairly unobtrusive and solves a common problem,
> so I'm happy to have it.
>
> 70 + f.write("3.0 (native)")
> Should that have a newline?
Hmm, that's a good point. Both with and without seems to be allowed, but
with is more common. Fixed.

> 75 +def force_native_format(working_tree_path):
> Should this die if it doesn't recognise the format marker?
Yeah, better safe than sorry (and we don't support "2.0" at this point).

> 93 + Option("force-native",
> 94 + help="Force the source package format to be native."),

> Should this be an option? I can't really think of a reason why people
> wouldn't want this. Is it just being conservative? Maybe have the option,
> but invert the default?
Yeah, I was mainly being conservative. But you're right, without this
option things wouldn't really work anyway. I've killed it.

Cheers,

Jelmer

[lp:~jelmer/bzr-builder/force-native]

114. By Jelmer Vernooij on 2010-12-07

include newline in debian/source/format.

115. By Jelmer Vernooij on 2010-12-07

Kill --force-native option, error out on unknown source formats.

[James Westby (james-w)]

Looks good.

Thanks,

James

review: Approve

=== modified file 'cmds.py'
--- cmds.py	2010-08-25 19:27:04 +0000
+++ cmds.py	2010-12-07 17:56:23 +0000
@@ -251,7 +251,7 @@
 
 
 def _run_command(command, basedir, msg, error_msg,
-        not_installed_msg=None):
+        not_installed_msg=None, env=None):
     """ Run a command in a subprocess.
 
     :param command: list with command and parameters
@@ -259,6 +259,7 @@
     :param error_msg: message to display if something fails.
     :param not_installed_msg: the message to display if the command
         isn't available.
+    :param env: Optional environment to use rather than os.environ.
     """
     trace.note(msg)
     # Hide output if -q is in use.
@@ -267,6 +268,8 @@
         kwargs = {"stderr": subprocess.STDOUT, "stdout": subprocess.PIPE}
     else:
         kwargs = {}
+    if env is not None:
+        kwargs["env"] = env
     try:
         proc = subprocess.Popen(command, cwd=basedir,
                 stdin=subprocess.PIPE, **kwargs)
@@ -293,6 +296,59 @@
         not_installed_msg="debuild is not installed, please install "
             "the devscripts package.")
 
+def get_source_format(path):
+    """Retrieve the source format name from a package.
+
+    :param path: Path to the package
+    :return: String with package format
+    """
+    source_format_path = os.path.join(path, "debian", "source", "format")
+    if not os.path.exists(source_format_path):
+        return "1.0"
+    f = open(source_format_path, 'r')
+    try:
+        return f.read().strip()
+    finally:
+        f.close()
+
+
+def convert_3_0_quilt_to_native(path):
+    """Convert a package in 3.0 (quilt) format to 3.0 (native).
+
+    This applies all patches in the package and updates the 
+    debian/source/format file.
+
+    :param path: Path to the package on disk
+    """
+    path = os.path.abspath(path)
+    patches_dir = os.path.join(path, "debian", "patches")
+    series_file = os.path.join(patches_dir, "series")
+    if os.path.exists(series_file):
+        _run_command(["quilt", "push", "-a", "-v"], path,
+            "Applying quilt patches",
+            "Failed to apply quilt patches",
+            not_installed_msg="quilt is not installed, please install it.",
+            env={"QUILT_SERIES": series_file, "QUILT_PATCHES": patches_dir})
+        shutil.rmtree(os.path.join(path, "debian/patches"))
+    f = open(os.path.join(path, "debian", "source", "format"), 'w')
+    try:
+        f.write("3.0 (native)\n")
+    finally:
+        f.close()
+
+
+def force_native_format(working_tree_path):
+    """Make sure a package is a format that supports native packages.
+
+    :param working_tree_path: Path to the package
+    """
+    current_format = get_source_format(working_tree_path)
+    if current_format == "3.0 (quilt)":
+        convert_3_0_quilt_to_native(working_tree_path)
+    elif current_format not in ("1.0", "3.0 (native)"):
+        raise errors.BzrCommandError("Unknown source format %s" %
+                                     current_format)
+
 
 def sign_source_package(basedir, key_id):
     command = ["/usr/bin/debsign", "-S", "-k%s" % key_id]
@@ -402,7 +458,7 @@
                         "specified string to the end of the version used "
                         "in debian/changelog."),
                 Option("safe", help="Error if the recipe would cause"
-                       " arbitrary code execution.")
+                       " arbitrary code execution."),
             ]
 
     takes_args = ["recipe_file", "working_basedir?"]
@@ -451,6 +507,7 @@
             add_changelog_entry(base_branch, working_directory,
                 distribution=distribution, package=package,
                 append_version=append_version)
+            force_native_format(working_directory)
             package_dir = calculate_package_dir(base_branch,
                     package_name, working_basedir)
             # working_directory -> package_dir: after this debian stuff works.

=== modified file 'tests/test_blackbox.py'
--- tests/test_blackbox.py	2010-08-25 19:27:04 +0000
+++ tests/test_blackbox.py	2010-12-07 17:56:23 +0000
@@ -14,6 +14,7 @@
 # with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 import os
+from textwrap import dedent
 
 from bzrlib import workingtree
 from bzrlib.tests import (
@@ -284,3 +285,89 @@
             retcode=3)
         self.assertContainsRe(err, "The 'run' instruction is forbidden.$")
 
+    def make_simple_quilt_package(self):
+        source = self.make_simple_package()
+        self.build_tree(["source/debian/source/"])
+        self.build_tree_contents([
+            ("source/debian/source/format", "3.0 (quilt)\n")])
+        source.add(["debian/source", "debian/source/format"])
+        source.commit("set source format")
+        return source
+
+    def test_cmd_dailydeb_force_native(self):
+        self.make_simple_quilt_package()
+        self.build_tree_contents([("test.recipe", "# bzr-builder format 0.3 "
+                    "deb-version 1\nsource 2\n")])
+        out, err = self.run_bzr(
+            "dailydeb -q test.recipe working", retcode=0)
+        self.assertFileEqual("3.0 (native)\n",
+            "working/test-1/debian/source/format")
+
+    def test_cmd_dailydeb_force_native_apply_quilt(self):
+        source = self.make_simple_quilt_package()
+        self.build_tree(["source/debian/patches/"])
+        patch = dedent(
+        """diff -ur a/thefile b/thefile
+           --- a/thefile	2010-12-05 20:14:22.000000000 +0100
+           +++ b/thefile	2010-12-05 20:14:26.000000000 +0100
+           @@ -1 +1 @@
+           -old-contents
+           +new-contents
+           """)
+        self.build_tree_contents([
+            ("source/thefile", "old-contents\n"),
+            ("source/debian/patches/series", "01_foo.patch"),
+            ("source/debian/patches/01_foo.patch", patch)])
+        source.add(["thefile", "debian/patches", "debian/patches/series",
+                    "debian/patches/01_foo.patch"])
+        source.commit("add patch")
+
+        self.build_tree_contents([("test.recipe", "# bzr-builder format 0.3 "
+                    "deb-version 1\nsource\n")])
+        out, err = self.run_bzr(
+            "dailydeb -q test.recipe working", retcode=0)
+        self.assertFileEqual("3.0 (native)\n",
+            "working/test-1/debian/source/format")
+        self.assertFileEqual("new-contents\n",
+            "working/test-1/thefile")
+        self.failIfExists("working/test-1/debian/patches")
+
+    def test_cmd_dailydeb_force_native_apply_quilt_failure(self):
+        source = self.make_simple_quilt_package()
+        self.build_tree(["source/debian/patches/"])
+        patch = dedent(
+        """diff -ur a/thefile b/thefile
+           --- a/thefile	2010-12-05 20:14:22.000000000 +0100
+           +++ b/thefile	2010-12-05 20:14:26.000000000 +0100
+           @@ -1 +1 @@
+           -old-contents
+           +new-contents
+           """)
+        self.build_tree_contents([
+            ("source/thefile", "contents\n"),
+            ("source/debian/patches/series", "01_foo.patch"),
+            ("source/debian/patches/01_foo.patch", patch)])
+        source.add(["thefile", "debian/patches", "debian/patches/series",
+                    "debian/patches/01_foo.patch"])
+        source.commit("add patch")
+
+        self.build_tree_contents([("test.recipe", "# bzr-builder format 0.3 "
+                    "deb-version 1\nsource\n")])
+        out, err = self.run_bzr(
+            "dailydeb -q test.recipe working", retcode=3)
+        self.assertContainsRe(err, "bzr: ERROR: Failed to apply quilt patches")
+
+    def test_unknown_source_format(self):
+        source = self.make_simple_package()
+        self.build_tree(["source/debian/source/"])
+        self.build_tree_contents([
+            ("source/debian/source/format", "2.0\n")])
+        source.add(["debian/source", "debian/source/format"])
+        source.commit("set source format")
+
+        self.build_tree_contents([("test.recipe", "# bzr-builder format 0.3 "
+                    "deb-version 1\nsource\n")])
+        out, err = self.run_bzr(
+            "dailydeb -q test.recipe working", retcode=3)
+        self.assertEquals(err, "bzr: ERROR: Unknown source format 2.0\n")
+