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_duplicate_file_id(self):
34
error = errors.DuplicateFileId('a_file_id', 'foo')
35
self.assertEqualDiff('File id {a_file_id} already exists in inventory'
36
' as foo', str(error))
38
def test_inventory_modified(self):
39
error = errors.InventoryModified("a tree to be repred")
40
self.assertEqualDiff("The current inventory for the tree 'a tree to "
41
"be repred' has been modified, so a clean inventory cannot be "
42
"read without data loss.",
45
def test_install_failed(self):
46
error = errors.InstallFailed(['rev-one'])
47
self.assertEqual("Could not install revisions:\nrev-one", str(error))
48
error = errors.InstallFailed(['rev-one', 'rev-two'])
49
self.assertEqual("Could not install revisions:\nrev-one, rev-two",
51
error = errors.InstallFailed([None])
52
self.assertEqual("Could not install revisions:\nNone", str(error))
54
def test_lock_active(self):
55
error = errors.LockActive("lock description")
56
self.assertEqualDiff("The lock for 'lock description' is in use and "
60
def test_knit_header_error(self):
61
error = errors.KnitHeaderError('line foo\n', 'path/to/file')
62
self.assertEqual("Knit header error: 'line foo\\n' unexpected"
63
" for file path/to/file", str(error))
65
def test_knit_index_unknown_method(self):
66
error = errors.KnitIndexUnknownMethod('http://host/foo.kndx',
68
self.assertEqual("Knit index http://host/foo.kndx does not have a"
69
" known method in options: ['bad', 'no-eol']",
72
def test_medium_not_connected(self):
73
error = errors.MediumNotConnected("a medium")
75
"The medium 'a medium' is not connected.", str(error))
77
def test_no_repo(self):
78
dir = bzrdir.BzrDir.create(self.get_url())
79
error = errors.NoRepositoryPresent(dir)
80
self.assertNotEqual(-1, str(error).find((dir.transport.clone('..').base)))
81
self.assertEqual(-1, str(error).find((dir.transport.base)))
83
def test_no_smart_medium(self):
84
error = errors.NoSmartMedium("a transport")
85
self.assertEqualDiff("The transport 'a transport' cannot tunnel the "
89
def test_no_such_id(self):
90
error = errors.NoSuchId("atree", "anid")
91
self.assertEqualDiff("The file id anid is not present in the tree "
95
def test_no_such_revision_in_tree(self):
96
error = errors.NoSuchRevisionInTree("atree", "anid")
97
self.assertEqualDiff("The revision id anid is not present in the tree "
100
self.assertIsInstance(error, errors.NoSuchRevision)
102
def test_not_write_locked(self):
103
error = errors.NotWriteLocked('a thing to repr')
104
self.assertEqualDiff("'a thing to repr' is not write locked but needs "
108
def test_read_only_lock_error(self):
109
error = errors.ReadOnlyLockError('filename', 'error message')
110
self.assertEqualDiff("Cannot acquire write lock on filename."
111
" error message", str(error))
113
def test_too_many_concurrent_requests(self):
114
error = errors.TooManyConcurrentRequests("a medium")
115
self.assertEqualDiff("The medium 'a medium' has reached its concurrent "
116
"request limit. Be sure to finish_writing and finish_reading on "
117
"the current request that is open.",
120
def test_unknown_hook(self):
121
error = errors.UnknownHook("branch", "foo")
122
self.assertEqualDiff("The branch hook 'foo' is unknown in this version"
125
error = errors.UnknownHook("tree", "bar")
126
self.assertEqualDiff("The tree hook 'bar' is unknown in this version"
130
def test_up_to_date(self):
131
error = errors.UpToDateFormat(bzrdir.BzrDirFormat4())
132
self.assertEqualDiff("The branch format Bazaar-NG branch, "
133
"format 0.0.4 is already at the most "
137
def test_corrupt_repository(self):
138
repo = self.make_repository('.')
139
error = errors.CorruptRepository(repo)
140
self.assertEqualDiff("An error has been detected in the repository %s.\n"
141
"Please run bzr reconcile on this repository." %
142
repo.bzrdir.root_transport.base,
145
def test_bzrnewerror_is_deprecated(self):
146
class DeprecatedError(errors.BzrNewError):
148
self.callDeprecated(['BzrNewError was deprecated in bzr 0.13; '
149
'please convert DeprecatedError to use BzrError instead'],
152
def test_bzrerror_from_literal_string(self):
153
# Some code constructs BzrError from a literal string, in which case
154
# no further formatting is done. (I'm not sure raising the base class
155
# is a great idea, but if the exception is not intended to be caught
156
# perhaps no more is needed.)
158
raise errors.BzrError('this is my errors; %d is not expanded')
159
except errors.BzrError, e:
160
self.assertEqual('this is my errors; %d is not expanded', str(e))
162
def test_reading_completed(self):
163
error = errors.ReadingCompleted("a request")
164
self.assertEqualDiff("The MediumRequest 'a request' has already had "
165
"finish_reading called upon it - the request has been completed and"
166
" no more data may be read.",
169
def test_writing_completed(self):
170
error = errors.WritingCompleted("a request")
171
self.assertEqualDiff("The MediumRequest 'a request' has already had "
172
"finish_writing called upon it - accept bytes may not be called "
176
def test_writing_not_completed(self):
177
error = errors.WritingNotComplete("a request")
178
self.assertEqualDiff("The MediumRequest 'a request' has not has "
179
"finish_writing called upon it - until the write phase is complete"
180
" no data may be read.",
183
def test_transport_not_possible(self):
184
e = errors.TransportNotPossible('readonly', 'original error')
185
self.assertEqual('Transport operation not possible:'
186
' readonly original error', str(e))
188
def assertSocketConnectionError(self, expected, *args, **kwargs):
189
"""Check the formatting of a SocketConnectionError exception"""
190
e = errors.SocketConnectionError(*args, **kwargs)
191
self.assertEqual(expected, str(e))
193
def test_socket_connection_error(self):
194
"""Test the formatting of SocketConnectionError"""
196
# There should be a default msg about failing to connect
197
# we only require a host name.
198
self.assertSocketConnectionError(
199
'Failed to connect to ahost',
202
# If port is None, we don't put :None
203
self.assertSocketConnectionError(
204
'Failed to connect to ahost',
206
# But if port is supplied we include it
207
self.assertSocketConnectionError(
208
'Failed to connect to ahost:22',
211
# We can also supply extra information about the error
212
# with or without a port
213
self.assertSocketConnectionError(
214
'Failed to connect to ahost:22; bogus error',
215
'ahost', port=22, orig_error='bogus error')
216
self.assertSocketConnectionError(
217
'Failed to connect to ahost; bogus error',
218
'ahost', orig_error='bogus error')
219
# An exception object can be passed rather than a string
220
orig_error = ValueError('bad value')
221
self.assertSocketConnectionError(
222
'Failed to connect to ahost; %s' % (str(orig_error),),
223
host='ahost', orig_error=orig_error)
225
# And we can supply a custom failure message
226
self.assertSocketConnectionError(
227
'Unable to connect to ssh host ahost:444; my_error',
228
host='ahost', port=444, msg='Unable to connect to ssh host',
229
orig_error='my_error')
233
class PassThroughError(errors.BzrError):
235
_fmt = """Pass through %(foo)s and %(bar)s"""
237
def __init__(self, foo, bar):
238
errors.BzrError.__init__(self, foo=foo, bar=bar)
241
class ErrorWithBadFormat(errors.BzrError):
243
_fmt = """One format specifier: %(thing)s"""
246
class ErrorWithNoFormat(errors.BzrError):
247
"""This class has a docstring but no format string."""
250
class TestErrorFormatting(TestCase):
252
def test_always_str(self):
253
e = PassThroughError(u'\xb5', 'bar')
254
self.assertIsInstance(e.__str__(), str)
255
# In Python str(foo) *must* return a real byte string
256
# not a Unicode string. The following line would raise a
257
# Unicode error, because it tries to call str() on the string
258
# returned from e.__str__(), and it has non ascii characters
260
self.assertEqual('Pass through \xc2\xb5 and bar', s)
262
def test_missing_format_string(self):
263
e = ErrorWithNoFormat(param='randomvalue')
264
s = self.callDeprecated(
265
['ErrorWithNoFormat uses its docstring as a format, it should use _fmt instead'],
269
"This class has a docstring but no format string.")
271
def test_mismatched_format_args(self):
272
# Even though ErrorWithBadFormat's format string does not match the
273
# arguments we constructing it with, we can still stringify an instance
274
# of this exception. The resulting string will say its unprintable.
275
e = ErrorWithBadFormat(not_thing='x')
276
self.assertStartsWith(
277
str(e), 'Unprintable exception ErrorWithBadFormat')
added
removed
bzrlib/tests/test_errors.py
