17
17
"""Tests for the formatting and construction of errors."""
29
from bzrlib.tests import TestCase, TestCaseWithTransport
32
class TestErrors(TestCaseWithTransport):
31
from ..sixish import (
36
class TestErrors(tests.TestCase):
38
def test_no_arg_named_message(self):
39
"""Ensure the __init__ and _fmt in errors do not have "message" arg.
41
This test fails if __init__ or _fmt in errors has an argument
42
named "message" as this can cause errors in some Python versions.
43
Python 2.5 uses a slot for StandardError.message.
46
fmt_pattern = re.compile("%\\(message\\)[sir]")
47
for c in errors.BzrError.__subclasses__():
48
init = getattr(c, '__init__', None)
49
fmt = getattr(c, '_fmt', None)
51
args = inspect.getargspec(init)[0]
52
self.assertFalse('message' in args,
53
('Argument name "message" not allowed for '
54
'"errors.%s.__init__"' % c.__name__))
55
if fmt and fmt_pattern.search(fmt):
56
self.assertFalse(True, ('"message" not allowed in '
57
'"errors.%s._fmt"' % c.__name__))
34
59
def test_bad_filename_encoding(self):
35
error = errors.BadFilenameEncoding('bad/filen\xe5me', 'UTF-8')
37
"Filename 'bad/filen\\xe5me' is not valid in your current"
38
" filesystem encoding UTF-8",
41
def test_corrupt_dirstate(self):
42
error = errors.CorruptDirstate('path/to/dirstate', 'the reason why')
44
"Inconsistency in dirstate file path/to/dirstate.\n"
45
"Error: the reason why",
48
def test_dirstate_corrupt(self):
49
error = errors.DirstateCorrupt('.bzr/checkout/dirstate',
50
'trailing garbage: "x"')
51
self.assertEqualDiff("The dirstate file (.bzr/checkout/dirstate)"
52
" appears to be corrupt: trailing garbage: \"x\"",
55
def test_disabled_method(self):
56
error = errors.DisabledMethod("class name")
58
"The smart server method 'class name' is disabled.", str(error))
60
error = errors.BadFilenameEncoding(b'bad/filen\xe5me', 'UTF-8')
61
self.assertContainsRe(
63
"^Filename b?'bad/filen\\\\xe5me' is not valid in your current"
64
" filesystem encoding UTF-8$")
60
66
def test_duplicate_file_id(self):
61
67
error = errors.DuplicateFileId('a_file_id', 'foo')
73
79
" its ancestry shows a ghost at {ghost_rev}",
76
def test_incompatibleAPI(self):
77
error = errors.IncompatibleAPI("module", (1, 2, 3), (4, 5, 6), (7, 8, 9))
82
def test_incompatibleVersion(self):
83
error = errors.IncompatibleVersion("module", [(4, 5, 6), (7, 8, 9)],
78
85
self.assertEqualDiff(
79
'The API for "module" is not compatible with "(1, 2, 3)". '
80
'It supports versions "(4, 5, 6)" to "(7, 8, 9)".',
86
'API module is not compatible; one of versions '
87
'[(4, 5, 6), (7, 8, 9)] is required, but current version is '
83
91
def test_inconsistent_delta(self):
103
111
error = errors.InvalidHttpRange('path',
104
112
'Content-Range: potatoes 0-00/o0oo0',
106
self.assertEquals("Invalid http range"
107
" 'Content-Range: potatoes 0-00/o0oo0'"
108
" for path: bad range",
114
self.assertEqual("Invalid http range"
115
" 'Content-Range: potatoes 0-00/o0oo0'"
116
" for path: bad range",
111
119
def test_invalid_range(self):
112
120
error = errors.InvalidRange('path', 12, 'bad range')
113
self.assertEquals("Invalid range access in path at 12: bad range",
121
self.assertEqual("Invalid range access in path at 12: bad range",
116
124
def test_inventory_modified(self):
117
125
error = errors.InventoryModified("a tree to be repred")
132
140
"cannot be broken.",
135
def test_knit_data_stream_incompatible(self):
136
error = errors.KnitDataStreamIncompatible(
137
'stream format', 'target format')
138
self.assertEqual('Cannot insert knit data stream of format '
139
'"stream format" into knit of format '
140
'"target format".', str(error))
142
def test_knit_data_stream_unknown(self):
143
error = errors.KnitDataStreamUnknown(
145
self.assertEqual('Cannot parse knit data stream of format '
146
'"stream format".', str(error))
148
def test_knit_header_error(self):
149
error = errors.KnitHeaderError('line foo\n', 'path/to/file')
150
self.assertEqual("Knit header error: 'line foo\\n' unexpected"
151
" for file \"path/to/file\".", str(error))
153
def test_knit_index_unknown_method(self):
154
error = errors.KnitIndexUnknownMethod('http://host/foo.kndx',
156
self.assertEqual("Knit index http://host/foo.kndx does not have a"
157
" known method in options: ['bad', 'no-eol']",
143
def test_lock_corrupt(self):
144
error = errors.LockCorrupt("corruption info")
145
self.assertEqualDiff("Lock is apparently held, but corrupted: "
147
"Use 'brz break-lock' to clear it",
160
150
def test_medium_not_connected(self):
161
151
error = errors.MediumNotConnected("a medium")
162
152
self.assertEqualDiff(
163
153
"The medium 'a medium' is not connected.", str(error))
165
def test_no_public_branch(self):
166
b = self.make_branch('.')
167
error = errors.NoPublicBranch(b)
168
url = urlutils.unescape_for_display(b.base, 'ascii')
169
self.assertEqualDiff(
170
'There is no public branch set for "%s".' % url, str(error))
172
def test_no_repo(self):
173
dir = bzrdir.BzrDir.create(self.get_url())
174
error = errors.NoRepositoryPresent(dir)
175
self.assertNotEqual(-1, str(error).find((dir.transport.clone('..').base)))
176
self.assertEqual(-1, str(error).find((dir.transport.base)))
178
155
def test_no_smart_medium(self):
179
156
error = errors.NoSmartMedium("a transport")
180
157
self.assertEqualDiff("The transport 'a transport' cannot tunnel the "
181
158
"smart protocol.",
184
def test_no_help_topic(self):
185
error = errors.NoHelpTopic("topic")
186
self.assertEqualDiff("No help could be found for 'topic'. "
187
"Please use 'bzr help topics' to obtain a list of topics.",
190
161
def test_no_such_id(self):
191
162
error = errors.NoSuchId("atree", "anid")
192
163
self.assertEqualDiff("The file id \"anid\" is not present in the tree "
229
200
"('key',) which is encoded as 'fulltext'.",
232
def test_unknown_hook(self):
233
error = errors.UnknownHook("branch", "foo")
234
self.assertEqualDiff("The branch hook 'foo' is unknown in this version"
237
error = errors.UnknownHook("tree", "bar")
238
self.assertEqualDiff("The tree hook 'bar' is unknown in this version"
242
def test_unstackable_branch_format(self):
245
error = errors.UnstackableBranchFormat(format, url)
246
self.assertEqualDiff(
247
"The branch '/foo'(foo) is not a stackable format. "
248
"You will need to upgrade the branch to permit branch stacking.",
251
203
def test_unstackable_location(self):
252
204
error = errors.UnstackableLocationError('foo', 'bar')
253
205
self.assertEqualDiff("The branch 'foo' cannot be stacked on 'bar'.",
265
217
def test_up_to_date(self):
266
error = errors.UpToDateFormat(bzrdir.BzrDirFormat4())
267
self.assertEqualDiff("The branch format All-in-one "
268
"format 4 is already at the most "
272
def test_corrupt_repository(self):
273
repo = self.make_repository('.')
274
error = errors.CorruptRepository(repo)
275
self.assertEqualDiff("An error has been detected in the repository %s.\n"
276
"Please run bzr reconcile on this repository." %
277
repo.bzrdir.root_transport.base,
218
error = errors.UpToDateFormat("someformat")
219
self.assertEqualDiff(
220
"The branch format someformat is already at the most "
221
"recent format.", str(error))
280
223
def test_read_error(self):
281
224
# a unicode path to check that %r is being used.
283
226
error = errors.ReadError(path)
284
self.assertEqualDiff("Error reading from u'a path'.", str(error))
286
def test_bad_index_format_signature(self):
287
error = errors.BadIndexFormatSignature("foo", "bar")
288
self.assertEqual("foo is not an index of type bar.",
291
def test_bad_index_data(self):
292
error = errors.BadIndexData("foo")
293
self.assertEqual("Error in data for index foo.",
296
def test_bad_index_duplicate_key(self):
297
error = errors.BadIndexDuplicateKey("foo", "bar")
298
self.assertEqual("The key 'foo' is already in index 'bar'.",
301
def test_bad_index_key(self):
302
error = errors.BadIndexKey("foo")
303
self.assertEqual("The key 'foo' is not a valid key.",
306
def test_bad_index_options(self):
307
error = errors.BadIndexOptions("foo")
308
self.assertEqual("Could not parse options for index foo.",
311
def test_bad_index_value(self):
312
error = errors.BadIndexValue("foo")
313
self.assertEqual("The value 'foo' is not a valid value.",
316
def test_bzrnewerror_is_deprecated(self):
317
class DeprecatedError(errors.BzrNewError):
319
self.callDeprecated(['BzrNewError was deprecated in bzr 0.13; '
320
'please convert DeprecatedError to use BzrError instead'],
227
self.assertContainsRe(str(error), "^Error reading from u?'a path'.$")
323
229
def test_bzrerror_from_literal_string(self):
324
230
# Some code constructs BzrError from a literal string, in which case
408
314
"location specified in the merge directive is not a branch: "
409
315
"foo.", str(error))
411
def test_malformed_bug_identifier(self):
412
"""Test the formatting of MalformedBugIdentifier."""
413
error = errors.MalformedBugIdentifier('bogus', 'reason for bogosity')
415
'Did not understand bug identifier bogus: reason for bogosity. '
416
'See "bzr help bugs" for more information on this feature.',
419
def test_unknown_bug_tracker_abbreviation(self):
420
"""Test the formatting of UnknownBugTrackerAbbreviation."""
421
branch = self.make_branch('some_branch')
422
error = errors.UnknownBugTrackerAbbreviation('xxx', branch)
424
"Cannot find registered bug tracker called xxx on %s" % branch,
427
317
def test_unexpected_smart_server_response(self):
428
318
e = errors.UnexpectedSmartServerResponse(('not yes',))
429
319
self.assertEqual(
467
357
def test_duplicate_record_name_error(self):
468
358
"""Test the formatting of DuplicateRecordNameError."""
469
e = errors.DuplicateRecordNameError(u"n\xe5me".encode('utf-8'))
359
e = errors.DuplicateRecordNameError(b"n\xc3\xa5me")
470
360
self.assertEqual(
471
"Container has multiple records with the same name: n\xc3\xa5me",
361
u"Container has multiple records with the same name: n\xe5me",
474
364
def test_check_error(self):
475
# This has a member called 'message', which is problematic in
476
# python2.5 because that is a slot on the base Exception class
477
365
e = errors.BzrCheckError('example check failure')
478
366
self.assertEqual(
479
367
"Internal check failed: example check failure",
497
385
def test_unable_create_symlink(self):
498
386
err = errors.UnableCreateSymlink()
500
388
"Unable to create symlink on this platform",
502
390
err = errors.UnableCreateSymlink(path=u'foo')
504
392
"Unable to create symlink 'foo' on this platform",
506
394
err = errors.UnableCreateSymlink(path=u'\xb5')
508
"Unable to create symlink u'\\xb5' on this platform",
396
"Unable to create symlink %s on this platform" % repr(u'\xb5'),
511
399
def test_invalid_url_join(self):
512
400
"""Test the formatting of InvalidURLJoin."""
513
e = errors.InvalidURLJoin('Reason', 'base path', ('args',))
401
e = urlutils.InvalidURLJoin('Reason', 'base path', ('args',))
514
402
self.assertEqual(
515
403
"Invalid URL join request: Reason: 'base path' + ('args',)",
518
def test_incorrect_url(self):
519
err = errors.InvalidBugTrackerURL('foo', 'http://bug.com/')
521
("The URL for bug tracker \"foo\" doesn't contain {id}: "
525
406
def test_unable_encode_path(self):
526
407
err = errors.UnableEncodePath('foo', 'executable')
527
self.assertEquals("Unable to encode executable path 'foo' in "
528
"user encoding " + osutils.get_user_encoding(),
408
self.assertEqual("Unable to encode executable path 'foo' in "
409
"user encoding " + osutils.get_user_encoding(),
531
412
def test_unknown_format(self):
532
413
err = errors.UnknownFormatError('bar', kind='foo')
533
self.assertEquals("Unknown foo format: 'bar'", str(err))
535
def test_unknown_rules(self):
536
err = errors.UnknownRules(['foo', 'bar'])
537
self.assertEquals("Unknown rules detected: foo, bar.", str(err))
539
def test_hook_failed(self):
540
# Create an exc_info tuple by raising and catching an exception.
543
except ZeroDivisionError:
544
exc_info = sys.exc_info()
545
err = errors.HookFailed('hook stage', 'hook name', exc_info, warn=False)
546
self.assertStartsWith(
547
str(err), 'Hook \'hook name\' during hook stage failed:\n')
549
str(err), 'integer division or modulo by zero')
414
self.assertEqual("Unknown foo format: 'bar'", str(err))
551
416
def test_tip_change_rejected(self):
552
417
err = errors.TipChangeRejected(u'Unicode message\N{INTERROBANG}')
554
419
u'Tip change rejected: Unicode message\N{INTERROBANG}',
557
'Tip change rejected: Unicode message\xe2\x80\xbd',
560
422
def test_error_from_smart_server(self):
561
423
error_tuple = ('error', 'tuple')
562
424
err = errors.ErrorFromSmartServer(error_tuple)
564
426
"Error received from smart server: ('error', 'tuple')", str(err))
566
428
def test_untranslateable_error_from_smart_server(self):
567
429
error_tuple = ('error', 'tuple')
568
430
orig_err = errors.ErrorFromSmartServer(error_tuple)
569
431
err = errors.UnknownErrorFromSmartServer(orig_err)
571
433
"Server sent an unexpected error: ('error', 'tuple')", str(err))
573
435
def test_smart_message_handler_error(self):
576
438
raise Exception("example error")
577
439
except Exception:
578
exc_info = sys.exc_info()
579
err = errors.SmartMessageHandlerError(exc_info)
580
self.assertStartsWith(
581
str(err), "The message handler raised an exception:\n")
582
self.assertEndsWith(str(err), "Exception: example error\n")
584
def test_must_have_working_tree(self):
585
err = errors.MustHaveWorkingTree('foo', 'bar')
586
self.assertEqual(str(err), "Branching 'bar'(foo) must create a"
589
def test_no_such_view(self):
590
err = errors.NoSuchView('foo')
591
self.assertEquals("No such view: foo.", str(err))
593
def test_views_not_supported(self):
594
err = errors.ViewsNotSupported('atree')
596
self.assertStartsWith(err_str, "Views are not supported by ")
597
self.assertEndsWith(err_str, "; use 'bzr upgrade' to change your "
598
"tree to a later format.")
600
def test_file_outside_view(self):
601
err = errors.FileOutsideView('baz', ['foo', 'bar'])
602
self.assertEquals('Specified file "baz" is outside the current view: '
603
'foo, bar', str(err))
605
def test_invalid_shelf_id(self):
607
err = errors.InvalidShelfId(invalid_id)
608
self.assertEqual('"foo" is not a valid shelf id, '
609
'try a number instead.', str(err))
440
err = errors.SmartMessageHandlerError(sys.exc_info())
441
# GZ 2010-11-08: Should not store exc_info in exception instances.
443
self.assertStartsWith(
444
str(err), "The message handler raised an exception:\n")
445
self.assertEndsWith(str(err), "Exception: example error\n")
611
449
def test_unresumable_write_group(self):
612
450
repo = "dummy repo"
627
465
err = errors.NotBranchError('path')
628
466
self.assertEqual('Not a branch: "path".', str(err))
630
def test_not_branch_bzrdir_with_repo(self):
631
bzrdir = self.make_repository('repo').bzrdir
632
err = errors.NotBranchError('path', bzrdir=bzrdir)
634
'Not a branch: "path": location is a repository.', str(err))
636
def test_not_branch_bzrdir_without_repo(self):
637
bzrdir = self.make_bzrdir('bzrdir')
638
err = errors.NotBranchError('path', bzrdir=bzrdir)
639
self.assertEqual('Not a branch: "path".', str(err))
641
def test_not_branch_laziness(self):
642
real_bzrdir = self.make_bzrdir('path')
468
def test_not_branch_bzrdir_with_recursive_not_branch_error(self):
643
469
class FakeBzrDir(object):
646
470
def open_repository(self):
647
self.calls.append('open_repository')
648
raise errors.NoRepositoryPresent(real_bzrdir)
649
fake_bzrdir = FakeBzrDir()
650
err = errors.NotBranchError('path', bzrdir=fake_bzrdir)
651
self.assertEqual([], fake_bzrdir.calls)
653
self.assertEqual(['open_repository'], fake_bzrdir.calls)
654
# Stringifying twice doesn't try to open a repository twice.
656
self.assertEqual(['open_repository'], fake_bzrdir.calls)
471
# str() on the NotBranchError will trigger a call to this,
472
# which in turn will another, identical NotBranchError.
473
raise errors.NotBranchError('path', controldir=FakeBzrDir())
474
err = errors.NotBranchError('path', controldir=FakeBzrDir())
475
self.assertEqual('Not a branch: "path": NotBranchError.', str(err))
477
def test_recursive_bind(self):
478
error = errors.RecursiveBind('foo_bar_branch')
479
msg = ('Branch "foo_bar_branch" appears to be bound to itself. '
480
'Please use `brz unbind` to fix.')
481
self.assertEqualDiff(msg, str(error))
483
def test_retry_with_new_packs(self):
484
fake_exc_info = ('{exc type}', '{exc value}', '{exc traceback}')
485
error = errors.RetryWithNewPacks(
486
'{context}', reload_occurred=False, exc_info=fake_exc_info)
488
'Pack files have changed, reload and retry. context: '
489
'{context} {exc value}', str(error))
659
492
class PassThroughError(errors.BzrError):
703
532
str(e), 'Unprintable exception ErrorWithBadFormat')
705
534
def test_cannot_bind_address(self):
706
# see <https://bugs.edge.launchpad.net/bzr/+bug/286871>
535
# see <https://bugs.launchpad.net/bzr/+bug/286871>
707
536
e = errors.CannotBindAddress('example.com', 22,
708
socket.error(13, 'Permission denied'))
709
self.assertContainsRe(str(e),
537
socket.error(13, 'Permission denied'))
538
self.assertContainsRe(
710
540
r'Cannot bind address "example\.com:22":.*Permission denied')
712
def test_file_timestamp_unavailable(self):
713
e = errors.FileTimestampUnavailable("/path/foo")
714
self.assertEquals("The filestamp for /path/foo is not available.",
542
def test_transform_rename_failed(self):
543
e = errors.TransformRenameFailed(u"from", u"to", "readonly file", 2)
545
u"Failed to rename from to to: readonly file",
549
class TestErrorsUsingTransport(tests.TestCaseWithMemoryTransport):
550
"""Tests for errors that need to use a branch or repo."""
552
def test_no_public_branch(self):
553
b = self.make_branch('.')
554
error = errors.NoPublicBranch(b)
555
url = urlutils.unescape_for_display(b.base, 'ascii')
556
self.assertEqualDiff(
557
'There is no public branch set for "%s".' % url, str(error))
559
def test_no_repo(self):
560
dir = controldir.ControlDir.create(self.get_url())
561
error = errors.NoRepositoryPresent(dir)
562
self.assertNotEqual(-1, str(error).find((dir.transport.clone('..').base)))
563
self.assertEqual(-1, str(error).find((dir.transport.base)))
565
def test_corrupt_repository(self):
566
repo = self.make_repository('.')
567
error = errors.CorruptRepository(repo)
568
self.assertEqualDiff("An error has been detected in the repository %s.\n"
569
"Please run brz reconcile on this repository." %
570
repo.controldir.root_transport.base,
573
def test_not_branch_bzrdir_with_repo(self):
574
controldir = self.make_repository('repo').controldir
575
err = errors.NotBranchError('path', controldir=controldir)
577
'Not a branch: "path": location is a repository.', str(err))
579
def test_not_branch_bzrdir_without_repo(self):
580
controldir = self.make_controldir('bzrdir')
581
err = errors.NotBranchError('path', controldir=controldir)
582
self.assertEqual('Not a branch: "path".', str(err))
584
def test_not_branch_laziness(self):
585
real_bzrdir = self.make_controldir('path')
586
class FakeBzrDir(object):
589
def open_repository(self):
590
self.calls.append('open_repository')
591
raise errors.NoRepositoryPresent(real_bzrdir)
592
fake_bzrdir = FakeBzrDir()
593
err = errors.NotBranchError('path', controldir=fake_bzrdir)
594
self.assertEqual([], fake_bzrdir.calls)
596
self.assertEqual(['open_repository'], fake_bzrdir.calls)
597
# Stringifying twice doesn't try to open a repository twice.
599
self.assertEqual(['open_repository'], fake_bzrdir.calls)