14
15
# You should have received a copy of the GNU General Public License
15
16
# along with this program; if not, write to the Free Software
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
19
"""Tests for the formatting and construction of errors."""
20
import bzrlib.bzrdir as bzrdir
21
import bzrlib.errors as errors
22
from bzrlib.tests import TestCaseWithTransport
29
from bzrlib.tests import TestCase, TestCaseWithTransport
25
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_in_process_transport(self):
91
error = errors.InProcessTransport('fpp')
93
"The transport 'fpp' is only accessible within this process.",
96
def test_invalid_http_range(self):
97
error = errors.InvalidHttpRange('path',
98
'Content-Range: potatoes 0-00/o0oo0',
100
self.assertEquals("Invalid http range"
101
" 'Content-Range: potatoes 0-00/o0oo0'"
102
" for path: bad range",
105
def test_invalid_range(self):
106
error = errors.InvalidRange('path', 12, 'bad range')
107
self.assertEquals("Invalid range access in path at 12: bad range",
110
def test_inventory_modified(self):
111
error = errors.InventoryModified("a tree to be repred")
112
self.assertEqualDiff("The current inventory for the tree 'a tree to "
113
"be repred' has been modified, so a clean inventory cannot be "
114
"read without data loss.",
117
def test_install_failed(self):
118
error = errors.InstallFailed(['rev-one'])
119
self.assertEqual("Could not install revisions:\nrev-one", str(error))
120
error = errors.InstallFailed(['rev-one', 'rev-two'])
121
self.assertEqual("Could not install revisions:\nrev-one, rev-two",
123
error = errors.InstallFailed([None])
124
self.assertEqual("Could not install revisions:\nNone", str(error))
126
def test_jail_break(self):
127
error = errors.JailBreak("some url")
128
self.assertEqualDiff("An attempt to access a url outside the server"
129
" jail was made: 'some url'.",
132
def test_lock_active(self):
133
error = errors.LockActive("lock description")
134
self.assertEqualDiff("The lock for 'lock description' is in use and "
138
def test_knit_data_stream_incompatible(self):
139
error = errors.KnitDataStreamIncompatible(
140
'stream format', 'target format')
141
self.assertEqual('Cannot insert knit data stream of format '
142
'"stream format" into knit of format '
143
'"target format".', str(error))
145
def test_knit_data_stream_unknown(self):
146
error = errors.KnitDataStreamUnknown(
148
self.assertEqual('Cannot parse knit data stream of format '
149
'"stream format".', str(error))
151
def test_knit_header_error(self):
152
error = errors.KnitHeaderError('line foo\n', 'path/to/file')
153
self.assertEqual("Knit header error: 'line foo\\n' unexpected"
154
" for file \"path/to/file\".", str(error))
156
def test_knit_index_unknown_method(self):
157
error = errors.KnitIndexUnknownMethod('http://host/foo.kndx',
159
self.assertEqual("Knit index http://host/foo.kndx does not have a"
160
" known method in options: ['bad', 'no-eol']",
163
def test_medium_not_connected(self):
164
error = errors.MediumNotConnected("a medium")
165
self.assertEqualDiff(
166
"The medium 'a medium' is not connected.", str(error))
168
def test_no_public_branch(self):
169
b = self.make_branch('.')
170
error = errors.NoPublicBranch(b)
171
url = urlutils.unescape_for_display(b.base, 'ascii')
172
self.assertEqualDiff(
173
'There is no public branch set for "%s".' % url, str(error))
27
175
def test_no_repo(self):
28
176
dir = bzrdir.BzrDir.create(self.get_url())
29
177
error = errors.NoRepositoryPresent(dir)
30
self.assertNotEqual(-1, str(error).find(repr(dir.transport.clone('..').base)))
31
self.assertEqual(-1, str(error).find(repr(dir.transport.base)))
178
self.assertNotEqual(-1, str(error).find((dir.transport.clone('..').base)))
179
self.assertEqual(-1, str(error).find((dir.transport.base)))
181
def test_no_smart_medium(self):
182
error = errors.NoSmartMedium("a transport")
183
self.assertEqualDiff("The transport 'a transport' cannot tunnel the "
187
def test_no_help_topic(self):
188
error = errors.NoHelpTopic("topic")
189
self.assertEqualDiff("No help could be found for 'topic'. "
190
"Please use 'bzr help topics' to obtain a list of topics.",
193
def test_no_such_id(self):
194
error = errors.NoSuchId("atree", "anid")
195
self.assertEqualDiff("The file id \"anid\" is not present in the tree "
199
def test_no_such_revision_in_tree(self):
200
error = errors.NoSuchRevisionInTree("atree", "anid")
201
self.assertEqualDiff("The revision id {anid} is not present in the"
202
" tree atree.", str(error))
203
self.assertIsInstance(error, errors.NoSuchRevision)
205
def test_not_stacked(self):
206
error = errors.NotStacked('a branch')
207
self.assertEqualDiff("The branch 'a branch' is not stacked.",
210
def test_not_write_locked(self):
211
error = errors.NotWriteLocked('a thing to repr')
212
self.assertEqualDiff("'a thing to repr' is not write locked but needs "
216
def test_lock_failed(self):
217
error = errors.LockFailed('http://canonical.com/', 'readonly transport')
218
self.assertEqualDiff("Cannot lock http://canonical.com/: readonly transport",
220
self.assertFalse(error.internal_error)
222
def test_too_many_concurrent_requests(self):
223
error = errors.TooManyConcurrentRequests("a medium")
224
self.assertEqualDiff("The medium 'a medium' has reached its concurrent "
225
"request limit. Be sure to finish_writing and finish_reading on "
226
"the currently open request.",
229
def test_unavailable_representation(self):
230
error = errors.UnavailableRepresentation(('key',), "mpdiff", "fulltext")
231
self.assertEqualDiff("The encoding 'mpdiff' is not available for key "
232
"('key',) which is encoded as 'fulltext'.",
235
def test_unknown_hook(self):
236
error = errors.UnknownHook("branch", "foo")
237
self.assertEqualDiff("The branch hook 'foo' is unknown in this version"
240
error = errors.UnknownHook("tree", "bar")
241
self.assertEqualDiff("The tree hook 'bar' is unknown in this version"
245
def test_unstackable_branch_format(self):
248
error = errors.UnstackableBranchFormat(format, url)
249
self.assertEqualDiff(
250
"The branch '/foo'(foo) is not a stackable format. "
251
"You will need to upgrade the branch to permit branch stacking.",
254
def test_unstackable_repository_format(self):
257
error = errors.UnstackableRepositoryFormat(format, url)
258
self.assertEqualDiff(
259
"The repository '/foo'(foo) is not a stackable format. "
260
"You will need to upgrade the repository to permit branch stacking.",
33
263
def test_up_to_date(self):
34
264
error = errors.UpToDateFormat(bzrdir.BzrDirFormat4())
35
self.assertEqualDiff("The branch format Bazaar-NG branch, "
36
"format 0.0.4 is already at the most "
265
self.assertEqualDiff("The branch format All-in-one "
266
"format 4 is already at the most "
44
274
"Please run bzr reconcile on this repository." %
45
275
repo.bzrdir.root_transport.base,
278
def test_read_error(self):
279
# a unicode path to check that %r is being used.
281
error = errors.ReadError(path)
282
self.assertEqualDiff("Error reading from u'a path'.", str(error))
284
def test_bad_index_format_signature(self):
285
error = errors.BadIndexFormatSignature("foo", "bar")
286
self.assertEqual("foo is not an index of type bar.",
289
def test_bad_index_data(self):
290
error = errors.BadIndexData("foo")
291
self.assertEqual("Error in data for index foo.",
294
def test_bad_index_duplicate_key(self):
295
error = errors.BadIndexDuplicateKey("foo", "bar")
296
self.assertEqual("The key 'foo' is already in index 'bar'.",
299
def test_bad_index_key(self):
300
error = errors.BadIndexKey("foo")
301
self.assertEqual("The key 'foo' is not a valid key.",
304
def test_bad_index_options(self):
305
error = errors.BadIndexOptions("foo")
306
self.assertEqual("Could not parse options for index foo.",
309
def test_bad_index_value(self):
310
error = errors.BadIndexValue("foo")
311
self.assertEqual("The value 'foo' is not a valid value.",
314
def test_bzrnewerror_is_deprecated(self):
315
class DeprecatedError(errors.BzrNewError):
317
self.callDeprecated(['BzrNewError was deprecated in bzr 0.13; '
318
'please convert DeprecatedError to use BzrError instead'],
321
def test_bzrerror_from_literal_string(self):
322
# Some code constructs BzrError from a literal string, in which case
323
# no further formatting is done. (I'm not sure raising the base class
324
# is a great idea, but if the exception is not intended to be caught
325
# perhaps no more is needed.)
327
raise errors.BzrError('this is my errors; %d is not expanded')
328
except errors.BzrError, e:
329
self.assertEqual('this is my errors; %d is not expanded', str(e))
331
def test_reading_completed(self):
332
error = errors.ReadingCompleted("a request")
333
self.assertEqualDiff("The MediumRequest 'a request' has already had "
334
"finish_reading called upon it - the request has been completed and"
335
" no more data may be read.",
338
def test_writing_completed(self):
339
error = errors.WritingCompleted("a request")
340
self.assertEqualDiff("The MediumRequest 'a request' has already had "
341
"finish_writing called upon it - accept bytes may not be called "
345
def test_writing_not_completed(self):
346
error = errors.WritingNotComplete("a request")
347
self.assertEqualDiff("The MediumRequest 'a request' has not has "
348
"finish_writing called upon it - until the write phase is complete"
349
" no data may be read.",
352
def test_transport_not_possible(self):
353
error = errors.TransportNotPossible('readonly', 'original error')
354
self.assertEqualDiff('Transport operation not possible:'
355
' readonly original error', str(error))
357
def assertSocketConnectionError(self, expected, *args, **kwargs):
358
"""Check the formatting of a SocketConnectionError exception"""
359
e = errors.SocketConnectionError(*args, **kwargs)
360
self.assertEqual(expected, str(e))
362
def test_socket_connection_error(self):
363
"""Test the formatting of SocketConnectionError"""
365
# There should be a default msg about failing to connect
366
# we only require a host name.
367
self.assertSocketConnectionError(
368
'Failed to connect to ahost',
371
# If port is None, we don't put :None
372
self.assertSocketConnectionError(
373
'Failed to connect to ahost',
375
# But if port is supplied we include it
376
self.assertSocketConnectionError(
377
'Failed to connect to ahost:22',
380
# We can also supply extra information about the error
381
# with or without a port
382
self.assertSocketConnectionError(
383
'Failed to connect to ahost:22; bogus error',
384
'ahost', port=22, orig_error='bogus error')
385
self.assertSocketConnectionError(
386
'Failed to connect to ahost; bogus error',
387
'ahost', orig_error='bogus error')
388
# An exception object can be passed rather than a string
389
orig_error = ValueError('bad value')
390
self.assertSocketConnectionError(
391
'Failed to connect to ahost; %s' % (str(orig_error),),
392
host='ahost', orig_error=orig_error)
394
# And we can supply a custom failure message
395
self.assertSocketConnectionError(
396
'Unable to connect to ssh host ahost:444; my_error',
397
host='ahost', port=444, msg='Unable to connect to ssh host',
398
orig_error='my_error')
400
def test_target_not_branch(self):
401
"""Test the formatting of TargetNotBranch."""
402
error = errors.TargetNotBranch('foo')
404
"Your branch does not have all of the revisions required in "
405
"order to merge this merge directive and the target "
406
"location specified in the merge directive is not a branch: "
409
def test_malformed_bug_identifier(self):
410
"""Test the formatting of MalformedBugIdentifier."""
411
error = errors.MalformedBugIdentifier('bogus', 'reason for bogosity')
413
'Did not understand bug identifier bogus: reason for bogosity. '
414
'See "bzr help bugs" for more information on this feature.',
417
def test_unknown_bug_tracker_abbreviation(self):
418
"""Test the formatting of UnknownBugTrackerAbbreviation."""
419
branch = self.make_branch('some_branch')
420
error = errors.UnknownBugTrackerAbbreviation('xxx', branch)
422
"Cannot find registered bug tracker called xxx on %s" % branch,
425
def test_unexpected_smart_server_response(self):
426
e = errors.UnexpectedSmartServerResponse(('not yes',))
428
"Could not understand response from smart server: ('not yes',)",
431
def test_unknown_container_format(self):
432
"""Test the formatting of UnknownContainerFormatError."""
433
e = errors.UnknownContainerFormatError('bad format string')
435
"Unrecognised container format: 'bad format string'",
438
def test_unexpected_end_of_container(self):
439
"""Test the formatting of UnexpectedEndOfContainerError."""
440
e = errors.UnexpectedEndOfContainerError()
442
"Unexpected end of container stream", str(e))
444
def test_unknown_record_type(self):
445
"""Test the formatting of UnknownRecordTypeError."""
446
e = errors.UnknownRecordTypeError("X")
448
"Unknown record type: 'X'",
451
def test_invalid_record(self):
452
"""Test the formatting of InvalidRecordError."""
453
e = errors.InvalidRecordError("xxx")
455
"Invalid record: xxx",
458
def test_container_has_excess_data(self):
459
"""Test the formatting of ContainerHasExcessDataError."""
460
e = errors.ContainerHasExcessDataError("excess bytes")
462
"Container has data after end marker: 'excess bytes'",
465
def test_duplicate_record_name_error(self):
466
"""Test the formatting of DuplicateRecordNameError."""
467
e = errors.DuplicateRecordNameError(u"n\xe5me".encode('utf-8'))
469
"Container has multiple records with the same name: n\xc3\xa5me",
472
def test_check_error(self):
473
# This has a member called 'message', which is problematic in
474
# python2.5 because that is a slot on the base Exception class
475
e = errors.BzrCheckError('example check failure')
477
"Internal check failed: example check failure",
479
self.assertTrue(e.internal_error)
481
def test_repository_data_stream_error(self):
482
"""Test the formatting of RepositoryDataStreamError."""
483
e = errors.RepositoryDataStreamError(u"my reason")
485
"Corrupt or incompatible data stream: my reason", str(e))
487
def test_immortal_pending_deletion_message(self):
488
err = errors.ImmortalPendingDeletion('foo')
490
"Unable to delete transform temporary directory foo. "
491
"Please examine foo to see if it contains any files "
492
"you wish to keep, and delete it when you are done.",
495
def test_unable_create_symlink(self):
496
err = errors.UnableCreateSymlink()
498
"Unable to create symlink on this platform",
500
err = errors.UnableCreateSymlink(path=u'foo')
502
"Unable to create symlink 'foo' on this platform",
504
err = errors.UnableCreateSymlink(path=u'\xb5')
506
"Unable to create symlink u'\\xb5' on this platform",
509
def test_invalid_url_join(self):
510
"""Test the formatting of InvalidURLJoin."""
511
e = errors.InvalidURLJoin('Reason', 'base path', ('args',))
513
"Invalid URL join request: Reason: 'base path' + ('args',)",
516
def test_incorrect_url(self):
517
err = errors.InvalidBugTrackerURL('foo', 'http://bug.com/')
519
("The URL for bug tracker \"foo\" doesn't contain {id}: "
523
def test_unable_encode_path(self):
524
err = errors.UnableEncodePath('foo', 'executable')
525
self.assertEquals("Unable to encode executable path 'foo' in "
526
"user encoding " + osutils.get_user_encoding(),
529
def test_unknown_format(self):
530
err = errors.UnknownFormatError('bar', kind='foo')
531
self.assertEquals("Unknown foo format: 'bar'", str(err))
533
def test_unknown_rules(self):
534
err = errors.UnknownRules(['foo', 'bar'])
535
self.assertEquals("Unknown rules detected: foo, bar.", str(err))
537
def test_hook_failed(self):
538
# Create an exc_info tuple by raising and catching an exception.
541
except ZeroDivisionError:
542
exc_info = sys.exc_info()
543
err = errors.HookFailed('hook stage', 'hook name', exc_info)
544
self.assertStartsWith(
545
str(err), 'Hook \'hook name\' during hook stage failed:\n')
547
str(err), 'integer division or modulo by zero')
549
def test_tip_change_rejected(self):
550
err = errors.TipChangeRejected(u'Unicode message\N{INTERROBANG}')
552
u'Tip change rejected: Unicode message\N{INTERROBANG}',
555
'Tip change rejected: Unicode message\xe2\x80\xbd',
558
def test_error_from_smart_server(self):
559
error_tuple = ('error', 'tuple')
560
err = errors.ErrorFromSmartServer(error_tuple)
562
"Error received from smart server: ('error', 'tuple')", str(err))
564
def test_untranslateable_error_from_smart_server(self):
565
error_tuple = ('error', 'tuple')
566
orig_err = errors.ErrorFromSmartServer(error_tuple)
567
err = errors.UnknownErrorFromSmartServer(orig_err)
569
"Server sent an unexpected error: ('error', 'tuple')", str(err))
571
def test_smart_message_handler_error(self):
572
# Make an exc_info tuple.
574
raise Exception("example error")
576
exc_info = sys.exc_info()
577
err = errors.SmartMessageHandlerError(exc_info)
578
self.assertStartsWith(
579
str(err), "The message handler raised an exception:\n")
580
self.assertEndsWith(str(err), "Exception: example error\n")
582
def test_must_have_working_tree(self):
583
err = errors.MustHaveWorkingTree('foo', 'bar')
584
self.assertEqual(str(err), "Branching 'bar'(foo) must create a"
587
def test_no_such_view(self):
588
err = errors.NoSuchView('foo')
589
self.assertEquals("No such view: foo.", str(err))
591
def test_views_not_supported(self):
592
err = errors.ViewsNotSupported('atree')
594
self.assertStartsWith(err_str, "Views are not supported by ")
595
self.assertEndsWith(err_str, "; use 'bzr upgrade' to change your "
596
"tree to a later format.")
598
def test_file_outside_view(self):
599
err = errors.FileOutsideView('baz', ['foo', 'bar'])
600
self.assertEquals('Specified file "baz" is outside the current view: '
601
'foo, bar', str(err))
603
def test_invalid_shelf_id(self):
605
err = errors.InvalidShelfId(invalid_id)
606
self.assertEqual('"foo" is not a valid shelf id, '
607
'try a number instead.', str(err))
609
def test_unresumable_write_group(self):
611
wg_tokens = ['token']
613
err = errors.UnresumableWriteGroup(repo, wg_tokens, reason)
615
"Repository dummy repo cannot resume write group "
616
"['token']: a reason", str(err))
618
def test_unsuspendable_write_group(self):
620
err = errors.UnsuspendableWriteGroup(repo)
622
'Repository dummy repo cannot suspend a write group.', str(err))
625
class PassThroughError(errors.BzrError):
627
_fmt = """Pass through %(foo)s and %(bar)s"""
629
def __init__(self, foo, bar):
630
errors.BzrError.__init__(self, foo=foo, bar=bar)
633
class ErrorWithBadFormat(errors.BzrError):
635
_fmt = """One format specifier: %(thing)s"""
638
class ErrorWithNoFormat(errors.BzrError):
639
"""This class has a docstring but no format string."""
642
class TestErrorFormatting(TestCase):
644
def test_always_str(self):
645
e = PassThroughError(u'\xb5', 'bar')
646
self.assertIsInstance(e.__str__(), str)
647
# In Python str(foo) *must* return a real byte string
648
# not a Unicode string. The following line would raise a
649
# Unicode error, because it tries to call str() on the string
650
# returned from e.__str__(), and it has non ascii characters
652
self.assertEqual('Pass through \xc2\xb5 and bar', s)
654
def test_missing_format_string(self):
655
e = ErrorWithNoFormat(param='randomvalue')
656
s = self.callDeprecated(
657
['ErrorWithNoFormat uses its docstring as a format, it should use _fmt instead'],
661
"This class has a docstring but no format string.")
663
def test_mismatched_format_args(self):
664
# Even though ErrorWithBadFormat's format string does not match the
665
# arguments we constructing it with, we can still stringify an instance
666
# of this exception. The resulting string will say its unprintable.
667
e = ErrorWithBadFormat(not_thing='x')
668
self.assertStartsWith(
669
str(e), 'Unprintable exception ErrorWithBadFormat')
added
removed
bzrlib/tests/test_errors.py
