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",
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$")
41
66
def test_corrupt_dirstate(self):
42
67
error = errors.CorruptDirstate('path/to/dirstate', 'the reason why')
73
93
" 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))
96
def test_incompatibleVersion(self):
97
error = errors.IncompatibleVersion("module", [(4, 5, 6), (7, 8, 9)],
78
99
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)".',
100
'API module is not compatible; one of versions '
101
'[(4, 5, 6), (7, 8, 9)] is required, but current version is '
83
105
def test_inconsistent_delta(self):
103
125
error = errors.InvalidHttpRange('path',
104
126
'Content-Range: potatoes 0-00/o0oo0',
106
self.assertEquals("Invalid http range"
107
" 'Content-Range: potatoes 0-00/o0oo0'"
108
" for path: bad range",
128
self.assertEqual("Invalid http range"
129
" 'Content-Range: potatoes 0-00/o0oo0'"
130
" for path: bad range",
111
133
def test_invalid_range(self):
112
134
error = errors.InvalidRange('path', 12, 'bad range')
113
self.assertEquals("Invalid range access in path at 12: bad range",
135
self.assertEqual("Invalid range access in path at 12: bad range",
116
138
def test_inventory_modified(self):
117
139
error = errors.InventoryModified("a tree to be repred")
162
191
self.assertEqualDiff(
163
192
"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
194
def test_no_smart_medium(self):
179
195
error = errors.NoSmartMedium("a transport")
180
196
self.assertEqualDiff("The transport 'a transport' cannot tunnel the "
181
197
"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
200
def test_no_such_id(self):
191
201
error = errors.NoSuchId("atree", "anid")
192
202
self.assertEqualDiff("The file id \"anid\" is not present in the tree "
232
242
def test_unknown_hook(self):
233
243
error = errors.UnknownHook("branch", "foo")
234
244
self.assertEqualDiff("The branch hook 'foo' is unknown in this version"
237
247
error = errors.UnknownHook("tree", "bar")
238
248
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
252
def test_unstackable_location(self):
265
266
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,
267
error = errors.UpToDateFormat("someformat")
268
self.assertEqualDiff(
269
"The branch format someformat is already at the most "
270
"recent format.", str(error))
280
272
def test_read_error(self):
281
273
# a unicode path to check that %r is being used.
283
275
error = errors.ReadError(path)
284
self.assertEqualDiff("Error reading from u'a path'.", str(error))
276
self.assertContainsRe(str(error), "^Error reading from u?'a path'.$")
286
278
def test_bad_index_format_signature(self):
287
279
error = errors.BadIndexFormatSignature("foo", "bar")
313
305
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'],
323
308
def test_bzrerror_from_literal_string(self):
324
309
# Some code constructs BzrError from a literal string, in which case
325
310
# no further formatting is done. (I'm not sure raising the base class
408
393
"location specified in the merge directive is not a branch: "
409
394
"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
396
def test_unexpected_smart_server_response(self):
428
397
e = errors.UnexpectedSmartServerResponse(('not yes',))
429
398
self.assertEqual(
467
436
def test_duplicate_record_name_error(self):
468
437
"""Test the formatting of DuplicateRecordNameError."""
469
e = errors.DuplicateRecordNameError(u"n\xe5me".encode('utf-8'))
438
e = errors.DuplicateRecordNameError(b"n\xc3\xa5me")
470
439
self.assertEqual(
471
"Container has multiple records with the same name: n\xc3\xa5me",
440
u"Container has multiple records with the same name: n\xe5me",
474
443
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
444
e = errors.BzrCheckError('example check failure')
478
445
self.assertEqual(
479
446
"Internal check failed: example check failure",
497
464
def test_unable_create_symlink(self):
498
465
err = errors.UnableCreateSymlink()
500
467
"Unable to create symlink on this platform",
502
469
err = errors.UnableCreateSymlink(path=u'foo')
504
471
"Unable to create symlink 'foo' on this platform",
506
473
err = errors.UnableCreateSymlink(path=u'\xb5')
508
"Unable to create symlink u'\\xb5' on this platform",
475
"Unable to create symlink %s on this platform" % repr(u'\xb5'),
511
478
def test_invalid_url_join(self):
515
482
"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
485
def test_unable_encode_path(self):
526
486
err = errors.UnableEncodePath('foo', 'executable')
527
self.assertEquals("Unable to encode executable path 'foo' in "
528
"user encoding " + osutils.get_user_encoding(),
487
self.assertEqual("Unable to encode executable path 'foo' in "
488
"user encoding " + osutils.get_user_encoding(),
531
491
def test_unknown_format(self):
532
492
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')
493
self.assertEqual("Unknown foo format: 'bar'", str(err))
551
495
def test_tip_change_rejected(self):
552
496
err = errors.TipChangeRejected(u'Unicode message\N{INTERROBANG}')
554
498
u'Tip change rejected: Unicode message\N{INTERROBANG}',
557
'Tip change rejected: Unicode message\xe2\x80\xbd',
560
501
def test_error_from_smart_server(self):
561
502
error_tuple = ('error', 'tuple')
562
503
err = errors.ErrorFromSmartServer(error_tuple)
564
505
"Error received from smart server: ('error', 'tuple')", str(err))
566
507
def test_untranslateable_error_from_smart_server(self):
567
508
error_tuple = ('error', 'tuple')
568
509
orig_err = errors.ErrorFromSmartServer(error_tuple)
569
510
err = errors.UnknownErrorFromSmartServer(orig_err)
571
512
"Server sent an unexpected error: ('error', 'tuple')", str(err))
573
514
def test_smart_message_handler_error(self):
576
517
raise Exception("example error")
577
518
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")
519
err = errors.SmartMessageHandlerError(sys.exc_info())
520
# GZ 2010-11-08: Should not store exc_info in exception instances.
522
self.assertStartsWith(
523
str(err), "The message handler raised an exception:\n")
524
self.assertEndsWith(str(err), "Exception: example error\n")
584
528
def test_must_have_working_tree(self):
585
529
err = errors.MustHaveWorkingTree('foo', 'bar')
586
530
self.assertEqual(str(err), "Branching 'bar'(foo) must create a"
587
531
" working tree.")
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))
611
533
def test_unresumable_write_group(self):
612
534
repo = "dummy repo"
613
535
wg_tokens = ['token']
627
549
err = errors.NotBranchError('path')
628
550
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')
552
def test_not_branch_bzrdir_with_recursive_not_branch_error(self):
643
553
class FakeBzrDir(object):
646
554
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)
555
# str() on the NotBranchError will trigger a call to this,
556
# which in turn will another, identical NotBranchError.
557
raise errors.NotBranchError('path', controldir=FakeBzrDir())
558
err = errors.NotBranchError('path', controldir=FakeBzrDir())
559
self.assertEqual('Not a branch: "path": NotBranchError.', str(err))
561
def test_recursive_bind(self):
562
error = errors.RecursiveBind('foo_bar_branch')
563
msg = ('Branch "foo_bar_branch" appears to be bound to itself. '
564
'Please use `brz unbind` to fix.')
565
self.assertEqualDiff(msg, str(error))
567
def test_retry_with_new_packs(self):
568
fake_exc_info = ('{exc type}', '{exc value}', '{exc traceback}')
569
error = errors.RetryWithNewPacks(
570
'{context}', reload_occurred=False, exc_info=fake_exc_info)
572
'Pack files have changed, reload and retry. context: '
573
'{context} {exc value}', str(error))
659
576
class PassThroughError(errors.BzrError):
688
605
def test_missing_format_string(self):
689
606
e = ErrorWithNoFormat(param='randomvalue')
690
s = self.callDeprecated(
691
['ErrorWithNoFormat uses its docstring as a format, it should use _fmt instead'],
695
"This class has a docstring but no format string.")
607
self.assertStartsWith(str(e),
608
"Unprintable exception ErrorWithNoFormat")
697
610
def test_mismatched_format_args(self):
698
611
# Even though ErrorWithBadFormat's format string does not match the
703
616
str(e), 'Unprintable exception ErrorWithBadFormat')
705
618
def test_cannot_bind_address(self):
706
# see <https://bugs.edge.launchpad.net/bzr/+bug/286871>
619
# see <https://bugs.launchpad.net/bzr/+bug/286871>
707
620
e = errors.CannotBindAddress('example.com', 22,
708
socket.error(13, 'Permission denied'))
709
self.assertContainsRe(str(e),
621
socket.error(13, 'Permission denied'))
622
self.assertContainsRe(
710
624
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.",
626
def test_transform_rename_failed(self):
627
e = errors.TransformRenameFailed(u"from", u"to", "readonly file", 2)
629
u"Failed to rename from to to: readonly file",
633
class TestErrorsUsingTransport(tests.TestCaseWithMemoryTransport):
634
"""Tests for errors that need to use a branch or repo."""
636
def test_no_public_branch(self):
637
b = self.make_branch('.')
638
error = errors.NoPublicBranch(b)
639
url = urlutils.unescape_for_display(b.base, 'ascii')
640
self.assertEqualDiff(
641
'There is no public branch set for "%s".' % url, str(error))
643
def test_no_repo(self):
644
dir = controldir.ControlDir.create(self.get_url())
645
error = errors.NoRepositoryPresent(dir)
646
self.assertNotEqual(-1, str(error).find((dir.transport.clone('..').base)))
647
self.assertEqual(-1, str(error).find((dir.transport.base)))
649
def test_corrupt_repository(self):
650
repo = self.make_repository('.')
651
error = errors.CorruptRepository(repo)
652
self.assertEqualDiff("An error has been detected in the repository %s.\n"
653
"Please run brz reconcile on this repository." %
654
repo.controldir.root_transport.base,
657
def test_not_branch_bzrdir_with_repo(self):
658
controldir = self.make_repository('repo').controldir
659
err = errors.NotBranchError('path', controldir=controldir)
661
'Not a branch: "path": location is a repository.', str(err))
663
def test_not_branch_bzrdir_without_repo(self):
664
controldir = self.make_controldir('bzrdir')
665
err = errors.NotBranchError('path', controldir=controldir)
666
self.assertEqual('Not a branch: "path".', str(err))
668
def test_not_branch_laziness(self):
669
real_bzrdir = self.make_controldir('path')
670
class FakeBzrDir(object):
673
def open_repository(self):
674
self.calls.append('open_repository')
675
raise errors.NoRepositoryPresent(real_bzrdir)
676
fake_bzrdir = FakeBzrDir()
677
err = errors.NotBranchError('path', controldir=fake_bzrdir)
678
self.assertEqual([], fake_bzrdir.calls)
680
self.assertEqual(['open_repository'], fake_bzrdir.calls)
681
# Stringifying twice doesn't try to open a repository twice.
683
self.assertEqual(['open_repository'], fake_bzrdir.calls)