14
13
# You should have received a copy of the GNU General Public License
15
14
# along with this program; if not, write to the Free Software
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
17
"""Tests for the formatting and construction of errors."""
20
24
from bzrlib import (
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.
30
from bzrlib.tests import (
32
TestCaseWithTransport,
31
37
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
def test_disabled_method(self):
86
error = errors.DisabledMethod("class name")
88
"The smart server method 'class name' is disabled.", str(error))
90
def test_duplicate_file_id(self):
91
error = errors.DuplicateFileId('a_file_id', 'foo')
92
self.assertEqualDiff('File id {a_file_id} already exists in inventory'
93
' 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",
33
146
def test_inventory_modified(self):
34
147
error = errors.InventoryModified("a tree to be repred")
35
148
self.assertEqualDiff("The current inventory for the tree 'a tree to "
37
150
"read without data loss.",
40
def test_install_failed(self):
41
error = errors.InstallFailed(['rev-one'])
42
self.assertEqual("Could not install revisions:\nrev-one", str(error))
43
error = errors.InstallFailed(['rev-one', 'rev-two'])
44
self.assertEqual("Could not install revisions:\nrev-one, rev-two",
153
def test_jail_break(self):
154
error = errors.JailBreak("some url")
155
self.assertEqualDiff("An attempt to access a url outside the server"
156
" jail was made: 'some url'.",
159
def test_lock_active(self):
160
error = errors.LockActive("lock description")
161
self.assertEqualDiff("The lock for 'lock description' is in use and "
165
def test_lock_corrupt(self):
166
error = errors.LockCorrupt("corruption info")
167
self.assertEqualDiff("Lock is apparently held, but corrupted: "
169
"Use 'bzr break-lock' to clear it",
172
def test_knit_data_stream_incompatible(self):
173
error = errors.KnitDataStreamIncompatible(
174
'stream format', 'target format')
175
self.assertEqual('Cannot insert knit data stream of format '
176
'"stream format" into knit of format '
177
'"target format".', str(error))
179
def test_knit_data_stream_unknown(self):
180
error = errors.KnitDataStreamUnknown(
182
self.assertEqual('Cannot parse knit data stream of format '
183
'"stream format".', str(error))
185
def test_knit_header_error(self):
186
error = errors.KnitHeaderError('line foo\n', 'path/to/file')
187
self.assertEqual("Knit header error: 'line foo\\n' unexpected"
188
" for file \"path/to/file\".", str(error))
190
def test_knit_index_unknown_method(self):
191
error = errors.KnitIndexUnknownMethod('http://host/foo.kndx',
193
self.assertEqual("Knit index http://host/foo.kndx does not have a"
194
" known method in options: ['bad', 'no-eol']",
46
error = errors.InstallFailed([None])
47
self.assertEqual("Could not install revisions:\nNone", str(error))
49
197
def test_medium_not_connected(self):
50
198
error = errors.MediumNotConnected("a medium")
51
199
self.assertEqualDiff(
52
200
"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))
54
209
def test_no_repo(self):
55
210
dir = bzrdir.BzrDir.create(self.get_url())
56
211
error = errors.NoRepositoryPresent(dir)
57
212
self.assertNotEqual(-1, str(error).find((dir.transport.clone('..').base)))
58
213
self.assertEqual(-1, str(error).find((dir.transport.base)))
60
215
def test_no_smart_medium(self):
61
216
error = errors.NoSmartMedium("a transport")
62
217
self.assertEqualDiff("The transport 'a transport' cannot tunnel the "
63
218
"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.",
66
227
def test_no_such_id(self):
67
228
error = errors.NoSuchId("atree", "anid")
68
self.assertEqualDiff("The file id anid is not present in the tree "
229
self.assertEqualDiff("The file id \"anid\" is not present in the tree "
233
def test_no_such_revision_in_tree(self):
234
error = errors.NoSuchRevisionInTree("atree", "anid")
235
self.assertEqualDiff("The revision id {anid} is not present in the"
236
" tree atree.", str(error))
237
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.",
72
244
def test_not_write_locked(self):
73
245
error = errors.NotWriteLocked('a thing to repr')
74
246
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)
78
256
def test_too_many_concurrent_requests(self):
79
257
error = errors.TooManyConcurrentRequests("a medium")
80
258
self.assertEqualDiff("The medium 'a medium' has reached its concurrent "
81
259
"request limit. Be sure to finish_writing and finish_reading on "
82
"the current request that is open.",
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'.",
269
def test_unknown_hook(self):
270
error = errors.UnknownHook("branch", "foo")
271
self.assertEqualDiff("The branch hook 'foo' is unknown in this version"
274
error = errors.UnknownHook("tree", "bar")
275
self.assertEqualDiff("The tree hook 'bar' is unknown in this version"
279
def test_unstackable_branch_format(self):
282
error = errors.UnstackableBranchFormat(format, url)
283
self.assertEqualDiff(
284
"The branch '/foo'(foo) is not a stackable format. "
285
"You will need to upgrade the branch to permit branch stacking.",
288
def test_unstackable_location(self):
289
error = errors.UnstackableLocationError('foo', 'bar')
290
self.assertEqualDiff("The branch 'foo' cannot be stacked on 'bar'.",
293
def test_unstackable_repository_format(self):
296
error = errors.UnstackableRepositoryFormat(format, url)
297
self.assertEqualDiff(
298
"The repository '/foo'(foo) is not a stackable format. "
299
"You will need to upgrade the repository to permit branch stacking.",
85
302
def test_up_to_date(self):
86
error = errors.UpToDateFormat(bzrdir.BzrDirFormat4())
87
self.assertEqualDiff("The branch format Bazaar-NG branch, "
88
"format 0.0.4 is already at the most "
303
error = errors.UpToDateFormat("someformat")
304
self.assertEqualDiff(
305
"The branch format someformat is already at the most "
306
"recent format.", str(error))
92
308
def test_corrupt_repository(self):
93
309
repo = self.make_repository('.')
183
435
host='ahost', port=444, msg='Unable to connect to ssh host',
184
436
orig_error='my_error')
438
def test_target_not_branch(self):
439
"""Test the formatting of TargetNotBranch."""
440
error = errors.TargetNotBranch('foo')
442
"Your branch does not have all of the revisions required in "
443
"order to merge this merge directive and the target "
444
"location specified in the merge directive is not a branch: "
447
def test_malformed_bug_identifier(self):
448
"""Test the formatting of MalformedBugIdentifier."""
449
error = errors.MalformedBugIdentifier('bogus', 'reason for bogosity')
451
'Did not understand bug identifier bogus: reason for bogosity. '
452
'See "bzr help bugs" for more information on this feature.',
455
def test_unknown_bug_tracker_abbreviation(self):
456
"""Test the formatting of UnknownBugTrackerAbbreviation."""
457
branch = self.make_branch('some_branch')
458
error = errors.UnknownBugTrackerAbbreviation('xxx', branch)
460
"Cannot find registered bug tracker called xxx on %s" % branch,
463
def test_unexpected_smart_server_response(self):
464
e = errors.UnexpectedSmartServerResponse(('not yes',))
466
"Could not understand response from smart server: ('not yes',)",
469
def test_unknown_container_format(self):
470
"""Test the formatting of UnknownContainerFormatError."""
471
e = errors.UnknownContainerFormatError('bad format string')
473
"Unrecognised container format: 'bad format string'",
476
def test_unexpected_end_of_container(self):
477
"""Test the formatting of UnexpectedEndOfContainerError."""
478
e = errors.UnexpectedEndOfContainerError()
480
"Unexpected end of container stream", str(e))
482
def test_unknown_record_type(self):
483
"""Test the formatting of UnknownRecordTypeError."""
484
e = errors.UnknownRecordTypeError("X")
486
"Unknown record type: 'X'",
489
def test_invalid_record(self):
490
"""Test the formatting of InvalidRecordError."""
491
e = errors.InvalidRecordError("xxx")
493
"Invalid record: xxx",
496
def test_container_has_excess_data(self):
497
"""Test the formatting of ContainerHasExcessDataError."""
498
e = errors.ContainerHasExcessDataError("excess bytes")
500
"Container has data after end marker: 'excess bytes'",
503
def test_duplicate_record_name_error(self):
504
"""Test the formatting of DuplicateRecordNameError."""
505
e = errors.DuplicateRecordNameError(u"n\xe5me".encode('utf-8'))
507
"Container has multiple records with the same name: n\xc3\xa5me",
510
def test_check_error(self):
511
# This has a member called 'message', which is problematic in
512
# python2.5 because that is a slot on the base Exception class
513
e = errors.BzrCheckError('example check failure')
515
"Internal check failed: example check failure",
517
self.assertTrue(e.internal_error)
519
def test_repository_data_stream_error(self):
520
"""Test the formatting of RepositoryDataStreamError."""
521
e = errors.RepositoryDataStreamError(u"my reason")
523
"Corrupt or incompatible data stream: my reason", str(e))
525
def test_immortal_pending_deletion_message(self):
526
err = errors.ImmortalPendingDeletion('foo')
528
"Unable to delete transform temporary directory foo. "
529
"Please examine foo to see if it contains any files "
530
"you wish to keep, and delete it when you are done.",
533
def test_unable_create_symlink(self):
534
err = errors.UnableCreateSymlink()
536
"Unable to create symlink on this platform",
538
err = errors.UnableCreateSymlink(path=u'foo')
540
"Unable to create symlink 'foo' on this platform",
542
err = errors.UnableCreateSymlink(path=u'\xb5')
544
"Unable to create symlink u'\\xb5' on this platform",
547
def test_invalid_url_join(self):
548
"""Test the formatting of InvalidURLJoin."""
549
e = errors.InvalidURLJoin('Reason', 'base path', ('args',))
551
"Invalid URL join request: Reason: 'base path' + ('args',)",
554
def test_incorrect_url(self):
555
err = errors.InvalidBugTrackerURL('foo', 'http://bug.com/')
557
("The URL for bug tracker \"foo\" doesn't contain {id}: "
561
def test_unable_encode_path(self):
562
err = errors.UnableEncodePath('foo', 'executable')
563
self.assertEquals("Unable to encode executable path 'foo' in "
564
"user encoding " + osutils.get_user_encoding(),
567
def test_unknown_format(self):
568
err = errors.UnknownFormatError('bar', kind='foo')
569
self.assertEquals("Unknown foo format: 'bar'", str(err))
571
def test_unknown_rules(self):
572
err = errors.UnknownRules(['foo', 'bar'])
573
self.assertEquals("Unknown rules detected: foo, bar.", str(err))
575
def test_hook_failed(self):
576
# Create an exc_info tuple by raising and catching an exception.
579
except ZeroDivisionError:
580
exc_info = sys.exc_info()
581
err = errors.HookFailed('hook stage', 'hook name', exc_info, warn=False)
582
self.assertStartsWith(
583
str(err), 'Hook \'hook name\' during hook stage failed:\n')
585
str(err), 'integer division or modulo by zero')
587
def test_tip_change_rejected(self):
588
err = errors.TipChangeRejected(u'Unicode message\N{INTERROBANG}')
590
u'Tip change rejected: Unicode message\N{INTERROBANG}',
593
'Tip change rejected: Unicode message\xe2\x80\xbd',
596
def test_error_from_smart_server(self):
597
error_tuple = ('error', 'tuple')
598
err = errors.ErrorFromSmartServer(error_tuple)
600
"Error received from smart server: ('error', 'tuple')", str(err))
602
def test_untranslateable_error_from_smart_server(self):
603
error_tuple = ('error', 'tuple')
604
orig_err = errors.ErrorFromSmartServer(error_tuple)
605
err = errors.UnknownErrorFromSmartServer(orig_err)
607
"Server sent an unexpected error: ('error', 'tuple')", str(err))
609
def test_smart_message_handler_error(self):
610
# Make an exc_info tuple.
612
raise Exception("example error")
614
exc_info = sys.exc_info()
615
err = errors.SmartMessageHandlerError(exc_info)
616
self.assertStartsWith(
617
str(err), "The message handler raised an exception:\n")
618
self.assertEndsWith(str(err), "Exception: example error\n")
620
def test_must_have_working_tree(self):
621
err = errors.MustHaveWorkingTree('foo', 'bar')
622
self.assertEqual(str(err), "Branching 'bar'(foo) must create a"
625
def test_no_such_view(self):
626
err = errors.NoSuchView('foo')
627
self.assertEquals("No such view: foo.", str(err))
629
def test_views_not_supported(self):
630
err = errors.ViewsNotSupported('atree')
632
self.assertStartsWith(err_str, "Views are not supported by ")
633
self.assertEndsWith(err_str, "; use 'bzr upgrade' to change your "
634
"tree to a later format.")
636
def test_file_outside_view(self):
637
err = errors.FileOutsideView('baz', ['foo', 'bar'])
638
self.assertEquals('Specified file "baz" is outside the current view: '
639
'foo, bar', str(err))
641
def test_invalid_shelf_id(self):
643
err = errors.InvalidShelfId(invalid_id)
644
self.assertEqual('"foo" is not a valid shelf id, '
645
'try a number instead.', str(err))
647
def test_unresumable_write_group(self):
649
wg_tokens = ['token']
651
err = errors.UnresumableWriteGroup(repo, wg_tokens, reason)
653
"Repository dummy repo cannot resume write group "
654
"['token']: a reason", str(err))
656
def test_unsuspendable_write_group(self):
658
err = errors.UnsuspendableWriteGroup(repo)
660
'Repository dummy repo cannot suspend a write group.', str(err))
662
def test_not_branch_no_args(self):
663
err = errors.NotBranchError('path')
664
self.assertEqual('Not a branch: "path".', str(err))
666
def test_not_branch_bzrdir_with_repo(self):
667
bzrdir = self.make_repository('repo').bzrdir
668
err = errors.NotBranchError('path', bzrdir=bzrdir)
670
'Not a branch: "path": location is a repository.', str(err))
672
def test_not_branch_bzrdir_without_repo(self):
673
bzrdir = self.make_bzrdir('bzrdir')
674
err = errors.NotBranchError('path', bzrdir=bzrdir)
675
self.assertEqual('Not a branch: "path".', str(err))
677
def test_not_branch_bzrdir_with_recursive_not_branch_error(self):
678
class FakeBzrDir(object):
679
def open_repository(self):
680
# str() on the NotBranchError will trigger a call to this,
681
# which in turn will another, identical NotBranchError.
682
raise errors.NotBranchError('path', bzrdir=FakeBzrDir())
683
err = errors.NotBranchError('path', bzrdir=FakeBzrDir())
684
self.assertEqual('Not a branch: "path".', str(err))
686
def test_not_branch_laziness(self):
687
real_bzrdir = self.make_bzrdir('path')
688
class FakeBzrDir(object):
691
def open_repository(self):
692
self.calls.append('open_repository')
693
raise errors.NoRepositoryPresent(real_bzrdir)
694
fake_bzrdir = FakeBzrDir()
695
err = errors.NotBranchError('path', bzrdir=fake_bzrdir)
696
self.assertEqual([], fake_bzrdir.calls)
698
self.assertEqual(['open_repository'], fake_bzrdir.calls)
699
# Stringifying twice doesn't try to open a repository twice.
701
self.assertEqual(['open_repository'], fake_bzrdir.calls)
703
def test_invalid_pattern(self):
704
error = errors.InvalidPattern('Bad pattern msg.')
705
self.assertEqualDiff("Invalid pattern(s) found. Bad pattern msg.",
708
def test_recursive_bind(self):
709
error = errors.RecursiveBind('foo_bar_branch')
710
msg = ('Branch "foo_bar_branch" appears to be bound to itself. '
711
'Please use `bzr unbind` to fix.')
712
self.assertEqualDiff(msg, str(error))
188
715
class PassThroughError(errors.BzrError):
190
717
_fmt = """Pass through %(foo)s and %(bar)s"""
192
719
def __init__(self, foo, bar):
added
removed
bzrlib/tests/test_errors.py
