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 (
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__))
34
63
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))
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$")
60
70
def test_duplicate_file_id(self):
61
71
error = errors.DuplicateFileId('a_file_id', 'foo')
73
83
" 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))
86
def test_incompatibleVersion(self):
87
error = errors.IncompatibleVersion("module", [(4, 5, 6), (7, 8, 9)],
78
89
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)".',
90
'API module is not compatible; one of versions '
91
'[(4, 5, 6), (7, 8, 9)] is required, but current version is '
83
95
def test_inconsistent_delta(self):
103
115
error = errors.InvalidHttpRange('path',
104
116
'Content-Range: potatoes 0-00/o0oo0',
106
self.assertEquals("Invalid http range"
107
" 'Content-Range: potatoes 0-00/o0oo0'"
108
" for path: bad range",
118
self.assertEqual("Invalid http range"
119
" 'Content-Range: potatoes 0-00/o0oo0'"
120
" for path: bad range",
111
123
def test_invalid_range(self):
112
124
error = errors.InvalidRange('path', 12, 'bad range')
113
self.assertEquals("Invalid range access in path at 12: bad range",
125
self.assertEqual("Invalid range access in path at 12: bad range",
116
128
def test_inventory_modified(self):
117
129
error = errors.InventoryModified("a tree to be repred")
132
144
"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']",
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",
160
154
def test_medium_not_connected(self):
161
155
error = errors.MediumNotConnected("a medium")
162
156
self.assertEqualDiff(
163
157
"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
159
def test_no_smart_medium(self):
179
160
error = errors.NoSmartMedium("a transport")
180
161
self.assertEqualDiff("The transport 'a transport' cannot tunnel the "
181
162
"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
165
def test_no_such_id(self):
191
166
error = errors.NoSuchId("atree", "anid")
192
167
self.assertEqualDiff("The file id \"anid\" is not present in the tree "
229
204
"('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
207
def test_unstackable_location(self):
252
208
error = errors.UnstackableLocationError('foo', 'bar')
253
209
self.assertEqualDiff("The branch 'foo' cannot be stacked on 'bar'.",
265
221
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,
222
error = errors.UpToDateFormat("someformat")
223
self.assertEqualDiff(
224
"The branch format someformat is already at the most "
225
"recent format.", str(error))
280
227
def test_read_error(self):
281
228
# a unicode path to check that %r is being used.
283
230
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'],
231
self.assertContainsRe(str(error), "^Error reading from u?'a path'.$")
323
233
def test_bzrerror_from_literal_string(self):
324
234
# Some code constructs BzrError from a literal string, in which case
408
318
"location specified in the merge directive is not a branch: "
409
319
"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
321
def test_unexpected_smart_server_response(self):
428
322
e = errors.UnexpectedSmartServerResponse(('not yes',))
429
323
self.assertEqual(
467
361
def test_duplicate_record_name_error(self):
468
362
"""Test the formatting of DuplicateRecordNameError."""
469
e = errors.DuplicateRecordNameError(u"n\xe5me".encode('utf-8'))
363
e = errors.DuplicateRecordNameError(b"n\xc3\xa5me")
470
364
self.assertEqual(
471
"Container has multiple records with the same name: n\xc3\xa5me",
365
u"Container has multiple records with the same name: n\xe5me",
474
368
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
369
e = errors.BzrCheckError('example check failure')
478
370
self.assertEqual(
479
371
"Internal check failed: example check failure",
497
389
def test_unable_create_symlink(self):
498
390
err = errors.UnableCreateSymlink()
500
392
"Unable to create symlink on this platform",
502
394
err = errors.UnableCreateSymlink(path=u'foo')
504
396
"Unable to create symlink 'foo' on this platform",
506
398
err = errors.UnableCreateSymlink(path=u'\xb5')
508
"Unable to create symlink u'\\xb5' on this platform",
400
"Unable to create symlink %s on this platform" % repr(u'\xb5'),
511
403
def test_invalid_url_join(self):
512
404
"""Test the formatting of InvalidURLJoin."""
513
e = errors.InvalidURLJoin('Reason', 'base path', ('args',))
405
e = urlutils.InvalidURLJoin('Reason', 'base path', ('args',))
514
406
self.assertEqual(
515
407
"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
410
def test_unable_encode_path(self):
526
411
err = errors.UnableEncodePath('foo', 'executable')
527
self.assertEquals("Unable to encode executable path 'foo' in "
528
"user encoding " + osutils.get_user_encoding(),
412
self.assertEqual("Unable to encode executable path 'foo' in "
413
"user encoding " + osutils.get_user_encoding(),
531
416
def test_unknown_format(self):
532
417
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')
418
self.assertEqual("Unknown foo format: 'bar'", str(err))
551
420
def test_tip_change_rejected(self):
552
421
err = errors.TipChangeRejected(u'Unicode message\N{INTERROBANG}')
554
423
u'Tip change rejected: Unicode message\N{INTERROBANG}',
557
'Tip change rejected: Unicode message\xe2\x80\xbd',
560
426
def test_error_from_smart_server(self):
561
427
error_tuple = ('error', 'tuple')
562
428
err = errors.ErrorFromSmartServer(error_tuple)
564
430
"Error received from smart server: ('error', 'tuple')", str(err))
566
432
def test_untranslateable_error_from_smart_server(self):
567
433
error_tuple = ('error', 'tuple')
568
434
orig_err = errors.ErrorFromSmartServer(error_tuple)
569
435
err = errors.UnknownErrorFromSmartServer(orig_err)
571
437
"Server sent an unexpected error: ('error', 'tuple')", str(err))
573
439
def test_smart_message_handler_error(self):
576
442
raise Exception("example error")
577
443
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))
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")
611
453
def test_unresumable_write_group(self):
612
454
repo = "dummy repo"
627
469
err = errors.NotBranchError('path')
628
470
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')
472
def test_not_branch_bzrdir_with_recursive_not_branch_error(self):
643
473
class FakeBzrDir(object):
646
474
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)
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))
659
496
class PassThroughError(errors.BzrError):
673
510
__doc__ = """This class has a docstring but no format string."""
676
class TestErrorFormatting(TestCase):
513
class TestErrorFormatting(tests.TestCase):
678
515
def test_always_str(self):
679
516
e = PassThroughError(u'\xb5', 'bar')
680
517
self.assertIsInstance(e.__str__(), str)
681
# In Python str(foo) *must* return a real byte string
518
# In Python 2 str(foo) *must* return a real byte string
682
519
# not a Unicode string. The following line would raise a
683
520
# Unicode error, because it tries to call str() on the string
684
521
# returned from e.__str__(), and it has non ascii characters
686
self.assertEqual('Pass through \xc2\xb5 and bar', s)
524
self.assertEqual('Pass through \xb5 and bar', s)
526
self.assertEqual('Pass through \xc2\xb5 and bar', s)
688
528
def test_missing_format_string(self):
689
529
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.")
530
self.assertStartsWith(str(e),
531
"Unprintable exception ErrorWithNoFormat")
697
533
def test_mismatched_format_args(self):
698
534
# Even though ErrorWithBadFormat's format string does not match the
703
539
str(e), 'Unprintable exception ErrorWithBadFormat')
705
541
def test_cannot_bind_address(self):
706
# see <https://bugs.edge.launchpad.net/bzr/+bug/286871>
542
# see <https://bugs.launchpad.net/bzr/+bug/286871>
707
543
e = errors.CannotBindAddress('example.com', 22,
708
socket.error(13, 'Permission denied'))
709
self.assertContainsRe(str(e),
544
socket.error(13, 'Permission denied'))
545
self.assertContainsRe(
710
547
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.",
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))
566
def test_no_repo(self):
567
dir = controldir.ControlDir.create(self.get_url())
568
error = errors.NoRepositoryPresent(dir)
569
self.assertNotEqual(-1, str(error).find((dir.transport.clone('..').base)))
570
self.assertEqual(-1, str(error).find((dir.transport.base)))
572
def test_corrupt_repository(self):
573
repo = self.make_repository('.')
574
error = errors.CorruptRepository(repo)
575
self.assertEqualDiff("An error has been detected in the repository %s.\n"
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
