1
# Copyright (C) 2009, 2010 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""Tests for smart server request infrastructure (breezy.bzr.smart.request)."""
25
from breezy.bzr.bzrdir import BzrDir
26
from breezy.bzr.smart import request
27
from breezy.tests import TestCase, TestCaseWithMemoryTransport
30
class NoBodyRequest(request.SmartServerRequest):
31
"""A request that does not implement do_body."""
34
return request.SuccessfulSmartServerResponse(('ok',))
37
class DoErrorRequest(request.SmartServerRequest):
38
"""A request that raises an error from self.do()."""
41
raise errors.NoSuchFile('xyzzy')
44
class DoUnexpectedErrorRequest(request.SmartServerRequest):
45
"""A request that encounters a generic error in self.do()"""
51
class ChunkErrorRequest(request.SmartServerRequest):
52
"""A request that raises an error from self.do_chunk()."""
58
def do_chunk(self, bytes):
59
raise errors.NoSuchFile('xyzzy')
62
class EndErrorRequest(request.SmartServerRequest):
63
"""A request that raises an error from self.do_end()."""
69
def do_chunk(self, bytes):
74
raise errors.NoSuchFile('xyzzy')
77
class CheckJailRequest(request.SmartServerRequest):
79
def __init__(self, *args):
80
request.SmartServerRequest.__init__(self, *args)
81
self.jail_transports_log = []
84
self.jail_transports_log.append(request.jail_info.transports)
86
def do_chunk(self, bytes):
87
self.jail_transports_log.append(request.jail_info.transports)
90
self.jail_transports_log.append(request.jail_info.transports)
93
class TestErrors(TestCase):
95
def test_disabled_method(self):
96
error = request.DisabledMethod("class name")
98
"The smart server method 'class name' is disabled.", str(error))
101
class TestSmartRequest(TestCase):
103
def test_request_class_without_do_body(self):
104
"""If a request has no body data, and the request's implementation does
105
not override do_body, then no exception is raised.
107
# Create a SmartServerRequestHandler with a SmartServerRequest subclass
108
# that does not implement do_body.
109
handler = request.SmartServerRequestHandler(
110
None, {'foo': NoBodyRequest}, '/')
111
# Emulate a request with no body (i.e. just args).
112
handler.args_received(('foo',))
113
handler.end_received()
114
# Request done, no exception was raised.
116
def test_only_request_code_is_jailed(self):
117
transport = 'dummy transport'
118
handler = request.SmartServerRequestHandler(
119
transport, {'foo': CheckJailRequest}, '/')
120
handler.args_received(('foo',))
121
self.assertEqual(None, request.jail_info.transports)
122
handler.accept_body('bytes')
123
self.assertEqual(None, request.jail_info.transports)
124
handler.end_received()
125
self.assertEqual(None, request.jail_info.transports)
127
[[transport]] * 3, handler._command.jail_transports_log)
129
def test_all_registered_requests_are_safety_qualified(self):
130
unclassified_requests = []
131
allowed_info = ('read', 'idem', 'mutate', 'semivfs', 'semi', 'stream')
132
for key in request.request_handlers.keys():
133
info = request.request_handlers.get_info(key)
134
if info is None or info not in allowed_info:
135
unclassified_requests.append(key)
136
if unclassified_requests:
137
self.fail('These requests were not categorized as safe/unsafe'
138
' to retry: %s' % (unclassified_requests,))
141
class TestSmartRequestHandlerErrorTranslation(TestCase):
142
"""Tests that SmartServerRequestHandler will translate exceptions raised by
143
a SmartServerRequest into FailedSmartServerResponses.
146
def assertNoResponse(self, handler):
147
self.assertEqual(None, handler.response)
149
def assertResponseIsTranslatedError(self, handler):
150
expected_translation = ('NoSuchFile', 'xyzzy')
152
request.FailedSmartServerResponse(expected_translation),
155
def test_error_translation_from_args_received(self):
156
handler = request.SmartServerRequestHandler(
157
None, {'foo': DoErrorRequest}, '/')
158
handler.args_received(('foo',))
159
self.assertResponseIsTranslatedError(handler)
161
def test_error_translation_from_chunk_received(self):
162
handler = request.SmartServerRequestHandler(
163
None, {'foo': ChunkErrorRequest}, '/')
164
handler.args_received(('foo',))
165
self.assertNoResponse(handler)
166
handler.accept_body('bytes')
167
self.assertResponseIsTranslatedError(handler)
169
def test_error_translation_from_end_received(self):
170
handler = request.SmartServerRequestHandler(
171
None, {'foo': EndErrorRequest}, '/')
172
handler.args_received(('foo',))
173
self.assertNoResponse(handler)
174
handler.end_received()
175
self.assertResponseIsTranslatedError(handler)
177
def test_unexpected_error_translation(self):
178
handler = request.SmartServerRequestHandler(
179
None, {'foo': DoUnexpectedErrorRequest}, '/')
180
handler.args_received(('foo',))
182
request.FailedSmartServerResponse(('error', 'KeyError', "1")),
186
class TestRequestHanderErrorTranslation(TestCase):
187
"""Tests for breezy.bzr.smart.request._translate_error."""
189
def assertTranslationEqual(self, expected_tuple, error):
190
self.assertEqual(expected_tuple, request._translate_error(error))
192
def test_NoSuchFile(self):
193
self.assertTranslationEqual(
194
('NoSuchFile', 'path'), errors.NoSuchFile('path'))
196
def test_LockContention(self):
197
# For now, LockContentions are always transmitted with no details.
198
# Eventually they should include a relpath or url or something else to
199
# identify which lock is busy.
200
self.assertTranslationEqual(
201
('LockContention',), errors.LockContention('lock', 'msg'))
203
def test_TokenMismatch(self):
204
self.assertTranslationEqual(
205
('TokenMismatch', 'some-token', 'actual-token'),
206
errors.TokenMismatch('some-token', 'actual-token'))
208
def test_MemoryError(self):
209
self.assertTranslationEqual(("MemoryError",), MemoryError())
211
def test_generic_Exception(self):
212
self.assertTranslationEqual(('error', 'Exception', ""),
215
def test_generic_BzrError(self):
216
self.assertTranslationEqual(('error', 'BzrError', "some text"),
217
errors.BzrError(msg="some text"))
219
def test_generic_zlib_error(self):
220
from zlib import error
221
msg = "Error -3 while decompressing data: incorrect data check"
222
self.assertTranslationEqual(('error', 'zlib.error', msg),
226
class TestRequestJail(TestCaseWithMemoryTransport):
229
transport = self.get_transport('blah')
230
req = request.SmartServerRequest(transport)
231
self.assertEqual(None, request.jail_info.transports)
233
self.assertEqual([transport], request.jail_info.transports)
235
self.assertEqual(None, request.jail_info.transports)
238
class TestJailHook(TestCaseWithMemoryTransport):
241
super(TestJailHook, self).setUp()
242
def clear_jail_info():
243
request.jail_info.transports = None
244
self.addCleanup(clear_jail_info)
246
def test_jail_hook(self):
247
request.jail_info.transports = None
248
_pre_open_hook = request._pre_open_hook
249
# Any transport is fine if jail_info.transports is None
250
t = self.get_transport('foo')
252
# A transport in jail_info.transports is allowed
253
request.jail_info.transports = [t]
255
# A child of a transport in jail_info is allowed
256
_pre_open_hook(t.clone('child'))
257
# A parent is not allowed
258
self.assertRaises(errors.JailBreak, _pre_open_hook, t.clone('..'))
259
# A completely unrelated transport is not allowed
260
self.assertRaises(errors.JailBreak, _pre_open_hook,
261
transport.get_transport_from_url('http://host/'))
263
def test_open_bzrdir_in_non_main_thread(self):
264
"""Opening a bzrdir in a non-main thread should work ok.
266
This makes sure that the globally-installed
267
breezy.bzr.smart.request._pre_open_hook, which uses a threading.local(),
268
works in a newly created thread.
270
bzrdir = self.make_controldir('.')
271
transport = bzrdir.root_transport
274
BzrDir.open_from_transport(transport)
275
thread_result.append('ok')
276
thread = threading.Thread(target=t)
279
self.assertEqual(['ok'], thread_result)
added
removed
breezy/tests/test_smart_request.py
