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
28
from bzrlib.tests import TestCase, TestCaseWithTransport
25
31
class TestErrors(TestCaseWithTransport):
33
def test_corrupt_dirstate(self):
34
error = errors.CorruptDirstate('path/to/dirstate', 'the reason why')
36
"Inconsistency in dirstate file path/to/dirstate.\n"
37
"Error: the reason why",
40
def test_disabled_method(self):
41
error = errors.DisabledMethod("class name")
43
"The smart server method 'class name' is disabled.", str(error))
45
def test_duplicate_file_id(self):
46
error = errors.DuplicateFileId('a_file_id', 'foo')
47
self.assertEqualDiff('File id {a_file_id} already exists in inventory'
48
' as foo', str(error))
50
def test_duplicate_help_prefix(self):
51
error = errors.DuplicateHelpPrefix('foo')
52
self.assertEqualDiff('The prefix foo is in the help search path twice.',
55
def test_incompatibleAPI(self):
56
error = errors.IncompatibleAPI("module", (1, 2, 3), (4, 5, 6), (7, 8, 9))
58
'The API for "module" is not compatible with "(1, 2, 3)". '
59
'It supports versions "(4, 5, 6)" to "(7, 8, 9)".',
62
def test_inconsistent_delta(self):
63
error = errors.InconsistentDelta('path', 'file-id', 'reason for foo')
65
"An inconsistent delta was supplied involving 'path', 'file-id'\n"
66
"reason: reason for foo",
69
def test_in_process_transport(self):
70
error = errors.InProcessTransport('fpp')
72
"The transport 'fpp' is only accessible within this process.",
75
def test_invalid_http_range(self):
76
error = errors.InvalidHttpRange('path',
77
'Content-Range: potatoes 0-00/o0oo0',
79
self.assertEquals("Invalid http range"
80
" 'Content-Range: potatoes 0-00/o0oo0'"
81
" for path: bad range",
84
def test_invalid_range(self):
85
error = errors.InvalidRange('path', 12, 'bad range')
86
self.assertEquals("Invalid range access in path at 12: bad range",
89
def test_inventory_modified(self):
90
error = errors.InventoryModified("a tree to be repred")
91
self.assertEqualDiff("The current inventory for the tree 'a tree to "
92
"be repred' has been modified, so a clean inventory cannot be "
93
"read without data loss.",
96
def test_install_failed(self):
97
error = errors.InstallFailed(['rev-one'])
98
self.assertEqual("Could not install revisions:\nrev-one", str(error))
99
error = errors.InstallFailed(['rev-one', 'rev-two'])
100
self.assertEqual("Could not install revisions:\nrev-one, rev-two",
102
error = errors.InstallFailed([None])
103
self.assertEqual("Could not install revisions:\nNone", str(error))
105
def test_lock_active(self):
106
error = errors.LockActive("lock description")
107
self.assertEqualDiff("The lock for 'lock description' is in use and "
111
def test_knit_data_stream_incompatible(self):
112
error = errors.KnitDataStreamIncompatible(
113
'stream format', 'target format')
114
self.assertEqual('Cannot insert knit data stream of format '
115
'"stream format" into knit of format '
116
'"target format".', str(error))
118
def test_knit_data_stream_unknown(self):
119
error = errors.KnitDataStreamUnknown(
121
self.assertEqual('Cannot parse knit data stream of format '
122
'"stream format".', str(error))
124
def test_knit_header_error(self):
125
error = errors.KnitHeaderError('line foo\n', 'path/to/file')
126
self.assertEqual("Knit header error: 'line foo\\n' unexpected"
127
" for file \"path/to/file\".", str(error))
129
def test_knit_index_unknown_method(self):
130
error = errors.KnitIndexUnknownMethod('http://host/foo.kndx',
132
self.assertEqual("Knit index http://host/foo.kndx does not have a"
133
" known method in options: ['bad', 'no-eol']",
136
def test_medium_not_connected(self):
137
error = errors.MediumNotConnected("a medium")
138
self.assertEqualDiff(
139
"The medium 'a medium' is not connected.", str(error))
141
def test_no_public_branch(self):
142
b = self.make_branch('.')
143
error = errors.NoPublicBranch(b)
144
url = urlutils.unescape_for_display(b.base, 'ascii')
145
self.assertEqualDiff(
146
'There is no public branch set for "%s".' % url, str(error))
27
148
def test_no_repo(self):
28
149
dir = bzrdir.BzrDir.create(self.get_url())
29
150
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)))
151
self.assertNotEqual(-1, str(error).find((dir.transport.clone('..').base)))
152
self.assertEqual(-1, str(error).find((dir.transport.base)))
154
def test_no_smart_medium(self):
155
error = errors.NoSmartMedium("a transport")
156
self.assertEqualDiff("The transport 'a transport' cannot tunnel the "
160
def test_no_help_topic(self):
161
error = errors.NoHelpTopic("topic")
162
self.assertEqualDiff("No help could be found for 'topic'. "
163
"Please use 'bzr help topics' to obtain a list of topics.",
166
def test_no_such_id(self):
167
error = errors.NoSuchId("atree", "anid")
168
self.assertEqualDiff("The file id \"anid\" is not present in the tree "
172
def test_no_such_revision_in_tree(self):
173
error = errors.NoSuchRevisionInTree("atree", "anid")
174
self.assertEqualDiff("The revision id {anid} is not present in the"
175
" tree atree.", str(error))
176
self.assertIsInstance(error, errors.NoSuchRevision)
178
def test_not_write_locked(self):
179
error = errors.NotWriteLocked('a thing to repr')
180
self.assertEqualDiff("'a thing to repr' is not write locked but needs "
184
def test_read_only_lock_error(self):
185
error = self.applyDeprecated(symbol_versioning.zero_ninetytwo,
186
errors.ReadOnlyLockError, 'filename', 'error message')
187
self.assertEqualDiff("Cannot acquire write lock on filename."
188
" error message", str(error))
190
def test_lock_failed(self):
191
error = errors.LockFailed('http://canonical.com/', 'readonly transport')
192
self.assertEqualDiff("Cannot lock http://canonical.com/: readonly transport",
194
self.assertFalse(error.internal_error)
196
def test_too_many_concurrent_requests(self):
197
error = errors.TooManyConcurrentRequests("a medium")
198
self.assertEqualDiff("The medium 'a medium' has reached its concurrent "
199
"request limit. Be sure to finish_writing and finish_reading on "
200
"the currently open request.",
203
def test_unknown_hook(self):
204
error = errors.UnknownHook("branch", "foo")
205
self.assertEqualDiff("The branch hook 'foo' is unknown in this version"
208
error = errors.UnknownHook("tree", "bar")
209
self.assertEqualDiff("The tree hook 'bar' is unknown in this version"
33
213
def test_up_to_date(self):
34
214
error = errors.UpToDateFormat(bzrdir.BzrDirFormat4())
44
224
"Please run bzr reconcile on this repository." %
45
225
repo.bzrdir.root_transport.base,
228
def test_read_error(self):
229
# a unicode path to check that %r is being used.
231
error = errors.ReadError(path)
232
self.assertEqualDiff("Error reading from u'a path'.", str(error))
234
def test_bad_index_format_signature(self):
235
error = errors.BadIndexFormatSignature("foo", "bar")
236
self.assertEqual("foo is not an index of type bar.",
239
def test_bad_index_data(self):
240
error = errors.BadIndexData("foo")
241
self.assertEqual("Error in data for index foo.",
244
def test_bad_index_duplicate_key(self):
245
error = errors.BadIndexDuplicateKey("foo", "bar")
246
self.assertEqual("The key 'foo' is already in index 'bar'.",
249
def test_bad_index_key(self):
250
error = errors.BadIndexKey("foo")
251
self.assertEqual("The key 'foo' is not a valid key.",
254
def test_bad_index_options(self):
255
error = errors.BadIndexOptions("foo")
256
self.assertEqual("Could not parse options for index foo.",
259
def test_bad_index_value(self):
260
error = errors.BadIndexValue("foo")
261
self.assertEqual("The value 'foo' is not a valid value.",
264
def test_bzrnewerror_is_deprecated(self):
265
class DeprecatedError(errors.BzrNewError):
267
self.callDeprecated(['BzrNewError was deprecated in bzr 0.13; '
268
'please convert DeprecatedError to use BzrError instead'],
271
def test_bzrerror_from_literal_string(self):
272
# Some code constructs BzrError from a literal string, in which case
273
# no further formatting is done. (I'm not sure raising the base class
274
# is a great idea, but if the exception is not intended to be caught
275
# perhaps no more is needed.)
277
raise errors.BzrError('this is my errors; %d is not expanded')
278
except errors.BzrError, e:
279
self.assertEqual('this is my errors; %d is not expanded', str(e))
281
def test_reading_completed(self):
282
error = errors.ReadingCompleted("a request")
283
self.assertEqualDiff("The MediumRequest 'a request' has already had "
284
"finish_reading called upon it - the request has been completed and"
285
" no more data may be read.",
288
def test_writing_completed(self):
289
error = errors.WritingCompleted("a request")
290
self.assertEqualDiff("The MediumRequest 'a request' has already had "
291
"finish_writing called upon it - accept bytes may not be called "
295
def test_writing_not_completed(self):
296
error = errors.WritingNotComplete("a request")
297
self.assertEqualDiff("The MediumRequest 'a request' has not has "
298
"finish_writing called upon it - until the write phase is complete"
299
" no data may be read.",
302
def test_transport_not_possible(self):
303
error = errors.TransportNotPossible('readonly', 'original error')
304
self.assertEqualDiff('Transport operation not possible:'
305
' readonly original error', str(error))
307
def assertSocketConnectionError(self, expected, *args, **kwargs):
308
"""Check the formatting of a SocketConnectionError exception"""
309
e = errors.SocketConnectionError(*args, **kwargs)
310
self.assertEqual(expected, str(e))
312
def test_socket_connection_error(self):
313
"""Test the formatting of SocketConnectionError"""
315
# There should be a default msg about failing to connect
316
# we only require a host name.
317
self.assertSocketConnectionError(
318
'Failed to connect to ahost',
321
# If port is None, we don't put :None
322
self.assertSocketConnectionError(
323
'Failed to connect to ahost',
325
# But if port is supplied we include it
326
self.assertSocketConnectionError(
327
'Failed to connect to ahost:22',
330
# We can also supply extra information about the error
331
# with or without a port
332
self.assertSocketConnectionError(
333
'Failed to connect to ahost:22; bogus error',
334
'ahost', port=22, orig_error='bogus error')
335
self.assertSocketConnectionError(
336
'Failed to connect to ahost; bogus error',
337
'ahost', orig_error='bogus error')
338
# An exception object can be passed rather than a string
339
orig_error = ValueError('bad value')
340
self.assertSocketConnectionError(
341
'Failed to connect to ahost; %s' % (str(orig_error),),
342
host='ahost', orig_error=orig_error)
344
# And we can supply a custom failure message
345
self.assertSocketConnectionError(
346
'Unable to connect to ssh host ahost:444; my_error',
347
host='ahost', port=444, msg='Unable to connect to ssh host',
348
orig_error='my_error')
350
def test_malformed_bug_identifier(self):
351
"""Test the formatting of MalformedBugIdentifier."""
352
error = errors.MalformedBugIdentifier('bogus', 'reason for bogosity')
354
"Did not understand bug identifier bogus: reason for bogosity",
357
def test_unknown_bug_tracker_abbreviation(self):
358
"""Test the formatting of UnknownBugTrackerAbbreviation."""
359
branch = self.make_branch('some_branch')
360
error = errors.UnknownBugTrackerAbbreviation('xxx', branch)
362
"Cannot find registered bug tracker called xxx on %s" % branch,
365
def test_unexpected_smart_server_response(self):
366
e = errors.UnexpectedSmartServerResponse(('not yes',))
368
"Could not understand response from smart server: ('not yes',)",
371
def test_unknown_container_format(self):
372
"""Test the formatting of UnknownContainerFormatError."""
373
e = errors.UnknownContainerFormatError('bad format string')
375
"Unrecognised container format: 'bad format string'",
378
def test_unexpected_end_of_container(self):
379
"""Test the formatting of UnexpectedEndOfContainerError."""
380
e = errors.UnexpectedEndOfContainerError()
382
"Unexpected end of container stream", str(e))
384
def test_unknown_record_type(self):
385
"""Test the formatting of UnknownRecordTypeError."""
386
e = errors.UnknownRecordTypeError("X")
388
"Unknown record type: 'X'",
391
def test_invalid_record(self):
392
"""Test the formatting of InvalidRecordError."""
393
e = errors.InvalidRecordError("xxx")
395
"Invalid record: xxx",
398
def test_container_has_excess_data(self):
399
"""Test the formatting of ContainerHasExcessDataError."""
400
e = errors.ContainerHasExcessDataError("excess bytes")
402
"Container has data after end marker: 'excess bytes'",
405
def test_duplicate_record_name_error(self):
406
"""Test the formatting of DuplicateRecordNameError."""
407
e = errors.DuplicateRecordNameError(u"n\xe5me".encode('utf-8'))
409
"Container has multiple records with the same name: n\xc3\xa5me",
412
def test_check_error(self):
413
# This has a member called 'message', which is problematic in
414
# python2.5 because that is a slot on the base Exception class
415
e = errors.BzrCheckError('example check failure')
417
"Internal check failed: example check failure",
419
self.assertTrue(e.internal_error)
421
def test_repository_data_stream_error(self):
422
"""Test the formatting of RepositoryDataStreamError."""
423
e = errors.RepositoryDataStreamError(u"my reason")
425
"Corrupt or incompatible data stream: my reason", str(e))
427
def test_immortal_pending_deletion_message(self):
428
err = errors.ImmortalPendingDeletion('foo')
430
"Unable to delete transform temporary directory foo. "
431
"Please examine foo to see if it contains any files "
432
"you wish to keep, and delete it when you are done.",
435
def test_unable_create_symlink(self):
436
err = errors.UnableCreateSymlink()
438
"Unable to create symlink on this platform",
440
err = errors.UnableCreateSymlink(path=u'foo')
442
"Unable to create symlink 'foo' on this platform",
444
err = errors.UnableCreateSymlink(path=u'\xb5')
446
"Unable to create symlink u'\\xb5' on this platform",
449
def test_incorrect_url(self):
450
err = errors.InvalidBugTrackerURL('foo', 'http://bug.com/')
452
("The URL for bug tracker \"foo\" doesn't contain {id}: "
456
def test_unable_encode_path(self):
457
err = errors.UnableEncodePath('foo', 'executable')
458
self.assertEquals("Unable to encode executable path 'foo' in "
459
"user encoding " + osutils.get_user_encoding(),
462
def test_unknown_format(self):
463
err = errors.UnknownFormatError('bar', kind='foo')
464
self.assertEquals("Unknown foo format: 'bar'", str(err))
467
class PassThroughError(errors.BzrError):
469
_fmt = """Pass through %(foo)s and %(bar)s"""
471
def __init__(self, foo, bar):
472
errors.BzrError.__init__(self, foo=foo, bar=bar)
475
class ErrorWithBadFormat(errors.BzrError):
477
_fmt = """One format specifier: %(thing)s"""
480
class ErrorWithNoFormat(errors.BzrError):
481
"""This class has a docstring but no format string."""
484
class TestErrorFormatting(TestCase):
486
def test_always_str(self):
487
e = PassThroughError(u'\xb5', 'bar')
488
self.assertIsInstance(e.__str__(), str)
489
# In Python str(foo) *must* return a real byte string
490
# not a Unicode string. The following line would raise a
491
# Unicode error, because it tries to call str() on the string
492
# returned from e.__str__(), and it has non ascii characters
494
self.assertEqual('Pass through \xc2\xb5 and bar', s)
496
def test_missing_format_string(self):
497
e = ErrorWithNoFormat(param='randomvalue')
498
s = self.callDeprecated(
499
['ErrorWithNoFormat uses its docstring as a format, it should use _fmt instead'],
503
"This class has a docstring but no format string.")
505
def test_mismatched_format_args(self):
506
# Even though ErrorWithBadFormat's format string does not match the
507
# arguments we constructing it with, we can still stringify an instance
508
# of this exception. The resulting string will say its unprintable.
509
e = ErrorWithBadFormat(not_thing='x')
510
self.assertStartsWith(
511
str(e), 'Unprintable exception ErrorWithBadFormat')
added
removed
bzrlib/tests/test_errors.py
