1
# Copyright (C) 2006 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,
34
from bzrlib.branch import Branch
35
from bzrlib.bzrdir import BzrDir
36
from bzrlib.errors import ParamikoNotPresent
37
from bzrlib.smart import client, medium
38
from bzrlib.smart.server import BzrServerFactory, SmartTCPServer
39
from bzrlib.tests import (
40
TestCaseWithTransport,
41
TestCaseWithMemoryTransport,
44
from bzrlib.trace import mutter
45
from bzrlib.transport import get_transport, remote
48
class TestBzrServe(TestCaseWithTransport):
51
super(TestBzrServe, self).setUp()
52
self.disable_missing_extensions_warning()
54
def assertInetServerShutsdownCleanly(self, process):
55
"""Shutdown the server process looking for errors."""
56
# Shutdown the server: the server should shut down when it cannot read
59
# Hide stdin from the subprocess module, so it won't fail to close it.
61
result = self.finish_bzr_subprocess(process)
62
self.assertEqual('', result[0])
63
self.assertEqual('', result[1])
65
def assertServerFinishesCleanly(self, process):
66
"""Shutdown the bzr serve instance process looking for errors."""
68
result = self.finish_bzr_subprocess(process, retcode=3,
69
send_signal=signal.SIGINT)
70
self.assertEqual('', result[0])
71
self.assertEqual('bzr: interrupted\n', result[1])
73
def make_read_requests(self, branch):
74
"""Do some read only requests."""
77
branch.repository.all_revision_ids()
78
self.assertEqual(_mod_revision.NULL_REVISION,
79
_mod_revision.ensure_null(branch.last_revision()))
83
def start_server_inet(self, extra_options=()):
84
"""Start a bzr server subprocess using the --inet option.
86
:param extra_options: extra options to give the server.
87
:return: a tuple with the bzr process handle for passing to
88
finish_bzr_subprocess, a client for the server, and a transport.
90
# Serve from the current directory
91
process = self.start_bzr_subprocess(['serve', '--inet'])
93
# Connect to the server
94
# We use this url because while this is no valid URL to connect to this
95
# server instance, the transport needs a URL.
96
url = 'bzr://localhost/'
98
client_medium = medium.SmartSimplePipesClientMedium(
99
process.stdout, process.stdin, url)
100
transport = remote.RemoteTransport(url, medium=client_medium)
101
return process, transport
103
def start_server_port(self, extra_options=()):
104
"""Start a bzr server subprocess.
106
:param extra_options: extra options to give the server.
107
:return: a tuple with the bzr process handle for passing to
108
finish_bzr_subprocess, and the base url for the server.
110
# Serve from the current directory
111
args = ['serve', '--port', 'localhost:0']
112
args.extend(extra_options)
113
process = self.start_bzr_subprocess(args, skip_if_plan_to_signal=True)
114
port_line = process.stderr.readline()
115
prefix = 'listening on port: '
116
self.assertStartsWith(port_line, prefix)
117
port = int(port_line[len(prefix):])
118
url = 'bzr://localhost:%d/' % port
122
def test_bzr_serve_inet_readonly(self):
123
"""bzr server should provide a read only filesystem by default."""
124
process, transport = self.start_server_inet()
125
self.assertRaises(errors.TransportNotPossible, transport.mkdir, 'adir')
126
self.assertInetServerShutsdownCleanly(process)
128
def test_bzr_serve_inet_readwrite(self):
130
self.make_branch('.')
132
process, transport = self.start_server_inet(['--allow-writes'])
134
# We get a working branch
135
branch = BzrDir.open_from_transport(transport).open_branch()
136
self.make_read_requests(branch)
137
self.assertInetServerShutsdownCleanly(process)
139
def test_bzr_serve_port_readonly(self):
140
"""bzr server should provide a read only filesystem by default."""
141
process, url = self.start_server_port()
142
transport = get_transport(url)
143
self.assertRaises(errors.TransportNotPossible, transport.mkdir, 'adir')
144
self.assertServerFinishesCleanly(process)
146
def test_bzr_serve_port_readwrite(self):
148
self.make_branch('.')
150
process, url = self.start_server_port(['--allow-writes'])
152
# Connect to the server
153
branch = Branch.open(url)
154
self.make_read_requests(branch)
155
self.assertServerFinishesCleanly(process)
157
def test_bzr_serve_supports_protocol(self):
159
self.make_branch('.')
161
process, url = self.start_server_port(['--allow-writes',
164
# Connect to the server
165
branch = Branch.open(url)
166
self.make_read_requests(branch)
167
self.assertServerFinishesCleanly(process)
169
def test_bzr_connect_to_bzr_ssh(self):
170
"""User acceptance that get_transport of a bzr+ssh:// behaves correctly.
172
bzr+ssh:// should cause bzr to run a remote bzr smart server over SSH.
175
# SFTPFullAbsoluteServer has a get_url method, and doesn't
176
# override the interface (doesn't change self._vendor).
177
from bzrlib.transport.sftp import SFTPFullAbsoluteServer
178
except ParamikoNotPresent:
179
raise TestSkipped('Paramiko not installed')
180
from bzrlib.tests.stub_sftp import StubServer
183
self.make_branch('a_branch')
185
# Start an SSH server
186
self.command_executed = []
187
# XXX: This is horrible -- we define a really dumb SSH server that
188
# executes commands, and manage the hooking up of stdin/out/err to the
189
# SSH channel ourselves. Surely this has already been implemented
191
class StubSSHServer(StubServer):
195
def check_channel_exec_request(self, channel, command):
196
self.test.command_executed.append(command)
197
proc = subprocess.Popen(
198
command, shell=True, stdin=subprocess.PIPE,
199
stdout=subprocess.PIPE, stderr=subprocess.PIPE)
201
# XXX: horribly inefficient, not to mention ugly.
202
# Start a thread for each of stdin/out/err, and relay bytes from
203
# the subprocess to channel and vice versa.
204
def ferry_bytes(read, write, close):
213
(channel.recv, proc.stdin.write, proc.stdin.close),
214
(proc.stdout.read, channel.sendall, channel.close),
215
(proc.stderr.read, channel.sendall_stderr, channel.close)]
216
for read, write, close in file_functions:
217
t = threading.Thread(
218
target=ferry_bytes, args=(read, write, close))
223
ssh_server = SFTPFullAbsoluteServer(StubSSHServer)
224
# XXX: We *don't* want to override the default SSH vendor, so we set
225
# _vendor to what _get_ssh_vendor returns.
226
self.start_server(ssh_server)
227
port = ssh_server._listener.port
229
# Access the branch via a bzr+ssh URL. The BZR_REMOTE_PATH environment
230
# variable is used to tell bzr what command to run on the remote end.
231
path_to_branch = osutils.abspath('a_branch')
233
orig_bzr_remote_path = os.environ.get('BZR_REMOTE_PATH')
234
bzr_remote_path = self.get_bzr_path()
235
if sys.platform == 'win32':
236
bzr_remote_path = sys.executable + ' ' + self.get_bzr_path()
237
os.environ['BZR_REMOTE_PATH'] = bzr_remote_path
239
if sys.platform == 'win32':
240
path_to_branch = os.path.splitdrive(path_to_branch)[1]
241
url_suffix = '@localhost:%d%s' % (port, path_to_branch)
242
self.permit_url('bzr+ssh://fred' + url_suffix)
243
branch = Branch.open('bzr+ssh://fred:secret' + url_suffix)
244
self.make_read_requests(branch)
245
# Check we can perform write operations
246
branch.bzrdir.root_transport.mkdir('foo')
248
# Restore the BZR_REMOTE_PATH environment variable back to its
250
if orig_bzr_remote_path is None:
251
del os.environ['BZR_REMOTE_PATH']
253
os.environ['BZR_REMOTE_PATH'] = orig_bzr_remote_path
256
['%s serve --inet --directory=/ --allow-writes'
258
self.command_executed)
261
class TestCmdServeChrooting(TestCaseWithTransport):
263
def test_serve_tcp(self):
264
"""'bzr serve' wraps the given --directory in a ChrootServer.
266
So requests that search up through the parent directories (like
267
find_repositoryV3) will give "not found" responses, rather than
268
InvalidURLJoin or jail break errors.
270
t = self.get_transport()
271
t.mkdir('server-root')
272
self.run_bzr_serve_then_func(
273
['--port', '127.0.0.1:0',
274
'--directory', t.local_abspath('server-root'),
276
self.when_server_started)
277
# The when_server_started method issued a find_repositoryV3 that should
278
# fail with 'norepository' because there are no repositories inside the
280
self.assertEqual(('norepository',), self.client_resp)
282
def run_bzr_serve_then_func(self, serve_args, func, *func_args,
284
"""Run 'bzr serve', and run the given func in a thread once the server
287
When 'func' terminates, the server will be terminated too.
290
def on_server_start(backing_urls, tcp_server):
291
t = threading.Thread(
292
target=on_server_start_thread, args=(tcp_server,))
294
def on_server_start_thread(tcp_server):
297
self.tcp_server = tcp_server
299
func(*func_args, **func_kwargs)
301
# Log errors to make some test failures a little less
303
mutter('func broke: %r', e)
305
# Then stop the server
306
mutter('interrupting...')
307
thread.interrupt_main()
308
SmartTCPServer.hooks.install_named_hook(
309
'server_started_ex', on_server_start,
310
'run_bzr_serve_then_func hook')
313
self.run_bzr(['serve'] + list(serve_args))
314
except KeyboardInterrupt:
317
def when_server_started(self):
318
# Connect to the TCP server and issue some requests and see what comes
320
client_medium = medium.SmartTCPClientMedium(
321
'127.0.0.1', self.tcp_server.port,
322
'bzr://localhost:%d/' % (self.tcp_server.port,))
323
smart_client = client._SmartClient(client_medium)
324
resp = smart_client.call('mkdir', 'foo', '')
325
resp = smart_client.call('BzrDirFormat.initialize', 'foo/')
327
resp = smart_client.call('BzrDir.find_repositoryV3', 'foo/')
328
except errors.ErrorFromSmartServer, e:
330
self.client_resp = resp
331
client_medium.disconnect()
334
class TestUserdirExpansion(TestCaseWithMemoryTransport):
336
def fake_expanduser(self, path):
337
"""A simple, environment-independent, function for the duration of this
340
Paths starting with a path segment of '~user' will expand to start with
341
'/home/user/'. Every other path will be unchanged.
343
if path.split('/', 1)[0] == '~user':
344
return '/home/user' + path[len('~user'):]
347
def make_test_server(self, base_path='/'):
348
"""Make and setUp a BzrServerFactory, backed by a memory transport, and
349
creat '/home/user' in that transport.
351
bzr_server = BzrServerFactory(
352
self.fake_expanduser, lambda t: base_path)
353
mem_transport = self.get_transport()
354
mem_transport.mkdir_multi(['home', 'home/user'])
355
bzr_server.set_up(mem_transport, None, None, inet=True)
356
self.addCleanup(bzr_server.tear_down)
359
def test_bzr_serve_expands_userdir(self):
360
bzr_server = self.make_test_server()
361
self.assertTrue(bzr_server.smart_server.backing_transport.has('~user'))
363
def test_bzr_serve_does_not_expand_userdir_outside_base(self):
364
bzr_server = self.make_test_server('/foo')
365
self.assertFalse(bzr_server.smart_server.backing_transport.has('~user'))
367
def test_get_base_path(self):
368
"""cmd_serve will turn the --directory option into a LocalTransport
369
(optionally decorated with 'readonly+'). BzrServerFactory can
370
determine the original --directory from that transport.
372
# Define a fake 'protocol' to capture the transport that cmd_serve
373
# passes to serve_bzr.
374
def capture_transport(transport, host, port, inet):
375
self.bzr_serve_transport = transport
376
cmd = builtins.cmd_serve()
378
cmd.run(directory='/a/b/c', protocol=capture_transport)
379
server_maker = BzrServerFactory()
381
'readonly+file:///a/b/c/', self.bzr_serve_transport.base)
383
u'/a/b/c/', server_maker.get_base_path(self.bzr_serve_transport))
385
cmd.run(directory='/a/b/c', protocol=capture_transport,
387
server_maker = BzrServerFactory()
388
self.assertEqual('file:///a/b/c/', self.bzr_serve_transport.base)
390
u'/a/b/c/', server_maker.get_base_path(self.bzr_serve_transport))
added
removed
bzrlib/tests/blackbox/test_serve.py
