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_inventory_modified(self):
44
error = errors.InventoryModified("a tree to be repred")
45
self.assertEqualDiff("The current inventory for the tree 'a tree to "
46
"be repred' has been modified, so a clean inventory cannot be "
47
"read without data loss.",
50
def test_install_failed(self):
51
error = errors.InstallFailed(['rev-one'])
52
self.assertEqual("Could not install revisions:\nrev-one", str(error))
53
error = errors.InstallFailed(['rev-one', 'rev-two'])
54
self.assertEqual("Could not install revisions:\nrev-one, rev-two",
56
error = errors.InstallFailed([None])
57
self.assertEqual("Could not install revisions:\nNone", str(error))
59
def test_lock_active(self):
60
error = errors.LockActive("lock description")
61
self.assertEqualDiff("The lock for 'lock description' is in use and "
65
def test_knit_header_error(self):
66
error = errors.KnitHeaderError('line foo\n', 'path/to/file')
67
self.assertEqual("Knit header error: 'line foo\\n' unexpected"
68
" for file path/to/file", str(error))
70
def test_knit_index_unknown_method(self):
71
error = errors.KnitIndexUnknownMethod('http://host/foo.kndx',
73
self.assertEqual("Knit index http://host/foo.kndx does not have a"
74
" known method in options: ['bad', 'no-eol']",
77
def test_medium_not_connected(self):
78
error = errors.MediumNotConnected("a medium")
80
"The medium 'a medium' is not connected.", str(error))
82
def test_no_repo(self):
83
dir = bzrdir.BzrDir.create(self.get_url())
84
error = errors.NoRepositoryPresent(dir)
85
self.assertNotEqual(-1, str(error).find((dir.transport.clone('..').base)))
86
self.assertEqual(-1, str(error).find((dir.transport.base)))
88
def test_no_smart_medium(self):
89
error = errors.NoSmartMedium("a transport")
90
self.assertEqualDiff("The transport 'a transport' cannot tunnel the "
94
def test_no_help_topic(self):
95
error = errors.NoHelpTopic("topic")
96
self.assertEqualDiff("No help could be found for 'topic'. "
97
"Please use 'bzr help topics' to obtain a list of topics.",
100
def test_no_such_id(self):
101
error = errors.NoSuchId("atree", "anid")
102
self.assertEqualDiff("The file id anid is not present in the tree "
106
def test_no_such_revision_in_tree(self):
107
error = errors.NoSuchRevisionInTree("atree", "anid")
108
self.assertEqualDiff("The revision id anid is not present in the tree "
111
self.assertIsInstance(error, errors.NoSuchRevision)
113
def test_not_write_locked(self):
114
error = errors.NotWriteLocked('a thing to repr')
115
self.assertEqualDiff("'a thing to repr' is not write locked but needs "
119
def test_read_only_lock_error(self):
120
error = errors.ReadOnlyLockError('filename', 'error message')
121
self.assertEqualDiff("Cannot acquire write lock on filename."
122
" error message", str(error))
124
def test_too_many_concurrent_requests(self):
125
error = errors.TooManyConcurrentRequests("a medium")
126
self.assertEqualDiff("The medium 'a medium' has reached its concurrent "
127
"request limit. Be sure to finish_writing and finish_reading on "
128
"the current request that is open.",
131
def test_unknown_hook(self):
132
error = errors.UnknownHook("branch", "foo")
133
self.assertEqualDiff("The branch hook 'foo' is unknown in this version"
136
error = errors.UnknownHook("tree", "bar")
137
self.assertEqualDiff("The tree hook 'bar' is unknown in this version"
141
def test_up_to_date(self):
142
error = errors.UpToDateFormat(bzrdir.BzrDirFormat4())
143
self.assertEqualDiff("The branch format Bazaar-NG branch, "
144
"format 0.0.4 is already at the most "
148
def test_corrupt_repository(self):
149
repo = self.make_repository('.')
150
error = errors.CorruptRepository(repo)
151
self.assertEqualDiff("An error has been detected in the repository %s.\n"
152
"Please run bzr reconcile on this repository." %
153
repo.bzrdir.root_transport.base,
156
def test_bzrnewerror_is_deprecated(self):
157
class DeprecatedError(errors.BzrNewError):
159
self.callDeprecated(['BzrNewError was deprecated in bzr 0.13; '
160
'please convert DeprecatedError to use BzrError instead'],
163
def test_bzrerror_from_literal_string(self):
164
# Some code constructs BzrError from a literal string, in which case
165
# no further formatting is done. (I'm not sure raising the base class
166
# is a great idea, but if the exception is not intended to be caught
167
# perhaps no more is needed.)
169
raise errors.BzrError('this is my errors; %d is not expanded')
170
except errors.BzrError, e:
171
self.assertEqual('this is my errors; %d is not expanded', str(e))
173
def test_reading_completed(self):
174
error = errors.ReadingCompleted("a request")
175
self.assertEqualDiff("The MediumRequest 'a request' has already had "
176
"finish_reading called upon it - the request has been completed and"
177
" no more data may be read.",
180
def test_writing_completed(self):
181
error = errors.WritingCompleted("a request")
182
self.assertEqualDiff("The MediumRequest 'a request' has already had "
183
"finish_writing called upon it - accept bytes may not be called "
187
def test_writing_not_completed(self):
188
error = errors.WritingNotComplete("a request")
189
self.assertEqualDiff("The MediumRequest 'a request' has not has "
190
"finish_writing called upon it - until the write phase is complete"
191
" no data may be read.",
194
def test_transport_not_possible(self):
195
e = errors.TransportNotPossible('readonly', 'original error')
196
self.assertEqual('Transport operation not possible:'
197
' readonly original error', str(e))
199
def assertSocketConnectionError(self, expected, *args, **kwargs):
200
"""Check the formatting of a SocketConnectionError exception"""
201
e = errors.SocketConnectionError(*args, **kwargs)
202
self.assertEqual(expected, str(e))
204
def test_socket_connection_error(self):
205
"""Test the formatting of SocketConnectionError"""
207
# There should be a default msg about failing to connect
208
# we only require a host name.
209
self.assertSocketConnectionError(
210
'Failed to connect to ahost',
213
# If port is None, we don't put :None
214
self.assertSocketConnectionError(
215
'Failed to connect to ahost',
217
# But if port is supplied we include it
218
self.assertSocketConnectionError(
219
'Failed to connect to ahost:22',
222
# We can also supply extra information about the error
223
# with or without a port
224
self.assertSocketConnectionError(
225
'Failed to connect to ahost:22; bogus error',
226
'ahost', port=22, orig_error='bogus error')
227
self.assertSocketConnectionError(
228
'Failed to connect to ahost; bogus error',
229
'ahost', orig_error='bogus error')
230
# An exception object can be passed rather than a string
231
orig_error = ValueError('bad value')
232
self.assertSocketConnectionError(
233
'Failed to connect to ahost; %s' % (str(orig_error),),
234
host='ahost', orig_error=orig_error)
236
# And we can supply a custom failure message
237
self.assertSocketConnectionError(
238
'Unable to connect to ssh host ahost:444; my_error',
239
host='ahost', port=444, msg='Unable to connect to ssh host',
240
orig_error='my_error')
244
class PassThroughError(errors.BzrError):
246
_fmt = """Pass through %(foo)s and %(bar)s"""
248
def __init__(self, foo, bar):
249
errors.BzrError.__init__(self, foo=foo, bar=bar)
252
class ErrorWithBadFormat(errors.BzrError):
254
_fmt = """One format specifier: %(thing)s"""
257
class ErrorWithNoFormat(errors.BzrError):
258
"""This class has a docstring but no format string."""
261
class TestErrorFormatting(TestCase):
263
def test_always_str(self):
264
e = PassThroughError(u'\xb5', 'bar')
265
self.assertIsInstance(e.__str__(), str)
266
# In Python str(foo) *must* return a real byte string
267
# not a Unicode string. The following line would raise a
268
# Unicode error, because it tries to call str() on the string
269
# returned from e.__str__(), and it has non ascii characters
271
self.assertEqual('Pass through \xc2\xb5 and bar', s)
273
def test_missing_format_string(self):
274
e = ErrorWithNoFormat(param='randomvalue')
275
s = self.callDeprecated(
276
['ErrorWithNoFormat uses its docstring as a format, it should use _fmt instead'],
280
"This class has a docstring but no format string.")
282
def test_mismatched_format_args(self):
283
# Even though ErrorWithBadFormat's format string does not match the
284
# arguments we constructing it with, we can still stringify an instance
285
# of this exception. The resulting string will say its unprintable.
286
e = ErrorWithBadFormat(not_thing='x')
287
self.assertStartsWith(
288
str(e), 'Unprintable exception ErrorWithBadFormat')
added
removed
bzrlib/tests/test_errors.py
