1
# Copyright (C) 2006 Canonical Ltd
2
# Authors: Robert Collins <robert.collins@canonical.com>
4
# This program is free software; you can redistribute it and/or modify
5
# it under the terms of the GNU General Public License as published by
6
# the Free Software Foundation; either version 2 of the License, or
7
# (at your option) any later version.
9
# This program is distributed in the hope that it will be useful,
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
# GNU General Public License for more details.
14
# You should have received a copy of the GNU General Public License
15
# along with this program; if not, write to the Free Software
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
"""Tests for the formatting and construction of errors."""
24
from bzrlib.tests import TestCase, TestCaseWithTransport
27
# TODO: Make sure builtin exception class formats are consistent - e.g. should
28
# or shouldn't end with a full stop, etc.
31
class TestErrors(TestCaseWithTransport):
33
def test_disabled_method(self):
34
error = errors.DisabledMethod("class name")
36
"The smart server method 'class name' is disabled.", str(error))
38
def test_duplicate_file_id(self):
39
error = errors.DuplicateFileId('a_file_id', 'foo')
40
self.assertEqualDiff('File id {a_file_id} already exists in inventory'
41
' as foo', str(error))
43
def test_duplicate_help_prefix(self):
44
error = errors.DuplicateHelpPrefix('foo')
45
self.assertEqualDiff('The prefix foo is in the help search path twice.',
48
def test_inventory_modified(self):
49
error = errors.InventoryModified("a tree to be repred")
50
self.assertEqualDiff("The current inventory for the tree 'a tree to "
51
"be repred' has been modified, so a clean inventory cannot be "
52
"read without data loss.",
55
def test_install_failed(self):
56
error = errors.InstallFailed(['rev-one'])
57
self.assertEqual("Could not install revisions:\nrev-one", str(error))
58
error = errors.InstallFailed(['rev-one', 'rev-two'])
59
self.assertEqual("Could not install revisions:\nrev-one, rev-two",
61
error = errors.InstallFailed([None])
62
self.assertEqual("Could not install revisions:\nNone", str(error))
64
def test_lock_active(self):
65
error = errors.LockActive("lock description")
66
self.assertEqualDiff("The lock for 'lock description' is in use and "
70
def test_knit_header_error(self):
71
error = errors.KnitHeaderError('line foo\n', 'path/to/file')
72
self.assertEqual("Knit header error: 'line foo\\n' unexpected"
73
" for file path/to/file", str(error))
75
def test_knit_index_unknown_method(self):
76
error = errors.KnitIndexUnknownMethod('http://host/foo.kndx',
78
self.assertEqual("Knit index http://host/foo.kndx does not have a"
79
" known method in options: ['bad', 'no-eol']",
82
def test_medium_not_connected(self):
83
error = errors.MediumNotConnected("a medium")
85
"The medium 'a medium' is not connected.", str(error))
87
def test_no_repo(self):
88
dir = bzrdir.BzrDir.create(self.get_url())
89
error = errors.NoRepositoryPresent(dir)
90
self.assertNotEqual(-1, str(error).find((dir.transport.clone('..').base)))
91
self.assertEqual(-1, str(error).find((dir.transport.base)))
93
def test_no_smart_medium(self):
94
error = errors.NoSmartMedium("a transport")
95
self.assertEqualDiff("The transport 'a transport' cannot tunnel the "
99
def test_no_help_topic(self):
100
error = errors.NoHelpTopic("topic")
101
self.assertEqualDiff("No help could be found for 'topic'. "
102
"Please use 'bzr help topics' to obtain a list of topics.",
105
def test_no_such_id(self):
106
error = errors.NoSuchId("atree", "anid")
107
self.assertEqualDiff("The file id anid is not present in the tree "
111
def test_no_such_revision_in_tree(self):
112
error = errors.NoSuchRevisionInTree("atree", "anid")
113
self.assertEqualDiff("The revision id anid is not present in the tree "
116
self.assertIsInstance(error, errors.NoSuchRevision)
118
def test_not_write_locked(self):
119
error = errors.NotWriteLocked('a thing to repr')
120
self.assertEqualDiff("'a thing to repr' is not write locked but needs "
124
def test_read_only_lock_error(self):
125
error = errors.ReadOnlyLockError('filename', 'error message')
126
self.assertEqualDiff("Cannot acquire write lock on filename."
127
" error message", str(error))
129
def test_too_many_concurrent_requests(self):
130
error = errors.TooManyConcurrentRequests("a medium")
131
self.assertEqualDiff("The medium 'a medium' has reached its concurrent "
132
"request limit. Be sure to finish_writing and finish_reading on "
133
"the currently open request.",
136
def test_unknown_hook(self):
137
error = errors.UnknownHook("branch", "foo")
138
self.assertEqualDiff("The branch hook 'foo' is unknown in this version"
141
error = errors.UnknownHook("tree", "bar")
142
self.assertEqualDiff("The tree hook 'bar' is unknown in this version"
146
def test_up_to_date(self):
147
error = errors.UpToDateFormat(bzrdir.BzrDirFormat4())
148
self.assertEqualDiff("The branch format Bazaar-NG branch, "
149
"format 0.0.4 is already at the most "
153
def test_corrupt_repository(self):
154
repo = self.make_repository('.')
155
error = errors.CorruptRepository(repo)
156
self.assertEqualDiff("An error has been detected in the repository %s.\n"
157
"Please run bzr reconcile on this repository." %
158
repo.bzrdir.root_transport.base,
161
def test_bzrnewerror_is_deprecated(self):
162
class DeprecatedError(errors.BzrNewError):
164
self.callDeprecated(['BzrNewError was deprecated in bzr 0.13; '
165
'please convert DeprecatedError to use BzrError instead'],
168
def test_bzrerror_from_literal_string(self):
169
# Some code constructs BzrError from a literal string, in which case
170
# no further formatting is done. (I'm not sure raising the base class
171
# is a great idea, but if the exception is not intended to be caught
172
# perhaps no more is needed.)
174
raise errors.BzrError('this is my errors; %d is not expanded')
175
except errors.BzrError, e:
176
self.assertEqual('this is my errors; %d is not expanded', str(e))
178
def test_reading_completed(self):
179
error = errors.ReadingCompleted("a request")
180
self.assertEqualDiff("The MediumRequest 'a request' has already had "
181
"finish_reading called upon it - the request has been completed and"
182
" no more data may be read.",
185
def test_writing_completed(self):
186
error = errors.WritingCompleted("a request")
187
self.assertEqualDiff("The MediumRequest 'a request' has already had "
188
"finish_writing called upon it - accept bytes may not be called "
192
def test_writing_not_completed(self):
193
error = errors.WritingNotComplete("a request")
194
self.assertEqualDiff("The MediumRequest 'a request' has not has "
195
"finish_writing called upon it - until the write phase is complete"
196
" no data may be read.",
199
def test_transport_not_possible(self):
200
e = errors.TransportNotPossible('readonly', 'original error')
201
self.assertEqual('Transport operation not possible:'
202
' readonly original error', str(e))
204
def assertSocketConnectionError(self, expected, *args, **kwargs):
205
"""Check the formatting of a SocketConnectionError exception"""
206
e = errors.SocketConnectionError(*args, **kwargs)
207
self.assertEqual(expected, str(e))
209
def test_socket_connection_error(self):
210
"""Test the formatting of SocketConnectionError"""
212
# There should be a default msg about failing to connect
213
# we only require a host name.
214
self.assertSocketConnectionError(
215
'Failed to connect to ahost',
218
# If port is None, we don't put :None
219
self.assertSocketConnectionError(
220
'Failed to connect to ahost',
222
# But if port is supplied we include it
223
self.assertSocketConnectionError(
224
'Failed to connect to ahost:22',
227
# We can also supply extra information about the error
228
# with or without a port
229
self.assertSocketConnectionError(
230
'Failed to connect to ahost:22; bogus error',
231
'ahost', port=22, orig_error='bogus error')
232
self.assertSocketConnectionError(
233
'Failed to connect to ahost; bogus error',
234
'ahost', orig_error='bogus error')
235
# An exception object can be passed rather than a string
236
orig_error = ValueError('bad value')
237
self.assertSocketConnectionError(
238
'Failed to connect to ahost; %s' % (str(orig_error),),
239
host='ahost', orig_error=orig_error)
241
# And we can supply a custom failure message
242
self.assertSocketConnectionError(
243
'Unable to connect to ssh host ahost:444; my_error',
244
host='ahost', port=444, msg='Unable to connect to ssh host',
245
orig_error='my_error')
247
def test_malformed_bug_identifier(self):
248
"""Test the formatting of MalformedBugIdentifier."""
249
error = errors.MalformedBugIdentifier('bogus', 'reason for bogosity')
251
"Did not understand bug identifier bogus: reason for bogosity",
254
def test_unknown_bug_tracker_abbreviation(self):
255
"""Test the formatting of UnknownBugTrackerAbbreviation."""
256
branch = self.make_branch('some_branch')
257
error = errors.UnknownBugTrackerAbbreviation('xxx', branch)
259
"Cannot find registered bug tracker called xxx on %s" % branch,
262
def test_unexpected_smart_server_response(self):
263
e = errors.UnexpectedSmartServerResponse(('not yes',))
265
"Could not understand response from smart server: ('not yes',)",
269
class PassThroughError(errors.BzrError):
271
_fmt = """Pass through %(foo)s and %(bar)s"""
273
def __init__(self, foo, bar):
274
errors.BzrError.__init__(self, foo=foo, bar=bar)
277
class ErrorWithBadFormat(errors.BzrError):
279
_fmt = """One format specifier: %(thing)s"""
282
class ErrorWithNoFormat(errors.BzrError):
283
"""This class has a docstring but no format string."""
286
class TestErrorFormatting(TestCase):
288
def test_always_str(self):
289
e = PassThroughError(u'\xb5', 'bar')
290
self.assertIsInstance(e.__str__(), str)
291
# In Python str(foo) *must* return a real byte string
292
# not a Unicode string. The following line would raise a
293
# Unicode error, because it tries to call str() on the string
294
# returned from e.__str__(), and it has non ascii characters
296
self.assertEqual('Pass through \xc2\xb5 and bar', s)
298
def test_missing_format_string(self):
299
e = ErrorWithNoFormat(param='randomvalue')
300
s = self.callDeprecated(
301
['ErrorWithNoFormat uses its docstring as a format, it should use _fmt instead'],
305
"This class has a docstring but no format string.")
307
def test_mismatched_format_args(self):
308
# Even though ErrorWithBadFormat's format string does not match the
309
# arguments we constructing it with, we can still stringify an instance
310
# of this exception. The resulting string will say its unprintable.
311
e = ErrorWithBadFormat(not_thing='x')
312
self.assertStartsWith(
313
str(e), 'Unprintable exception ErrorWithBadFormat')
added
removed
bzrlib/tests/test_errors.py
