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,
35
from bzrlib.branch import Branch
36
from bzrlib.bzrdir import BzrDir
37
from bzrlib.smart import client, medium
38
from bzrlib.smart.server import BzrServerFactory, SmartTCPServer
39
from bzrlib.tests import (
41
TestCaseWithMemoryTransport,
42
TestCaseWithTransport,
45
from bzrlib.trace import mutter
46
from bzrlib.transport import get_transport, remote
48
class TestBzrServeBase(TestCaseWithTransport):
50
def run_bzr_serve_then_func(self, serve_args, retcode=0, func=None,
51
*func_args, **func_kwargs):
52
"""Run 'bzr serve', and run the given func in a thread once the server
55
When 'func' terminates, the server will be terminated too.
57
Returns stdout and stderr.
60
def on_server_start(backing_urls, tcp_server):
62
target=on_server_start_thread, args=(tcp_server,))
64
def on_server_start_thread(tcp_server):
67
self.tcp_server = tcp_server
70
func(*func_args, **func_kwargs)
72
# Log errors to make some test failures a little less
74
mutter('func broke: %r', e)
76
# Then stop the server
77
mutter('interrupting...')
78
thread.interrupt_main()
79
SmartTCPServer.hooks.install_named_hook(
80
'server_started_ex', on_server_start,
81
'run_bzr_serve_then_func hook')
84
out, err = self.run_bzr(['serve'] + list(serve_args))
85
except KeyboardInterrupt, e:
90
class TestBzrServe(TestBzrServeBase):
93
super(TestBzrServe, self).setUp()
94
self.disable_missing_extensions_warning()
96
def assertInetServerShutsdownCleanly(self, process):
97
"""Shutdown the server process looking for errors."""
98
# Shutdown the server: the server should shut down when it cannot read
100
process.stdin.close()
101
# Hide stdin from the subprocess module, so it won't fail to close it.
103
result = self.finish_bzr_subprocess(process)
104
self.assertEqual('', result[0])
105
self.assertEqual('', result[1])
107
def assertServerFinishesCleanly(self, process):
108
"""Shutdown the bzr serve instance process looking for errors."""
109
# Shutdown the server
110
result = self.finish_bzr_subprocess(process, retcode=3,
111
send_signal=signal.SIGINT)
112
self.assertEqual('', result[0])
113
self.assertEqual('bzr: interrupted\n', result[1])
115
def make_read_requests(self, branch):
116
"""Do some read only requests."""
119
branch.repository.all_revision_ids()
120
self.assertEqual(_mod_revision.NULL_REVISION,
121
_mod_revision.ensure_null(branch.last_revision()))
125
def start_server_inet(self, extra_options=()):
126
"""Start a bzr server subprocess using the --inet option.
128
:param extra_options: extra options to give the server.
129
:return: a tuple with the bzr process handle for passing to
130
finish_bzr_subprocess, a client for the server, and a transport.
132
# Serve from the current directory
133
process = self.start_bzr_subprocess(['serve', '--inet'])
135
# Connect to the server
136
# We use this url because while this is no valid URL to connect to this
137
# server instance, the transport needs a URL.
138
url = 'bzr://localhost/'
140
client_medium = medium.SmartSimplePipesClientMedium(
141
process.stdout, process.stdin, url)
142
transport = remote.RemoteTransport(url, medium=client_medium)
143
return process, transport
145
def start_server_port(self, extra_options=()):
146
"""Start a bzr server subprocess.
148
:param extra_options: extra options to give the server.
149
:return: a tuple with the bzr process handle for passing to
150
finish_bzr_subprocess, and the base url for the server.
152
# Serve from the current directory
153
args = ['serve', '--port', 'localhost:0']
154
args.extend(extra_options)
155
process = self.start_bzr_subprocess(args, skip_if_plan_to_signal=True)
156
port_line = process.stderr.readline()
157
prefix = 'listening on port: '
158
self.assertStartsWith(port_line, prefix)
159
port = int(port_line[len(prefix):])
160
url = 'bzr://localhost:%d/' % port
164
def test_bzr_serve_quiet(self):
165
self.make_branch('.')
166
args = ['--port', 'localhost:0', '--quiet']
167
out, err = self.run_bzr_serve_then_func(args, retcode=3)
168
self.assertEqual('', out)
169
self.assertEqual('', err)
171
def test_bzr_serve_inet_readonly(self):
172
"""bzr server should provide a read only filesystem by default."""
173
process, transport = self.start_server_inet()
174
self.assertRaises(errors.TransportNotPossible, transport.mkdir, 'adir')
175
self.assertInetServerShutsdownCleanly(process)
177
def test_bzr_serve_inet_readwrite(self):
179
self.make_branch('.')
181
process, transport = self.start_server_inet(['--allow-writes'])
183
# We get a working branch
184
branch = BzrDir.open_from_transport(transport).open_branch()
185
self.make_read_requests(branch)
186
self.assertInetServerShutsdownCleanly(process)
188
def test_bzr_serve_port_readonly(self):
189
"""bzr server should provide a read only filesystem by default."""
190
process, url = self.start_server_port()
191
transport = get_transport(url)
192
self.assertRaises(errors.TransportNotPossible, transport.mkdir, 'adir')
193
self.assertServerFinishesCleanly(process)
195
def test_bzr_serve_port_readwrite(self):
197
self.make_branch('.')
199
process, url = self.start_server_port(['--allow-writes'])
201
# Connect to the server
202
branch = Branch.open(url)
203
self.make_read_requests(branch)
204
self.assertServerFinishesCleanly(process)
206
def test_bzr_serve_supports_protocol(self):
208
self.make_branch('.')
210
process, url = self.start_server_port(['--allow-writes',
213
# Connect to the server
214
branch = Branch.open(url)
215
self.make_read_requests(branch)
216
self.assertServerFinishesCleanly(process)
219
class TestCmdServeChrooting(TestBzrServeBase):
221
def test_serve_tcp(self):
222
"""'bzr serve' wraps the given --directory in a ChrootServer.
224
So requests that search up through the parent directories (like
225
find_repositoryV3) will give "not found" responses, rather than
226
InvalidURLJoin or jail break errors.
228
t = self.get_transport()
229
t.mkdir('server-root')
230
self.run_bzr_serve_then_func(
231
['--port', '127.0.0.1:0',
232
'--directory', t.local_abspath('server-root'),
234
func=self.when_server_started)
235
# The when_server_started method issued a find_repositoryV3 that should
236
# fail with 'norepository' because there are no repositories inside the
238
self.assertEqual(('norepository',), self.client_resp)
240
def when_server_started(self):
241
# Connect to the TCP server and issue some requests and see what comes
243
client_medium = medium.SmartTCPClientMedium(
244
'127.0.0.1', self.tcp_server.port,
245
'bzr://localhost:%d/' % (self.tcp_server.port,))
246
smart_client = client._SmartClient(client_medium)
247
resp = smart_client.call('mkdir', 'foo', '')
248
resp = smart_client.call('BzrDirFormat.initialize', 'foo/')
250
resp = smart_client.call('BzrDir.find_repositoryV3', 'foo/')
251
except errors.ErrorFromSmartServer, e:
253
self.client_resp = resp
254
client_medium.disconnect()
257
class TestUserdirExpansion(TestCaseWithMemoryTransport):
259
def fake_expanduser(self, path):
260
"""A simple, environment-independent, function for the duration of this
263
Paths starting with a path segment of '~user' will expand to start with
264
'/home/user/'. Every other path will be unchanged.
266
if path.split('/', 1)[0] == '~user':
267
return '/home/user' + path[len('~user'):]
270
def make_test_server(self, base_path='/'):
271
"""Make and setUp a BzrServerFactory, backed by a memory transport, and
272
creat '/home/user' in that transport.
274
bzr_server = BzrServerFactory(
275
self.fake_expanduser, lambda t: base_path)
276
mem_transport = self.get_transport()
277
mem_transport.mkdir_multi(['home', 'home/user'])
278
bzr_server.set_up(mem_transport, None, None, inet=True)
279
self.addCleanup(bzr_server.tear_down)
282
def test_bzr_serve_expands_userdir(self):
283
bzr_server = self.make_test_server()
284
self.assertTrue(bzr_server.smart_server.backing_transport.has('~user'))
286
def test_bzr_serve_does_not_expand_userdir_outside_base(self):
287
bzr_server = self.make_test_server('/foo')
288
self.assertFalse(bzr_server.smart_server.backing_transport.has('~user'))
290
def test_get_base_path(self):
291
"""cmd_serve will turn the --directory option into a LocalTransport
292
(optionally decorated with 'readonly+'). BzrServerFactory can
293
determine the original --directory from that transport.
295
# URLs always include the trailing slash, and get_base_path returns it
296
base_dir = osutils.abspath('/a/b/c') + '/'
297
base_url = urlutils.local_path_to_url(base_dir) + '/'
298
# Define a fake 'protocol' to capture the transport that cmd_serve
299
# passes to serve_bzr.
300
def capture_transport(transport, host, port, inet):
301
self.bzr_serve_transport = transport
302
cmd = builtins.cmd_serve()
304
cmd.run(directory=base_dir, protocol=capture_transport)
305
server_maker = BzrServerFactory()
307
'readonly+%s' % base_url, self.bzr_serve_transport.base)
309
base_dir, server_maker.get_base_path(self.bzr_serve_transport))
311
cmd.run(directory=base_dir, protocol=capture_transport,
313
server_maker = BzrServerFactory()
314
self.assertEqual(base_url, self.bzr_serve_transport.base)
315
self.assertEqual(base_dir,
316
server_maker.get_base_path(self.bzr_serve_transport))
added
removed
bzrlib/tests/blackbox/test_serve.py
