Merge lp:~garyvdm/bzr/commit-BoundBranchOutOfDate into lp:bzr

[Gary van der Merwe]

[Gary van der Merwe (garyvdm)]

In qbzr, we would like to detect when a commit fails because the bound branch is not up to date. But because the Commit.run method returns a very generic BzrCommandError, this cannot be done. This patch changes things so that it returns a more specific BoundBranchOutOfDate.

[Martin Pool (mbp)]

Nice.

I wonder if the extra message should somehow always be defined in the error, but this is fine for now.

review: Approve

[lp:~garyvdm/bzr/commit-BoundBranchOutOfDate]

5068. By Gary van der Merwe on 2010-03-03

Merge bzr.dev.

=== modified file 'NEWS'
--- NEWS	2010-03-02 19:50:18 +0000
+++ NEWS	2010-03-03 08:27:18 +0000
@@ -130,12 +130,19 @@
 * ``bzrlib.branchbuilder.BranchBuilder.build_snapshot`` now accepts a
   ``message_callback`` in the same way that commit does. (Robert Collins)
 
+* ``bzrlib.builtins.Commit.run`` raises ``bzrlib.errors.BoundBranchOutOfDate``
+  rather than ``bzrlib.errors.BzrCommandError`` when the bound branch is out
+  of date. (Gary van der Merwe)
+
 * ``bzrlib.commands.run_bzr`` is more extensible: callers can supply the
   functions to load or disable plugins if they wish to use a different
   plugin mechanism; the --help, --version and no-command name code paths
   now use the generic pluggable command lookup infrastructure.
   (Robert Collins)
 
+* ``bzrlib.errors.BoundBranchOutOfDate`` has a new field ``extra_help``
+  which can be set to add extra help to the error. (Gary van der Merwe)
+
 * The methods ``BzrDir.create_branch()``, ``BzrDir.destroy_branch()`` and 
   ``BzrDir.open_branch()`` now take an optional ``name`` argument. 
   (Jelmer Vernooij)

=== modified file 'bzrlib/builtins.py'
--- bzrlib/builtins.py	2010-03-02 15:56:28 +0000
+++ bzrlib/builtins.py	2010-03-03 08:27:18 +0000
@@ -3174,10 +3174,11 @@
             raise errors.BzrCommandError("Commit refused because there are"
                               " unknown files in the working tree.")
         except errors.BoundBranchOutOfDate, e:
-            raise errors.BzrCommandError(str(e) + "\n"
-            'To commit to master branch, run update and then commit.\n'
-            'You can also pass --local to commit to continue working '
-            'disconnected.')
+            e.extra_help = ("\n"
+                'To commit to master branch, run update and then commit.\n'
+                'You can also pass --local to commit to continue working '
+                'disconnected.')
+            raise
 
 
 class cmd_check(Command):

=== modified file 'bzrlib/errors.py'
--- bzrlib/errors.py	2010-03-02 19:50:18 +0000
+++ bzrlib/errors.py	2010-03-03 08:27:18 +0000
@@ -1297,12 +1297,13 @@
 class BoundBranchOutOfDate(BzrError):
 
     _fmt = ("Bound branch %(branch)s is out of date with master branch"
-            " %(master)s.")
+            " %(master)s.%(extra_help)s")
 
     def __init__(self, branch, master):
         BzrError.__init__(self)
         self.branch = branch
         self.master = master
+        self.extra_help = ''
 
 
 class CommitToDoubleBoundBranch(BzrError):

=== modified file 'bzrlib/tests/commands/test_commit.py'
--- bzrlib/tests/commands/test_commit.py	2010-02-17 17:11:16 +0000
+++ bzrlib/tests/commands/test_commit.py	2010-03-03 08:27:18 +0000
@@ -53,8 +53,7 @@
         # commit do not provide a directory parameter, we have to change dir
         # manually
         os.chdir('local')
-        # cmd_commit translates BoundBranchOutOfDate into BzrCommandError
-        self.assertRaises(errors.BzrCommandError, commit.run,
+        self.assertRaises(errors.BoundBranchOutOfDate, commit.run,
                           message=u'empty commit', unchanged=True)
         self.assertEquals(1, len(self.connections))