Merge lp:~vila/bzr-builddeb/debug-pristine-tar into lp:bzr-builddeb

[Vincent Ladeuil]

This helped me to debug pristine-tar failures by preserving the exported
tree used as input by pristine-tar. This tree is normally removed as it's
part of a temp dir used to produce the delta. As such, when pristine-tar
failed, it was removed when unwinding the stack leaving nothing for
diagnosis.

This is mainly intended to be used on jubany or on a dev setup where
'debug-pristine-tar=True' should be specified in ~/.bazaar/builddeb.conf.

The option defaults to False.

[lp:~vila/bzr-builddeb/debug-pristine-tar]

735. By Vincent Ladeuil on 2012-06-19

Fix typos.

[Vincent Ladeuil (vila)]

Re-testing after the last change revealed typos fixed in revno 735.

[James Westby (james-w)]

review: Approve

=== modified file 'config.py'
--- config.py	2012-01-13 10:25:27 +0000
+++ config.py	2012-06-19 08:10:27 +0000
@@ -265,6 +265,10 @@
 
   merge = _bool_property('merge', "Run in merge mode")
 
+  debug_pristine_tar  = _bool_property(
+    'debug-pristine-tar',
+    "Save some context when pristine-tar fails")
+
   @property
   def build_type(self):
     if self.merge:

=== modified file 'info.py'
--- info.py	2011-02-16 13:19:52 +0000
+++ info.py	2012-06-19 08:10:27 +0000
@@ -18,7 +18,7 @@
 
 bzr_plugin_name = 'builddeb'
 
-bzr_plugin_version = (2, 7, 0, 'dev', 0)
+bzr_plugin_version = (2, 8, 5, 'dev', 0)
 
 bzr_commands = [
     "test_builddeb",

=== modified file 'upstream/pristinetar.py'
--- upstream/pristinetar.py	2012-02-17 14:38:45 +0000
+++ upstream/pristinetar.py	2012-06-19 08:10:27 +0000
@@ -18,6 +18,7 @@
 #    along with bzr-builddeb; if not, write to the Free Software
 #    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 
+
 from base64 import (
     standard_b64decode,
     standard_b64encode,
@@ -34,6 +35,7 @@
     )
 from bzrlib.plugins.builddeb.upstream import UpstreamSource
 from bzrlib.plugins.builddeb.util import (
+    debuild_config,
     export,
     subprocess_setup,
     )
@@ -409,7 +411,26 @@
                 export(tree, dest, format='dir', subdir=subdir)
             finally:
                 tree.unlock()
-            return make_pristine_tar_delta(dest, tarball_path)
+            try:
+                return make_pristine_tar_delta(dest, tarball_path)
+            except PristineTarDeltaTooLarge:
+                raise
+            except PristineTarError: # I.e. not PristineTarDeltaTooLarge
+                conf = debuild_config(tree, True)
+                if conf.debug_pristine_tar:
+                    revno, revid = tree.branch.last_revision_info()
+                    preserved = osutils.pathjoin(osutils.dirname(tarball_path),
+                                                 'orig-%s' % (revno,))
+                    mutter('pristine-tar failed for delta between %s rev: %s'
+                           ' and tarball %s'
+                           % (tree.basedir, (revno, revid), tarball_path))
+                    osutils.copy_tree(
+                        dest, preserved)
+                    mutter('The failure can be reproduced with:\n'
+                           '  cd %s\n'
+                           '  pristine-tar -vdk gendelta %s -'
+                           % (preserved, tarball_path))
+                raise
         finally:
             shutil.rmtree(tmpdir)