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
class TestErrors(TestCaseWithTransport):
29
def test_disabled_method(self):
30
error = errors.DisabledMethod("class name")
32
"The smart server method 'class name' is disabled.", str(error))
34
def test_inventory_modified(self):
35
error = errors.InventoryModified("a tree to be repred")
36
self.assertEqualDiff("The current inventory for the tree 'a tree to "
37
"be repred' has been modified, so a clean inventory cannot be "
38
"read without data loss.",
41
def test_medium_not_connected(self):
42
error = errors.MediumNotConnected("a medium")
44
"The medium 'a medium' is not connected.", str(error))
46
def test_no_repo(self):
47
dir = bzrdir.BzrDir.create(self.get_url())
48
error = errors.NoRepositoryPresent(dir)
49
self.assertNotEqual(-1, str(error).find((dir.transport.clone('..').base)))
50
self.assertEqual(-1, str(error).find((dir.transport.base)))
52
def test_no_smart_medium(self):
53
error = errors.NoSmartMedium("a transport")
54
self.assertEqualDiff("The transport 'a transport' cannot tunnel the "
58
def test_no_such_id(self):
59
error = errors.NoSuchId("atree", "anid")
60
self.assertEqualDiff("The file id anid is not present in the tree "
64
def test_not_write_locked(self):
65
error = errors.NotWriteLocked('a thing to repr')
66
self.assertEqualDiff("'a thing to repr' is not write locked but needs "
70
def test_too_many_concurrent_requests(self):
71
error = errors.TooManyConcurrentRequests("a medium")
72
self.assertEqualDiff("The medium 'a medium' has reached its concurrent "
73
"request limit. Be sure to finish_writing and finish_reading on "
74
"the current request that is open.",
77
def test_up_to_date(self):
78
error = errors.UpToDateFormat(bzrdir.BzrDirFormat4())
79
self.assertEqualDiff("The branch format Bazaar-NG branch, "
80
"format 0.0.4 is already at the most "
84
def test_corrupt_repository(self):
85
repo = self.make_repository('.')
86
error = errors.CorruptRepository(repo)
87
self.assertEqualDiff("An error has been detected in the repository %s.\n"
88
"Please run bzr reconcile on this repository." %
89
repo.bzrdir.root_transport.base,
92
def test_reading_completed(self):
93
error = errors.ReadingCompleted("a request")
94
self.assertEqualDiff("The MediumRequest 'a request' has already had "
95
"finish_reading called upon it - the request has been completed and"
96
" no more data may be read.",
99
def test_writing_completed(self):
100
error = errors.WritingCompleted("a request")
101
self.assertEqualDiff("The MediumRequest 'a request' has already had "
102
"finish_writing called upon it - accept bytes may not be called "
106
def test_writing_not_completed(self):
107
error = errors.WritingNotComplete("a request")
108
self.assertEqualDiff("The MediumRequest 'a request' has not has "
109
"finish_writing called upon it - until the write phase is complete"
110
" no data may be read.",
114
class PassThroughError(errors.BzrNewError):
115
"""Pass through %(foo)s and %(bar)s"""
117
def __init__(self, foo, bar):
118
errors.BzrNewError.__init__(self, foo=foo, bar=bar)
121
class ErrorWithBadFormat(errors.BzrNewError):
122
"""One format specifier: %(thing)s"""
125
class TestErrorFormatting(TestCase):
127
def test_always_str(self):
128
e = PassThroughError(u'\xb5', 'bar')
129
self.assertIsInstance(e.__str__(), str)
130
# In Python str(foo) *must* return a real byte string
131
# not a Unicode string. The following line would raise a
132
# Unicode error, because it tries to call str() on the string
133
# returned from e.__str__(), and it has non ascii characters
135
self.assertEqual('Pass through \xc2\xb5 and bar', s)
137
def test_mismatched_format_args(self):
138
# Even though ErrorWithBadFormat's format string does not match the
139
# arguments we constructing it with, we can still stringify an instance
140
# of this exception. The resulting string will say its unprintable.
141
e = ErrorWithBadFormat(not_thing='x')
142
self.assertStartsWith(
143
str(e), 'Unprintable exception ErrorWithBadFormat(')
146
class TestSpecificErrors(TestCase):
148
def test_transport_not_possible(self):
149
e = errors.TransportNotPossible('readonly', 'original error')
150
self.assertEqual('Transport operation not possible:'
151
' readonly original error', str(e))
153
def assertSocketConnectionError(self, expected, *args, **kwargs):
154
"""Check the formatting of a SocketConnectionError exception"""
155
e = errors.SocketConnectionError(*args, **kwargs)
156
self.assertEqual(expected, str(e))
158
def test_socket_connection_error(self):
159
"""Test the formatting of SocketConnectionError"""
161
# There should be a default msg about failing to connect
162
# we only require a host name.
163
self.assertSocketConnectionError(
164
'Failed to connect to ahost',
167
# If port is None, we don't put :None
168
self.assertSocketConnectionError(
169
'Failed to connect to ahost',
171
# But if port is supplied we include it
172
self.assertSocketConnectionError(
173
'Failed to connect to ahost:22',
176
# We can also supply extra information about the error
177
# with or without a port
178
self.assertSocketConnectionError(
179
'Failed to connect to ahost:22; bogus error',
180
'ahost', port=22, orig_error='bogus error')
181
self.assertSocketConnectionError(
182
'Failed to connect to ahost; bogus error',
183
'ahost', orig_error='bogus error')
184
# An exception object can be passed rather than a string
185
orig_error = ValueError('bad value')
186
self.assertSocketConnectionError(
187
'Failed to connect to ahost; %s' % (str(orig_error),),
188
host='ahost', orig_error=orig_error)
190
# And we can supply a custom failure message
191
self.assertSocketConnectionError(
192
'Unable to connect to ssh host ahost:444; my_error',
193
host='ahost', port=444, msg='Unable to connect to ssh host',
194
orig_error='my_error')