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)
52
args = inspect.getargspec(init)[0]
53
self.assertFalse('message' in args,
54
('Argument name "message" not allowed for '
55
'"errors.%s.__init__"' % c.__name__))
56
if fmt and fmt_pattern.search(fmt):
57
self.assertFalse(True, ('"message" not allowed in '
58
'"errors.%s._fmt"' % c.__name__))
34
60
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))
61
error = errors.BadFilenameEncoding(b'bad/filen\xe5me', 'UTF-8')
62
self.assertContainsRe(
64
"^Filename b?'bad/filen\\\\xe5me' is not valid in your current"
65
" filesystem encoding UTF-8$")
60
67
def test_duplicate_file_id(self):
61
68
error = errors.DuplicateFileId('a_file_id', 'foo')
73
80
" 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))
83
def test_incompatibleVersion(self):
84
error = errors.IncompatibleVersion("module", [(4, 5, 6), (7, 8, 9)],
78
86
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)".',
87
'API module is not compatible; one of versions '
88
'[(4, 5, 6), (7, 8, 9)] is required, but current version is '
83
92
def test_inconsistent_delta(self):
103
112
error = errors.InvalidHttpRange('path',
104
113
'Content-Range: potatoes 0-00/o0oo0',
106
self.assertEquals("Invalid http range"
107
" 'Content-Range: potatoes 0-00/o0oo0'"
108
" for path: bad range",
115
self.assertEqual("Invalid http range"
116
" 'Content-Range: potatoes 0-00/o0oo0'"
117
" for path: bad range",
111
120
def test_invalid_range(self):
112
121
error = errors.InvalidRange('path', 12, 'bad range')
113
self.assertEquals("Invalid range access in path at 12: bad range",
122
self.assertEqual("Invalid range access in path at 12: bad range",
116
125
def test_inventory_modified(self):
117
126
error = errors.InventoryModified("a tree to be repred")
132
141
"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']",
144
def test_lock_corrupt(self):
145
error = errors.LockCorrupt("corruption info")
146
self.assertEqualDiff("Lock is apparently held, but corrupted: "
148
"Use 'brz break-lock' to clear it",
160
151
def test_medium_not_connected(self):
161
152
error = errors.MediumNotConnected("a medium")
162
153
self.assertEqualDiff(
163
154
"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
156
def test_no_smart_medium(self):
179
157
error = errors.NoSmartMedium("a transport")
180
158
self.assertEqualDiff("The transport 'a transport' cannot tunnel the "
181
159
"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
162
def test_no_such_id(self):
191
163
error = errors.NoSuchId("atree", "anid")
192
164
self.assertEqualDiff("The file id \"anid\" is not present in the tree "
229
201
"('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
204
def test_unstackable_location(self):
252
205
error = errors.UnstackableLocationError('foo', 'bar')
253
206
self.assertEqualDiff("The branch 'foo' cannot be stacked on 'bar'.",
265
218
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,
219
error = errors.UpToDateFormat("someformat")
220
self.assertEqualDiff(
221
"The branch format someformat is already at the most "
222
"recent format.", str(error))
280
224
def test_read_error(self):
281
225
# a unicode path to check that %r is being used.
283
227
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'],
228
self.assertContainsRe(str(error), "^Error reading from u?'a path'.$")
323
230
def test_bzrerror_from_literal_string(self):
324
231
# Some code constructs BzrError from a literal string, in which case
408
315
"location specified in the merge directive is not a branch: "
409
316
"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
318
def test_unexpected_smart_server_response(self):
428
319
e = errors.UnexpectedSmartServerResponse(('not yes',))
429
320
self.assertEqual(
467
358
def test_duplicate_record_name_error(self):
468
359
"""Test the formatting of DuplicateRecordNameError."""
469
e = errors.DuplicateRecordNameError(u"n\xe5me".encode('utf-8'))
360
e = errors.DuplicateRecordNameError(b"n\xc3\xa5me")
470
361
self.assertEqual(
471
"Container has multiple records with the same name: n\xc3\xa5me",
362
u"Container has multiple records with the same name: n\xe5me",
474
365
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
366
e = errors.BzrCheckError('example check failure')
478
367
self.assertEqual(
479
368
"Internal check failed: example check failure",
497
386
def test_unable_create_symlink(self):
498
387
err = errors.UnableCreateSymlink()
500
389
"Unable to create symlink on this platform",
502
391
err = errors.UnableCreateSymlink(path=u'foo')
504
393
"Unable to create symlink 'foo' on this platform",
506
395
err = errors.UnableCreateSymlink(path=u'\xb5')
508
"Unable to create symlink u'\\xb5' on this platform",
397
"Unable to create symlink %s on this platform" % repr(u'\xb5'),
511
400
def test_invalid_url_join(self):
512
401
"""Test the formatting of InvalidURLJoin."""
513
e = errors.InvalidURLJoin('Reason', 'base path', ('args',))
402
e = urlutils.InvalidURLJoin('Reason', 'base path', ('args',))
514
403
self.assertEqual(
515
404
"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
407
def test_unable_encode_path(self):
526
408
err = errors.UnableEncodePath('foo', 'executable')
527
self.assertEquals("Unable to encode executable path 'foo' in "
528
"user encoding " + osutils.get_user_encoding(),
409
self.assertEqual("Unable to encode executable path 'foo' in "
410
"user encoding " + osutils.get_user_encoding(),
531
413
def test_unknown_format(self):
532
414
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')
415
self.assertEqual("Unknown foo format: 'bar'", str(err))
551
417
def test_tip_change_rejected(self):
552
418
err = errors.TipChangeRejected(u'Unicode message\N{INTERROBANG}')
554
420
u'Tip change rejected: Unicode message\N{INTERROBANG}',
557
'Tip change rejected: Unicode message\xe2\x80\xbd',
560
423
def test_error_from_smart_server(self):
561
424
error_tuple = ('error', 'tuple')
562
425
err = errors.ErrorFromSmartServer(error_tuple)
564
427
"Error received from smart server: ('error', 'tuple')", str(err))
566
429
def test_untranslateable_error_from_smart_server(self):
567
430
error_tuple = ('error', 'tuple')
568
431
orig_err = errors.ErrorFromSmartServer(error_tuple)
569
432
err = errors.UnknownErrorFromSmartServer(orig_err)
571
434
"Server sent an unexpected error: ('error', 'tuple')", str(err))
573
436
def test_smart_message_handler_error(self):
576
439
raise Exception("example error")
577
440
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))
441
err = errors.SmartMessageHandlerError(sys.exc_info())
442
# GZ 2010-11-08: Should not store exc_info in exception instances.
444
self.assertStartsWith(
445
str(err), "The message handler raised an exception:\n")
446
self.assertEndsWith(str(err), "Exception: example error\n")
611
450
def test_unresumable_write_group(self):
612
451
repo = "dummy repo"
627
466
err = errors.NotBranchError('path')
628
467
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')
469
def test_not_branch_bzrdir_with_recursive_not_branch_error(self):
643
470
class FakeBzrDir(object):
646
471
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)
472
# str() on the NotBranchError will trigger a call to this,
473
# which in turn will another, identical NotBranchError.
474
raise errors.NotBranchError('path', controldir=FakeBzrDir())
475
err = errors.NotBranchError('path', controldir=FakeBzrDir())
476
self.assertEqual('Not a branch: "path": NotBranchError.', str(err))
478
def test_recursive_bind(self):
479
error = errors.RecursiveBind('foo_bar_branch')
480
msg = ('Branch "foo_bar_branch" appears to be bound to itself. '
481
'Please use `brz unbind` to fix.')
482
self.assertEqualDiff(msg, str(error))
484
def test_retry_with_new_packs(self):
485
fake_exc_info = ('{exc type}', '{exc value}', '{exc traceback}')
486
error = errors.RetryWithNewPacks(
487
'{context}', reload_occurred=False, exc_info=fake_exc_info)
489
'Pack files have changed, reload and retry. context: '
490
'{context} {exc value}', str(error))
659
493
class PassThroughError(errors.BzrError):
673
507
__doc__ = """This class has a docstring but no format string."""
676
class TestErrorFormatting(TestCase):
510
class TestErrorFormatting(tests.TestCase):
678
512
def test_always_str(self):
679
513
e = PassThroughError(u'\xb5', 'bar')
680
514
self.assertIsInstance(e.__str__(), str)
681
# In Python str(foo) *must* return a real byte string
515
# In Python 2 str(foo) *must* return a real byte string
682
516
# not a Unicode string. The following line would raise a
683
517
# Unicode error, because it tries to call str() on the string
684
518
# returned from e.__str__(), and it has non ascii characters
686
self.assertEqual('Pass through \xc2\xb5 and bar', s)
521
self.assertEqual('Pass through \xb5 and bar', s)
523
self.assertEqual('Pass through \xc2\xb5 and bar', s)
688
525
def test_missing_format_string(self):
689
526
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.")
527
self.assertStartsWith(str(e),
528
"Unprintable exception ErrorWithNoFormat")
697
530
def test_mismatched_format_args(self):
698
531
# Even though ErrorWithBadFormat's format string does not match the
703
536
str(e), 'Unprintable exception ErrorWithBadFormat')
705
538
def test_cannot_bind_address(self):
706
# see <https://bugs.edge.launchpad.net/bzr/+bug/286871>
539
# see <https://bugs.launchpad.net/bzr/+bug/286871>
707
540
e = errors.CannotBindAddress('example.com', 22,
708
socket.error(13, 'Permission denied'))
709
self.assertContainsRe(str(e),
541
socket.error(13, 'Permission denied'))
542
self.assertContainsRe(
710
544
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.",
546
def test_transform_rename_failed(self):
547
e = errors.TransformRenameFailed(u"from", u"to", "readonly file", 2)
549
u"Failed to rename from to to: readonly file",
553
class TestErrorsUsingTransport(tests.TestCaseWithMemoryTransport):
554
"""Tests for errors that need to use a branch or repo."""
556
def test_no_public_branch(self):
557
b = self.make_branch('.')
558
error = errors.NoPublicBranch(b)
559
url = urlutils.unescape_for_display(b.base, 'ascii')
560
self.assertEqualDiff(
561
'There is no public branch set for "%s".' % url, str(error))
563
def test_no_repo(self):
564
dir = controldir.ControlDir.create(self.get_url())
565
error = errors.NoRepositoryPresent(dir)
566
self.assertNotEqual(-1, str(error).find((dir.transport.clone('..').base)))
567
self.assertEqual(-1, str(error).find((dir.transport.base)))
569
def test_corrupt_repository(self):
570
repo = self.make_repository('.')
571
error = errors.CorruptRepository(repo)
572
self.assertEqualDiff("An error has been detected in the repository %s.\n"
573
"Please run brz reconcile on this repository." %
574
repo.controldir.root_transport.base,
577
def test_not_branch_bzrdir_with_repo(self):
578
controldir = self.make_repository('repo').controldir
579
err = errors.NotBranchError('path', controldir=controldir)
581
'Not a branch: "path": location is a repository.', str(err))
583
def test_not_branch_bzrdir_without_repo(self):
584
controldir = self.make_controldir('bzrdir')
585
err = errors.NotBranchError('path', controldir=controldir)
586
self.assertEqual('Not a branch: "path".', str(err))
588
def test_not_branch_laziness(self):
589
real_bzrdir = self.make_controldir('path')
590
class FakeBzrDir(object):
593
def open_repository(self):
594
self.calls.append('open_repository')
595
raise errors.NoRepositoryPresent(real_bzrdir)
596
fake_bzrdir = FakeBzrDir()
597
err = errors.NotBranchError('path', controldir=fake_bzrdir)
598
self.assertEqual([], fake_bzrdir.calls)
600
self.assertEqual(['open_repository'], fake_bzrdir.calls)
601
# Stringifying twice doesn't try to open a repository twice.
603
self.assertEqual(['open_repository'], fake_bzrdir.calls)
added
removed
breezy/tests/test_errors.py
