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."""
26
from bzrlib.tests import TestCase, TestCaseWithTransport
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_data_stream_unknown(self):
89
error = errors.KnitDataStreamUnknown(
91
self.assertEqual('Cannot parse knit data stream of format '
92
'"stream format".', str(error))
94
def test_knit_header_error(self):
95
error = errors.KnitHeaderError('line foo\n', 'path/to/file')
96
self.assertEqual("Knit header error: 'line foo\\n' unexpected"
97
" for file \"path/to/file\".", str(error))
99
def test_knit_index_unknown_method(self):
100
error = errors.KnitIndexUnknownMethod('http://host/foo.kndx',
102
self.assertEqual("Knit index http://host/foo.kndx does not have a"
103
" known method in options: ['bad', 'no-eol']",
106
def test_medium_not_connected(self):
107
error = errors.MediumNotConnected("a medium")
108
self.assertEqualDiff(
109
"The medium 'a medium' is not connected.", str(error))
111
def test_no_repo(self):
112
dir = bzrdir.BzrDir.create(self.get_url())
113
error = errors.NoRepositoryPresent(dir)
114
self.assertNotEqual(-1, str(error).find((dir.transport.clone('..').base)))
115
self.assertEqual(-1, str(error).find((dir.transport.base)))
117
def test_no_smart_medium(self):
118
error = errors.NoSmartMedium("a transport")
119
self.assertEqualDiff("The transport 'a transport' cannot tunnel the "
123
def test_no_help_topic(self):
124
error = errors.NoHelpTopic("topic")
125
self.assertEqualDiff("No help could be found for 'topic'. "
126
"Please use 'bzr help topics' to obtain a list of topics.",
129
def test_no_such_id(self):
130
error = errors.NoSuchId("atree", "anid")
131
self.assertEqualDiff("The file id \"anid\" is not present in the tree "
135
def test_no_such_revision_in_tree(self):
136
error = errors.NoSuchRevisionInTree("atree", "anid")
137
self.assertEqualDiff("The revision id {anid} is not present in the"
138
" tree atree.", str(error))
139
self.assertIsInstance(error, errors.NoSuchRevision)
141
def test_not_write_locked(self):
142
error = errors.NotWriteLocked('a thing to repr')
143
self.assertEqualDiff("'a thing to repr' is not write locked but needs "
147
def test_read_only_lock_error(self):
148
error = self.applyDeprecated(symbol_versioning.zero_ninetytwo,
149
errors.ReadOnlyLockError, 'filename', 'error message')
150
self.assertEqualDiff("Cannot acquire write lock on filename."
151
" error message", str(error))
153
def test_lock_failed(self):
154
error = errors.LockFailed('http://canonical.com/', 'readonly transport')
155
self.assertEqualDiff("Cannot lock http://canonical.com/: readonly transport",
157
self.assertFalse(error.internal_error)
159
def test_too_many_concurrent_requests(self):
160
error = errors.TooManyConcurrentRequests("a medium")
161
self.assertEqualDiff("The medium 'a medium' has reached its concurrent "
162
"request limit. Be sure to finish_writing and finish_reading on "
163
"the currently open request.",
166
def test_unknown_hook(self):
167
error = errors.UnknownHook("branch", "foo")
168
self.assertEqualDiff("The branch hook 'foo' is unknown in this version"
171
error = errors.UnknownHook("tree", "bar")
172
self.assertEqualDiff("The tree hook 'bar' is unknown in this version"
176
def test_up_to_date(self):
177
error = errors.UpToDateFormat(bzrdir.BzrDirFormat4())
178
self.assertEqualDiff("The branch format Bazaar-NG branch, "
179
"format 0.0.4 is already at the most "
183
def test_corrupt_repository(self):
184
repo = self.make_repository('.')
185
error = errors.CorruptRepository(repo)
186
self.assertEqualDiff("An error has been detected in the repository %s.\n"
187
"Please run bzr reconcile on this repository." %
188
repo.bzrdir.root_transport.base,
191
def test_read_error(self):
192
# a unicode path to check that %r is being used.
194
error = errors.ReadError(path)
195
self.assertEqualDiff("Error reading from u'a path'.", str(error))
197
def test_bad_index_format_signature(self):
198
error = errors.BadIndexFormatSignature("foo", "bar")
199
self.assertEqual("foo is not an index of type bar.",
202
def test_bad_index_data(self):
203
error = errors.BadIndexData("foo")
204
self.assertEqual("Error in data for index foo.",
207
def test_bad_index_duplicate_key(self):
208
error = errors.BadIndexDuplicateKey("foo", "bar")
209
self.assertEqual("The key 'foo' is already in index 'bar'.",
212
def test_bad_index_key(self):
213
error = errors.BadIndexKey("foo")
214
self.assertEqual("The key 'foo' is not a valid key.",
217
def test_bad_index_options(self):
218
error = errors.BadIndexOptions("foo")
219
self.assertEqual("Could not parse options for index foo.",
222
def test_bad_index_value(self):
223
error = errors.BadIndexValue("foo")
224
self.assertEqual("The value 'foo' is not a valid value.",
227
def test_bzrnewerror_is_deprecated(self):
228
class DeprecatedError(errors.BzrNewError):
230
self.callDeprecated(['BzrNewError was deprecated in bzr 0.13; '
231
'please convert DeprecatedError to use BzrError instead'],
234
def test_bzrerror_from_literal_string(self):
235
# Some code constructs BzrError from a literal string, in which case
236
# no further formatting is done. (I'm not sure raising the base class
237
# is a great idea, but if the exception is not intended to be caught
238
# perhaps no more is needed.)
240
raise errors.BzrError('this is my errors; %d is not expanded')
241
except errors.BzrError, e:
242
self.assertEqual('this is my errors; %d is not expanded', str(e))
244
def test_reading_completed(self):
245
error = errors.ReadingCompleted("a request")
246
self.assertEqualDiff("The MediumRequest 'a request' has already had "
247
"finish_reading called upon it - the request has been completed and"
248
" no more data may be read.",
251
def test_writing_completed(self):
252
error = errors.WritingCompleted("a request")
253
self.assertEqualDiff("The MediumRequest 'a request' has already had "
254
"finish_writing called upon it - accept bytes may not be called "
258
def test_writing_not_completed(self):
259
error = errors.WritingNotComplete("a request")
260
self.assertEqualDiff("The MediumRequest 'a request' has not has "
261
"finish_writing called upon it - until the write phase is complete"
262
" no data may be read.",
265
def test_transport_not_possible(self):
266
error = errors.TransportNotPossible('readonly', 'original error')
267
self.assertEqualDiff('Transport operation not possible:'
268
' readonly original error', str(error))
270
def assertSocketConnectionError(self, expected, *args, **kwargs):
271
"""Check the formatting of a SocketConnectionError exception"""
272
e = errors.SocketConnectionError(*args, **kwargs)
273
self.assertEqual(expected, str(e))
275
def test_socket_connection_error(self):
276
"""Test the formatting of SocketConnectionError"""
278
# There should be a default msg about failing to connect
279
# we only require a host name.
280
self.assertSocketConnectionError(
281
'Failed to connect to ahost',
284
# If port is None, we don't put :None
285
self.assertSocketConnectionError(
286
'Failed to connect to ahost',
288
# But if port is supplied we include it
289
self.assertSocketConnectionError(
290
'Failed to connect to ahost:22',
293
# We can also supply extra information about the error
294
# with or without a port
295
self.assertSocketConnectionError(
296
'Failed to connect to ahost:22; bogus error',
297
'ahost', port=22, orig_error='bogus error')
298
self.assertSocketConnectionError(
299
'Failed to connect to ahost; bogus error',
300
'ahost', orig_error='bogus error')
301
# An exception object can be passed rather than a string
302
orig_error = ValueError('bad value')
303
self.assertSocketConnectionError(
304
'Failed to connect to ahost; %s' % (str(orig_error),),
305
host='ahost', orig_error=orig_error)
307
# And we can supply a custom failure message
308
self.assertSocketConnectionError(
309
'Unable to connect to ssh host ahost:444; my_error',
310
host='ahost', port=444, msg='Unable to connect to ssh host',
311
orig_error='my_error')
313
def test_malformed_bug_identifier(self):
314
"""Test the formatting of MalformedBugIdentifier."""
315
error = errors.MalformedBugIdentifier('bogus', 'reason for bogosity')
317
"Did not understand bug identifier bogus: reason for bogosity",
320
def test_unknown_bug_tracker_abbreviation(self):
321
"""Test the formatting of UnknownBugTrackerAbbreviation."""
322
branch = self.make_branch('some_branch')
323
error = errors.UnknownBugTrackerAbbreviation('xxx', branch)
325
"Cannot find registered bug tracker called xxx on %s" % branch,
328
def test_unexpected_smart_server_response(self):
329
e = errors.UnexpectedSmartServerResponse(('not yes',))
331
"Could not understand response from smart server: ('not yes',)",
334
def test_unknown_container_format(self):
335
"""Test the formatting of UnknownContainerFormatError."""
336
e = errors.UnknownContainerFormatError('bad format string')
338
"Unrecognised container format: 'bad format string'",
341
def test_unexpected_end_of_container(self):
342
"""Test the formatting of UnexpectedEndOfContainerError."""
343
e = errors.UnexpectedEndOfContainerError()
345
"Unexpected end of container stream", str(e))
347
def test_unknown_record_type(self):
348
"""Test the formatting of UnknownRecordTypeError."""
349
e = errors.UnknownRecordTypeError("X")
351
"Unknown record type: 'X'",
354
def test_invalid_record(self):
355
"""Test the formatting of InvalidRecordError."""
356
e = errors.InvalidRecordError("xxx")
358
"Invalid record: xxx",
361
def test_container_has_excess_data(self):
362
"""Test the formatting of ContainerHasExcessDataError."""
363
e = errors.ContainerHasExcessDataError("excess bytes")
365
"Container has data after end marker: 'excess bytes'",
368
def test_duplicate_record_name_error(self):
369
"""Test the formatting of DuplicateRecordNameError."""
370
e = errors.DuplicateRecordNameError(u"n\xe5me".encode('utf-8'))
372
"Container has multiple records with the same name: n\xc3\xa5me",
375
def test_check_error(self):
376
# This has a member called 'message', which is problematic in
377
# python2.5 because that is a slot on the base Exception class
378
e = errors.BzrCheckError('example check failure')
380
"Internal check failed: example check failure",
382
self.assertTrue(e.internal_error)
384
def test_repository_data_stream_error(self):
385
"""Test the formatting of RepositoryDataStreamError."""
386
e = errors.RepositoryDataStreamError(u"my reason")
388
"Corrupt or incompatible data stream: my reason", str(e))
390
def test_immortal_pending_deletion_message(self):
391
err = errors.ImmortalPendingDeletion('foo')
393
"Unable to delete transform temporary directory foo. "
394
"Please examine foo to see if it contains any files "
395
"you wish to keep, and delete it when you are done.",
398
def test_unable_create_symlink(self):
399
err = errors.UnableCreateSymlink()
401
"Unable to create symlink on this platform",
403
err = errors.UnableCreateSymlink(path=u'foo')
405
"Unable to create symlink 'foo' on this platform",
407
err = errors.UnableCreateSymlink(path=u'\xb5')
409
"Unable to create symlink u'\\xb5' on this platform",
412
def test_incorrect_url(self):
413
err = errors.InvalidBugTrackerURL('foo', 'http://bug.com/')
415
("The URL for bug tracker \"foo\" doesn't contain {id}: "
420
class PassThroughError(errors.BzrError):
422
_fmt = """Pass through %(foo)s and %(bar)s"""
424
def __init__(self, foo, bar):
425
errors.BzrError.__init__(self, foo=foo, bar=bar)
428
class ErrorWithBadFormat(errors.BzrError):
430
_fmt = """One format specifier: %(thing)s"""
433
class ErrorWithNoFormat(errors.BzrError):
434
"""This class has a docstring but no format string."""
437
class TestErrorFormatting(TestCase):
439
def test_always_str(self):
440
e = PassThroughError(u'\xb5', 'bar')
441
self.assertIsInstance(e.__str__(), str)
442
# In Python str(foo) *must* return a real byte string
443
# not a Unicode string. The following line would raise a
444
# Unicode error, because it tries to call str() on the string
445
# returned from e.__str__(), and it has non ascii characters
447
self.assertEqual('Pass through \xc2\xb5 and bar', s)
449
def test_missing_format_string(self):
450
e = ErrorWithNoFormat(param='randomvalue')
451
s = self.callDeprecated(
452
['ErrorWithNoFormat uses its docstring as a format, it should use _fmt instead'],
456
"This class has a docstring but no format string.")
458
def test_mismatched_format_args(self):
459
# Even though ErrorWithBadFormat's format string does not match the
460
# arguments we constructing it with, we can still stringify an instance
461
# of this exception. The resulting string will say its unprintable.
462
e = ErrorWithBadFormat(not_thing='x')
463
self.assertStartsWith(
464
str(e), 'Unprintable exception ErrorWithBadFormat')
added
removed
bzrlib/tests/test_errors.py
