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_header_error(self):
85
error = errors.KnitHeaderError('line foo\n', 'path/to/file')
86
self.assertEqual("Knit header error: 'line foo\\n' unexpected"
87
" for file path/to/file", str(error))
89
def test_knit_index_unknown_method(self):
90
error = errors.KnitIndexUnknownMethod('http://host/foo.kndx',
92
self.assertEqual("Knit index http://host/foo.kndx does not have a"
93
" known method in options: ['bad', 'no-eol']",
96
def test_medium_not_connected(self):
97
error = errors.MediumNotConnected("a medium")
99
"The medium 'a medium' is not connected.", str(error))
101
def test_no_repo(self):
102
dir = bzrdir.BzrDir.create(self.get_url())
103
error = errors.NoRepositoryPresent(dir)
104
self.assertNotEqual(-1, str(error).find((dir.transport.clone('..').base)))
105
self.assertEqual(-1, str(error).find((dir.transport.base)))
107
def test_no_smart_medium(self):
108
error = errors.NoSmartMedium("a transport")
109
self.assertEqualDiff("The transport 'a transport' cannot tunnel the "
113
def test_no_help_topic(self):
114
error = errors.NoHelpTopic("topic")
115
self.assertEqualDiff("No help could be found for 'topic'. "
116
"Please use 'bzr help topics' to obtain a list of topics.",
119
def test_no_such_id(self):
120
error = errors.NoSuchId("atree", "anid")
121
self.assertEqualDiff("The file id anid is not present in the tree "
125
def test_no_such_revision_in_tree(self):
126
error = errors.NoSuchRevisionInTree("atree", "anid")
127
self.assertEqualDiff("The revision id anid is not present in the tree "
130
self.assertIsInstance(error, errors.NoSuchRevision)
132
def test_not_write_locked(self):
133
error = errors.NotWriteLocked('a thing to repr')
134
self.assertEqualDiff("'a thing to repr' is not write locked but needs "
138
def test_read_only_lock_error(self):
139
error = errors.ReadOnlyLockError('filename', 'error message')
140
self.assertEqualDiff("Cannot acquire write lock on filename."
141
" error message", str(error))
143
def test_too_many_concurrent_requests(self):
144
error = errors.TooManyConcurrentRequests("a medium")
145
self.assertEqualDiff("The medium 'a medium' has reached its concurrent "
146
"request limit. Be sure to finish_writing and finish_reading on "
147
"the currently open request.",
150
def test_unknown_hook(self):
151
error = errors.UnknownHook("branch", "foo")
152
self.assertEqualDiff("The branch hook 'foo' is unknown in this version"
155
error = errors.UnknownHook("tree", "bar")
156
self.assertEqualDiff("The tree hook 'bar' is unknown in this version"
160
def test_up_to_date(self):
161
error = errors.UpToDateFormat(bzrdir.BzrDirFormat4())
162
self.assertEqualDiff("The branch format Bazaar-NG branch, "
163
"format 0.0.4 is already at the most "
167
def test_corrupt_repository(self):
168
repo = self.make_repository('.')
169
error = errors.CorruptRepository(repo)
170
self.assertEqualDiff("An error has been detected in the repository %s.\n"
171
"Please run bzr reconcile on this repository." %
172
repo.bzrdir.root_transport.base,
175
def test_read_error(self):
176
# a unicode path to check that %r is being used.
178
error = errors.ReadError(path)
179
self.assertEqualDiff("Error reading from u'a path'.", str(error))
181
def test_bad_index_format_signature(self):
182
error = errors.BadIndexFormatSignature("foo", "bar")
183
self.assertEqual("foo is not an index of type bar.",
186
def test_bad_index_data(self):
187
error = errors.BadIndexData("foo")
188
self.assertEqual("Error in data for index foo.",
191
def test_bad_index_duplicate_key(self):
192
error = errors.BadIndexDuplicateKey("foo", "bar")
193
self.assertEqual("The key 'foo' is already in index 'bar'.",
196
def test_bad_index_key(self):
197
error = errors.BadIndexKey("foo")
198
self.assertEqual("The key 'foo' is not a valid key.",
201
def test_bad_index_options(self):
202
error = errors.BadIndexOptions("foo")
203
self.assertEqual("Could not parse options for index foo.",
206
def test_bad_index_value(self):
207
error = errors.BadIndexValue("foo")
208
self.assertEqual("The value 'foo' is not a valid value.",
211
def test_bzrnewerror_is_deprecated(self):
212
class DeprecatedError(errors.BzrNewError):
214
self.callDeprecated(['BzrNewError was deprecated in bzr 0.13; '
215
'please convert DeprecatedError to use BzrError instead'],
218
def test_bzrerror_from_literal_string(self):
219
# Some code constructs BzrError from a literal string, in which case
220
# no further formatting is done. (I'm not sure raising the base class
221
# is a great idea, but if the exception is not intended to be caught
222
# perhaps no more is needed.)
224
raise errors.BzrError('this is my errors; %d is not expanded')
225
except errors.BzrError, e:
226
self.assertEqual('this is my errors; %d is not expanded', str(e))
228
def test_reading_completed(self):
229
error = errors.ReadingCompleted("a request")
230
self.assertEqualDiff("The MediumRequest 'a request' has already had "
231
"finish_reading called upon it - the request has been completed and"
232
" no more data may be read.",
235
def test_writing_completed(self):
236
error = errors.WritingCompleted("a request")
237
self.assertEqualDiff("The MediumRequest 'a request' has already had "
238
"finish_writing called upon it - accept bytes may not be called "
242
def test_writing_not_completed(self):
243
error = errors.WritingNotComplete("a request")
244
self.assertEqualDiff("The MediumRequest 'a request' has not has "
245
"finish_writing called upon it - until the write phase is complete"
246
" no data may be read.",
249
def test_transport_not_possible(self):
250
error = errors.TransportNotPossible('readonly', 'original error')
251
self.assertEqualDiff('Transport operation not possible:'
252
' readonly original error', str(error))
254
def assertSocketConnectionError(self, expected, *args, **kwargs):
255
"""Check the formatting of a SocketConnectionError exception"""
256
e = errors.SocketConnectionError(*args, **kwargs)
257
self.assertEqual(expected, str(e))
259
def test_socket_connection_error(self):
260
"""Test the formatting of SocketConnectionError"""
262
# There should be a default msg about failing to connect
263
# we only require a host name.
264
self.assertSocketConnectionError(
265
'Failed to connect to ahost',
268
# If port is None, we don't put :None
269
self.assertSocketConnectionError(
270
'Failed to connect to ahost',
272
# But if port is supplied we include it
273
self.assertSocketConnectionError(
274
'Failed to connect to ahost:22',
277
# We can also supply extra information about the error
278
# with or without a port
279
self.assertSocketConnectionError(
280
'Failed to connect to ahost:22; bogus error',
281
'ahost', port=22, orig_error='bogus error')
282
self.assertSocketConnectionError(
283
'Failed to connect to ahost; bogus error',
284
'ahost', orig_error='bogus error')
285
# An exception object can be passed rather than a string
286
orig_error = ValueError('bad value')
287
self.assertSocketConnectionError(
288
'Failed to connect to ahost; %s' % (str(orig_error),),
289
host='ahost', orig_error=orig_error)
291
# And we can supply a custom failure message
292
self.assertSocketConnectionError(
293
'Unable to connect to ssh host ahost:444; my_error',
294
host='ahost', port=444, msg='Unable to connect to ssh host',
295
orig_error='my_error')
297
def test_malformed_bug_identifier(self):
298
"""Test the formatting of MalformedBugIdentifier."""
299
error = errors.MalformedBugIdentifier('bogus', 'reason for bogosity')
301
"Did not understand bug identifier bogus: reason for bogosity",
304
def test_unknown_bug_tracker_abbreviation(self):
305
"""Test the formatting of UnknownBugTrackerAbbreviation."""
306
branch = self.make_branch('some_branch')
307
error = errors.UnknownBugTrackerAbbreviation('xxx', branch)
309
"Cannot find registered bug tracker called xxx on %s" % branch,
312
def test_unexpected_smart_server_response(self):
313
e = errors.UnexpectedSmartServerResponse(('not yes',))
315
"Could not understand response from smart server: ('not yes',)",
318
def test_unknown_container_format(self):
319
"""Test the formatting of UnknownContainerFormatError."""
320
e = errors.UnknownContainerFormatError('bad format string')
322
"Unrecognised container format: 'bad format string'",
325
def test_unexpected_end_of_container(self):
326
"""Test the formatting of UnexpectedEndOfContainerError."""
327
e = errors.UnexpectedEndOfContainerError()
329
"Unexpected end of container stream", str(e))
331
def test_unknown_record_type(self):
332
"""Test the formatting of UnknownRecordTypeError."""
333
e = errors.UnknownRecordTypeError("X")
335
"Unknown record type: 'X'",
338
def test_invalid_record(self):
339
"""Test the formatting of InvalidRecordError."""
340
e = errors.InvalidRecordError("xxx")
342
"Invalid record: xxx",
345
def test_container_has_excess_data(self):
346
"""Test the formatting of ContainerHasExcessDataError."""
347
e = errors.ContainerHasExcessDataError("excess bytes")
349
"Container has data after end marker: 'excess bytes'",
352
def test_duplicate_record_name_error(self):
353
"""Test the formatting of DuplicateRecordNameError."""
354
e = errors.DuplicateRecordNameError(u"n\xe5me".encode('utf-8'))
356
"Container has multiple records with the same name: \"n\xc3\xa5me\"",
360
class PassThroughError(errors.BzrError):
362
_fmt = """Pass through %(foo)s and %(bar)s"""
364
def __init__(self, foo, bar):
365
errors.BzrError.__init__(self, foo=foo, bar=bar)
368
class ErrorWithBadFormat(errors.BzrError):
370
_fmt = """One format specifier: %(thing)s"""
373
class ErrorWithNoFormat(errors.BzrError):
374
"""This class has a docstring but no format string."""
377
class TestErrorFormatting(TestCase):
379
def test_always_str(self):
380
e = PassThroughError(u'\xb5', 'bar')
381
self.assertIsInstance(e.__str__(), str)
382
# In Python str(foo) *must* return a real byte string
383
# not a Unicode string. The following line would raise a
384
# Unicode error, because it tries to call str() on the string
385
# returned from e.__str__(), and it has non ascii characters
387
self.assertEqual('Pass through \xc2\xb5 and bar', s)
389
def test_missing_format_string(self):
390
e = ErrorWithNoFormat(param='randomvalue')
391
s = self.callDeprecated(
392
['ErrorWithNoFormat uses its docstring as a format, it should use _fmt instead'],
396
"This class has a docstring but no format string.")
398
def test_mismatched_format_args(self):
399
# Even though ErrorWithBadFormat's format string does not match the
400
# arguments we constructing it with, we can still stringify an instance
401
# of this exception. The resulting string will say its unprintable.
402
e = ErrorWithBadFormat(not_thing='x')
403
self.assertStartsWith(
404
str(e), 'Unprintable exception ErrorWithBadFormat')
added
removed
bzrlib/tests/test_errors.py
