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."""
25
from bzrlib.tests import TestCase, TestCaseWithTransport
28
# TODO: Make sure builtin exception class formats are consistent - e.g. should
29
# or shouldn't end with a full stop, etc.
32
class TestErrors(TestCaseWithTransport):
34
def test_disabled_method(self):
35
error = errors.DisabledMethod("class name")
37
"The smart server method 'class name' is disabled.", str(error))
39
def test_duplicate_file_id(self):
40
error = errors.DuplicateFileId('a_file_id', 'foo')
41
self.assertEqualDiff('File id {a_file_id} already exists in inventory'
42
' as foo', str(error))
44
def test_duplicate_help_prefix(self):
45
error = errors.DuplicateHelpPrefix('foo')
46
self.assertEqualDiff('The prefix foo is in the help search path twice.',
49
def test_incompatibleAPI(self):
50
error = errors.IncompatibleAPI("module", (1, 2, 3), (4, 5, 6), (7, 8, 9))
52
'The API for "module" is not compatible with "(1, 2, 3)". '
53
'It supports versions "(4, 5, 6)" to "(7, 8, 9)".',
56
def test_in_process_transport(self):
57
error = errors.InProcessTransport('fpp')
59
"The transport 'fpp' is only accessible within this process.",
62
def test_inventory_modified(self):
63
error = errors.InventoryModified("a tree to be repred")
64
self.assertEqualDiff("The current inventory for the tree 'a tree to "
65
"be repred' has been modified, so a clean inventory cannot be "
66
"read without data loss.",
69
def test_install_failed(self):
70
error = errors.InstallFailed(['rev-one'])
71
self.assertEqual("Could not install revisions:\nrev-one", str(error))
72
error = errors.InstallFailed(['rev-one', 'rev-two'])
73
self.assertEqual("Could not install revisions:\nrev-one, rev-two",
75
error = errors.InstallFailed([None])
76
self.assertEqual("Could not install revisions:\nNone", str(error))
78
def test_lock_active(self):
79
error = errors.LockActive("lock description")
80
self.assertEqualDiff("The lock for 'lock description' is in use and "
84
def test_knit_data_stream_incompatible(self):
85
error = errors.KnitDataStreamIncompatible(
86
'stream format', 'target format')
87
self.assertEqual('Cannot insert knit data stream of format '
88
'"stream format" into knit of format '
89
'"target format".', str(error))
91
def test_knit_header_error(self):
92
error = errors.KnitHeaderError('line foo\n', 'path/to/file')
93
self.assertEqual("Knit header error: 'line foo\\n' unexpected"
94
" for file \"path/to/file\".", str(error))
96
def test_knit_index_unknown_method(self):
97
error = errors.KnitIndexUnknownMethod('http://host/foo.kndx',
99
self.assertEqual("Knit index http://host/foo.kndx does not have a"
100
" known method in options: ['bad', 'no-eol']",
103
def test_medium_not_connected(self):
104
error = errors.MediumNotConnected("a medium")
105
self.assertEqualDiff(
106
"The medium 'a medium' is not connected.", str(error))
108
def test_no_repo(self):
109
dir = bzrdir.BzrDir.create(self.get_url())
110
error = errors.NoRepositoryPresent(dir)
111
self.assertNotEqual(-1, str(error).find((dir.transport.clone('..').base)))
112
self.assertEqual(-1, str(error).find((dir.transport.base)))
114
def test_no_smart_medium(self):
115
error = errors.NoSmartMedium("a transport")
116
self.assertEqualDiff("The transport 'a transport' cannot tunnel the "
120
def test_no_help_topic(self):
121
error = errors.NoHelpTopic("topic")
122
self.assertEqualDiff("No help could be found for 'topic'. "
123
"Please use 'bzr help topics' to obtain a list of topics.",
126
def test_no_such_id(self):
127
error = errors.NoSuchId("atree", "anid")
128
self.assertEqualDiff("The file id \"anid\" is not present in the tree "
132
def test_no_such_revision_in_tree(self):
133
error = errors.NoSuchRevisionInTree("atree", "anid")
134
self.assertEqualDiff("The revision id {anid} is not present in the"
135
" tree atree.", str(error))
136
self.assertIsInstance(error, errors.NoSuchRevision)
138
def test_not_write_locked(self):
139
error = errors.NotWriteLocked('a thing to repr')
140
self.assertEqualDiff("'a thing to repr' is not write locked but needs "
144
def test_read_only_lock_error(self):
145
error = errors.ReadOnlyLockError('filename', 'error message')
146
self.assertEqualDiff("Cannot acquire write lock on filename."
147
" error message", str(error))
149
def test_too_many_concurrent_requests(self):
150
error = errors.TooManyConcurrentRequests("a medium")
151
self.assertEqualDiff("The medium 'a medium' has reached its concurrent "
152
"request limit. Be sure to finish_writing and finish_reading on "
153
"the currently open request.",
156
def test_unknown_hook(self):
157
error = errors.UnknownHook("branch", "foo")
158
self.assertEqualDiff("The branch hook 'foo' is unknown in this version"
161
error = errors.UnknownHook("tree", "bar")
162
self.assertEqualDiff("The tree hook 'bar' is unknown in this version"
166
def test_up_to_date(self):
167
error = errors.UpToDateFormat(bzrdir.BzrDirFormat4())
168
self.assertEqualDiff("The branch format Bazaar-NG branch, "
169
"format 0.0.4 is already at the most "
173
def test_corrupt_repository(self):
174
repo = self.make_repository('.')
175
error = errors.CorruptRepository(repo)
176
self.assertEqualDiff("An error has been detected in the repository %s.\n"
177
"Please run bzr reconcile on this repository." %
178
repo.bzrdir.root_transport.base,
181
def test_read_error(self):
182
# a unicode path to check that %r is being used.
184
error = errors.ReadError(path)
185
self.assertEqualDiff("Error reading from u'a path'.", str(error))
187
def test_bad_index_format_signature(self):
188
error = errors.BadIndexFormatSignature("foo", "bar")
189
self.assertEqual("foo is not an index of type bar.",
192
def test_bad_index_data(self):
193
error = errors.BadIndexData("foo")
194
self.assertEqual("Error in data for index foo.",
197
def test_bad_index_duplicate_key(self):
198
error = errors.BadIndexDuplicateKey("foo", "bar")
199
self.assertEqual("The key 'foo' is already in index 'bar'.",
202
def test_bad_index_key(self):
203
error = errors.BadIndexKey("foo")
204
self.assertEqual("The key 'foo' is not a valid key.",
207
def test_bad_index_options(self):
208
error = errors.BadIndexOptions("foo")
209
self.assertEqual("Could not parse options for index foo.",
212
def test_bad_index_value(self):
213
error = errors.BadIndexValue("foo")
214
self.assertEqual("The value 'foo' is not a valid value.",
217
def test_bzrnewerror_is_deprecated(self):
218
class DeprecatedError(errors.BzrNewError):
220
self.callDeprecated(['BzrNewError was deprecated in bzr 0.13; '
221
'please convert DeprecatedError to use BzrError instead'],
224
def test_bzrerror_from_literal_string(self):
225
# Some code constructs BzrError from a literal string, in which case
226
# no further formatting is done. (I'm not sure raising the base class
227
# is a great idea, but if the exception is not intended to be caught
228
# perhaps no more is needed.)
230
raise errors.BzrError('this is my errors; %d is not expanded')
231
except errors.BzrError, e:
232
self.assertEqual('this is my errors; %d is not expanded', str(e))
234
def test_reading_completed(self):
235
error = errors.ReadingCompleted("a request")
236
self.assertEqualDiff("The MediumRequest 'a request' has already had "
237
"finish_reading called upon it - the request has been completed and"
238
" no more data may be read.",
241
def test_writing_completed(self):
242
error = errors.WritingCompleted("a request")
243
self.assertEqualDiff("The MediumRequest 'a request' has already had "
244
"finish_writing called upon it - accept bytes may not be called "
248
def test_writing_not_completed(self):
249
error = errors.WritingNotComplete("a request")
250
self.assertEqualDiff("The MediumRequest 'a request' has not has "
251
"finish_writing called upon it - until the write phase is complete"
252
" no data may be read.",
255
def test_transport_not_possible(self):
256
error = errors.TransportNotPossible('readonly', 'original error')
257
self.assertEqualDiff('Transport operation not possible:'
258
' readonly original error', str(error))
260
def assertSocketConnectionError(self, expected, *args, **kwargs):
261
"""Check the formatting of a SocketConnectionError exception"""
262
e = errors.SocketConnectionError(*args, **kwargs)
263
self.assertEqual(expected, str(e))
265
def test_socket_connection_error(self):
266
"""Test the formatting of SocketConnectionError"""
268
# There should be a default msg about failing to connect
269
# we only require a host name.
270
self.assertSocketConnectionError(
271
'Failed to connect to ahost',
274
# If port is None, we don't put :None
275
self.assertSocketConnectionError(
276
'Failed to connect to ahost',
278
# But if port is supplied we include it
279
self.assertSocketConnectionError(
280
'Failed to connect to ahost:22',
283
# We can also supply extra information about the error
284
# with or without a port
285
self.assertSocketConnectionError(
286
'Failed to connect to ahost:22; bogus error',
287
'ahost', port=22, orig_error='bogus error')
288
self.assertSocketConnectionError(
289
'Failed to connect to ahost; bogus error',
290
'ahost', orig_error='bogus error')
291
# An exception object can be passed rather than a string
292
orig_error = ValueError('bad value')
293
self.assertSocketConnectionError(
294
'Failed to connect to ahost; %s' % (str(orig_error),),
295
host='ahost', orig_error=orig_error)
297
# And we can supply a custom failure message
298
self.assertSocketConnectionError(
299
'Unable to connect to ssh host ahost:444; my_error',
300
host='ahost', port=444, msg='Unable to connect to ssh host',
301
orig_error='my_error')
303
def test_malformed_bug_identifier(self):
304
"""Test the formatting of MalformedBugIdentifier."""
305
error = errors.MalformedBugIdentifier('bogus', 'reason for bogosity')
307
"Did not understand bug identifier bogus: reason for bogosity",
310
def test_unknown_bug_tracker_abbreviation(self):
311
"""Test the formatting of UnknownBugTrackerAbbreviation."""
312
branch = self.make_branch('some_branch')
313
error = errors.UnknownBugTrackerAbbreviation('xxx', branch)
315
"Cannot find registered bug tracker called xxx on %s" % branch,
318
def test_unexpected_smart_server_response(self):
319
e = errors.UnexpectedSmartServerResponse(('not yes',))
321
"Could not understand response from smart server: ('not yes',)",
324
def test_unknown_container_format(self):
325
"""Test the formatting of UnknownContainerFormatError."""
326
e = errors.UnknownContainerFormatError('bad format string')
328
"Unrecognised container format: 'bad format string'",
331
def test_unexpected_end_of_container(self):
332
"""Test the formatting of UnexpectedEndOfContainerError."""
333
e = errors.UnexpectedEndOfContainerError()
335
"Unexpected end of container stream", str(e))
337
def test_unknown_record_type(self):
338
"""Test the formatting of UnknownRecordTypeError."""
339
e = errors.UnknownRecordTypeError("X")
341
"Unknown record type: 'X'",
344
def test_invalid_record(self):
345
"""Test the formatting of InvalidRecordError."""
346
e = errors.InvalidRecordError("xxx")
348
"Invalid record: xxx",
351
def test_container_has_excess_data(self):
352
"""Test the formatting of ContainerHasExcessDataError."""
353
e = errors.ContainerHasExcessDataError("excess bytes")
355
"Container has data after end marker: 'excess bytes'",
358
def test_duplicate_record_name_error(self):
359
"""Test the formatting of DuplicateRecordNameError."""
360
e = errors.DuplicateRecordNameError(u"n\xe5me".encode('utf-8'))
362
"Container has multiple records with the same name: n\xc3\xa5me",
366
class PassThroughError(errors.BzrError):
368
_fmt = """Pass through %(foo)s and %(bar)s"""
370
def __init__(self, foo, bar):
371
errors.BzrError.__init__(self, foo=foo, bar=bar)
374
class ErrorWithBadFormat(errors.BzrError):
376
_fmt = """One format specifier: %(thing)s"""
379
class ErrorWithNoFormat(errors.BzrError):
380
"""This class has a docstring but no format string."""
383
class TestErrorFormatting(TestCase):
385
def test_always_str(self):
386
e = PassThroughError(u'\xb5', 'bar')
387
self.assertIsInstance(e.__str__(), str)
388
# In Python str(foo) *must* return a real byte string
389
# not a Unicode string. The following line would raise a
390
# Unicode error, because it tries to call str() on the string
391
# returned from e.__str__(), and it has non ascii characters
393
self.assertEqual('Pass through \xc2\xb5 and bar', s)
395
def test_missing_format_string(self):
396
e = ErrorWithNoFormat(param='randomvalue')
397
s = self.callDeprecated(
398
['ErrorWithNoFormat uses its docstring as a format, it should use _fmt instead'],
402
"This class has a docstring but no format string.")
404
def test_mismatched_format_args(self):
405
# Even though ErrorWithBadFormat's format string does not match the
406
# arguments we constructing it with, we can still stringify an instance
407
# of this exception. The resulting string will say its unprintable.
408
e = ErrorWithBadFormat(not_thing='x')
409
self.assertStartsWith(
410
str(e), 'Unprintable exception ErrorWithBadFormat')
added
removed
bzrlib/tests/test_errors.py
