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_inventory_modified(self):
57
error = errors.InventoryModified("a tree to be repred")
58
self.assertEqualDiff("The current inventory for the tree 'a tree to "
59
"be repred' has been modified, so a clean inventory cannot be "
60
"read without data loss.",
63
def test_install_failed(self):
64
error = errors.InstallFailed(['rev-one'])
65
self.assertEqual("Could not install revisions:\nrev-one", str(error))
66
error = errors.InstallFailed(['rev-one', 'rev-two'])
67
self.assertEqual("Could not install revisions:\nrev-one, rev-two",
69
error = errors.InstallFailed([None])
70
self.assertEqual("Could not install revisions:\nNone", str(error))
72
def test_lock_active(self):
73
error = errors.LockActive("lock description")
74
self.assertEqualDiff("The lock for 'lock description' is in use and "
78
def test_knit_header_error(self):
79
error = errors.KnitHeaderError('line foo\n', 'path/to/file')
80
self.assertEqual("Knit header error: 'line foo\\n' unexpected"
81
" for file path/to/file", str(error))
83
def test_knit_index_unknown_method(self):
84
error = errors.KnitIndexUnknownMethod('http://host/foo.kndx',
86
self.assertEqual("Knit index http://host/foo.kndx does not have a"
87
" known method in options: ['bad', 'no-eol']",
90
def test_medium_not_connected(self):
91
error = errors.MediumNotConnected("a medium")
93
"The medium 'a medium' is not connected.", str(error))
95
def test_no_repo(self):
96
dir = bzrdir.BzrDir.create(self.get_url())
97
error = errors.NoRepositoryPresent(dir)
98
self.assertNotEqual(-1, str(error).find((dir.transport.clone('..').base)))
99
self.assertEqual(-1, str(error).find((dir.transport.base)))
101
def test_no_smart_medium(self):
102
error = errors.NoSmartMedium("a transport")
103
self.assertEqualDiff("The transport 'a transport' cannot tunnel the "
107
def test_no_help_topic(self):
108
error = errors.NoHelpTopic("topic")
109
self.assertEqualDiff("No help could be found for 'topic'. "
110
"Please use 'bzr help topics' to obtain a list of topics.",
113
def test_no_such_id(self):
114
error = errors.NoSuchId("atree", "anid")
115
self.assertEqualDiff("The file id anid is not present in the tree "
119
def test_no_such_revision_in_tree(self):
120
error = errors.NoSuchRevisionInTree("atree", "anid")
121
self.assertEqualDiff("The revision id anid is not present in the tree "
124
self.assertIsInstance(error, errors.NoSuchRevision)
126
def test_not_write_locked(self):
127
error = errors.NotWriteLocked('a thing to repr')
128
self.assertEqualDiff("'a thing to repr' is not write locked but needs "
132
def test_read_only_lock_error(self):
133
error = errors.ReadOnlyLockError('filename', 'error message')
134
self.assertEqualDiff("Cannot acquire write lock on filename."
135
" error message", str(error))
137
def test_too_many_concurrent_requests(self):
138
error = errors.TooManyConcurrentRequests("a medium")
139
self.assertEqualDiff("The medium 'a medium' has reached its concurrent "
140
"request limit. Be sure to finish_writing and finish_reading on "
141
"the currently open request.",
144
def test_unknown_hook(self):
145
error = errors.UnknownHook("branch", "foo")
146
self.assertEqualDiff("The branch hook 'foo' is unknown in this version"
149
error = errors.UnknownHook("tree", "bar")
150
self.assertEqualDiff("The tree hook 'bar' is unknown in this version"
154
def test_up_to_date(self):
155
error = errors.UpToDateFormat(bzrdir.BzrDirFormat4())
156
self.assertEqualDiff("The branch format Bazaar-NG branch, "
157
"format 0.0.4 is already at the most "
161
def test_corrupt_repository(self):
162
repo = self.make_repository('.')
163
error = errors.CorruptRepository(repo)
164
self.assertEqualDiff("An error has been detected in the repository %s.\n"
165
"Please run bzr reconcile on this repository." %
166
repo.bzrdir.root_transport.base,
169
def test_read_error(self):
170
# a unicode path to check that %r is being used.
172
error = errors.ReadError(path)
173
self.assertEqualDiff("Error reading from u'a path'.", str(error))
176
def test_bzrnewerror_is_deprecated(self):
177
class DeprecatedError(errors.BzrNewError):
179
self.callDeprecated(['BzrNewError was deprecated in bzr 0.13; '
180
'please convert DeprecatedError to use BzrError instead'],
183
def test_bzrerror_from_literal_string(self):
184
# Some code constructs BzrError from a literal string, in which case
185
# no further formatting is done. (I'm not sure raising the base class
186
# is a great idea, but if the exception is not intended to be caught
187
# perhaps no more is needed.)
189
raise errors.BzrError('this is my errors; %d is not expanded')
190
except errors.BzrError, e:
191
self.assertEqual('this is my errors; %d is not expanded', str(e))
193
def test_reading_completed(self):
194
error = errors.ReadingCompleted("a request")
195
self.assertEqualDiff("The MediumRequest 'a request' has already had "
196
"finish_reading called upon it - the request has been completed and"
197
" no more data may be read.",
200
def test_writing_completed(self):
201
error = errors.WritingCompleted("a request")
202
self.assertEqualDiff("The MediumRequest 'a request' has already had "
203
"finish_writing called upon it - accept bytes may not be called "
207
def test_writing_not_completed(self):
208
error = errors.WritingNotComplete("a request")
209
self.assertEqualDiff("The MediumRequest 'a request' has not has "
210
"finish_writing called upon it - until the write phase is complete"
211
" no data may be read.",
214
def test_transport_not_possible(self):
215
error = errors.TransportNotPossible('readonly', 'original error')
216
self.assertEqualDiff('Transport operation not possible:'
217
' readonly original error', str(error))
219
def assertSocketConnectionError(self, expected, *args, **kwargs):
220
"""Check the formatting of a SocketConnectionError exception"""
221
e = errors.SocketConnectionError(*args, **kwargs)
222
self.assertEqual(expected, str(e))
224
def test_socket_connection_error(self):
225
"""Test the formatting of SocketConnectionError"""
227
# There should be a default msg about failing to connect
228
# we only require a host name.
229
self.assertSocketConnectionError(
230
'Failed to connect to ahost',
233
# If port is None, we don't put :None
234
self.assertSocketConnectionError(
235
'Failed to connect to ahost',
237
# But if port is supplied we include it
238
self.assertSocketConnectionError(
239
'Failed to connect to ahost:22',
242
# We can also supply extra information about the error
243
# with or without a port
244
self.assertSocketConnectionError(
245
'Failed to connect to ahost:22; bogus error',
246
'ahost', port=22, orig_error='bogus error')
247
self.assertSocketConnectionError(
248
'Failed to connect to ahost; bogus error',
249
'ahost', orig_error='bogus error')
250
# An exception object can be passed rather than a string
251
orig_error = ValueError('bad value')
252
self.assertSocketConnectionError(
253
'Failed to connect to ahost; %s' % (str(orig_error),),
254
host='ahost', orig_error=orig_error)
256
# And we can supply a custom failure message
257
self.assertSocketConnectionError(
258
'Unable to connect to ssh host ahost:444; my_error',
259
host='ahost', port=444, msg='Unable to connect to ssh host',
260
orig_error='my_error')
262
def test_malformed_bug_identifier(self):
263
"""Test the formatting of MalformedBugIdentifier."""
264
error = errors.MalformedBugIdentifier('bogus', 'reason for bogosity')
266
"Did not understand bug identifier bogus: reason for bogosity",
269
def test_unknown_bug_tracker_abbreviation(self):
270
"""Test the formatting of UnknownBugTrackerAbbreviation."""
271
branch = self.make_branch('some_branch')
272
error = errors.UnknownBugTrackerAbbreviation('xxx', branch)
274
"Cannot find registered bug tracker called xxx on %s" % branch,
277
def test_unexpected_smart_server_response(self):
278
e = errors.UnexpectedSmartServerResponse(('not yes',))
280
"Could not understand response from smart server: ('not yes',)",
283
def test_unknown_container_format(self):
284
"""Test the formatting of UnknownContainerFormatError."""
285
e = errors.UnknownContainerFormatError('bad format string')
287
"Unrecognised container format: 'bad format string'",
290
def test_unexpected_end_of_container(self):
291
"""Test the formatting of UnexpectedEndOfContainerError."""
292
e = errors.UnexpectedEndOfContainerError()
294
"Unexpected end of container stream", str(e))
296
def test_unknown_record_type(self):
297
"""Test the formatting of UnknownRecordTypeError."""
298
e = errors.UnknownRecordTypeError("X")
300
"Unknown record type: 'X'",
303
def test_invalid_record(self):
304
"""Test the formatting of InvalidRecordError."""
305
e = errors.InvalidRecordError("xxx")
307
"Invalid record: xxx",
310
def test_container_has_excess_data(self):
311
"""Test the formatting of ContainerHasExcessDataError."""
312
e = errors.ContainerHasExcessDataError("excess bytes")
314
"Container has data after end marker: 'excess bytes'",
317
def test_duplicate_record_name_error(self):
318
"""Test the formatting of DuplicateRecordNameError."""
319
e = errors.DuplicateRecordNameError(u"n\xe5me".encode('utf-8'))
321
"Container has multiple records with the same name: \"n\xc3\xa5me\"",
325
class PassThroughError(errors.BzrError):
327
_fmt = """Pass through %(foo)s and %(bar)s"""
329
def __init__(self, foo, bar):
330
errors.BzrError.__init__(self, foo=foo, bar=bar)
333
class ErrorWithBadFormat(errors.BzrError):
335
_fmt = """One format specifier: %(thing)s"""
338
class ErrorWithNoFormat(errors.BzrError):
339
"""This class has a docstring but no format string."""
342
class TestErrorFormatting(TestCase):
344
def test_always_str(self):
345
e = PassThroughError(u'\xb5', 'bar')
346
self.assertIsInstance(e.__str__(), str)
347
# In Python str(foo) *must* return a real byte string
348
# not a Unicode string. The following line would raise a
349
# Unicode error, because it tries to call str() on the string
350
# returned from e.__str__(), and it has non ascii characters
352
self.assertEqual('Pass through \xc2\xb5 and bar', s)
354
def test_missing_format_string(self):
355
e = ErrorWithNoFormat(param='randomvalue')
356
s = self.callDeprecated(
357
['ErrorWithNoFormat uses its docstring as a format, it should use _fmt instead'],
361
"This class has a docstring but no format string.")
363
def test_mismatched_format_args(self):
364
# Even though ErrorWithBadFormat's format string does not match the
365
# arguments we constructing it with, we can still stringify an instance
366
# of this exception. The resulting string will say its unprintable.
367
e = ErrorWithBadFormat(not_thing='x')
368
self.assertStartsWith(
369
str(e), 'Unprintable exception ErrorWithBadFormat')
added
removed
bzrlib/tests/test_errors.py
