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_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_knit_header_error(self):
55
error = errors.KnitHeaderError('line foo\n', 'path/to/file')
56
self.assertEqual("Knit header error: 'line foo\\n' unexpected"
57
" for file path/to/file", str(error))
59
def test_knit_index_unknown_method(self):
60
error = errors.KnitIndexUnknownMethod('http://host/foo.kndx',
62
self.assertEqual("Knit index http://host/foo.kndx does not have a"
63
" known method in options: ['bad', 'no-eol']",
66
def test_medium_not_connected(self):
67
error = errors.MediumNotConnected("a medium")
69
"The medium 'a medium' is not connected.", str(error))
71
def test_no_repo(self):
72
dir = bzrdir.BzrDir.create(self.get_url())
73
error = errors.NoRepositoryPresent(dir)
74
self.assertNotEqual(-1, str(error).find((dir.transport.clone('..').base)))
75
self.assertEqual(-1, str(error).find((dir.transport.base)))
77
def test_no_smart_medium(self):
78
error = errors.NoSmartMedium("a transport")
79
self.assertEqualDiff("The transport 'a transport' cannot tunnel the "
83
def test_no_such_id(self):
84
error = errors.NoSuchId("atree", "anid")
85
self.assertEqualDiff("The file id anid is not present in the tree "
89
def test_not_write_locked(self):
90
error = errors.NotWriteLocked('a thing to repr')
91
self.assertEqualDiff("'a thing to repr' is not write locked but needs "
95
def test_too_many_concurrent_requests(self):
96
error = errors.TooManyConcurrentRequests("a medium")
97
self.assertEqualDiff("The medium 'a medium' has reached its concurrent "
98
"request limit. Be sure to finish_writing and finish_reading on "
99
"the current request that is open.",
102
def test_unknown_hook(self):
103
error = errors.UnknownHook("branch", "foo")
104
self.assertEqualDiff("The branch hook 'foo' is unknown in this version"
107
error = errors.UnknownHook("tree", "bar")
108
self.assertEqualDiff("The tree hook 'bar' is unknown in this version"
112
def test_up_to_date(self):
113
error = errors.UpToDateFormat(bzrdir.BzrDirFormat4())
114
self.assertEqualDiff("The branch format Bazaar-NG branch, "
115
"format 0.0.4 is already at the most "
119
def test_corrupt_repository(self):
120
repo = self.make_repository('.')
121
error = errors.CorruptRepository(repo)
122
self.assertEqualDiff("An error has been detected in the repository %s.\n"
123
"Please run bzr reconcile on this repository." %
124
repo.bzrdir.root_transport.base,
127
def test_bzrnewerror_is_deprecated(self):
128
class DeprecatedError(errors.BzrNewError):
130
self.callDeprecated(['BzrNewError was deprecated in bzr 0.13; '
131
'please convert DeprecatedError to use BzrError instead'],
134
def test_bzrerror_from_literal_string(self):
135
# Some code constructs BzrError from a literal string, in which case
136
# no further formatting is done. (I'm not sure raising the base class
137
# is a great idea, but if the exception is not intended to be caught
138
# perhaps no more is needed.)
140
raise errors.BzrError('this is my errors; %d is not expanded')
141
except errors.BzrError, e:
142
self.assertEqual('this is my errors; %d is not expanded', str(e))
144
def test_reading_completed(self):
145
error = errors.ReadingCompleted("a request")
146
self.assertEqualDiff("The MediumRequest 'a request' has already had "
147
"finish_reading called upon it - the request has been completed and"
148
" no more data may be read.",
151
def test_writing_completed(self):
152
error = errors.WritingCompleted("a request")
153
self.assertEqualDiff("The MediumRequest 'a request' has already had "
154
"finish_writing called upon it - accept bytes may not be called "
158
def test_writing_not_completed(self):
159
error = errors.WritingNotComplete("a request")
160
self.assertEqualDiff("The MediumRequest 'a request' has not has "
161
"finish_writing called upon it - until the write phase is complete"
162
" no data may be read.",
165
def test_transport_not_possible(self):
166
e = errors.TransportNotPossible('readonly', 'original error')
167
self.assertEqual('Transport operation not possible:'
168
' readonly original error', str(e))
170
def assertSocketConnectionError(self, expected, *args, **kwargs):
171
"""Check the formatting of a SocketConnectionError exception"""
172
e = errors.SocketConnectionError(*args, **kwargs)
173
self.assertEqual(expected, str(e))
175
def test_socket_connection_error(self):
176
"""Test the formatting of SocketConnectionError"""
178
# There should be a default msg about failing to connect
179
# we only require a host name.
180
self.assertSocketConnectionError(
181
'Failed to connect to ahost',
184
# If port is None, we don't put :None
185
self.assertSocketConnectionError(
186
'Failed to connect to ahost',
188
# But if port is supplied we include it
189
self.assertSocketConnectionError(
190
'Failed to connect to ahost:22',
193
# We can also supply extra information about the error
194
# with or without a port
195
self.assertSocketConnectionError(
196
'Failed to connect to ahost:22; bogus error',
197
'ahost', port=22, orig_error='bogus error')
198
self.assertSocketConnectionError(
199
'Failed to connect to ahost; bogus error',
200
'ahost', orig_error='bogus error')
201
# An exception object can be passed rather than a string
202
orig_error = ValueError('bad value')
203
self.assertSocketConnectionError(
204
'Failed to connect to ahost; %s' % (str(orig_error),),
205
host='ahost', orig_error=orig_error)
207
# And we can supply a custom failure message
208
self.assertSocketConnectionError(
209
'Unable to connect to ssh host ahost:444; my_error',
210
host='ahost', port=444, msg='Unable to connect to ssh host',
211
orig_error='my_error')
215
class PassThroughError(errors.BzrError):
217
_fmt = """Pass through %(foo)s and %(bar)s"""
219
def __init__(self, foo, bar):
220
errors.BzrError.__init__(self, foo=foo, bar=bar)
223
class ErrorWithBadFormat(errors.BzrError):
225
_fmt = """One format specifier: %(thing)s"""
228
class ErrorWithNoFormat(errors.BzrError):
229
"""This class has a docstring but no format string."""
232
class TestErrorFormatting(TestCase):
234
def test_always_str(self):
235
e = PassThroughError(u'\xb5', 'bar')
236
self.assertIsInstance(e.__str__(), str)
237
# In Python str(foo) *must* return a real byte string
238
# not a Unicode string. The following line would raise a
239
# Unicode error, because it tries to call str() on the string
240
# returned from e.__str__(), and it has non ascii characters
242
self.assertEqual('Pass through \xc2\xb5 and bar', s)
244
def test_missing_format_string(self):
245
e = ErrorWithNoFormat(param='randomvalue')
246
s = self.callDeprecated(
247
['ErrorWithNoFormat uses its docstring as a format, it should use _fmt instead'],
251
"This class has a docstring but no format string.")
253
def test_mismatched_format_args(self):
254
# Even though ErrorWithBadFormat's format string does not match the
255
# arguments we constructing it with, we can still stringify an instance
256
# of this exception. The resulting string will say its unprintable.
257
e = ErrorWithBadFormat(not_thing='x')
258
self.assertStartsWith(
259
str(e), 'Unprintable exception ErrorWithBadFormat')
added
removed
bzrlib/tests/test_errors.py
