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
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_inventory_modified(self):
61
error = errors.InventoryModified("a tree to be repred")
62
self.assertEqualDiff("The current inventory for the tree 'a tree to "
63
"be repred' has been modified, so a clean inventory cannot be "
64
"read without data loss.",
67
def test_install_failed(self):
68
error = errors.InstallFailed(['rev-one'])
69
self.assertEqual("Could not install revisions:\nrev-one", str(error))
70
error = errors.InstallFailed(['rev-one', 'rev-two'])
71
self.assertEqual("Could not install revisions:\nrev-one, rev-two",
73
error = errors.InstallFailed([None])
74
self.assertEqual("Could not install revisions:\nNone", str(error))
76
def test_lock_active(self):
77
error = errors.LockActive("lock description")
78
self.assertEqualDiff("The lock for 'lock description' is in use and "
82
def test_knit_data_stream_incompatible(self):
83
error = errors.KnitDataStreamIncompatible(
84
'stream format', 'target format')
85
self.assertEqual('Cannot insert knit data stream of format '
86
'"stream format" into knit of format '
87
'"target format".', str(error))
89
def test_knit_header_error(self):
90
error = errors.KnitHeaderError('line foo\n', 'path/to/file')
91
self.assertEqual("Knit header error: 'line foo\\n' unexpected"
92
" for file \"path/to/file\".", str(error))
94
def test_knit_index_unknown_method(self):
95
error = errors.KnitIndexUnknownMethod('http://host/foo.kndx',
97
self.assertEqual("Knit index http://host/foo.kndx does not have a"
98
" known method in options: ['bad', 'no-eol']",
101
def test_medium_not_connected(self):
102
error = errors.MediumNotConnected("a medium")
103
self.assertEqualDiff(
104
"The medium 'a medium' is not connected.", str(error))
106
def test_no_repo(self):
107
dir = bzrdir.BzrDir.create(self.get_url())
108
error = errors.NoRepositoryPresent(dir)
109
self.assertNotEqual(-1, str(error).find((dir.transport.clone('..').base)))
110
self.assertEqual(-1, str(error).find((dir.transport.base)))
112
def test_no_smart_medium(self):
113
error = errors.NoSmartMedium("a transport")
114
self.assertEqualDiff("The transport 'a transport' cannot tunnel the "
118
def test_no_help_topic(self):
119
error = errors.NoHelpTopic("topic")
120
self.assertEqualDiff("No help could be found for 'topic'. "
121
"Please use 'bzr help topics' to obtain a list of topics.",
124
def test_no_such_id(self):
125
error = errors.NoSuchId("atree", "anid")
126
self.assertEqualDiff("The file id \"anid\" is not present in the tree "
130
def test_no_such_revision_in_tree(self):
131
error = errors.NoSuchRevisionInTree("atree", "anid")
132
self.assertEqualDiff("The revision id {anid} is not present in the"
133
" tree atree.", str(error))
134
self.assertIsInstance(error, errors.NoSuchRevision)
136
def test_not_write_locked(self):
137
error = errors.NotWriteLocked('a thing to repr')
138
self.assertEqualDiff("'a thing to repr' is not write locked but needs "
142
def test_read_only_lock_error(self):
143
error = self.applyDeprecated(symbol_versioning.zero_ninetytwo,
144
errors.ReadOnlyLockError, 'filename', 'error message')
145
self.assertEqualDiff("Cannot acquire write lock on filename."
146
" error message", str(error))
148
def test_lock_failed(self):
149
error = errors.LockFailed('http://canonical.com/', 'readonly transport')
150
self.assertEqualDiff("Cannot lock http://canonical.com/: readonly transport",
152
self.assertFalse(error.internal_error)
154
def test_too_many_concurrent_requests(self):
155
error = errors.TooManyConcurrentRequests("a medium")
156
self.assertEqualDiff("The medium 'a medium' has reached its concurrent "
157
"request limit. Be sure to finish_writing and finish_reading on "
158
"the currently open request.",
161
def test_unknown_hook(self):
162
error = errors.UnknownHook("branch", "foo")
163
self.assertEqualDiff("The branch hook 'foo' is unknown in this version"
166
error = errors.UnknownHook("tree", "bar")
167
self.assertEqualDiff("The tree hook 'bar' is unknown in this version"
171
def test_up_to_date(self):
172
error = errors.UpToDateFormat(bzrdir.BzrDirFormat4())
173
self.assertEqualDiff("The branch format Bazaar-NG branch, "
174
"format 0.0.4 is already at the most "
178
def test_corrupt_repository(self):
179
repo = self.make_repository('.')
180
error = errors.CorruptRepository(repo)
181
self.assertEqualDiff("An error has been detected in the repository %s.\n"
182
"Please run bzr reconcile on this repository." %
183
repo.bzrdir.root_transport.base,
186
def test_read_error(self):
187
# a unicode path to check that %r is being used.
189
error = errors.ReadError(path)
190
self.assertEqualDiff("Error reading from u'a path'.", str(error))
192
def test_bad_index_format_signature(self):
193
error = errors.BadIndexFormatSignature("foo", "bar")
194
self.assertEqual("foo is not an index of type bar.",
197
def test_bad_index_data(self):
198
error = errors.BadIndexData("foo")
199
self.assertEqual("Error in data for index foo.",
202
def test_bad_index_duplicate_key(self):
203
error = errors.BadIndexDuplicateKey("foo", "bar")
204
self.assertEqual("The key 'foo' is already in index 'bar'.",
207
def test_bad_index_key(self):
208
error = errors.BadIndexKey("foo")
209
self.assertEqual("The key 'foo' is not a valid key.",
212
def test_bad_index_options(self):
213
error = errors.BadIndexOptions("foo")
214
self.assertEqual("Could not parse options for index foo.",
217
def test_bad_index_value(self):
218
error = errors.BadIndexValue("foo")
219
self.assertEqual("The value 'foo' is not a valid value.",
222
def test_bzrnewerror_is_deprecated(self):
223
class DeprecatedError(errors.BzrNewError):
225
self.callDeprecated(['BzrNewError was deprecated in bzr 0.13; '
226
'please convert DeprecatedError to use BzrError instead'],
229
def test_bzrerror_from_literal_string(self):
230
# Some code constructs BzrError from a literal string, in which case
231
# no further formatting is done. (I'm not sure raising the base class
232
# is a great idea, but if the exception is not intended to be caught
233
# perhaps no more is needed.)
235
raise errors.BzrError('this is my errors; %d is not expanded')
236
except errors.BzrError, e:
237
self.assertEqual('this is my errors; %d is not expanded', str(e))
239
def test_reading_completed(self):
240
error = errors.ReadingCompleted("a request")
241
self.assertEqualDiff("The MediumRequest 'a request' has already had "
242
"finish_reading called upon it - the request has been completed and"
243
" no more data may be read.",
246
def test_writing_completed(self):
247
error = errors.WritingCompleted("a request")
248
self.assertEqualDiff("The MediumRequest 'a request' has already had "
249
"finish_writing called upon it - accept bytes may not be called "
253
def test_writing_not_completed(self):
254
error = errors.WritingNotComplete("a request")
255
self.assertEqualDiff("The MediumRequest 'a request' has not has "
256
"finish_writing called upon it - until the write phase is complete"
257
" no data may be read.",
260
def test_transport_not_possible(self):
261
error = errors.TransportNotPossible('readonly', 'original error')
262
self.assertEqualDiff('Transport operation not possible:'
263
' readonly original error', str(error))
265
def assertSocketConnectionError(self, expected, *args, **kwargs):
266
"""Check the formatting of a SocketConnectionError exception"""
267
e = errors.SocketConnectionError(*args, **kwargs)
268
self.assertEqual(expected, str(e))
270
def test_socket_connection_error(self):
271
"""Test the formatting of SocketConnectionError"""
273
# There should be a default msg about failing to connect
274
# we only require a host name.
275
self.assertSocketConnectionError(
276
'Failed to connect to ahost',
279
# If port is None, we don't put :None
280
self.assertSocketConnectionError(
281
'Failed to connect to ahost',
283
# But if port is supplied we include it
284
self.assertSocketConnectionError(
285
'Failed to connect to ahost:22',
288
# We can also supply extra information about the error
289
# with or without a port
290
self.assertSocketConnectionError(
291
'Failed to connect to ahost:22; bogus error',
292
'ahost', port=22, orig_error='bogus error')
293
self.assertSocketConnectionError(
294
'Failed to connect to ahost; bogus error',
295
'ahost', orig_error='bogus error')
296
# An exception object can be passed rather than a string
297
orig_error = ValueError('bad value')
298
self.assertSocketConnectionError(
299
'Failed to connect to ahost; %s' % (str(orig_error),),
300
host='ahost', orig_error=orig_error)
302
# And we can supply a custom failure message
303
self.assertSocketConnectionError(
304
'Unable to connect to ssh host ahost:444; my_error',
305
host='ahost', port=444, msg='Unable to connect to ssh host',
306
orig_error='my_error')
308
def test_malformed_bug_identifier(self):
309
"""Test the formatting of MalformedBugIdentifier."""
310
error = errors.MalformedBugIdentifier('bogus', 'reason for bogosity')
312
"Did not understand bug identifier bogus: reason for bogosity",
315
def test_unknown_bug_tracker_abbreviation(self):
316
"""Test the formatting of UnknownBugTrackerAbbreviation."""
317
branch = self.make_branch('some_branch')
318
error = errors.UnknownBugTrackerAbbreviation('xxx', branch)
320
"Cannot find registered bug tracker called xxx on %s" % branch,
323
def test_unexpected_smart_server_response(self):
324
e = errors.UnexpectedSmartServerResponse(('not yes',))
326
"Could not understand response from smart server: ('not yes',)",
329
def test_unknown_container_format(self):
330
"""Test the formatting of UnknownContainerFormatError."""
331
e = errors.UnknownContainerFormatError('bad format string')
333
"Unrecognised container format: 'bad format string'",
336
def test_unexpected_end_of_container(self):
337
"""Test the formatting of UnexpectedEndOfContainerError."""
338
e = errors.UnexpectedEndOfContainerError()
340
"Unexpected end of container stream", str(e))
342
def test_unknown_record_type(self):
343
"""Test the formatting of UnknownRecordTypeError."""
344
e = errors.UnknownRecordTypeError("X")
346
"Unknown record type: 'X'",
349
def test_invalid_record(self):
350
"""Test the formatting of InvalidRecordError."""
351
e = errors.InvalidRecordError("xxx")
353
"Invalid record: xxx",
356
def test_container_has_excess_data(self):
357
"""Test the formatting of ContainerHasExcessDataError."""
358
e = errors.ContainerHasExcessDataError("excess bytes")
360
"Container has data after end marker: 'excess bytes'",
363
def test_duplicate_record_name_error(self):
364
"""Test the formatting of DuplicateRecordNameError."""
365
e = errors.DuplicateRecordNameError(u"n\xe5me".encode('utf-8'))
367
"Container has multiple records with the same name: n\xc3\xa5me",
370
def test_check_error(self):
371
# This has a member called 'message', which is problematic in
372
# python2.5 because that is a slot on the base Exception class
373
e = errors.BzrCheckError('example check failure')
375
"Internal check failed: example check failure",
377
self.assertTrue(e.internal_error)
379
def test_repository_data_stream_error(self):
380
"""Test the formatting of RepositoryDataStreamError."""
381
e = errors.RepositoryDataStreamError(u"my reason")
383
"Corrupt or incompatible data stream: my reason", str(e))
386
class PassThroughError(errors.BzrError):
388
_fmt = """Pass through %(foo)s and %(bar)s"""
390
def __init__(self, foo, bar):
391
errors.BzrError.__init__(self, foo=foo, bar=bar)
394
class ErrorWithBadFormat(errors.BzrError):
396
_fmt = """One format specifier: %(thing)s"""
399
class ErrorWithNoFormat(errors.BzrError):
400
"""This class has a docstring but no format string."""
403
class TestErrorFormatting(TestCase):
405
def test_always_str(self):
406
e = PassThroughError(u'\xb5', 'bar')
407
self.assertIsInstance(e.__str__(), str)
408
# In Python str(foo) *must* return a real byte string
409
# not a Unicode string. The following line would raise a
410
# Unicode error, because it tries to call str() on the string
411
# returned from e.__str__(), and it has non ascii characters
413
self.assertEqual('Pass through \xc2\xb5 and bar', s)
415
def test_missing_format_string(self):
416
e = ErrorWithNoFormat(param='randomvalue')
417
s = self.callDeprecated(
418
['ErrorWithNoFormat uses its docstring as a format, it should use _fmt instead'],
422
"This class has a docstring but no format string.")
424
def test_mismatched_format_args(self):
425
# Even though ErrorWithBadFormat's format string does not match the
426
# arguments we constructing it with, we can still stringify an instance
427
# of this exception. The resulting string will say its unprintable.
428
e = ErrorWithBadFormat(not_thing='x')
429
self.assertStartsWith(
430
str(e), 'Unprintable exception ErrorWithBadFormat')
added
removed
bzrlib/tests/test_errors.py
