Merge lp:~jr/bzr-builddeb/862188-get-tar into lp:bzr-builddeb

[Jonathan Riddell]

Add get-tar command, helps workflow for those of us who like to build packages on their native system (not pbuilder etc)

https://bugs.launchpad.net/bzr-builddeb/+bug/862188

[Jelmer Vernooij (jelmer)]

Thanks for adding this.

give_instruction doesn't appear to be used.

This should have tests, as well as an entry in debian/changelog.

UpstreamProvider.provide() can raise exceptions - in particular, it could raise an exception if the current version is not available, in which case a sane error message should be printed rather than a backtrace.

It would be nice if it could print where exactly it has generated a file.

The call to generate build_source_dir seems pointless as get_parent_dir will return the dirname.

review: Needs Fixing

[lp:~jr/bzr-builddeb/862188-get-tar]

615. By Jonathan Riddell on 2011-09-30

remove pointless variables

616. By Jonathan Riddell on 2011-09-30

add changelog

617. By Jonathan Riddell on 2011-09-30

print location of tar

618. By Jonathan Riddell on 2011-09-30

use orig_dir rather than build_dir to get tar

619. By Jonathan Riddell on 2011-09-30

add blackbox tests for get-tar

[Jonathan Riddell (jr)]

all done

[Jelmer Vernooij (jelmer)]

Thanks! Some more minor comments:

Please use four-space indentation in new files - I realize some of the existing bzr-builddeb tests still use two-space indentation, but we should slowly get rid of that rather than add more files with two-space indentation.

When would provide() return an empty list? Also, I think the other entries in the list should also be displayed, not just the first one.

get-tar seems fairly generic for something that is a bzr subcommand - it could mean a lot of things, e.g. be confused with "bzr export foo.tar.gz". What about something like get-orig-source, deb-orig-source ?

 + "get_tar": ["bd"],

This register "bd" as an alias for get_tar, but it is also already registered for "bzr builddeb".

[Jelmer Vernooij (jelmer)]

review: Needs Fixing

[Jonathan Riddell (jr)]

all done

[lp:~jr/bzr-builddeb/862188-get-tar]

620. By Jonathan Riddell on 2011-10-03

reindent to 4 spaces

621. By Jonathan Riddell on 2011-10-03

merge in trunk

622. By Jonathan Riddell on 2011-10-03

print result for all tars

623. By Jonathan Riddell on 2011-10-03

don't alias bd for get-tar

624. By Jonathan Riddell on 2011-10-03

rename to get-orig-source

[Jelmer Vernooij (jelmer)]

review: Approve

[Jelmer Vernooij (jelmer)]

2.7.9 has been uploaded so the changelog entry should be in 2.7.10.

=== modified file '__init__.py'
--- __init__.py	2011-10-01 00:18:46 +0000
+++ __init__.py	2011-10-03 10:55:35 +0000
@@ -37,6 +37,7 @@
 commands = {
         "bd_do": [],
         "builddeb": ["bd"],
+        "get_orig_source": [],
         "dep3_patch": [],
         "dh_make": ["dh_make"],
         "import_dsc": [],
 
=== modified file 'cmds.py'
--- cmds.py	2011-09-29 10:11:07 +0000
+++ cmds.py	2011-10-03 10:55:35 +0000
@@ -73,6 +73,9 @@
     PackageVersionNotPresent,
     StrictBuildFailed,
     )
