Merge lp:~jelmer/bzr-builddeb/auto-native into lp:bzr-builddeb

[Jelmer Vernooij]

Recognize that a branch is native or normal based on debian/source/format.

[Jelmer Vernooij (jelmer)]

This branch makes bzr-builddeb recognize that a package is native or not by looking at the debian/source/format file.

It will also report inconsistencies between debian/source/format and the version in the changelog file, if both are present.

[Jelmer Vernooij (jelmer)]

Related to this I wonder if we can drop the --native and --merge flags, they no longer seem necessary now.

[James Westby (james-w)]

On Tue, 11 Jan 2011 00:36:09 -0000, Jelmer Vernooij <email address hidden> wrote:
> Related to this I wonder if we can drop the --native and --merge flags, they no longer seem necessary now.

For --native there will still be a bunch of 1.0 native packages that
this won't get.

Having said that, I would like to get rid of them anyway, as there are
some people that don't create the configuration files, and only use the
flags, meaning that other people find problems when they try and build
the packages.

I think that we should probably have a deprecation period though.

Thanks,

James

[James Westby (james-w)]

Looks good.

Thanks,

James

review: Approve

[Jelmer Vernooij (jelmer)]

Hi,

Thanks for the review :-)

On Thu, 2011-01-13 at 17:58 +0000, James Westby wrote:
> On Tue, 11 Jan 2011 00:36:09 -0000, Jelmer Vernooij <email address hidden> wrote:
> > Related to this I wonder if we can drop the --native and --merge flags, they no longer seem necessary now.
> For --native there will still be a bunch of 1.0 native packages that
> this won't get.
The version is also used as an indication of whether the package is
native or not, and should work for 1.0 packages too.

> Having said that, I would like to get rid of them anyway, as there are
> some people that don't create the configuration files, and only use the
> flags, meaning that other people find problems when they try and build
> the packages.
>
> I think that we should probably have a deprecation period though.
Yeah, that makes sense.

Cheers,

Jelmer

=== modified file 'cmds.py'
--- cmds.py	2011-01-11 00:29:56 +0000
+++ cmds.py	2011-01-11 00:29:56 +0000
@@ -104,6 +104,7 @@
         find_last_distribution,
         find_previous_upload,
         get_export_upstream_revision,
+        guess_build_type,
         lookup_distribution,
         open_file,
         open_file_via_transport,
@@ -135,7 +136,6 @@
     help="Select the upstream revision that will be exported.",
     type=str)
 
