1
# Copyright (C) 2006-2011 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
18
"""Tests of the bzr serve command."""
32
revision as _mod_revision,
37
from bzrlib.branch import Branch
38
from bzrlib.bzrdir import BzrDir
39
from bzrlib.smart import client, medium
40
from bzrlib.smart.server import (
44
from bzrlib.tests import (
45
TestCaseWithMemoryTransport,
46
TestCaseWithTransport,
48
from bzrlib.transport import remote
51
class TestBzrServeBase(TestCaseWithTransport):
53
def run_bzr_serve_then_func(self, serve_args, retcode=0, func=None,
54
*func_args, **func_kwargs):
55
"""Run 'bzr serve', and run the given func in a thread once the server
58
When 'func' terminates, the server will be terminated too.
60
Returns stdout and stderr.
62
def on_server_start_thread(tcp_server):
63
"""This runs concurrently with the server thread.
65
The server is interrupted as soon as ``func`` finishes, even if an
66
exception is encountered.
70
self.tcp_server = tcp_server
73
func(*func_args, **func_kwargs)
75
# Log errors to make some test failures a little less
77
trace.mutter('func broke: %r', e)
79
# Then stop the server
80
trace.mutter('interrupting...')
81
thread.interrupt_main()
82
# When the hook is fired, it just starts ``on_server_start_thread`` and
84
def on_server_start(backing_urls, tcp_server):
86
target=on_server_start_thread, args=(tcp_server,))
89
SmartTCPServer.hooks.install_named_hook(
90
'server_started_ex', on_server_start,
91
'run_bzr_serve_then_func hook')
92
# It seesm thread.interrupt_main() will not raise KeyboardInterrupt
93
# until after socket.accept returns. So we set the timeout low to make
95
self.overrideAttr(SmartTCPServer, '_ACCEPT_TIMEOUT', 0.1)
98
out, err = self.run_bzr(['serve'] + list(serve_args),
100
except KeyboardInterrupt, e:
105
class TestBzrServe(TestBzrServeBase):
108
super(TestBzrServe, self).setUp()
109
self.disable_missing_extensions_warning()
111
def test_server_exception_with_hook(self):
112
"""Catch exception from the server in the server_exception hook.
114
We use ``run_bzr_serve_then_func`` without a ``func`` so the server
115
will receive a KeyboardInterrupt exception we want to catch.
118
if exception[0] is KeyboardInterrupt:
119
sys.stderr.write('catching KeyboardInterrupt\n')
123
SmartTCPServer.hooks.install_named_hook(
124
'server_exception', hook,
125
'test_server_except_hook hook')
126
args = ['--port', 'localhost:0', '--quiet']
127
out, err = self.run_bzr_serve_then_func(args, retcode=0)
128
self.assertEqual('catching KeyboardInterrupt\n', err)
130
def test_server_exception_no_hook(self):
131
"""test exception without hook returns error"""
133
out, err = self.run_bzr_serve_then_func(args, retcode=3)
135
def assertInetServerShutsdownCleanly(self, process):
136
"""Shutdown the server process looking for errors."""
137
# Shutdown the server: the server should shut down when it cannot read
138
# from stdin anymore.
139
process.stdin.close()
140
# Hide stdin from the subprocess module, so it won't fail to close it.
142
result = self.finish_bzr_subprocess(process)
143
self.assertEqual('', result[0])
144
self.assertEqual('', result[1])
146
def assertServerFinishesCleanly(self, process):
147
"""Shutdown the bzr serve instance process looking for errors."""
148
# Shutdown the server
149
result = self.finish_bzr_subprocess(process, retcode=3,
150
send_signal=signal.SIGINT)
151
self.assertEqual('', result[0])
152
self.assertEqual('bzr: interrupted\n', result[1])
154
def make_read_requests(self, branch):
155
"""Do some read only requests."""
158
branch.repository.all_revision_ids()
159
self.assertEqual(_mod_revision.NULL_REVISION,
160
_mod_revision.ensure_null(branch.last_revision()))
164
def start_server_inet(self, extra_options=()):
165
"""Start a bzr server subprocess using the --inet option.
167
:param extra_options: extra options to give the server.
168
:return: a tuple with the bzr process handle for passing to
169
finish_bzr_subprocess, a client for the server, and a transport.
171
# Serve from the current directory
172
args = ['serve', '--inet']
173
args.extend(extra_options)
174
process = self.start_bzr_subprocess(args)
176
# Connect to the server
177
# We use this url because while this is no valid URL to connect to this
178
# server instance, the transport needs a URL.
179
url = 'bzr://localhost/'
181
client_medium = medium.SmartSimplePipesClientMedium(
182
process.stdout, process.stdin, url)
183
transport = remote.RemoteTransport(url, medium=client_medium)
184
return process, transport
186
def start_server_port(self, extra_options=()):
187
"""Start a bzr server subprocess.
189
:param extra_options: extra options to give the server.
190
:return: a tuple with the bzr process handle for passing to
191
finish_bzr_subprocess, and the base url for the server.
193
# Serve from the current directory
194
args = ['serve', '--port', 'localhost:0']
195
args.extend(extra_options)
196
process = self.start_bzr_subprocess(args, skip_if_plan_to_signal=True)
197
port_line = process.stderr.readline()
198
prefix = 'listening on port: '
199
self.assertStartsWith(port_line, prefix)
200
port = int(port_line[len(prefix):])
201
url = 'bzr://localhost:%d/' % port
205
def test_bzr_serve_quiet(self):
206
self.make_branch('.')
207
args = ['--port', 'localhost:0', '--quiet']
208
out, err = self.run_bzr_serve_then_func(args, retcode=3)
209
self.assertEqual('', out)
210
self.assertEqual('', err)
212
def test_bzr_serve_inet_readonly(self):
213
"""bzr server should provide a read only filesystem by default."""
214
process, transport = self.start_server_inet()
215
self.assertRaises(errors.TransportNotPossible, transport.mkdir, 'adir')
216
self.assertInetServerShutsdownCleanly(process)
218
def test_bzr_serve_inet_readwrite(self):
220
self.make_branch('.')
222
process, transport = self.start_server_inet(['--allow-writes'])
224
# We get a working branch, and can create a directory
225
branch = BzrDir.open_from_transport(transport).open_branch()
226
self.make_read_requests(branch)
227
transport.mkdir('adir')
228
self.assertInetServerShutsdownCleanly(process)
230
def test_bzr_serve_port_readonly(self):
231
"""bzr server should provide a read only filesystem by default."""
232
process, url = self.start_server_port()
233
t = transport.get_transport_from_url(url)
234
self.assertRaises(errors.TransportNotPossible, t.mkdir, 'adir')
235
self.assertServerFinishesCleanly(process)
237
def test_bzr_serve_port_readwrite(self):
239
self.make_branch('.')
241
process, url = self.start_server_port(['--allow-writes'])
243
# Connect to the server
244
branch = Branch.open(url)
245
self.make_read_requests(branch)
246
self.assertServerFinishesCleanly(process)
248
def test_bzr_serve_supports_protocol(self):
250
self.make_branch('.')
252
process, url = self.start_server_port(['--allow-writes',
255
# Connect to the server
256
branch = Branch.open(url)
257
self.make_read_requests(branch)
258
self.assertServerFinishesCleanly(process)
260
def test_bzr_serve_dhpss(self):
261
# This is a smoke test that the server doesn't crash when run with
262
# -Dhpss, and does drop some hpss logging to the file.
263
self.make_branch('.')
264
log_fname = os.getcwd() + '/server.log'
265
self.overrideEnv('BZR_LOG', log_fname)
266
process, transport = self.start_server_inet(['-Dhpss'])
267
branch = BzrDir.open_from_transport(transport).open_branch()
268
self.make_read_requests(branch)
269
self.assertInetServerShutsdownCleanly(process)
270
f = open(log_fname, 'rb')
273
self.assertContainsRe(content, r'hpss request: \[[0-9-]+\]')
275
def test_bzr_serve_supports_configurable_timeout(self):
276
gs = config.GlobalStack()
277
gs.set('serve.client_timeout', 0.2)
278
process, url = self.start_server_port()
279
self.build_tree_contents([('a_file', 'contents\n')])
280
# We can connect and issue a request
281
t = transport.get_transport_from_url(url)
282
self.assertEqual('contents\n', t.get_bytes('a_file'))
283
# However, if we just wait for more content from the server, it will
284
# eventually disconnect us.
285
# TODO: Use something like signal.alarm() so that if the server doesn't
286
# properly handle the timeout, we end up failing the test instead
287
# of hanging forever.
288
m = t.get_smart_medium()
290
# Now, we wait for timeout to trigger
291
err = process.stderr.readline()
293
'Connection Timeout: disconnecting client after 0.2 seconds\n',
295
self.assertServerFinishesCleanly(process)
297
def test_bzr_serve_supports_client_timeout(self):
298
process, url = self.start_server_port(['--client-timeout=0.1'])
299
self.build_tree_contents([('a_file', 'contents\n')])
300
# We can connect and issue a request
301
t = transport.get_transport_from_url(url)
302
self.assertEqual('contents\n', t.get_bytes('a_file'))
303
# However, if we just wait for more content from the server, it will
304
# eventually disconnect us.
305
# TODO: Use something like signal.alarm() so that if the server doesn't
306
# properly handle the timeout, we end up failing the test instead
307
# of hanging forever.
308
m = t.get_smart_medium()
310
# Now, we wait for timeout to trigger
311
err = process.stderr.readline()
313
'Connection Timeout: disconnecting client after 0.1 seconds\n',
315
self.assertServerFinishesCleanly(process)
317
def test_bzr_serve_graceful_shutdown(self):
318
big_contents = 'a'*64*1024
319
self.build_tree_contents([('bigfile', big_contents)])
320
process, url = self.start_server_port(['--client-timeout=1.0'])
321
t = transport.get_transport_from_url(url)
322
m = t.get_smart_medium()
323
c = client._SmartClient(m)
324
# Start, but don't finish a response
325
resp, response_handler = c.call_expecting_body('get', 'bigfile')
326
self.assertEqual(('ok',), resp)
327
# Note: process.send_signal is a Python 2.6ism
328
process.send_signal(signal.SIGHUP)
329
# Wait for the server to notice the signal, and then read the actual
330
# body of the response. That way we know that it is waiting for the
332
self.assertEqual('Requested to stop gracefully\n',
333
process.stderr.readline())
334
self.assertEqual('Waiting for 1 client(s) to finish\n',
335
process.stderr.readline())
336
body = response_handler.read_body_bytes()
337
if body != big_contents:
338
self.fail('Failed to properly read the contents of "bigfile"')
339
# Now that our request is finished, the medium should notice it has
341
self.assertEqual('', m.read_bytes(1))
342
# And the server should be stopping
343
self.assertEqual(0, process.wait())
346
class TestCmdServeChrooting(TestBzrServeBase):
348
def test_serve_tcp(self):
349
"""'bzr serve' wraps the given --directory in a ChrootServer.
351
So requests that search up through the parent directories (like
352
find_repositoryV3) will give "not found" responses, rather than
353
InvalidURLJoin or jail break errors.
355
t = self.get_transport()
356
t.mkdir('server-root')
357
self.run_bzr_serve_then_func(
358
['--port', '127.0.0.1:0',
359
'--directory', t.local_abspath('server-root'),
361
func=self.when_server_started)
362
# The when_server_started method issued a find_repositoryV3 that should
363
# fail with 'norepository' because there are no repositories inside the
365
self.assertEqual(('norepository',), self.client_resp)
367
def when_server_started(self):
368
# Connect to the TCP server and issue some requests and see what comes
370
client_medium = medium.SmartTCPClientMedium(
371
'127.0.0.1', self.tcp_server.port,
372
'bzr://localhost:%d/' % (self.tcp_server.port,))
373
smart_client = client._SmartClient(client_medium)
374
resp = smart_client.call('mkdir', 'foo', '')
375
resp = smart_client.call('BzrDirFormat.initialize', 'foo/')
377
resp = smart_client.call('BzrDir.find_repositoryV3', 'foo/')
378
except errors.ErrorFromSmartServer, e:
380
self.client_resp = resp
381
client_medium.disconnect()
384
class TestUserdirExpansion(TestCaseWithMemoryTransport):
387
def fake_expanduser(path):
388
"""A simple, environment-independent, function for the duration of this
391
Paths starting with a path segment of '~user' will expand to start with
392
'/home/user/'. Every other path will be unchanged.
394
if path.split('/', 1)[0] == '~user':
395
return '/home/user' + path[len('~user'):]
398
def make_test_server(self, base_path='/'):
399
"""Make and start a BzrServerFactory, backed by a memory transport, and
400
creat '/home/user' in that transport.
402
bzr_server = BzrServerFactory(
403
self.fake_expanduser, lambda t: base_path)
404
mem_transport = self.get_transport()
405
mem_transport.mkdir_multi(['home', 'home/user'])
406
bzr_server.set_up(mem_transport, None, None, inet=True, timeout=4.0)
407
self.addCleanup(bzr_server.tear_down)
410
def test_bzr_serve_expands_userdir(self):
411
bzr_server = self.make_test_server()
412
self.assertTrue(bzr_server.smart_server.backing_transport.has('~user'))
414
def test_bzr_serve_does_not_expand_userdir_outside_base(self):
415
bzr_server = self.make_test_server('/foo')
416
self.assertFalse(bzr_server.smart_server.backing_transport.has('~user'))
418
def test_get_base_path(self):
419
"""cmd_serve will turn the --directory option into a LocalTransport
420
(optionally decorated with 'readonly+'). BzrServerFactory can
421
determine the original --directory from that transport.
423
# URLs always include the trailing slash, and get_base_path returns it
424
base_dir = osutils.abspath('/a/b/c') + '/'
425
base_url = urlutils.local_path_to_url(base_dir) + '/'
426
# Define a fake 'protocol' to capture the transport that cmd_serve
427
# passes to serve_bzr.
428
def capture_transport(transport, host, port, inet, timeout):
429
self.bzr_serve_transport = transport
430
cmd = builtins.cmd_serve()
432
cmd.run(directory=base_dir, protocol=capture_transport)
433
server_maker = BzrServerFactory()
435
'readonly+%s' % base_url, self.bzr_serve_transport.base)
437
base_dir, server_maker.get_base_path(self.bzr_serve_transport))
439
cmd.run(directory=base_dir, protocol=capture_transport,
441
server_maker = BzrServerFactory()
442
self.assertEqual(base_url, self.bzr_serve_transport.base)
443
self.assertEqual(base_dir,
444
server_maker.get_base_path(self.bzr_serve_transport))
added
removed
bzrlib/tests/blackbox/test_serve.py
