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"
128
" tree atree.", str(error))
129
self.assertIsInstance(error, errors.NoSuchRevision)
131
def test_not_write_locked(self):
132
error = errors.NotWriteLocked('a thing to repr')
133
self.assertEqualDiff("'a thing to repr' is not write locked but needs "
137
def test_read_only_lock_error(self):
138
error = errors.ReadOnlyLockError('filename', 'error message')
139
self.assertEqualDiff("Cannot acquire write lock on filename."
140
" error message", str(error))
142
def test_too_many_concurrent_requests(self):
143
error = errors.TooManyConcurrentRequests("a medium")
144
self.assertEqualDiff("The medium 'a medium' has reached its concurrent "
145
"request limit. Be sure to finish_writing and finish_reading on "
146
"the currently open request.",
149
def test_unknown_hook(self):
150
error = errors.UnknownHook("branch", "foo")
151
self.assertEqualDiff("The branch hook 'foo' is unknown in this version"
154
error = errors.UnknownHook("tree", "bar")
155
self.assertEqualDiff("The tree hook 'bar' is unknown in this version"
159
def test_up_to_date(self):
160
error = errors.UpToDateFormat(bzrdir.BzrDirFormat4())
161
self.assertEqualDiff("The branch format Bazaar-NG branch, "
162
"format 0.0.4 is already at the most "
166
def test_corrupt_repository(self):
167
repo = self.make_repository('.')
168
error = errors.CorruptRepository(repo)
169
self.assertEqualDiff("An error has been detected in the repository %s.\n"
170
"Please run bzr reconcile on this repository." %
171
repo.bzrdir.root_transport.base,
174
def test_read_error(self):
175
# a unicode path to check that %r is being used.
177
error = errors.ReadError(path)
178
self.assertEqualDiff("Error reading from u'a path'.", str(error))
180
def test_bad_index_format_signature(self):
181
error = errors.BadIndexFormatSignature("foo", "bar")
182
self.assertEqual("foo is not an index of type bar.",
185
def test_bad_index_data(self):
186
error = errors.BadIndexData("foo")
187
self.assertEqual("Error in data for index foo.",
190
def test_bad_index_duplicate_key(self):
191
error = errors.BadIndexDuplicateKey("foo", "bar")
192
self.assertEqual("The key 'foo' is already in index 'bar'.",
195
def test_bad_index_key(self):
196
error = errors.BadIndexKey("foo")
197
self.assertEqual("The key 'foo' is not a valid key.",
200
def test_bad_index_options(self):
201
error = errors.BadIndexOptions("foo")
202
self.assertEqual("Could not parse options for index foo.",
205
def test_bad_index_value(self):
206
error = errors.BadIndexValue("foo")
207
self.assertEqual("The value 'foo' is not a valid value.",
210
def test_bzrnewerror_is_deprecated(self):
211
class DeprecatedError(errors.BzrNewError):
213
self.callDeprecated(['BzrNewError was deprecated in bzr 0.13; '
214
'please convert DeprecatedError to use BzrError instead'],
217
def test_bzrerror_from_literal_string(self):
218
# Some code constructs BzrError from a literal string, in which case
219
# no further formatting is done. (I'm not sure raising the base class
220
# is a great idea, but if the exception is not intended to be caught
221
# perhaps no more is needed.)
223
raise errors.BzrError('this is my errors; %d is not expanded')
224
except errors.BzrError, e:
225
self.assertEqual('this is my errors; %d is not expanded', str(e))
227
def test_reading_completed(self):
228
error = errors.ReadingCompleted("a request")
229
self.assertEqualDiff("The MediumRequest 'a request' has already had "
230
"finish_reading called upon it - the request has been completed and"
231
" no more data may be read.",
234
def test_writing_completed(self):
235
error = errors.WritingCompleted("a request")
236
self.assertEqualDiff("The MediumRequest 'a request' has already had "
237
"finish_writing called upon it - accept bytes may not be called "
241
def test_writing_not_completed(self):
242
error = errors.WritingNotComplete("a request")
243
self.assertEqualDiff("The MediumRequest 'a request' has not has "
244
"finish_writing called upon it - until the write phase is complete"
245
" no data may be read.",
248
def test_transport_not_possible(self):
249
error = errors.TransportNotPossible('readonly', 'original error')
250
self.assertEqualDiff('Transport operation not possible:'
251
' readonly original error', str(error))
253
def assertSocketConnectionError(self, expected, *args, **kwargs):
254
"""Check the formatting of a SocketConnectionError exception"""
255
e = errors.SocketConnectionError(*args, **kwargs)
256
self.assertEqual(expected, str(e))
258
def test_socket_connection_error(self):
259
"""Test the formatting of SocketConnectionError"""
261
# There should be a default msg about failing to connect
262
# we only require a host name.
263
self.assertSocketConnectionError(
264
'Failed to connect to ahost',
267
# If port is None, we don't put :None
268
self.assertSocketConnectionError(
269
'Failed to connect to ahost',
271
# But if port is supplied we include it
272
self.assertSocketConnectionError(
273
'Failed to connect to ahost:22',
276
# We can also supply extra information about the error
277
# with or without a port
278
self.assertSocketConnectionError(
279
'Failed to connect to ahost:22; bogus error',
280
'ahost', port=22, orig_error='bogus error')
281
self.assertSocketConnectionError(
282
'Failed to connect to ahost; bogus error',
283
'ahost', orig_error='bogus error')
284
# An exception object can be passed rather than a string
285
orig_error = ValueError('bad value')
286
self.assertSocketConnectionError(
287
'Failed to connect to ahost; %s' % (str(orig_error),),
288
host='ahost', orig_error=orig_error)
290
# And we can supply a custom failure message
291
self.assertSocketConnectionError(
292
'Unable to connect to ssh host ahost:444; my_error',
293
host='ahost', port=444, msg='Unable to connect to ssh host',
294
orig_error='my_error')
296
def test_malformed_bug_identifier(self):
297
"""Test the formatting of MalformedBugIdentifier."""
298
error = errors.MalformedBugIdentifier('bogus', 'reason for bogosity')
300
"Did not understand bug identifier bogus: reason for bogosity",
303
def test_unknown_bug_tracker_abbreviation(self):
304
"""Test the formatting of UnknownBugTrackerAbbreviation."""
305
branch = self.make_branch('some_branch')
306
error = errors.UnknownBugTrackerAbbreviation('xxx', branch)
308
"Cannot find registered bug tracker called xxx on %s" % branch,
311
def test_unexpected_smart_server_response(self):
312
e = errors.UnexpectedSmartServerResponse(('not yes',))
314
"Could not understand response from smart server: ('not yes',)",
317
def test_unknown_container_format(self):
318
"""Test the formatting of UnknownContainerFormatError."""
319
e = errors.UnknownContainerFormatError('bad format string')
321
"Unrecognised container format: 'bad format string'",
324
def test_unexpected_end_of_container(self):
325
"""Test the formatting of UnexpectedEndOfContainerError."""
326
e = errors.UnexpectedEndOfContainerError()
328
"Unexpected end of container stream", str(e))
330
def test_unknown_record_type(self):
331
"""Test the formatting of UnknownRecordTypeError."""
332
e = errors.UnknownRecordTypeError("X")
334
"Unknown record type: 'X'",
337
def test_invalid_record(self):
338
"""Test the formatting of InvalidRecordError."""
339
e = errors.InvalidRecordError("xxx")
341
"Invalid record: xxx",
344
def test_container_has_excess_data(self):
345
"""Test the formatting of ContainerHasExcessDataError."""
346
e = errors.ContainerHasExcessDataError("excess bytes")
348
"Container has data after end marker: 'excess bytes'",
351
def test_duplicate_record_name_error(self):
352
"""Test the formatting of DuplicateRecordNameError."""
353
e = errors.DuplicateRecordNameError(u"n\xe5me".encode('utf-8'))
355
"Container has multiple records with the same name: n\xc3\xa5me",
359
class PassThroughError(errors.BzrError):
361
_fmt = """Pass through %(foo)s and %(bar)s"""
363
def __init__(self, foo, bar):
364
errors.BzrError.__init__(self, foo=foo, bar=bar)
367
class ErrorWithBadFormat(errors.BzrError):
369
_fmt = """One format specifier: %(thing)s"""
372
class ErrorWithNoFormat(errors.BzrError):
373
"""This class has a docstring but no format string."""
376
class TestErrorFormatting(TestCase):
378
def test_always_str(self):
379
e = PassThroughError(u'\xb5', 'bar')
380
self.assertIsInstance(e.__str__(), str)
381
# In Python str(foo) *must* return a real byte string
382
# not a Unicode string. The following line would raise a
383
# Unicode error, because it tries to call str() on the string
384
# returned from e.__str__(), and it has non ascii characters
386
self.assertEqual('Pass through \xc2\xb5 and bar', s)
388
def test_missing_format_string(self):
389
e = ErrorWithNoFormat(param='randomvalue')
390
s = self.callDeprecated(
391
['ErrorWithNoFormat uses its docstring as a format, it should use _fmt instead'],
395
"This class has a docstring but no format string.")
397
def test_mismatched_format_args(self):
398
# Even though ErrorWithBadFormat's format string does not match the
399
# arguments we constructing it with, we can still stringify an instance
400
# of this exception. The resulting string will say its unprintable.
401
e = ErrorWithBadFormat(not_thing='x')
402
self.assertStartsWith(
403
str(e), 'Unprintable exception ErrorWithBadFormat')
added
removed
bzrlib/tests/test_errors.py
