1
# Copyright (C) 2006-2010 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""Tests for the formatting and construction of errors."""
29
from bzrlib.tests import TestCase, TestCaseWithTransport
32
class TestErrors(TestCaseWithTransport):
34
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))
60
def test_duplicate_file_id(self):
61
error = errors.DuplicateFileId('a_file_id', 'foo')
62
self.assertEqualDiff('File id {a_file_id} already exists in inventory'
63
' as foo', str(error))
65
def test_duplicate_help_prefix(self):
66
error = errors.DuplicateHelpPrefix('foo')
67
self.assertEqualDiff('The prefix foo is in the help search path twice.',
70
def test_ghost_revisions_have_no_revno(self):
71
error = errors.GhostRevisionsHaveNoRevno('target', 'ghost_rev')
72
self.assertEqualDiff("Could not determine revno for {target} because"
73
" 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))
79
'The API for "module" is not compatible with "(1, 2, 3)". '
80
'It supports versions "(4, 5, 6)" to "(7, 8, 9)".',
83
def test_inconsistent_delta(self):
84
error = errors.InconsistentDelta('path', 'file-id', 'reason for foo')
86
"An inconsistent delta was supplied involving 'path', 'file-id'\n"
87
"reason: reason for foo",
90
def test_inconsistent_delta_delta(self):
91
error = errors.InconsistentDeltaDelta([], 'reason')
93
"An inconsistent delta was supplied: []\nreason: reason",
96
def test_in_process_transport(self):
97
error = errors.InProcessTransport('fpp')
99
"The transport 'fpp' is only accessible within this process.",
102
def test_invalid_http_range(self):
103
error = errors.InvalidHttpRange('path',
104
'Content-Range: potatoes 0-00/o0oo0',
106
self.assertEquals("Invalid http range"
107
" 'Content-Range: potatoes 0-00/o0oo0'"
108
" for path: bad range",
111
def test_invalid_range(self):
112
error = errors.InvalidRange('path', 12, 'bad range')
113
self.assertEquals("Invalid range access in path at 12: bad range",
116
def test_inventory_modified(self):
117
error = errors.InventoryModified("a tree to be repred")
118
self.assertEqualDiff("The current inventory for the tree 'a tree to "
119
"be repred' has been modified, so a clean inventory cannot be "
120
"read without data loss.",
123
def test_jail_break(self):
124
error = errors.JailBreak("some url")
125
self.assertEqualDiff("An attempt to access a url outside the server"
126
" jail was made: 'some url'.",
129
def test_lock_active(self):
130
error = errors.LockActive("lock description")
131
self.assertEqualDiff("The lock for 'lock description' is in use and "
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']",
160
def test_medium_not_connected(self):
161
error = errors.MediumNotConnected("a medium")
162
self.assertEqualDiff(
163
"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
def test_no_smart_medium(self):
179
error = errors.NoSmartMedium("a transport")
180
self.assertEqualDiff("The transport 'a transport' cannot tunnel the "
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
def test_no_such_id(self):
191
error = errors.NoSuchId("atree", "anid")
192
self.assertEqualDiff("The file id \"anid\" is not present in the tree "
196
def test_no_such_revision_in_tree(self):
197
error = errors.NoSuchRevisionInTree("atree", "anid")
198
self.assertEqualDiff("The revision id {anid} is not present in the"
199
" tree atree.", str(error))
200
self.assertIsInstance(error, errors.NoSuchRevision)
202
def test_not_stacked(self):
203
error = errors.NotStacked('a branch')
204
self.assertEqualDiff("The branch 'a branch' is not stacked.",
207
def test_not_write_locked(self):
208
error = errors.NotWriteLocked('a thing to repr')
209
self.assertEqualDiff("'a thing to repr' is not write locked but needs "
213
def test_lock_failed(self):
214
error = errors.LockFailed('http://canonical.com/', 'readonly transport')
215
self.assertEqualDiff("Cannot lock http://canonical.com/: readonly transport",
217
self.assertFalse(error.internal_error)
219
def test_too_many_concurrent_requests(self):
220
error = errors.TooManyConcurrentRequests("a medium")
221
self.assertEqualDiff("The medium 'a medium' has reached its concurrent "
222
"request limit. Be sure to finish_writing and finish_reading on "
223
"the currently open request.",
226
def test_unavailable_representation(self):
227
error = errors.UnavailableRepresentation(('key',), "mpdiff", "fulltext")
228
self.assertEqualDiff("The encoding 'mpdiff' is not available for key "
229
"('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
def test_unstackable_location(self):
252
error = errors.UnstackableLocationError('foo', 'bar')
253
self.assertEqualDiff("The branch 'foo' cannot be stacked on 'bar'.",
256
def test_unstackable_repository_format(self):
259
error = errors.UnstackableRepositoryFormat(format, url)
260
self.assertEqualDiff(
261
"The repository '/foo'(foo) is not a stackable format. "
262
"You will need to upgrade the repository to permit branch stacking.",
265
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,
280
def test_read_error(self):
281
# a unicode path to check that %r is being used.
283
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'],
323
def test_bzrerror_from_literal_string(self):
324
# Some code constructs BzrError from a literal string, in which case
325
# no further formatting is done. (I'm not sure raising the base class
326
# is a great idea, but if the exception is not intended to be caught
327
# perhaps no more is needed.)
329
raise errors.BzrError('this is my errors; %d is not expanded')
330
except errors.BzrError, e:
331
self.assertEqual('this is my errors; %d is not expanded', str(e))
333
def test_reading_completed(self):
334
error = errors.ReadingCompleted("a request")
335
self.assertEqualDiff("The MediumRequest 'a request' has already had "
336
"finish_reading called upon it - the request has been completed and"
337
" no more data may be read.",
340
def test_writing_completed(self):
341
error = errors.WritingCompleted("a request")
342
self.assertEqualDiff("The MediumRequest 'a request' has already had "
343
"finish_writing called upon it - accept bytes may not be called "
347
def test_writing_not_completed(self):
348
error = errors.WritingNotComplete("a request")
349
self.assertEqualDiff("The MediumRequest 'a request' has not has "
350
"finish_writing called upon it - until the write phase is complete"
351
" no data may be read.",
354
def test_transport_not_possible(self):
355
error = errors.TransportNotPossible('readonly', 'original error')
356
self.assertEqualDiff('Transport operation not possible:'
357
' readonly original error', str(error))
359
def assertSocketConnectionError(self, expected, *args, **kwargs):
360
"""Check the formatting of a SocketConnectionError exception"""
361
e = errors.SocketConnectionError(*args, **kwargs)
362
self.assertEqual(expected, str(e))
364
def test_socket_connection_error(self):
365
"""Test the formatting of SocketConnectionError"""
367
# There should be a default msg about failing to connect
368
# we only require a host name.
369
self.assertSocketConnectionError(
370
'Failed to connect to ahost',
373
# If port is None, we don't put :None
374
self.assertSocketConnectionError(
375
'Failed to connect to ahost',
377
# But if port is supplied we include it
378
self.assertSocketConnectionError(
379
'Failed to connect to ahost:22',
382
# We can also supply extra information about the error
383
# with or without a port
384
self.assertSocketConnectionError(
385
'Failed to connect to ahost:22; bogus error',
386
'ahost', port=22, orig_error='bogus error')
387
self.assertSocketConnectionError(
388
'Failed to connect to ahost; bogus error',
389
'ahost', orig_error='bogus error')
390
# An exception object can be passed rather than a string
391
orig_error = ValueError('bad value')
392
self.assertSocketConnectionError(
393
'Failed to connect to ahost; %s' % (str(orig_error),),
394
host='ahost', orig_error=orig_error)
396
# And we can supply a custom failure message
397
self.assertSocketConnectionError(
398
'Unable to connect to ssh host ahost:444; my_error',
399
host='ahost', port=444, msg='Unable to connect to ssh host',
400
orig_error='my_error')
402
def test_target_not_branch(self):
403
"""Test the formatting of TargetNotBranch."""
404
error = errors.TargetNotBranch('foo')
406
"Your branch does not have all of the revisions required in "
407
"order to merge this merge directive and the target "
408
"location specified in the merge directive is not a branch: "
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
def test_unexpected_smart_server_response(self):
428
e = errors.UnexpectedSmartServerResponse(('not yes',))
430
"Could not understand response from smart server: ('not yes',)",
433
def test_unknown_container_format(self):
434
"""Test the formatting of UnknownContainerFormatError."""
435
e = errors.UnknownContainerFormatError('bad format string')
437
"Unrecognised container format: 'bad format string'",
440
def test_unexpected_end_of_container(self):
441
"""Test the formatting of UnexpectedEndOfContainerError."""
442
e = errors.UnexpectedEndOfContainerError()
444
"Unexpected end of container stream", str(e))
446
def test_unknown_record_type(self):
447
"""Test the formatting of UnknownRecordTypeError."""
448
e = errors.UnknownRecordTypeError("X")
450
"Unknown record type: 'X'",
453
def test_invalid_record(self):
454
"""Test the formatting of InvalidRecordError."""
455
e = errors.InvalidRecordError("xxx")
457
"Invalid record: xxx",
460
def test_container_has_excess_data(self):
461
"""Test the formatting of ContainerHasExcessDataError."""
462
e = errors.ContainerHasExcessDataError("excess bytes")
464
"Container has data after end marker: 'excess bytes'",
467
def test_duplicate_record_name_error(self):
468
"""Test the formatting of DuplicateRecordNameError."""
469
e = errors.DuplicateRecordNameError(u"n\xe5me".encode('utf-8'))
471
"Container has multiple records with the same name: n\xc3\xa5me",
474
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
e = errors.BzrCheckError('example check failure')
479
"Internal check failed: example check failure",
481
self.assertTrue(e.internal_error)
483
def test_repository_data_stream_error(self):
484
"""Test the formatting of RepositoryDataStreamError."""
485
e = errors.RepositoryDataStreamError(u"my reason")
487
"Corrupt or incompatible data stream: my reason", str(e))
489
def test_immortal_pending_deletion_message(self):
490
err = errors.ImmortalPendingDeletion('foo')
492
"Unable to delete transform temporary directory foo. "
493
"Please examine foo to see if it contains any files "
494
"you wish to keep, and delete it when you are done.",
497
def test_unable_create_symlink(self):
498
err = errors.UnableCreateSymlink()
500
"Unable to create symlink on this platform",
502
err = errors.UnableCreateSymlink(path=u'foo')
504
"Unable to create symlink 'foo' on this platform",
506
err = errors.UnableCreateSymlink(path=u'\xb5')
508
"Unable to create symlink u'\\xb5' on this platform",
511
def test_invalid_url_join(self):
512
"""Test the formatting of InvalidURLJoin."""
513
e = errors.InvalidURLJoin('Reason', 'base path', ('args',))
515
"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
def test_unable_encode_path(self):
526
err = errors.UnableEncodePath('foo', 'executable')
527
self.assertEquals("Unable to encode executable path 'foo' in "
528
"user encoding " + osutils.get_user_encoding(),
531
def test_unknown_format(self):
532
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')
551
def test_tip_change_rejected(self):
552
err = errors.TipChangeRejected(u'Unicode message\N{INTERROBANG}')
554
u'Tip change rejected: Unicode message\N{INTERROBANG}',
557
'Tip change rejected: Unicode message\xe2\x80\xbd',
560
def test_error_from_smart_server(self):
561
error_tuple = ('error', 'tuple')
562
err = errors.ErrorFromSmartServer(error_tuple)
564
"Error received from smart server: ('error', 'tuple')", str(err))
566
def test_untranslateable_error_from_smart_server(self):
567
error_tuple = ('error', 'tuple')
568
orig_err = errors.ErrorFromSmartServer(error_tuple)
569
err = errors.UnknownErrorFromSmartServer(orig_err)
571
"Server sent an unexpected error: ('error', 'tuple')", str(err))
573
def test_smart_message_handler_error(self):
574
# Make an exc_info tuple.
576
raise Exception("example error")
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))
611
def test_unresumable_write_group(self):
613
wg_tokens = ['token']
615
err = errors.UnresumableWriteGroup(repo, wg_tokens, reason)
617
"Repository dummy repo cannot resume write group "
618
"['token']: a reason", str(err))
620
def test_unsuspendable_write_group(self):
622
err = errors.UnsuspendableWriteGroup(repo)
624
'Repository dummy repo cannot suspend a write group.', str(err))
626
def test_not_branch_no_args(self):
627
err = errors.NotBranchError('path')
628
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')
643
class FakeBzrDir(object):
646
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)
659
class PassThroughError(errors.BzrError):
661
_fmt = """Pass through %(foo)s and %(bar)s"""
663
def __init__(self, foo, bar):
664
errors.BzrError.__init__(self, foo=foo, bar=bar)
667
class ErrorWithBadFormat(errors.BzrError):
669
_fmt = """One format specifier: %(thing)s"""
672
class ErrorWithNoFormat(errors.BzrError):
673
"""This class has a docstring but no format string."""
676
class TestErrorFormatting(TestCase):
678
def test_always_str(self):
679
e = PassThroughError(u'\xb5', 'bar')
680
self.assertIsInstance(e.__str__(), str)
681
# In Python str(foo) *must* return a real byte string
682
# not a Unicode string. The following line would raise a
683
# Unicode error, because it tries to call str() on the string
684
# returned from e.__str__(), and it has non ascii characters
686
self.assertEqual('Pass through \xc2\xb5 and bar', s)
688
def test_missing_format_string(self):
689
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.")
697
def test_mismatched_format_args(self):
698
# Even though ErrorWithBadFormat's format string does not match the
699
# arguments we constructing it with, we can still stringify an instance
700
# of this exception. The resulting string will say its unprintable.
701
e = ErrorWithBadFormat(not_thing='x')
702
self.assertStartsWith(
703
str(e), 'Unprintable exception ErrorWithBadFormat')
705
def test_cannot_bind_address(self):
706
# see <https://bugs.edge.launchpad.net/bzr/+bug/286871>
707
e = errors.CannotBindAddress('example.com', 22,
708
socket.error(13, 'Permission denied'))
709
self.assertContainsRe(str(e),
710
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.",
added
removed
bzrlib/tests/test_errors.py
