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