+from bzrlib.plugins.builddeb.util import (
+    get_parent_dir,
+    )
 from bzrlib.plugins.builddeb.hooks import run_hook
 from bzrlib.plugins.builddeb.import_dsc import (
         DistributionBranch,
@@ -463,6 +466,30 @@
             tree.unlock()
 
 
+class cmd_get_orig_source(Command):
+    """Gets the upstream tar file for the packaging branch."""
+
+    def run(self):
+        tree = WorkingTree.open_containing('.')[0]
+        config = debuild_config(tree, tree)
+
+        (changelog, larstiq) = find_changelog(tree, True)
+        orig_dir = config.orig_dir
+        if orig_dir is None:
+            orig_dir = default_orig_dir
+
+        upstream_provider = UpstreamProvider(changelog.package,
+                changelog.version.upstream_version, orig_dir,
+                [PristineTarSource(tree, tree.branch),
+                 AptSource(),
+                 GetOrigSourceSource(tree, larstiq),
+                 UScanSource(tree, larstiq) ])
+
+        result = upstream_provider.provide(orig_dir)
+        for tar, component in result:
+            note("Tar now in " + tar)
+
+
 class cmd_merge_upstream(Command):
     """Merges a new upstream version into the current branch.
 
 
=== modified file 'debian/changelog'
--- debian/changelog	2011-10-01 20:41:14 +0000
+++ debian/changelog	2011-10-03 10:55:35 +0000
@@ -3,6 +3,10 @@
   [ Jelmer Vernooij ]
   * Support .tar.xz Debian files rather than .tar.lzma.
 
+  [ Jonathan Riddell ]
+  * Add get-tar command which will get the upstream tar file.
+    LP: #862188
+
   [ Martin Packman ]
   * Support non-ascii characters in changelog entry when determining
     commit message. LP: #853664
 
=== modified file 'tests/blackbox/__init__.py'
--- tests/blackbox/__init__.py	2011-05-08 10:40:32 +0000
+++ tests/blackbox/__init__.py	2011-10-03 10:55:35 +0000
@@ -24,6 +24,7 @@
           'test_builddeb',
           'test_dep3',
           'test_do',
+          'test_get_tar',
           'test_import_dsc',
           'test_import_upstream',
           'test_mark_uploaded',
 
=== added file 'tests/blackbox/test_get_tar.py'
--- tests/blackbox/test_get_tar.py	1970-01-01 00:00:00 +0000
+++ tests/blackbox/test_get_tar.py	2011-10-03 10:55:35 +0000
@@ -0,0 +1,106 @@
+#    test_get_tar.py -- Blackbox tests for get-orig-source.
+#    Copyright 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
+#
+
+import os
+import tarfile
+
+try:
+    from debian.changelog import (Changelog,
+                                  Version,
+                                  )
+except ImportError:
+    # Prior to 0.1.15 the debian module was called debian_bundle
+    from debian_bundle.changelog import (Changelog,
+                                         Version,
+                                        )
+
+
+from bzrlib.plugins.builddeb.tests import BuilddebTestCase
+
+
+class TestGetOrigSource(BuilddebTestCase):
+
+    def make_changelog(self, version=None):
+        if version is None:
+            version = self.package_version
+        c = Changelog()
+        c.new_block()
+        c.version = Version(version)
+        c.package = self.package_name
+        c.distributions = 'unstable'
+        c.urgency = 'low'
+        c.author = 'James Westby <[e-mail]>'
+        c.date = 'The,  3 Aug 2006 19:16:22 +0100'
+        c.add_change('')
+        c.add_change('  *  test build')
+        c.add_change('')
+        return c
+
+    def make_unpacked_source(self):
+        """
+        Create an unpacked source tree in a branch. Return the working
+        tree
+        """
+        tree = self.make_branch_and_tree('.')
+        cl_file = 'debian/changelog'
+        source_files = ['README', 'debian/'] + [cl_file]
+        self.build_tree(source_files)
+        c = self.make_changelog()
+        self.write_changelog(c, cl_file)
+        tree.add(source_files)
+        return tree
+
+    def make_source_with_upstream(self):
+        """Create a source tree in a branch with an upstream tag."""
+        tree = self.make_branch_and_tree('.')
+        source_files = ['README']
+        self.build_tree(source_files)
+        tree.add(source_files)
+        tree.commit("one", rev_id='revid1')
+        tree.branch.tags.set_tag("upstream-0.1", tree.branch.last_revision())
+
+        cl_file = 'debian/changelog'
+        source_files = ['debian/'] + [cl_file]
+        self.build_tree(source_files)
+        c = self.make_changelog()
+        self.write_changelog(c, cl_file)
+        tree.add(source_files)
+        tree.commit("two", rev_id='revid2')
+        return tree
+
+    def test_get_orig_source_registered(self):
+        self.run_bzr("get-orig-source --help")
+
+    def test_get_orig_source_error_no_changelog(self):
+        self.run_bzr_error(
+        ['Could not find changelog at "debian/changelog" or "changelog".'],
+        "get-orig-source")
+
+    def test_get_orig_source_error_no_tar(self):
+        self.make_unpacked_source()
+        self.run_bzr_error(
+            ['Unable to find the needed upstream tarball for package test, '\
+            'version 0.1.'],
+            "get-orig-source")
+
+    def test_get_orig_source(self):
+        tree = self.make_source_with_upstream()
+        self.run_bzr(['get-orig-source'])
+        self.assertPathExists('../test_0.1.orig.tar.gz')