-
 class cmd_builddeb(Command):
     """Builds a Debian package from a branch.
 
@@ -359,14 +359,8 @@
             except NoPreviousUpload:
                 prev_version = None
             if build_type is None:
-                if prev_version and not prev_version.debian_revision:
-                    # If the package doesn't have a debian revision, assume it's native.
-                    build_type = BUILD_TYPE_NATIVE
-                elif not contains_upstream_source:
-                    # Default to merge mode if there's only a debian/ directory
-                    build_type = BUILD_TYPE_MERGE
-                else:
-                    build_type = BUILD_TYPE_NORMAL
+                build_type = guess_build_type(tree, changelog.version,
+                    contains_upstream_source)
 
             note("Building package in %s mode" % {
                 BUILD_TYPE_NATIVE: "native",
 
=== modified file 'debian/changelog'
--- debian/changelog	2010-09-10 02:53:47 +0000
+++ debian/changelog	2011-01-11 00:29:56 +0000
@@ -22,8 +22,10 @@
     if we can't find the tarball.
   * Determine Bazaar home directory using bzrlib to prevent test
     isolation issues. LP: #614125
+  * Automatically use debian/source/format if package is native. Closes:
+    #586617
 
- -- James Westby <[e-mail]>  Wed, 18 Aug 2010 20:12:20 -0400
+ -- Jelmer Vernooij <[e-mail]>  Tue, 11 Jan 2011 00:42:21 +0100
 
 bzr-builddeb (2.5) unstable; urgency=low
 
 
=== modified file 'errors.py'
--- errors.py	2010-06-15 11:33:11 +0000
+++ errors.py	2011-01-11 00:29:56 +0000
@@ -203,3 +203,20 @@
 class UnableToFindPreviousUpload(BzrError):
 
     _fmt = ("Unable to determine the previous upload for --package-merge.")
+
+
+class InconsistentSourceFormatError(BzrError):
+
+    _fmt = ("Inconsistency between source format and version: version is "
+            "%(version_bool)snative, format is %(format_bool)snative.")
+
+    def __init__(self, version_native, format_native):
+        if version_native:
+            version_bool = ""
+        else:
+            version_bool = "not "
+        if format_native:
+            format_bool = ""
+        else:
+            format_bool = "not "
+        BzrError.__init__(self, version_bool=version_bool, format_bool=format_bool)
 
=== modified file 'tests/test_util.py'
--- tests/test_util.py	2010-07-29 18:41:30 +0000
+++ tests/test_util.py	2011-01-11 00:29:56 +0000
@@ -31,9 +31,15 @@
     # Prior to 0.1.15 the debian module was called debian_bundle
     from debian_bundle.changelog import Changelog, Version
 
-from bzrlib.plugins.builddeb.config import DebBuildConfig
+from bzrlib.plugins.builddeb.config import (
+    DebBuildConfig,
+    BUILD_TYPE_MERGE,
+    BUILD_TYPE_NATIVE,
+    BUILD_TYPE_NORMAL,
+    )
 from bzrlib.plugins.builddeb.errors import (MissingChangelogError,
                 AddChangelogError,
+                InconsistentSourceFormatError,
                 NoPreviousUpload,
                 UnknownDistribution,
                 )
@@ -50,6 +56,8 @@
                   get_export_upstream_revision,
                   get_commit_info_from_changelog,
                   get_snapshot_revision,
+                  get_source_format,
+                  guess_build_type,
                   lookup_distribution,
                   move_file_if_different,
                   get_parent_dir,
@@ -772,3 +780,85 @@
         self.assertRaises(NoPreviousUpload, _find_previous_upload, cl)
         cl = self.make_changelog([("0.1-1", "unstable")])
         self.assertRaises(NoPreviousUpload, _find_previous_upload, cl)
+
+
+class SourceFormatTests(TestCaseWithTransport):
+
+    def test_no_source_format_file(self):
+        tree = self.make_branch_and_tree('.')
+        self.assertEquals("1.0", 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))
+
+    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))
+
+
+class GuessBuildTypeTests(TestCaseWithTransport):
+    """Tests for guess_build_type."""
+
+    def writeVersionFile(self, tree, format_string):
+        """Write a Debian source format file.
+
+        :param tree: Tree to write to.
+        :param format_string: Format string to write.
+        """
+        self.build_tree_contents([("debian/",), ("debian/source/",),
+            ("debian/source/format", format_string)])
+        tree.add(["debian", "debian/source", "debian/source/format"])
+
+    def test_normal_source_format(self):
+        # Normal source format -> NORMAL
+        tree = self.make_branch_and_tree('.')
+        self.writeVersionFile(tree, "3.0 (quilt)")
+        self.assertEquals(BUILD_TYPE_NORMAL, guess_build_type(tree, None, True))
+
+    def test_normal_source_format_merge(self):
+        # Normal source format without upstream source -> MERGE
+        tree = self.make_branch_and_tree('.')
+        self.writeVersionFile(tree, "3.0 (quilt)")
+        self.assertEquals(BUILD_TYPE_MERGE, guess_build_type(tree, None, False))
+
+    def test_native_source_format(self):
+        # Native source format -> NATIVE
+        tree = self.make_branch_and_tree('.')
+        self.writeVersionFile(tree, "3.0 (native)")
+        self.assertEquals(BUILD_TYPE_NATIVE, guess_build_type(tree, None, True))
+
+    def test_prev_version_native(self):
+        # Native package version -> NATIVE
+        tree = self.make_branch_and_tree('.')
+        self.assertEquals(BUILD_TYPE_NATIVE,
+            guess_build_type(tree, Version("1.0"), True))
+
+    def test_no_upstream_source(self):
+        # No upstream source code and a non-native package -> MERGE
+        tree = self.make_branch_and_tree('.')
+        self.assertEquals(BUILD_TYPE_MERGE,
+            guess_build_type(tree, Version("1.0-1"), False))
+
+    def test_default(self):
+        # Upstream source code and a non-native package -> NORMAL
+        tree = self.make_branch_and_tree('.')
+        self.assertEquals(BUILD_TYPE_NORMAL,
+            guess_build_type(tree, Version("1.0-1"), True))
+
+    def test_inconsistent(self):
+        # If version string and source format disagree on whether the package is native,
+        # raise an exception.
+        tree = self.make_branch_and_tree('.')
+        self.writeVersionFile(tree, "3.0 (native)")
+        e = self.assertRaises(InconsistentSourceFormatError, guess_build_type, tree,
+            Version("1.0-1"), True)
+        self.assertEquals(
+            "Inconsistency between source format and version: version is not native, "
+            "format is native.", str(e))
 
=== modified file 'util.py'
--- util.py	2011-01-11 00:29:56 +0000
+++ util.py	2011-01-11 00:29:56 +0000
@@ -55,10 +55,16 @@
     local_conf,
     global_conf,
     )
-from bzrlib.plugins.builddeb.config import DebBuildConfig
+from bzrlib.plugins.builddeb.config import (
+    DebBuildConfig,
+    BUILD_TYPE_MERGE,
+    BUILD_TYPE_NATIVE,
+    BUILD_TYPE_NORMAL,
+    )
 from bzrlib.plugins.builddeb.errors import (
                 MissingChangelogError,
                 AddChangelogError,
+                InconsistentSourceFormatError,
                 NoPreviousUpload,
                 UnableToFindPreviousUpload,
                 UnknownDistribution,
@@ -612,3 +618,53 @@
     present_files = set(root.children.keys())
     packaging_files = frozenset(["debian", ".bzr-builddeb"])
     return (len(present_files - packaging_files) > 0)
+
+
+def get_source_format(tree):
+    """Retrieve the source format name from a package.
+
+    :param path: Path to the package
+    :return: String with package format
+    """
+    if not tree.has_filename("debian/source/format"):
+        return "1.0"
+    return tree.get_file_text(tree.path2id("debian/source/format")).strip()
+
+
+NATIVE_SOURCE_FORMATS = ["3.0 (native)"]
+NORMAL_SOURCE_FORMATS = ["3.0 (quilt)"]
+
+
+def guess_build_type(tree, version, contains_upstream_source):
+    """Guess the build type based on the contents of a tree.
+
+    :param tree: A `Tree` object.
+    :param version: `Version` of the upload.
+    :param contains_upstream_source: Whether this branch contains the upstream source.
+    :return: A build_type value.
+    """
+    source_format = get_source_format(tree)
+    if source_format in NATIVE_SOURCE_FORMATS:
+        format_native = True
+    elif source_format in NORMAL_SOURCE_FORMATS:
+        format_native = False
+    else:
+        format_native = None
+
+    # If the package doesn't have a debian revision then it must be native.
+    if version is not None:
+        version_native = (not version.debian_revision)
+    else:
+        version_native = None
+
+    if type(version_native) is bool and type(format_native) is bool:
+        if version_native != format_native:
+            raise InconsistentSourceFormatError(version_native, format_native)
+
+    if version_native or format_native:
+        return BUILD_TYPE_NATIVE
+    if not contains_upstream_source:
+        # Default to merge mode if there's only a debian/ directory
+        return BUILD_TYPE_MERGE
+    else:
+        return BUILD_TYPE_NORMAL