Merge lp:~maxb/bzr-builddeb/better-error-multiple-upstream-tarballs into lp:bzr-builddeb

[Max Bowsher]

When attempting to import a package with multiple upstream tarballs, raise
MultipleUpstreamTarballsNotSupported rather than AssertionError.

The primary motivation is so that the UDD failures categorization will automatically split this case from other kinds of unpack failure.

[Jelmer Vernooij (jelmer)]

On Thu, 2011-06-09 at 21:46 +0000, Max Bowsher wrote:
> Max Bowsher has proposed merging lp:~maxb/bzr-builddeb/better-error-multiple-upstream-tarballs into lp:bzr-builddeb.
>
> Requested reviews:
> Bzr-builddeb-hackers (bzr-builddeb-hackers)
>
> For more details, see:
> https://code.launchpad.net/~maxb/bzr-builddeb/better-error-multiple-upstream-tarballs/+merge/64090
>
> When attempting to import a package with multiple upstream tarballs, raise
> MultipleUpstreamTarballsNotSupported rather than AssertionError.
>
> The primary motivation is so that the UDD failures categorization will automatically split this case from other kinds of unpack failure.
It would be nice to have a test that verifies that the exception is
raised when there are multiple upstream tarballs.

Other than that, looks good:

  review needsfixing
  merge approve

Cheers,

Jelmer

review: Needs Fixing

[lp:~maxb/bzr-builddeb/better-error-multiple-upstream-tarballs]

567. By Max Bowsher on 2011-06-10

Add test.

[Max Bowsher (maxb)]

Alright, I guess the work writing the test will pay off once we actually implement support.

How's this?

[Jelmer Vernooij (jelmer)]

Thanks :)

That last bit seems shorter as:

self.addCleanup(extractor.cleanup)
self.assertRaises(MultipleUpstreamTarballsNotSupported, extractor.extract)

rather than:

+ try:
124 + try:
125 + extractor.extract()
126 + self.fail("Expected exception not thrown")
127 + except MultipleUpstreamTarballsNotSupported:
128 + pass # Expected
129 + finally:
130 + extractor.cleanup()

review: Approve

[lp:~maxb/bzr-builddeb/better-error-multiple-upstream-tarballs]

568. By Max Bowsher on 2011-06-10

Write test in a shorter style using suggestion from Jelmer.

=== modified file 'errors.py'
--- errors.py	2011-06-03 12:17:42 +0000
+++ errors.py	2011-06-10 11:49:31 +0000
@@ -224,3 +224,9 @@
 
     def __init__(self, error):
         BzrError.__init__(self, error=error)
+
+
+class MultipleUpstreamTarballsNotSupported(BzrError):
+
+    _fmt = ("Importing packages using source format 3.0 multiple tarballs "
+            "is not yet supported.")

=== modified file 'import_dsc.py'
--- import_dsc.py	2011-06-05 00:12:43 +0000
+++ import_dsc.py	2011-06-10 11:49:31 +0000
@@ -62,6 +62,7 @@
 
 from bzrlib.plugins.builddeb.bzrtools_import import import_dir
 from bzrlib.plugins.builddeb.errors import (
+    MultipleUpstreamTarballsNotSupported,
     TarFailed,
     UpstreamAlreadyImported,
     UpstreamBranchAlreadyMerged,
@@ -1560,8 +1561,7 @@
                 "0000", "-exec", "chmod", "644", "{}", ";"])
         for part in self.dsc['files']:
             if (re.search("\.orig-[^.]+\.tar\.(gz|bz2|lzma)$", part['name'])):
-                raise AssertionError("Can't import packages with multiple "
-                    "upstream tarballs yet")
+                raise MultipleUpstreamTarballsNotSupported()
             if (part['name'].endswith(".orig.tar.gz")
                     or part['name'].endswith(".orig.tar.bz2")):
                 assert self.unextracted_upstream is None, "Two .orig.tar.(gz|bz2)?"

