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
26
from bzrlib.tests import TestCase, TestCaseWithTransport
25
29
class TestErrors(TestCaseWithTransport):
31
def test_disabled_method(self):
32
error = errors.DisabledMethod("class name")
34
"The smart server method 'class name' is disabled.", str(error))
36
def test_duplicate_file_id(self):
37
error = errors.DuplicateFileId('a_file_id', 'foo')
38
self.assertEqualDiff('File id {a_file_id} already exists in inventory'
39
' as foo', str(error))
41
def test_duplicate_help_prefix(self):
42
error = errors.DuplicateHelpPrefix('foo')
43
self.assertEqualDiff('The prefix foo is in the help search path twice.',
46
def test_incompatibleAPI(self):
47
error = errors.IncompatibleAPI("module", (1, 2, 3), (4, 5, 6), (7, 8, 9))
49
'The API for "module" is not compatible with "(1, 2, 3)". '
50
'It supports versions "(4, 5, 6)" to "(7, 8, 9)".',
53
def test_in_process_transport(self):
54
error = errors.InProcessTransport('fpp')
56
"The transport 'fpp' is only accessible within this process.",
59
def test_inventory_modified(self):
60
error = errors.InventoryModified("a tree to be repred")
61
self.assertEqualDiff("The current inventory for the tree 'a tree to "
62
"be repred' has been modified, so a clean inventory cannot be "
63
"read without data loss.",
66
def test_install_failed(self):
67
error = errors.InstallFailed(['rev-one'])
68
self.assertEqual("Could not install revisions:\nrev-one", str(error))
69
error = errors.InstallFailed(['rev-one', 'rev-two'])
70
self.assertEqual("Could not install revisions:\nrev-one, rev-two",
72
error = errors.InstallFailed([None])
73
self.assertEqual("Could not install revisions:\nNone", str(error))
75
def test_lock_active(self):
76
error = errors.LockActive("lock description")
77
self.assertEqualDiff("The lock for 'lock description' is in use and "
81
def test_knit_data_stream_incompatible(self):
82
error = errors.KnitDataStreamIncompatible(
83
'stream format', 'target format')
84
self.assertEqual('Cannot insert knit data stream of format '
85
'"stream format" into knit of format '
86
'"target format".', str(error))
88
def test_knit_header_error(self):
89
error = errors.KnitHeaderError('line foo\n', 'path/to/file')
90
self.assertEqual("Knit header error: 'line foo\\n' unexpected"
91
" for file \"path/to/file\".", str(error))
93
def test_knit_index_unknown_method(self):
94
error = errors.KnitIndexUnknownMethod('http://host/foo.kndx',
96
self.assertEqual("Knit index http://host/foo.kndx does not have a"
97
" known method in options: ['bad', 'no-eol']",
100
def test_medium_not_connected(self):
101
error = errors.MediumNotConnected("a medium")
102
self.assertEqualDiff(
103
"The medium 'a medium' is not connected.", str(error))
27
105
def test_no_repo(self):
28
106
dir = bzrdir.BzrDir.create(self.get_url())
29
107
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)))
108
self.assertNotEqual(-1, str(error).find((dir.transport.clone('..').base)))
109
self.assertEqual(-1, str(error).find((dir.transport.base)))
111
def test_no_smart_medium(self):
112
error = errors.NoSmartMedium("a transport")
113
self.assertEqualDiff("The transport 'a transport' cannot tunnel the "
117
def test_no_help_topic(self):
118
error = errors.NoHelpTopic("topic")
119
self.assertEqualDiff("No help could be found for 'topic'. "
120
"Please use 'bzr help topics' to obtain a list of topics.",
123
def test_no_such_id(self):
124
error = errors.NoSuchId("atree", "anid")
125
self.assertEqualDiff("The file id \"anid\" is not present in the tree "
129
def test_no_such_revision_in_tree(self):
130
error = errors.NoSuchRevisionInTree("atree", "anid")
131
self.assertEqualDiff("The revision id {anid} is not present in the"
132
" tree atree.", str(error))
133
self.assertIsInstance(error, errors.NoSuchRevision)
135
def test_not_write_locked(self):
136
error = errors.NotWriteLocked('a thing to repr')
137
self.assertEqualDiff("'a thing to repr' is not write locked but needs "
141
def test_read_only_lock_error(self):
142
error = self.applyDeprecated(symbol_versioning.zero_ninetytwo,
143
errors.ReadOnlyLockError, 'filename', 'error message')
144
self.assertEqualDiff("Cannot acquire write lock on filename."
145
" error message", str(error))
147
def test_lock_failed(self):
148
error = errors.LockFailed('http://canonical.com/', 'readonly transport')
149
self.assertEqualDiff("Cannot lock http://canonical.com/: readonly transport",
151
self.assertFalse(error.internal_error)
153
def test_too_many_concurrent_requests(self):
154
error = errors.TooManyConcurrentRequests("a medium")
155
self.assertEqualDiff("The medium 'a medium' has reached its concurrent "
156
"request limit. Be sure to finish_writing and finish_reading on "
157
"the currently open request.",
160
def test_unknown_hook(self):
161
error = errors.UnknownHook("branch", "foo")
162
self.assertEqualDiff("The branch hook 'foo' is unknown in this version"
165
error = errors.UnknownHook("tree", "bar")
166
self.assertEqualDiff("The tree hook 'bar' is unknown in this version"
33
170
def test_up_to_date(self):
34
171
error = errors.UpToDateFormat(bzrdir.BzrDirFormat4())
44
181
"Please run bzr reconcile on this repository." %
45
182
repo.bzrdir.root_transport.base,
185
def test_read_error(self):
186
# a unicode path to check that %r is being used.
188
error = errors.ReadError(path)
189
self.assertEqualDiff("Error reading from u'a path'.", str(error))
191
def test_bad_index_format_signature(self):
192
error = errors.BadIndexFormatSignature("foo", "bar")
193
self.assertEqual("foo is not an index of type bar.",
196
def test_bad_index_data(self):
197
error = errors.BadIndexData("foo")
198
self.assertEqual("Error in data for index foo.",
201
def test_bad_index_duplicate_key(self):
202
error = errors.BadIndexDuplicateKey("foo", "bar")
203
self.assertEqual("The key 'foo' is already in index 'bar'.",
206
def test_bad_index_key(self):
207
error = errors.BadIndexKey("foo")
208
self.assertEqual("The key 'foo' is not a valid key.",
211
def test_bad_index_options(self):
212
error = errors.BadIndexOptions("foo")
213
self.assertEqual("Could not parse options for index foo.",
216
def test_bad_index_value(self):
217
error = errors.BadIndexValue("foo")
218
self.assertEqual("The value 'foo' is not a valid value.",
221
def test_bzrnewerror_is_deprecated(self):
222
class DeprecatedError(errors.BzrNewError):
224
self.callDeprecated(['BzrNewError was deprecated in bzr 0.13; '
225
'please convert DeprecatedError to use BzrError instead'],
228
def test_bzrerror_from_literal_string(self):
229
# Some code constructs BzrError from a literal string, in which case
230
# no further formatting is done. (I'm not sure raising the base class
231
# is a great idea, but if the exception is not intended to be caught
232
# perhaps no more is needed.)
234
raise errors.BzrError('this is my errors; %d is not expanded')
235
except errors.BzrError, e:
236
self.assertEqual('this is my errors; %d is not expanded', str(e))
238
def test_reading_completed(self):
239
error = errors.ReadingCompleted("a request")
240
self.assertEqualDiff("The MediumRequest 'a request' has already had "
241
"finish_reading called upon it - the request has been completed and"
242
" no more data may be read.",
245
def test_writing_completed(self):
246
error = errors.WritingCompleted("a request")
247
self.assertEqualDiff("The MediumRequest 'a request' has already had "
248
"finish_writing called upon it - accept bytes may not be called "
252
def test_writing_not_completed(self):
253
error = errors.WritingNotComplete("a request")
254
self.assertEqualDiff("The MediumRequest 'a request' has not has "
255
"finish_writing called upon it - until the write phase is complete"
256
" no data may be read.",
259
def test_transport_not_possible(self):
260
error = errors.TransportNotPossible('readonly', 'original error')
261
self.assertEqualDiff('Transport operation not possible:'
262
' readonly original error', str(error))
264
def assertSocketConnectionError(self, expected, *args, **kwargs):
265
"""Check the formatting of a SocketConnectionError exception"""
266
e = errors.SocketConnectionError(*args, **kwargs)
267
self.assertEqual(expected, str(e))
269
def test_socket_connection_error(self):
270
"""Test the formatting of SocketConnectionError"""
272
# There should be a default msg about failing to connect
273
# we only require a host name.
274
self.assertSocketConnectionError(
275
'Failed to connect to ahost',
278
# If port is None, we don't put :None
279
self.assertSocketConnectionError(
280
'Failed to connect to ahost',
282
# But if port is supplied we include it
283
self.assertSocketConnectionError(
284
'Failed to connect to ahost:22',
287
# We can also supply extra information about the error
288
# with or without a port
289
self.assertSocketConnectionError(
290
'Failed to connect to ahost:22; bogus error',
291
'ahost', port=22, orig_error='bogus error')
292
self.assertSocketConnectionError(
293
'Failed to connect to ahost; bogus error',
294
'ahost', orig_error='bogus error')
295
# An exception object can be passed rather than a string
296
orig_error = ValueError('bad value')
297
self.assertSocketConnectionError(
298
'Failed to connect to ahost; %s' % (str(orig_error),),
299
host='ahost', orig_error=orig_error)
301
# And we can supply a custom failure message
302
self.assertSocketConnectionError(
303
'Unable to connect to ssh host ahost:444; my_error',
304
host='ahost', port=444, msg='Unable to connect to ssh host',
305
orig_error='my_error')
307
def test_malformed_bug_identifier(self):
308
"""Test the formatting of MalformedBugIdentifier."""
309
error = errors.MalformedBugIdentifier('bogus', 'reason for bogosity')
311
"Did not understand bug identifier bogus: reason for bogosity",
314
def test_unknown_bug_tracker_abbreviation(self):
315
"""Test the formatting of UnknownBugTrackerAbbreviation."""
316
branch = self.make_branch('some_branch')
317
error = errors.UnknownBugTrackerAbbreviation('xxx', branch)
319
"Cannot find registered bug tracker called xxx on %s" % branch,
322
def test_unexpected_smart_server_response(self):
323
e = errors.UnexpectedSmartServerResponse(('not yes',))
325
"Could not understand response from smart server: ('not yes',)",
328
def test_unknown_container_format(self):
329
"""Test the formatting of UnknownContainerFormatError."""
330
e = errors.UnknownContainerFormatError('bad format string')
332
"Unrecognised container format: 'bad format string'",
335
def test_unexpected_end_of_container(self):
336
"""Test the formatting of UnexpectedEndOfContainerError."""
337
e = errors.UnexpectedEndOfContainerError()
339
"Unexpected end of container stream", str(e))
341
def test_unknown_record_type(self):
342
"""Test the formatting of UnknownRecordTypeError."""
343
e = errors.UnknownRecordTypeError("X")
345
"Unknown record type: 'X'",
348
def test_invalid_record(self):
349
"""Test the formatting of InvalidRecordError."""
350
e = errors.InvalidRecordError("xxx")
352
"Invalid record: xxx",
355
def test_container_has_excess_data(self):
356
"""Test the formatting of ContainerHasExcessDataError."""
357
e = errors.ContainerHasExcessDataError("excess bytes")
359
"Container has data after end marker: 'excess bytes'",
362
def test_duplicate_record_name_error(self):
363
"""Test the formatting of DuplicateRecordNameError."""
364
e = errors.DuplicateRecordNameError(u"n\xe5me".encode('utf-8'))
366
"Container has multiple records with the same name: n\xc3\xa5me",
369
def test_check_error(self):
370
# This has a member called 'message', which is problematic in
371
# python2.5 because that is a slot on the base Exception class
372
e = errors.BzrCheckError('example check failure')
374
"Internal check failed: example check failure",
376
self.assertTrue(e.internal_error)
378
def test_repository_data_stream_error(self):
379
"""Test the formatting of RepositoryDataStreamError."""
380
e = errors.RepositoryDataStreamError(u"my reason")
382
"Corrupt or incompatible data stream: my reason", str(e))
384
def test_immortal_pending_deletion_message(self):
385
err = errors.ImmortalPendingDeletion('foo')
387
"Unable to delete transform temporary directory foo. "
388
"Please examine foo to see if it contains any files "
389
"you wish to keep, and delete it when you are done.",
392
def test_unable_create_symlink(self):
393
err = errors.UnableCreateSymlink()
395
"Unable to create symlink on this platform",
397
err = errors.UnableCreateSymlink(path=u'foo')
399
"Unable to create symlink 'foo' on this platform",
401
err = errors.UnableCreateSymlink(path=u'\xb5')
403
"Unable to create symlink u'\\xb5' on this platform",
407
class PassThroughError(errors.BzrError):
409
_fmt = """Pass through %(foo)s and %(bar)s"""
411
def __init__(self, foo, bar):
412
errors.BzrError.__init__(self, foo=foo, bar=bar)
415
class ErrorWithBadFormat(errors.BzrError):
417
_fmt = """One format specifier: %(thing)s"""
420
class ErrorWithNoFormat(errors.BzrError):
421
"""This class has a docstring but no format string."""
424
class TestErrorFormatting(TestCase):
426
def test_always_str(self):
427
e = PassThroughError(u'\xb5', 'bar')
428
self.assertIsInstance(e.__str__(), str)
429
# In Python str(foo) *must* return a real byte string
430
# not a Unicode string. The following line would raise a
431
# Unicode error, because it tries to call str() on the string
432
# returned from e.__str__(), and it has non ascii characters
434
self.assertEqual('Pass through \xc2\xb5 and bar', s)
436
def test_missing_format_string(self):
437
e = ErrorWithNoFormat(param='randomvalue')
438
s = self.callDeprecated(
439
['ErrorWithNoFormat uses its docstring as a format, it should use _fmt instead'],
443
"This class has a docstring but no format string.")
445
def test_mismatched_format_args(self):
446
# Even though ErrorWithBadFormat's format string does not match the
447
# arguments we constructing it with, we can still stringify an instance
448
# of this exception. The resulting string will say its unprintable.
449
e = ErrorWithBadFormat(not_thing='x')
450
self.assertStartsWith(
451
str(e), 'Unprintable exception ErrorWithBadFormat')
added
removed
bzrlib/tests/test_errors.py
