1
# Copyright (C) 2006, 2007 Canonical Ltd
2
# Authors: Robert Collins <robert.collins@canonical.com>
5
# This program is free software; you can redistribute it and/or modify
6
# it under the terms of the GNU General Public License as published by
7
# the Free Software Foundation; either version 2 of the License, or
8
# (at your option) any later version.
10
# This program is distributed in the hope that it will be useful,
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
# GNU General Public License for more details.
15
# You should have received a copy of the GNU General Public License
16
# along with this program; if not, write to the Free Software
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
"""Tests for the formatting and construction of errors."""
27
from bzrlib.tests import TestCase, TestCaseWithTransport
30
class TestErrors(TestCaseWithTransport):
32
def test_disabled_method(self):
33
error = errors.DisabledMethod("class name")
35
"The smart server method 'class name' is disabled.", str(error))
37
def test_duplicate_file_id(self):
38
error = errors.DuplicateFileId('a_file_id', 'foo')
39
self.assertEqualDiff('File id {a_file_id} already exists in inventory'
40
' as foo', str(error))
42
def test_duplicate_help_prefix(self):
43
error = errors.DuplicateHelpPrefix('foo')
44
self.assertEqualDiff('The prefix foo is in the help search path twice.',
47
def test_incompatibleAPI(self):
48
error = errors.IncompatibleAPI("module", (1, 2, 3), (4, 5, 6), (7, 8, 9))
50
'The API for "module" is not compatible with "(1, 2, 3)". '
51
'It supports versions "(4, 5, 6)" to "(7, 8, 9)".',
54
def test_in_process_transport(self):
55
error = errors.InProcessTransport('fpp')
57
"The transport 'fpp' is only accessible within this process.",
60
def test_invalid_http_range(self):
61
error = errors.InvalidHttpRange('path',
62
'Content-Range: potatoes 0-00/o0oo0',
64
self.assertEquals("Invalid http range"
65
" 'Content-Range: potatoes 0-00/o0oo0'"
66
" for path: bad range",
69
def test_invalid_range(self):
70
error = errors.InvalidRange('path', 12, 'bad range')
71
self.assertEquals("Invalid range access in path at 12: bad range",
74
def test_inventory_modified(self):
75
error = errors.InventoryModified("a tree to be repred")
76
self.assertEqualDiff("The current inventory for the tree 'a tree to "
77
"be repred' has been modified, so a clean inventory cannot be "
78
"read without data loss.",
81
def test_install_failed(self):
82
error = errors.InstallFailed(['rev-one'])
83
self.assertEqual("Could not install revisions:\nrev-one", str(error))
84
error = errors.InstallFailed(['rev-one', 'rev-two'])
85
self.assertEqual("Could not install revisions:\nrev-one, rev-two",
87
error = errors.InstallFailed([None])
88
self.assertEqual("Could not install revisions:\nNone", str(error))
90
def test_lock_active(self):
91
error = errors.LockActive("lock description")
92
self.assertEqualDiff("The lock for 'lock description' is in use and "
96
def test_knit_data_stream_incompatible(self):
97
error = errors.KnitDataStreamIncompatible(
98
'stream format', 'target format')
99
self.assertEqual('Cannot insert knit data stream of format '
100
'"stream format" into knit of format '
101
'"target format".', str(error))
103
def test_knit_data_stream_unknown(self):
104
error = errors.KnitDataStreamUnknown(
106
self.assertEqual('Cannot parse knit data stream of format '
107
'"stream format".', str(error))
109
def test_knit_header_error(self):
110
error = errors.KnitHeaderError('line foo\n', 'path/to/file')
111
self.assertEqual("Knit header error: 'line foo\\n' unexpected"
112
" for file \"path/to/file\".", str(error))
114
def test_knit_index_unknown_method(self):
115
error = errors.KnitIndexUnknownMethod('http://host/foo.kndx',
117
self.assertEqual("Knit index http://host/foo.kndx does not have a"
118
" known method in options: ['bad', 'no-eol']",
121
def test_medium_not_connected(self):
122
error = errors.MediumNotConnected("a medium")
123
self.assertEqualDiff(
124
"The medium 'a medium' is not connected.", str(error))
126
def test_no_public_branch(self):
127
b = self.make_branch('.')
128
error = errors.NoPublicBranch(b)
129
url = urlutils.unescape_for_display(b.base, 'ascii')
130
self.assertEqualDiff(
131
'There is no public branch set for "%s".' % url, str(error))
133
def test_no_repo(self):
134
dir = bzrdir.BzrDir.create(self.get_url())
135
error = errors.NoRepositoryPresent(dir)
136
self.assertNotEqual(-1, str(error).find((dir.transport.clone('..').base)))
137
self.assertEqual(-1, str(error).find((dir.transport.base)))
139
def test_no_smart_medium(self):
140
error = errors.NoSmartMedium("a transport")
141
self.assertEqualDiff("The transport 'a transport' cannot tunnel the "
145
def test_no_help_topic(self):
146
error = errors.NoHelpTopic("topic")
147
self.assertEqualDiff("No help could be found for 'topic'. "
148
"Please use 'bzr help topics' to obtain a list of topics.",
151
def test_no_such_id(self):
152
error = errors.NoSuchId("atree", "anid")
153
self.assertEqualDiff("The file id \"anid\" is not present in the tree "
157
def test_no_such_revision_in_tree(self):
158
error = errors.NoSuchRevisionInTree("atree", "anid")
159
self.assertEqualDiff("The revision id {anid} is not present in the"
160
" tree atree.", str(error))
161
self.assertIsInstance(error, errors.NoSuchRevision)
163
def test_not_write_locked(self):
164
error = errors.NotWriteLocked('a thing to repr')
165
self.assertEqualDiff("'a thing to repr' is not write locked but needs "
169
def test_read_only_lock_error(self):
170
error = self.applyDeprecated(symbol_versioning.zero_ninetytwo,
171
errors.ReadOnlyLockError, 'filename', 'error message')
172
self.assertEqualDiff("Cannot acquire write lock on filename."
173
" error message", str(error))
175
def test_lock_failed(self):
176
error = errors.LockFailed('http://canonical.com/', 'readonly transport')
177
self.assertEqualDiff("Cannot lock http://canonical.com/: readonly transport",
179
self.assertFalse(error.internal_error)
181
def test_too_many_concurrent_requests(self):
182
error = errors.TooManyConcurrentRequests("a medium")
183
self.assertEqualDiff("The medium 'a medium' has reached its concurrent "
184
"request limit. Be sure to finish_writing and finish_reading on "
185
"the currently open request.",
188
def test_unknown_hook(self):
189
error = errors.UnknownHook("branch", "foo")
190
self.assertEqualDiff("The branch hook 'foo' is unknown in this version"
193
error = errors.UnknownHook("tree", "bar")
194
self.assertEqualDiff("The tree hook 'bar' is unknown in this version"
198
def test_up_to_date(self):
199
error = errors.UpToDateFormat(bzrdir.BzrDirFormat4())
200
self.assertEqualDiff("The branch format Bazaar-NG branch, "
201
"format 0.0.4 is already at the most "
205
def test_corrupt_repository(self):
206
repo = self.make_repository('.')
207
error = errors.CorruptRepository(repo)
208
self.assertEqualDiff("An error has been detected in the repository %s.\n"
209
"Please run bzr reconcile on this repository." %
210
repo.bzrdir.root_transport.base,
213
def test_read_error(self):
214
# a unicode path to check that %r is being used.
216
error = errors.ReadError(path)
217
self.assertEqualDiff("Error reading from u'a path'.", str(error))
219
def test_bad_index_format_signature(self):
220
error = errors.BadIndexFormatSignature("foo", "bar")
221
self.assertEqual("foo is not an index of type bar.",
224
def test_bad_index_data(self):
225
error = errors.BadIndexData("foo")
226
self.assertEqual("Error in data for index foo.",
229
def test_bad_index_duplicate_key(self):
230
error = errors.BadIndexDuplicateKey("foo", "bar")
231
self.assertEqual("The key 'foo' is already in index 'bar'.",
234
def test_bad_index_key(self):
235
error = errors.BadIndexKey("foo")
236
self.assertEqual("The key 'foo' is not a valid key.",
239
def test_bad_index_options(self):
240
error = errors.BadIndexOptions("foo")
241
self.assertEqual("Could not parse options for index foo.",
244
def test_bad_index_value(self):
245
error = errors.BadIndexValue("foo")
246
self.assertEqual("The value 'foo' is not a valid value.",
249
def test_bzrnewerror_is_deprecated(self):
250
class DeprecatedError(errors.BzrNewError):
252
self.callDeprecated(['BzrNewError was deprecated in bzr 0.13; '
253
'please convert DeprecatedError to use BzrError instead'],
256
def test_bzrerror_from_literal_string(self):
257
# Some code constructs BzrError from a literal string, in which case
258
# no further formatting is done. (I'm not sure raising the base class
259
# is a great idea, but if the exception is not intended to be caught
260
# perhaps no more is needed.)
262
raise errors.BzrError('this is my errors; %d is not expanded')
263
except errors.BzrError, e:
264
self.assertEqual('this is my errors; %d is not expanded', str(e))
266
def test_reading_completed(self):
267
error = errors.ReadingCompleted("a request")
268
self.assertEqualDiff("The MediumRequest 'a request' has already had "
269
"finish_reading called upon it - the request has been completed and"
270
" no more data may be read.",
273
def test_writing_completed(self):
274
error = errors.WritingCompleted("a request")
275
self.assertEqualDiff("The MediumRequest 'a request' has already had "
276
"finish_writing called upon it - accept bytes may not be called "
280
def test_writing_not_completed(self):
281
error = errors.WritingNotComplete("a request")
282
self.assertEqualDiff("The MediumRequest 'a request' has not has "
283
"finish_writing called upon it - until the write phase is complete"
284
" no data may be read.",
287
def test_transport_not_possible(self):
288
error = errors.TransportNotPossible('readonly', 'original error')
289
self.assertEqualDiff('Transport operation not possible:'
290
' readonly original error', str(error))
292
def assertSocketConnectionError(self, expected, *args, **kwargs):
293
"""Check the formatting of a SocketConnectionError exception"""
294
e = errors.SocketConnectionError(*args, **kwargs)
295
self.assertEqual(expected, str(e))
297
def test_socket_connection_error(self):
298
"""Test the formatting of SocketConnectionError"""
300
# There should be a default msg about failing to connect
301
# we only require a host name.
302
self.assertSocketConnectionError(
303
'Failed to connect to ahost',
306
# If port is None, we don't put :None
307
self.assertSocketConnectionError(
308
'Failed to connect to ahost',
310
# But if port is supplied we include it
311
self.assertSocketConnectionError(
312
'Failed to connect to ahost:22',
315
# We can also supply extra information about the error
316
# with or without a port
317
self.assertSocketConnectionError(
318
'Failed to connect to ahost:22; bogus error',
319
'ahost', port=22, orig_error='bogus error')
320
self.assertSocketConnectionError(
321
'Failed to connect to ahost; bogus error',
322
'ahost', orig_error='bogus error')
323
# An exception object can be passed rather than a string
324
orig_error = ValueError('bad value')
325
self.assertSocketConnectionError(
326
'Failed to connect to ahost; %s' % (str(orig_error),),
327
host='ahost', orig_error=orig_error)
329
# And we can supply a custom failure message
330
self.assertSocketConnectionError(
331
'Unable to connect to ssh host ahost:444; my_error',
332
host='ahost', port=444, msg='Unable to connect to ssh host',
333
orig_error='my_error')
335
def test_malformed_bug_identifier(self):
336
"""Test the formatting of MalformedBugIdentifier."""
337
error = errors.MalformedBugIdentifier('bogus', 'reason for bogosity')
339
"Did not understand bug identifier bogus: reason for bogosity",
342
def test_unknown_bug_tracker_abbreviation(self):
343
"""Test the formatting of UnknownBugTrackerAbbreviation."""
344
branch = self.make_branch('some_branch')
345
error = errors.UnknownBugTrackerAbbreviation('xxx', branch)
347
"Cannot find registered bug tracker called xxx on %s" % branch,
350
def test_unexpected_smart_server_response(self):
351
e = errors.UnexpectedSmartServerResponse(('not yes',))
353
"Could not understand response from smart server: ('not yes',)",
356
def test_unknown_container_format(self):
357
"""Test the formatting of UnknownContainerFormatError."""
358
e = errors.UnknownContainerFormatError('bad format string')
360
"Unrecognised container format: 'bad format string'",
363
def test_unexpected_end_of_container(self):
364
"""Test the formatting of UnexpectedEndOfContainerError."""
365
e = errors.UnexpectedEndOfContainerError()
367
"Unexpected end of container stream", str(e))
369
def test_unknown_record_type(self):
370
"""Test the formatting of UnknownRecordTypeError."""
371
e = errors.UnknownRecordTypeError("X")
373
"Unknown record type: 'X'",
376
def test_invalid_record(self):
377
"""Test the formatting of InvalidRecordError."""
378
e = errors.InvalidRecordError("xxx")
380
"Invalid record: xxx",
383
def test_container_has_excess_data(self):
384
"""Test the formatting of ContainerHasExcessDataError."""
385
e = errors.ContainerHasExcessDataError("excess bytes")
387
"Container has data after end marker: 'excess bytes'",
390
def test_duplicate_record_name_error(self):
391
"""Test the formatting of DuplicateRecordNameError."""
392
e = errors.DuplicateRecordNameError(u"n\xe5me".encode('utf-8'))
394
"Container has multiple records with the same name: n\xc3\xa5me",
397
def test_check_error(self):
398
# This has a member called 'message', which is problematic in
399
# python2.5 because that is a slot on the base Exception class
400
e = errors.BzrCheckError('example check failure')
402
"Internal check failed: example check failure",
404
self.assertTrue(e.internal_error)
406
def test_repository_data_stream_error(self):
407
"""Test the formatting of RepositoryDataStreamError."""
408
e = errors.RepositoryDataStreamError(u"my reason")
410
"Corrupt or incompatible data stream: my reason", str(e))
412
def test_immortal_pending_deletion_message(self):
413
err = errors.ImmortalPendingDeletion('foo')
415
"Unable to delete transform temporary directory foo. "
416
"Please examine foo to see if it contains any files "
417
"you wish to keep, and delete it when you are done.",
420
def test_unable_create_symlink(self):
421
err = errors.UnableCreateSymlink()
423
"Unable to create symlink on this platform",
425
err = errors.UnableCreateSymlink(path=u'foo')
427
"Unable to create symlink 'foo' on this platform",
429
err = errors.UnableCreateSymlink(path=u'\xb5')
431
"Unable to create symlink u'\\xb5' on this platform",
434
def test_incorrect_url(self):
435
err = errors.InvalidBugTrackerURL('foo', 'http://bug.com/')
437
("The URL for bug tracker \"foo\" doesn't contain {id}: "
442
class PassThroughError(errors.BzrError):
444
_fmt = """Pass through %(foo)s and %(bar)s"""
446
def __init__(self, foo, bar):
447
errors.BzrError.__init__(self, foo=foo, bar=bar)
450
class ErrorWithBadFormat(errors.BzrError):
452
_fmt = """One format specifier: %(thing)s"""
455
class ErrorWithNoFormat(errors.BzrError):
456
"""This class has a docstring but no format string."""
459
class TestErrorFormatting(TestCase):
461
def test_always_str(self):
462
e = PassThroughError(u'\xb5', 'bar')
463
self.assertIsInstance(e.__str__(), str)
464
# In Python str(foo) *must* return a real byte string
465
# not a Unicode string. The following line would raise a
466
# Unicode error, because it tries to call str() on the string
467
# returned from e.__str__(), and it has non ascii characters
469
self.assertEqual('Pass through \xc2\xb5 and bar', s)
471
def test_missing_format_string(self):
472
e = ErrorWithNoFormat(param='randomvalue')
473
s = self.callDeprecated(
474
['ErrorWithNoFormat uses its docstring as a format, it should use _fmt instead'],
478
"This class has a docstring but no format string.")
480
def test_mismatched_format_args(self):
481
# Even though ErrorWithBadFormat's format string does not match the
482
# arguments we constructing it with, we can still stringify an instance
483
# of this exception. The resulting string will say its unprintable.
484
e = ErrorWithBadFormat(not_thing='x')
485
self.assertStartsWith(
486
str(e), 'Unprintable exception ErrorWithBadFormat')
added
removed
bzrlib/tests/test_errors.py