=== modified file 'tests/__init__.py'
--- tests/__init__.py	2011-05-08 07:39:35 +0000
+++ tests/__init__.py	2011-06-10 11:49:31 +0000
@@ -239,13 +239,27 @@
     >>> builder.dsc_name()
     """
 
-    def __init__(self, name, version, native=False, version3=False):
+    def __init__(self, name, version, native=False, version3=False,
+            multiple_upstream_tarballs=None):
+        """
+        :param name: Package name
+        :param version: Package version
+        :param native: Whether to build a native source package
+        :param version3: Whether to build a version 3.0 source package
+        :param multiple_upstream_tarballs: A list of each top-level directory
+            within the upstream tree which is to be packed as a source format
+            3.0 (quilt) additional upstream tarball
+        """
         self.upstream_files = {}
         self.upstream_symlinks = {}
         self.debian_files = {}
         self.name = name
         self.native = native
         self.version3 = version3
+        self.multiple_upstream_tarballs = multiple_upstream_tarballs
+        if multiple_upstream_tarballs and not (version3 and not native):
+            raise AssertionError("Multiple upstream tarballs are only "
+                    "possible with 3.0 (quilt) format")
         self._cl = Changelog()
         self.new_version(version)
 
@@ -356,6 +370,20 @@
                 cmd = ["dpkg-source", "-sn", "-b", basedir]
         else:
             if not self.native:
+                if self.multiple_upstream_tarballs:
+                    for part in self.multiple_upstream_tarballs:
+                        tar_path = "%s_%s.orig-%s.tar.%s" % (self.name,
+                                self._cl.version.upstream_version,
+                                part, tar_format)
+                        if os.path.exists(tar_path):
+                            os.unlink(tar_path)
+                        tar = tarfile.open(tar_path, 'w:%s' % tar_format)
+                        part_basedir = os.path.join(basedir, part)
+                        try:
+                            tar.add(part_basedir, arcname=part)
+                        finally:
+                            tar.close()
+                        shutil.rmtree(part_basedir)
                 tar_path = "%s_%s.orig.tar.%s" % (self.name,
                         self._cl.version.upstream_version, tar_format)
                 if os.path.exists(tar_path):

=== modified file 'tests/test_import_dsc.py'
--- tests/test_import_dsc.py	2011-06-04 08:52:53 +0000
+++ tests/test_import_dsc.py	2011-06-10 11:49:31 +0000
@@ -35,6 +35,9 @@
         tests,
         )
 
+from bzrlib.plugins.builddeb.errors import (
+        MultipleUpstreamTarballsNotSupported,
+        )
 from bzrlib.plugins.builddeb.import_dsc import (
         DistributionBranch,
         DistributionBranchSet,
@@ -1917,3 +1920,20 @@
         finally:
             extractor.cleanup()
 
+    def test_extract_format3_quilt_multiple_upstream_tarballs(self):
+        version = Version("0.1-1")
+        name = "package"
+        builder = SourcePackageBuilder(name, version, version3=True,
+                multiple_upstream_tarballs=("foo", "bar"))
+        builder.add_upstream_file("README", "Hi\n")
+        builder.add_upstream_file("BUGS")
+        builder.add_upstream_file("foo/wibble")
+        builder.add_upstream_file("bar/xyzzy")
+        builder.add_default_control()
+        builder.build(tar_format='bz2')
+        dsc = deb822.Dsc(open(builder.dsc_name()).read())
+        self.assertEqual(ThreeDotZeroQuiltSourceExtractor,
+                SOURCE_EXTRACTORS[dsc['Format']])
+        extractor = ThreeDotZeroQuiltSourceExtractor(builder.dsc_name(), dsc)
+        self.addCleanup(extractor.cleanup)
+        self.assertRaises(MultipleUpstreamTarballsNotSupported, extractor.extract)