14
13
# You should have received a copy of the GNU General Public License
15
14
# along with this program; if not, write to the Free Software
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
17
"""Tests for the formatting and construction of errors."""
20
import bzrlib.bzrdir as bzrdir
21
import bzrlib.errors as errors
22
from bzrlib.tests import TestCaseWithTransport
25
class TestErrors(TestCaseWithTransport):
31
from ..sixish import (
37
class TestErrors(tests.TestCase):
39
def test_no_arg_named_message(self):
40
"""Ensure the __init__ and _fmt in errors do not have "message" arg.
42
This test fails if __init__ or _fmt in errors has an argument
43
named "message" as this can cause errors in some Python versions.
44
Python 2.5 uses a slot for StandardError.message.
47
fmt_pattern = re.compile("%\\(message\\)[sir]")
48
for c in errors.BzrError.__subclasses__():
49
init = getattr(c, '__init__', None)
50
fmt = getattr(c, '_fmt', None)
53
args = inspect.getfullargspec(init)[0]
55
args = inspect.getargspec(init)[0]
56
self.assertFalse('message' in args,
57
('Argument name "message" not allowed for '
58
'"errors.%s.__init__"' % c.__name__))
59
if fmt and fmt_pattern.search(fmt):
60
self.assertFalse(True, ('"message" not allowed in '
61
'"errors.%s._fmt"' % c.__name__))
63
def test_bad_filename_encoding(self):
64
error = errors.BadFilenameEncoding(b'bad/filen\xe5me', 'UTF-8')
65
self.assertContainsRe(
67
"^Filename b?'bad/filen\\\\xe5me' is not valid in your current"
68
" filesystem encoding UTF-8$")
70
def test_duplicate_file_id(self):
71
error = errors.DuplicateFileId('a_file_id', 'foo')
72
self.assertEqualDiff('File id {a_file_id} already exists in inventory'
73
' as foo', str(error))
75
def test_duplicate_help_prefix(self):
76
error = errors.DuplicateHelpPrefix('foo')
77
self.assertEqualDiff('The prefix foo is in the help search path twice.',
80
def test_ghost_revisions_have_no_revno(self):
81
error = errors.GhostRevisionsHaveNoRevno('target', 'ghost_rev')
82
self.assertEqualDiff("Could not determine revno for {target} because"
83
" its ancestry shows a ghost at {ghost_rev}",
86
def test_incompatibleVersion(self):
87
error = errors.IncompatibleVersion("module", [(4, 5, 6), (7, 8, 9)],
90
'API module is not compatible; one of versions '
91
'[(4, 5, 6), (7, 8, 9)] is required, but current version is '
95
def test_inconsistent_delta(self):
96
error = errors.InconsistentDelta('path', 'file-id', 'reason for foo')
98
"An inconsistent delta was supplied involving 'path', 'file-id'\n"
99
"reason: reason for foo",
102
def test_inconsistent_delta_delta(self):
103
error = errors.InconsistentDeltaDelta([], 'reason')
104
self.assertEqualDiff(
105
"An inconsistent delta was supplied: []\nreason: reason",
108
def test_in_process_transport(self):
109
error = errors.InProcessTransport('fpp')
110
self.assertEqualDiff(
111
"The transport 'fpp' is only accessible within this process.",
114
def test_invalid_http_range(self):
115
error = errors.InvalidHttpRange('path',
116
'Content-Range: potatoes 0-00/o0oo0',
118
self.assertEqual("Invalid http range"
119
" 'Content-Range: potatoes 0-00/o0oo0'"
120
" for path: bad range",
123
def test_invalid_range(self):
124
error = errors.InvalidRange('path', 12, 'bad range')
125
self.assertEqual("Invalid range access in path at 12: bad range",
128
def test_inventory_modified(self):
129
error = errors.InventoryModified("a tree to be repred")
130
self.assertEqualDiff("The current inventory for the tree 'a tree to "
131
"be repred' has been modified, so a clean inventory cannot be "
132
"read without data loss.",
135
def test_jail_break(self):
136
error = errors.JailBreak("some url")
137
self.assertEqualDiff("An attempt to access a url outside the server"
138
" jail was made: 'some url'.",
141
def test_lock_active(self):
142
error = errors.LockActive("lock description")
143
self.assertEqualDiff("The lock for 'lock description' is in use and "
147
def test_lock_corrupt(self):
148
error = errors.LockCorrupt("corruption info")
149
self.assertEqualDiff("Lock is apparently held, but corrupted: "
151
"Use 'brz break-lock' to clear it",
154
def test_medium_not_connected(self):
155
error = errors.MediumNotConnected("a medium")
156
self.assertEqualDiff(
157
"The medium 'a medium' is not connected.", str(error))
159
def test_no_smart_medium(self):
160
error = errors.NoSmartMedium("a transport")
161
self.assertEqualDiff("The transport 'a transport' cannot tunnel the "
165
def test_no_such_id(self):
166
error = errors.NoSuchId("atree", "anid")
167
self.assertEqualDiff("The file id \"anid\" is not present in the tree "
171
def test_no_such_revision_in_tree(self):
172
error = errors.NoSuchRevisionInTree("atree", "anid")
173
self.assertEqualDiff("The revision id {anid} is not present in the"
174
" tree atree.", str(error))
175
self.assertIsInstance(error, errors.NoSuchRevision)
177
def test_not_stacked(self):
178
error = errors.NotStacked('a branch')
179
self.assertEqualDiff("The branch 'a branch' is not stacked.",
182
def test_not_write_locked(self):
183
error = errors.NotWriteLocked('a thing to repr')
184
self.assertEqualDiff("'a thing to repr' is not write locked but needs "
188
def test_lock_failed(self):
189
error = errors.LockFailed('http://canonical.com/', 'readonly transport')
190
self.assertEqualDiff("Cannot lock http://canonical.com/: readonly transport",
192
self.assertFalse(error.internal_error)
194
def test_too_many_concurrent_requests(self):
195
error = errors.TooManyConcurrentRequests("a medium")
196
self.assertEqualDiff("The medium 'a medium' has reached its concurrent "
197
"request limit. Be sure to finish_writing and finish_reading on "
198
"the currently open request.",
201
def test_unavailable_representation(self):
202
error = errors.UnavailableRepresentation(('key',), "mpdiff", "fulltext")
203
self.assertEqualDiff("The encoding 'mpdiff' is not available for key "
204
"('key',) which is encoded as 'fulltext'.",
207
def test_unstackable_location(self):
208
error = errors.UnstackableLocationError('foo', 'bar')
209
self.assertEqualDiff("The branch 'foo' cannot be stacked on 'bar'.",
212
def test_unstackable_repository_format(self):
215
error = errors.UnstackableRepositoryFormat(format, url)
216
self.assertEqualDiff(
217
"The repository '/foo'(foo) is not a stackable format. "
218
"You will need to upgrade the repository to permit branch stacking.",
221
def test_up_to_date(self):
222
error = errors.UpToDateFormat("someformat")
223
self.assertEqualDiff(
224
"The branch format someformat is already at the most "
225
"recent format.", str(error))
227
def test_read_error(self):
228
# a unicode path to check that %r is being used.
230
error = errors.ReadError(path)
231
self.assertContainsRe(str(error), "^Error reading from u?'a path'.$")
233
def test_bzrerror_from_literal_string(self):
234
# Some code constructs BzrError from a literal string, in which case
235
# no further formatting is done. (I'm not sure raising the base class
236
# is a great idea, but if the exception is not intended to be caught
237
# perhaps no more is needed.)
239
raise errors.BzrError('this is my errors; %d is not expanded')
240
except errors.BzrError as e:
241
self.assertEqual('this is my errors; %d is not expanded', str(e))
243
def test_reading_completed(self):
244
error = errors.ReadingCompleted("a request")
245
self.assertEqualDiff("The MediumRequest 'a request' has already had "
246
"finish_reading called upon it - the request has been completed and"
247
" no more data may be read.",
250
def test_writing_completed(self):
251
error = errors.WritingCompleted("a request")
252
self.assertEqualDiff("The MediumRequest 'a request' has already had "
253
"finish_writing called upon it - accept bytes may not be called "
257
def test_writing_not_completed(self):
258
error = errors.WritingNotComplete("a request")
259
self.assertEqualDiff("The MediumRequest 'a request' has not has "
260
"finish_writing called upon it - until the write phase is complete"
261
" no data may be read.",
264
def test_transport_not_possible(self):
265
error = errors.TransportNotPossible('readonly', 'original error')
266
self.assertEqualDiff('Transport operation not possible:'
267
' readonly original error', str(error))
269
def assertSocketConnectionError(self, expected, *args, **kwargs):
270
"""Check the formatting of a SocketConnectionError exception"""
271
e = errors.SocketConnectionError(*args, **kwargs)
272
self.assertEqual(expected, str(e))
274
def test_socket_connection_error(self):
275
"""Test the formatting of SocketConnectionError"""
277
# There should be a default msg about failing to connect
278
# we only require a host name.
279
self.assertSocketConnectionError(
280
'Failed to connect to ahost',
283
# If port is None, we don't put :None
284
self.assertSocketConnectionError(
285
'Failed to connect to ahost',
287
# But if port is supplied we include it
288
self.assertSocketConnectionError(
289
'Failed to connect to ahost:22',
292
# We can also supply extra information about the error
293
# with or without a port
294
self.assertSocketConnectionError(
295
'Failed to connect to ahost:22; bogus error',
296
'ahost', port=22, orig_error='bogus error')
297
self.assertSocketConnectionError(
298
'Failed to connect to ahost; bogus error',
299
'ahost', orig_error='bogus error')
300
# An exception object can be passed rather than a string
301
orig_error = ValueError('bad value')
302
self.assertSocketConnectionError(
303
'Failed to connect to ahost; %s' % (str(orig_error),),
304
host='ahost', orig_error=orig_error)
306
# And we can supply a custom failure message
307
self.assertSocketConnectionError(
308
'Unable to connect to ssh host ahost:444; my_error',
309
host='ahost', port=444, msg='Unable to connect to ssh host',
310
orig_error='my_error')
312
def test_target_not_branch(self):
313
"""Test the formatting of TargetNotBranch."""
314
error = errors.TargetNotBranch('foo')
316
"Your branch does not have all of the revisions required in "
317
"order to merge this merge directive and the target "
318
"location specified in the merge directive is not a branch: "
321
def test_unexpected_smart_server_response(self):
322
e = errors.UnexpectedSmartServerResponse(('not yes',))
324
"Could not understand response from smart server: ('not yes',)",
327
def test_unknown_container_format(self):
328
"""Test the formatting of UnknownContainerFormatError."""
329
e = errors.UnknownContainerFormatError('bad format string')
331
"Unrecognised container format: 'bad format string'",
334
def test_unexpected_end_of_container(self):
335
"""Test the formatting of UnexpectedEndOfContainerError."""
336
e = errors.UnexpectedEndOfContainerError()
338
"Unexpected end of container stream", str(e))
340
def test_unknown_record_type(self):
341
"""Test the formatting of UnknownRecordTypeError."""
342
e = errors.UnknownRecordTypeError("X")
344
"Unknown record type: 'X'",
347
def test_invalid_record(self):
348
"""Test the formatting of InvalidRecordError."""
349
e = errors.InvalidRecordError("xxx")
351
"Invalid record: xxx",
354
def test_container_has_excess_data(self):
355
"""Test the formatting of ContainerHasExcessDataError."""
356
e = errors.ContainerHasExcessDataError("excess bytes")
358
"Container has data after end marker: 'excess bytes'",
361
def test_duplicate_record_name_error(self):
362
"""Test the formatting of DuplicateRecordNameError."""
363
e = errors.DuplicateRecordNameError(b"n\xc3\xa5me")
365
u"Container has multiple records with the same name: n\xe5me",
368
def test_check_error(self):
369
e = errors.BzrCheckError('example check failure')
371
"Internal check failed: example check failure",
373
self.assertTrue(e.internal_error)
375
def test_repository_data_stream_error(self):
376
"""Test the formatting of RepositoryDataStreamError."""
377
e = errors.RepositoryDataStreamError(u"my reason")
379
"Corrupt or incompatible data stream: my reason", str(e))
381
def test_immortal_pending_deletion_message(self):
382
err = errors.ImmortalPendingDeletion('foo')
384
"Unable to delete transform temporary directory foo. "
385
"Please examine foo to see if it contains any files "
386
"you wish to keep, and delete it when you are done.",
389
def test_unable_create_symlink(self):
390
err = errors.UnableCreateSymlink()
392
"Unable to create symlink on this platform",
394
err = errors.UnableCreateSymlink(path=u'foo')
396
"Unable to create symlink 'foo' on this platform",
398
err = errors.UnableCreateSymlink(path=u'\xb5')
400
"Unable to create symlink %s on this platform" % repr(u'\xb5'),
403
def test_invalid_url_join(self):
404
"""Test the formatting of InvalidURLJoin."""
405
e = urlutils.InvalidURLJoin('Reason', 'base path', ('args',))
407
"Invalid URL join request: Reason: 'base path' + ('args',)",
410
def test_unable_encode_path(self):
411
err = errors.UnableEncodePath('foo', 'executable')
412
self.assertEqual("Unable to encode executable path 'foo' in "
413
"user encoding " + osutils.get_user_encoding(),
416
def test_unknown_format(self):
417
err = errors.UnknownFormatError('bar', kind='foo')
418
self.assertEqual("Unknown foo format: 'bar'", str(err))
420
def test_tip_change_rejected(self):
421
err = errors.TipChangeRejected(u'Unicode message\N{INTERROBANG}')
423
u'Tip change rejected: Unicode message\N{INTERROBANG}',
426
def test_error_from_smart_server(self):
427
error_tuple = ('error', 'tuple')
428
err = errors.ErrorFromSmartServer(error_tuple)
430
"Error received from smart server: ('error', 'tuple')", str(err))
432
def test_untranslateable_error_from_smart_server(self):
433
error_tuple = ('error', 'tuple')
434
orig_err = errors.ErrorFromSmartServer(error_tuple)
435
err = errors.UnknownErrorFromSmartServer(orig_err)
437
"Server sent an unexpected error: ('error', 'tuple')", str(err))
439
def test_smart_message_handler_error(self):
440
# Make an exc_info tuple.
442
raise Exception("example error")
444
err = errors.SmartMessageHandlerError(sys.exc_info())
445
# GZ 2010-11-08: Should not store exc_info in exception instances.
447
self.assertStartsWith(
448
str(err), "The message handler raised an exception:\n")
449
self.assertEndsWith(str(err), "Exception: example error\n")
453
def test_unresumable_write_group(self):
455
wg_tokens = ['token']
457
err = errors.UnresumableWriteGroup(repo, wg_tokens, reason)
459
"Repository dummy repo cannot resume write group "
460
"['token']: a reason", str(err))
462
def test_unsuspendable_write_group(self):
464
err = errors.UnsuspendableWriteGroup(repo)
466
'Repository dummy repo cannot suspend a write group.', str(err))
468
def test_not_branch_no_args(self):
469
err = errors.NotBranchError('path')
470
self.assertEqual('Not a branch: "path".', str(err))
472
def test_not_branch_bzrdir_with_recursive_not_branch_error(self):
473
class FakeBzrDir(object):
474
def open_repository(self):
475
# str() on the NotBranchError will trigger a call to this,
476
# which in turn will another, identical NotBranchError.
477
raise errors.NotBranchError('path', controldir=FakeBzrDir())
478
err = errors.NotBranchError('path', controldir=FakeBzrDir())
479
self.assertEqual('Not a branch: "path": NotBranchError.', str(err))
481
def test_recursive_bind(self):
482
error = errors.RecursiveBind('foo_bar_branch')
483
msg = ('Branch "foo_bar_branch" appears to be bound to itself. '
484
'Please use `brz unbind` to fix.')
485
self.assertEqualDiff(msg, str(error))
487
def test_retry_with_new_packs(self):
488
fake_exc_info = ('{exc type}', '{exc value}', '{exc traceback}')
489
error = errors.RetryWithNewPacks(
490
'{context}', reload_occurred=False, exc_info=fake_exc_info)
492
'Pack files have changed, reload and retry. context: '
493
'{context} {exc value}', str(error))
496
class PassThroughError(errors.BzrError):
498
_fmt = """Pass through %(foo)s and %(bar)s"""
500
def __init__(self, foo, bar):
501
errors.BzrError.__init__(self, foo=foo, bar=bar)
504
class ErrorWithBadFormat(errors.BzrError):
506
_fmt = """One format specifier: %(thing)s"""
509
class ErrorWithNoFormat(errors.BzrError):
510
__doc__ = """This class has a docstring but no format string."""
513
class TestErrorFormatting(tests.TestCase):
515
def test_always_str(self):
516
e = PassThroughError(u'\xb5', 'bar')
517
self.assertIsInstance(e.__str__(), str)
518
# In Python 2 str(foo) *must* return a real byte string
519
# not a Unicode string. The following line would raise a
520
# Unicode error, because it tries to call str() on the string
521
# returned from e.__str__(), and it has non ascii characters
524
self.assertEqual('Pass through \xb5 and bar', s)
526
self.assertEqual('Pass through \xc2\xb5 and bar', s)
528
def test_missing_format_string(self):
529
e = ErrorWithNoFormat(param='randomvalue')
530
self.assertStartsWith(str(e),
531
"Unprintable exception ErrorWithNoFormat")
533
def test_mismatched_format_args(self):
534
# Even though ErrorWithBadFormat's format string does not match the
535
# arguments we constructing it with, we can still stringify an instance
536
# of this exception. The resulting string will say its unprintable.
537
e = ErrorWithBadFormat(not_thing='x')
538
self.assertStartsWith(
539
str(e), 'Unprintable exception ErrorWithBadFormat')
541
def test_cannot_bind_address(self):
542
# see <https://bugs.launchpad.net/bzr/+bug/286871>
543
e = errors.CannotBindAddress('example.com', 22,
544
socket.error(13, 'Permission denied'))
545
self.assertContainsRe(
547
r'Cannot bind address "example\.com:22":.*Permission denied')
549
def test_transform_rename_failed(self):
550
e = errors.TransformRenameFailed(u"from", u"to", "readonly file", 2)
552
u"Failed to rename from to to: readonly file",
556
class TestErrorsUsingTransport(tests.TestCaseWithMemoryTransport):
557
"""Tests for errors that need to use a branch or repo."""
559
def test_no_public_branch(self):
560
b = self.make_branch('.')
561
error = errors.NoPublicBranch(b)
562
url = urlutils.unescape_for_display(b.base, 'ascii')
563
self.assertEqualDiff(
564
'There is no public branch set for "%s".' % url, str(error))
27
566
def test_no_repo(self):
28
dir = bzrdir.BzrDir.create(self.get_url())
567
dir = controldir.ControlDir.create(self.get_url())
29
568
error = errors.NoRepositoryPresent(dir)
30
self.assertNotEqual(-1, str(error).find(repr(dir.transport.clone('..').base)))
31
self.assertEqual(-1, str(error).find(repr(dir.transport.base)))
33
def test_up_to_date(self):
34
error = errors.UpToDateFormat(bzrdir.BzrDirFormat4())
35
self.assertEqualDiff("The branch format Bazaar-NG branch, "
36
"format 0.0.4 is already at the most "
569
self.assertNotEqual(-1, str(error).find((dir.transport.clone('..').base)))
570
self.assertEqual(-1, str(error).find((dir.transport.base)))
40
572
def test_corrupt_repository(self):
41
573
repo = self.make_repository('.')
42
574
error = errors.CorruptRepository(repo)
43
575
self.assertEqualDiff("An error has been detected in the repository %s.\n"
44
"Please run bzr reconcile on this repository." %
45
repo.bzrdir.root_transport.base,
576
"Please run brz reconcile on this repository." %
577
repo.controldir.root_transport.base,
580
def test_not_branch_bzrdir_with_repo(self):
581
controldir = self.make_repository('repo').controldir
582
err = errors.NotBranchError('path', controldir=controldir)
584
'Not a branch: "path": location is a repository.', str(err))
586
def test_not_branch_bzrdir_without_repo(self):
587
controldir = self.make_controldir('bzrdir')
588
err = errors.NotBranchError('path', controldir=controldir)
589
self.assertEqual('Not a branch: "path".', str(err))
591
def test_not_branch_laziness(self):
592
real_bzrdir = self.make_controldir('path')
593
class FakeBzrDir(object):
596
def open_repository(self):
597
self.calls.append('open_repository')
598
raise errors.NoRepositoryPresent(real_bzrdir)
599
fake_bzrdir = FakeBzrDir()
600
err = errors.NotBranchError('path', controldir=fake_bzrdir)
601
self.assertEqual([], fake_bzrdir.calls)
603
self.assertEqual(['open_repository'], fake_bzrdir.calls)
604
# Stringifying twice doesn't try to open a repository twice.
606
self.assertEqual(['open_repository'], fake_bzrdir.calls)
added
removed
breezy/tests/test_errors.py
