13
14
# You should have received a copy of the GNU General Public License
14
15
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
18
"""Tests for the formatting and construction of errors."""
24
20
from bzrlib import (
30
from bzrlib.tests import (
32
TestCaseWithTransport,
24
from bzrlib.tests import TestCase, TestCaseWithTransport
27
# TODO: Make sure builtin exception class formats are consistent - e.g. should
28
# or shouldn't end with a full stop, etc.
37
31
class TestErrors(TestCaseWithTransport):
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
subclasses_present = getattr(errors.BzrError, '__subclasses__', None)
49
if not subclasses_present:
50
raise TestSkipped('__subclasses__ attribute required for classes. '
51
'Requires Python 2.5 or later.')
52
for c in errors.BzrError.__subclasses__():
53
init = getattr(c, '__init__', None)
54
fmt = getattr(c, '_fmt', None)
56
args = inspect.getargspec(init)[0]
57
self.assertFalse('message' in args,
58
('Argument name "message" not allowed for '
59
'"errors.%s.__init__"' % c.__name__))
60
if fmt and fmt_pattern.search(fmt):
61
self.assertFalse(True, ('"message" not allowed in '
62
'"errors.%s._fmt"' % c.__name__))
64
def test_bad_filename_encoding(self):
65
error = errors.BadFilenameEncoding('bad/filen\xe5me', 'UTF-8')
67
"Filename 'bad/filen\\xe5me' is not valid in your current"
68
" filesystem encoding UTF-8",
71
def test_corrupt_dirstate(self):
72
error = errors.CorruptDirstate('path/to/dirstate', 'the reason why')
74
"Inconsistency in dirstate file path/to/dirstate.\n"
75
"Error: the reason why",
78
def test_dirstate_corrupt(self):
79
error = errors.DirstateCorrupt('.bzr/checkout/dirstate',
80
'trailing garbage: "x"')
81
self.assertEqualDiff("The dirstate file (.bzr/checkout/dirstate)"
82
" appears to be corrupt: trailing garbage: \"x\"",
85
33
def test_disabled_method(self):
86
34
error = errors.DisabledMethod("class name")
87
35
self.assertEqualDiff(
92
40
self.assertEqualDiff('File id {a_file_id} already exists in inventory'
93
41
' as foo', str(error))
95
def test_duplicate_help_prefix(self):
96
error = errors.DuplicateHelpPrefix('foo')
97
self.assertEqualDiff('The prefix foo is in the help search path twice.',
100
def test_ghost_revisions_have_no_revno(self):
101
error = errors.GhostRevisionsHaveNoRevno('target', 'ghost_rev')
102
self.assertEqualDiff("Could not determine revno for {target} because"
103
" its ancestry shows a ghost at {ghost_rev}",
106
def test_incompatibleAPI(self):
107
error = errors.IncompatibleAPI("module", (1, 2, 3), (4, 5, 6), (7, 8, 9))
108
self.assertEqualDiff(
109
'The API for "module" is not compatible with "(1, 2, 3)". '
110
'It supports versions "(4, 5, 6)" to "(7, 8, 9)".',
113
def test_inconsistent_delta(self):
114
error = errors.InconsistentDelta('path', 'file-id', 'reason for foo')
115
self.assertEqualDiff(
116
"An inconsistent delta was supplied involving 'path', 'file-id'\n"
117
"reason: reason for foo",
120
def test_inconsistent_delta_delta(self):
121
error = errors.InconsistentDeltaDelta([], 'reason')
122
self.assertEqualDiff(
123
"An inconsistent delta was supplied: []\nreason: reason",
126
def test_in_process_transport(self):
127
error = errors.InProcessTransport('fpp')
128
self.assertEqualDiff(
129
"The transport 'fpp' is only accessible within this process.",
132
def test_invalid_http_range(self):
133
error = errors.InvalidHttpRange('path',
134
'Content-Range: potatoes 0-00/o0oo0',
136
self.assertEquals("Invalid http range"
137
" 'Content-Range: potatoes 0-00/o0oo0'"
138
" for path: bad range",
141
def test_invalid_range(self):
142
error = errors.InvalidRange('path', 12, 'bad range')
143
self.assertEquals("Invalid range access in path at 12: bad range",
146
43
def test_inventory_modified(self):
147
44
error = errors.InventoryModified("a tree to be repred")
148
45
self.assertEqualDiff("The current inventory for the tree 'a tree to "
198
78
error = errors.MediumNotConnected("a medium")
199
79
self.assertEqualDiff(
200
80
"The medium 'a medium' is not connected.", str(error))
202
def test_no_public_branch(self):
203
b = self.make_branch('.')
204
error = errors.NoPublicBranch(b)
205
url = urlutils.unescape_for_display(b.base, 'ascii')
206
self.assertEqualDiff(
207
'There is no public branch set for "%s".' % url, str(error))
209
82
def test_no_repo(self):
210
83
dir = bzrdir.BzrDir.create(self.get_url())
211
84
error = errors.NoRepositoryPresent(dir)
212
85
self.assertNotEqual(-1, str(error).find((dir.transport.clone('..').base)))
213
86
self.assertEqual(-1, str(error).find((dir.transport.base)))
215
88
def test_no_smart_medium(self):
216
89
error = errors.NoSmartMedium("a transport")
217
90
self.assertEqualDiff("The transport 'a transport' cannot tunnel the "
218
91
"smart protocol.",
221
def test_no_help_topic(self):
222
error = errors.NoHelpTopic("topic")
223
self.assertEqualDiff("No help could be found for 'topic'. "
224
"Please use 'bzr help topics' to obtain a list of topics.",
227
94
def test_no_such_id(self):
228
95
error = errors.NoSuchId("atree", "anid")
229
self.assertEqualDiff("The file id \"anid\" is not present in the tree "
96
self.assertEqualDiff("The file id anid is not present in the tree "
233
100
def test_no_such_revision_in_tree(self):
234
101
error = errors.NoSuchRevisionInTree("atree", "anid")
235
self.assertEqualDiff("The revision id {anid} is not present in the"
236
" tree atree.", str(error))
102
self.assertEqualDiff("The revision id anid is not present in the tree "
237
105
self.assertIsInstance(error, errors.NoSuchRevision)
239
def test_not_stacked(self):
240
error = errors.NotStacked('a branch')
241
self.assertEqualDiff("The branch 'a branch' is not stacked.",
244
107
def test_not_write_locked(self):
245
108
error = errors.NotWriteLocked('a thing to repr')
246
109
self.assertEqualDiff("'a thing to repr' is not write locked but needs "
250
def test_lock_failed(self):
251
error = errors.LockFailed('http://canonical.com/', 'readonly transport')
252
self.assertEqualDiff("Cannot lock http://canonical.com/: readonly transport",
254
self.assertFalse(error.internal_error)
113
def test_read_only_lock_error(self):
114
error = errors.ReadOnlyLockError('filename', 'error message')
115
self.assertEqualDiff("Cannot acquire write lock on filename."
116
" error message", str(error))
256
118
def test_too_many_concurrent_requests(self):
257
119
error = errors.TooManyConcurrentRequests("a medium")
258
120
self.assertEqualDiff("The medium 'a medium' has reached its concurrent "
259
121
"request limit. Be sure to finish_writing and finish_reading on "
260
"the currently open request.",
263
def test_unavailable_representation(self):
264
error = errors.UnavailableRepresentation(('key',), "mpdiff", "fulltext")
265
self.assertEqualDiff("The encoding 'mpdiff' is not available for key "
266
"('key',) which is encoded as 'fulltext'.",
122
"the current request that is open.",
269
125
def test_unknown_hook(self):
436
233
host='ahost', port=444, msg='Unable to connect to ssh host',
437
234
orig_error='my_error')
439
def test_target_not_branch(self):
440
"""Test the formatting of TargetNotBranch."""
441
error = errors.TargetNotBranch('foo')
443
"Your branch does not have all of the revisions required in "
444
"order to merge this merge directive and the target "
445
"location specified in the merge directive is not a branch: "
448
def test_malformed_bug_identifier(self):
449
"""Test the formatting of MalformedBugIdentifier."""
450
error = errors.MalformedBugIdentifier('bogus', 'reason for bogosity')
452
'Did not understand bug identifier bogus: reason for bogosity. '
453
'See "bzr help bugs" for more information on this feature.',
456
def test_unknown_bug_tracker_abbreviation(self):
457
"""Test the formatting of UnknownBugTrackerAbbreviation."""
458
branch = self.make_branch('some_branch')
459
error = errors.UnknownBugTrackerAbbreviation('xxx', branch)
461
"Cannot find registered bug tracker called xxx on %s" % branch,
464
def test_unexpected_smart_server_response(self):
465
e = errors.UnexpectedSmartServerResponse(('not yes',))
467
"Could not understand response from smart server: ('not yes',)",
470
def test_unknown_container_format(self):
471
"""Test the formatting of UnknownContainerFormatError."""
472
e = errors.UnknownContainerFormatError('bad format string')
474
"Unrecognised container format: 'bad format string'",
477
def test_unexpected_end_of_container(self):
478
"""Test the formatting of UnexpectedEndOfContainerError."""
479
e = errors.UnexpectedEndOfContainerError()
481
"Unexpected end of container stream", str(e))
483
def test_unknown_record_type(self):
484
"""Test the formatting of UnknownRecordTypeError."""
485
e = errors.UnknownRecordTypeError("X")
487
"Unknown record type: 'X'",
490
def test_invalid_record(self):
491
"""Test the formatting of InvalidRecordError."""
492
e = errors.InvalidRecordError("xxx")
494
"Invalid record: xxx",
497
def test_container_has_excess_data(self):
498
"""Test the formatting of ContainerHasExcessDataError."""
499
e = errors.ContainerHasExcessDataError("excess bytes")
501
"Container has data after end marker: 'excess bytes'",
504
def test_duplicate_record_name_error(self):
505
"""Test the formatting of DuplicateRecordNameError."""
506
e = errors.DuplicateRecordNameError(u"n\xe5me".encode('utf-8'))
508
"Container has multiple records with the same name: n\xc3\xa5me",
511
def test_check_error(self):
512
# This has a member called 'message', which is problematic in
513
# python2.5 because that is a slot on the base Exception class
514
e = errors.BzrCheckError('example check failure')
516
"Internal check failed: example check failure",
518
self.assertTrue(e.internal_error)
520
def test_repository_data_stream_error(self):
521
"""Test the formatting of RepositoryDataStreamError."""
522
e = errors.RepositoryDataStreamError(u"my reason")
524
"Corrupt or incompatible data stream: my reason", str(e))
526
def test_immortal_pending_deletion_message(self):
527
err = errors.ImmortalPendingDeletion('foo')
529
"Unable to delete transform temporary directory foo. "
530
"Please examine foo to see if it contains any files "
531
"you wish to keep, and delete it when you are done.",
534
def test_unable_create_symlink(self):
535
err = errors.UnableCreateSymlink()
537
"Unable to create symlink on this platform",
539
err = errors.UnableCreateSymlink(path=u'foo')
541
"Unable to create symlink 'foo' on this platform",
543
err = errors.UnableCreateSymlink(path=u'\xb5')
545
"Unable to create symlink u'\\xb5' on this platform",
548
def test_invalid_url_join(self):
549
"""Test the formatting of InvalidURLJoin."""
550
e = errors.InvalidURLJoin('Reason', 'base path', ('args',))
552
"Invalid URL join request: Reason: 'base path' + ('args',)",
555
def test_incorrect_url(self):
556
err = errors.InvalidBugTrackerURL('foo', 'http://bug.com/')
558
("The URL for bug tracker \"foo\" doesn't contain {id}: "
562
def test_unable_encode_path(self):
563
err = errors.UnableEncodePath('foo', 'executable')
564
self.assertEquals("Unable to encode executable path 'foo' in "
565
"user encoding " + osutils.get_user_encoding(),
568
def test_unknown_format(self):
569
err = errors.UnknownFormatError('bar', kind='foo')
570
self.assertEquals("Unknown foo format: 'bar'", str(err))
572
def test_unknown_rules(self):
573
err = errors.UnknownRules(['foo', 'bar'])
574
self.assertEquals("Unknown rules detected: foo, bar.", str(err))
576
def test_hook_failed(self):
577
# Create an exc_info tuple by raising and catching an exception.
580
except ZeroDivisionError:
581
exc_info = sys.exc_info()
582
err = errors.HookFailed('hook stage', 'hook name', exc_info, warn=False)
583
self.assertStartsWith(
584
str(err), 'Hook \'hook name\' during hook stage failed:\n')
586
str(err), 'integer division or modulo by zero')
588
def test_tip_change_rejected(self):
589
err = errors.TipChangeRejected(u'Unicode message\N{INTERROBANG}')
591
u'Tip change rejected: Unicode message\N{INTERROBANG}',
594
'Tip change rejected: Unicode message\xe2\x80\xbd',
597
def test_error_from_smart_server(self):
598
error_tuple = ('error', 'tuple')
599
err = errors.ErrorFromSmartServer(error_tuple)
601
"Error received from smart server: ('error', 'tuple')", str(err))
603
def test_untranslateable_error_from_smart_server(self):
604
error_tuple = ('error', 'tuple')
605
orig_err = errors.ErrorFromSmartServer(error_tuple)
606
err = errors.UnknownErrorFromSmartServer(orig_err)
608
"Server sent an unexpected error: ('error', 'tuple')", str(err))
610
def test_smart_message_handler_error(self):
611
# Make an exc_info tuple.
613
raise Exception("example error")
615
exc_info = sys.exc_info()
616
err = errors.SmartMessageHandlerError(exc_info)
617
self.assertStartsWith(
618
str(err), "The message handler raised an exception:\n")
619
self.assertEndsWith(str(err), "Exception: example error\n")
621
def test_must_have_working_tree(self):
622
err = errors.MustHaveWorkingTree('foo', 'bar')
623
self.assertEqual(str(err), "Branching 'bar'(foo) must create a"
626
def test_no_such_view(self):
627
err = errors.NoSuchView('foo')
628
self.assertEquals("No such view: foo.", str(err))
630
def test_views_not_supported(self):
631
err = errors.ViewsNotSupported('atree')
633
self.assertStartsWith(err_str, "Views are not supported by ")
634
self.assertEndsWith(err_str, "; use 'bzr upgrade' to change your "
635
"tree to a later format.")
637
def test_file_outside_view(self):
638
err = errors.FileOutsideView('baz', ['foo', 'bar'])
639
self.assertEquals('Specified file "baz" is outside the current view: '
640
'foo, bar', str(err))
642
def test_invalid_shelf_id(self):
644
err = errors.InvalidShelfId(invalid_id)
645
self.assertEqual('"foo" is not a valid shelf id, '
646
'try a number instead.', str(err))
648
def test_unresumable_write_group(self):
650
wg_tokens = ['token']
652
err = errors.UnresumableWriteGroup(repo, wg_tokens, reason)
654
"Repository dummy repo cannot resume write group "
655
"['token']: a reason", str(err))
657
def test_unsuspendable_write_group(self):
659
err = errors.UnsuspendableWriteGroup(repo)
661
'Repository dummy repo cannot suspend a write group.', str(err))
663
def test_not_branch_no_args(self):
664
err = errors.NotBranchError('path')
665
self.assertEqual('Not a branch: "path".', str(err))
667
def test_not_branch_bzrdir_with_repo(self):
668
bzrdir = self.make_repository('repo').bzrdir
669
err = errors.NotBranchError('path', bzrdir=bzrdir)
671
'Not a branch: "path": location is a repository.', str(err))
673
def test_not_branch_bzrdir_without_repo(self):
674
bzrdir = self.make_bzrdir('bzrdir')
675
err = errors.NotBranchError('path', bzrdir=bzrdir)
676
self.assertEqual('Not a branch: "path".', str(err))
678
def test_not_branch_bzrdir_with_recursive_not_branch_error(self):
679
class FakeBzrDir(object):
680
def open_repository(self):
681
# str() on the NotBranchError will trigger a call to this,
682
# which in turn will another, identical NotBranchError.
683
raise errors.NotBranchError('path', bzrdir=FakeBzrDir())
684
err = errors.NotBranchError('path', bzrdir=FakeBzrDir())
685
self.assertEqual('Not a branch: "path".', str(err))
687
def test_not_branch_laziness(self):
688
real_bzrdir = self.make_bzrdir('path')
689
class FakeBzrDir(object):
692
def open_repository(self):
693
self.calls.append('open_repository')
694
raise errors.NoRepositoryPresent(real_bzrdir)
695
fake_bzrdir = FakeBzrDir()
696
err = errors.NotBranchError('path', bzrdir=fake_bzrdir)
697
self.assertEqual([], fake_bzrdir.calls)
699
self.assertEqual(['open_repository'], fake_bzrdir.calls)
700
# Stringifying twice doesn't try to open a repository twice.
702
self.assertEqual(['open_repository'], fake_bzrdir.calls)
704
def test_invalid_pattern(self):
705
error = errors.InvalidPattern('Bad pattern msg.')
706
self.assertEqualDiff("Invalid pattern(s) found. Bad pattern msg.",
709
def test_recursive_bind(self):
710
error = errors.RecursiveBind('foo_bar_branch')
711
msg = ('Branch "foo_bar_branch" appears to be bound to itself. '
712
'Please use `bzr unbind` to fix.')
713
self.assertEqualDiff(msg, str(error))
716
238
class PassThroughError(errors.BzrError):
718
240
_fmt = """Pass through %(foo)s and %(bar)s"""
720
242
def __init__(self, foo, bar):
added
removed
bzrlib/tests/test_errors.py
