15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
"""Tests of the bzr serve command."""
18
"""Tests of the brz serve command."""
24
from _thread import interrupt_main
25
except ImportError: # Python < 3
26
from thread import interrupt_main
33
35
revision as _mod_revision,
36
from bzrlib.branch import Branch
37
from bzrlib.bzrdir import BzrDir
38
from bzrlib.smart import client, medium
39
from bzrlib.smart.server import BzrServerFactory, SmartTCPServer
40
from bzrlib.tests import (
40
from ...branch import Branch
41
from ...controldir import ControlDir
42
from ...bzr.smart import client, medium
43
from ...bzr.smart.server import (
41
48
TestCaseWithMemoryTransport,
42
49
TestCaseWithTransport,
45
from bzrlib.trace import mutter
46
from bzrlib.transport import get_transport, remote
51
from ...transport import remote
49
54
class TestBzrServeBase(TestCaseWithTransport):
51
56
def run_bzr_serve_then_func(self, serve_args, retcode=0, func=None,
52
57
*func_args, **func_kwargs):
53
"""Run 'bzr serve', and run the given func in a thread once the server
58
"""Run 'brz serve', and run the given func in a thread once the server
56
61
When 'func' terminates, the server will be terminated too.
58
63
Returns stdout and stderr.
61
def on_server_start(backing_urls, tcp_server):
63
target=on_server_start_thread, args=(tcp_server,))
65
65
def on_server_start_thread(tcp_server):
66
"""This runs concurrently with the server thread.
68
The server is interrupted as soon as ``func`` finishes, even if an
69
exception is encountered.
68
73
self.tcp_server = tcp_server
71
76
func(*func_args, **func_kwargs)
77
except Exception as e:
73
78
# Log errors to make some test failures a little less
75
mutter('func broke: %r', e)
80
trace.mutter('func broke: %r', e)
77
82
# Then stop the server
78
mutter('interrupting...')
79
thread.interrupt_main()
83
trace.mutter('interrupting...')
85
# When the hook is fired, it just starts ``on_server_start_thread`` and
87
def on_server_start(backing_urls, tcp_server):
89
target=on_server_start_thread, args=(tcp_server,))
80
92
SmartTCPServer.hooks.install_named_hook(
81
93
'server_started_ex', on_server_start,
82
94
'run_bzr_serve_then_func hook')
95
# It seems interrupt_main() will not raise KeyboardInterrupt
96
# until after socket.accept returns. So we set the timeout low to make
98
self.overrideAttr(SmartTCPServer, '_ACCEPT_TIMEOUT', 0.1)
83
99
# start a TCP server
85
out, err = self.run_bzr(['serve'] + list(serve_args))
86
except KeyboardInterrupt, e:
101
out, err = self.run_bzr(['serve'] + list(serve_args),
103
except KeyboardInterrupt as e:
104
return (self._last_cmd_stdout.getvalue(),
105
self._last_cmd_stderr.getvalue())
94
112
super(TestBzrServe, self).setUp()
95
113
self.disable_missing_extensions_warning()
115
def test_server_exception_with_hook(self):
116
"""Catch exception from the server in the server_exception hook.
118
We use ``run_bzr_serve_then_func`` without a ``func`` so the server
119
will receive a KeyboardInterrupt exception we want to catch.
122
if exception[0] is KeyboardInterrupt:
123
sys.stderr.write(b'catching KeyboardInterrupt\n')
127
SmartTCPServer.hooks.install_named_hook(
128
'server_exception', hook,
129
'test_server_except_hook hook')
130
args = ['--listen', 'localhost', '--port', '0', '--quiet']
131
out, err = self.run_bzr_serve_then_func(args, retcode=0)
132
self.assertEqual(b'catching KeyboardInterrupt\n', err)
134
def test_server_exception_no_hook(self):
135
"""test exception without hook returns error"""
137
out, err = self.run_bzr_serve_then_func(args, retcode=3)
97
139
def assertInetServerShutsdownCleanly(self, process):
98
140
"""Shutdown the server process looking for errors."""
99
141
# Shutdown the server: the server should shut down when it cannot read
102
144
# Hide stdin from the subprocess module, so it won't fail to close it.
103
145
process.stdin = None
104
146
result = self.finish_bzr_subprocess(process)
105
self.assertEqual('', result[0])
106
self.assertEqual('', result[1])
147
self.assertEqual(b'', result[0])
148
self.assertEqual(b'', result[1])
108
150
def assertServerFinishesCleanly(self, process):
109
"""Shutdown the bzr serve instance process looking for errors."""
151
"""Shutdown the brz serve instance process looking for errors."""
110
152
# Shutdown the server
111
153
result = self.finish_bzr_subprocess(process, retcode=3,
112
154
send_signal=signal.SIGINT)
113
self.assertEqual('', result[0])
114
self.assertEqual('bzr: interrupted\n', result[1])
155
self.assertEqual(b'', result[0])
156
self.assertEqual(b'brz: interrupted\n', result[1])
116
158
def make_read_requests(self, branch):
117
159
"""Do some read only requests."""
160
with branch.lock_read():
120
161
branch.repository.all_revision_ids()
121
162
self.assertEqual(_mod_revision.NULL_REVISION,
122
163
_mod_revision.ensure_null(branch.last_revision()))
126
165
def start_server_inet(self, extra_options=()):
127
"""Start a bzr server subprocess using the --inet option.
166
"""Start a brz server subprocess using the --inet option.
129
168
:param extra_options: extra options to give the server.
130
:return: a tuple with the bzr process handle for passing to
169
:return: a tuple with the brz process handle for passing to
131
170
finish_bzr_subprocess, a client for the server, and a transport.
133
172
# Serve from the current directory
146
185
return process, transport
148
187
def start_server_port(self, extra_options=()):
149
"""Start a bzr server subprocess.
188
"""Start a brz server subprocess.
151
190
:param extra_options: extra options to give the server.
152
:return: a tuple with the bzr process handle for passing to
191
:return: a tuple with the brz process handle for passing to
153
192
finish_bzr_subprocess, and the base url for the server.
155
194
# Serve from the current directory
156
args = ['serve', '--port', 'localhost:0']
195
args = ['serve', '--listen', 'localhost', '--port', '0']
157
196
args.extend(extra_options)
158
197
process = self.start_bzr_subprocess(args, skip_if_plan_to_signal=True)
159
198
port_line = process.stderr.readline()
160
prefix = 'listening on port: '
199
prefix = b'listening on port: '
161
200
self.assertStartsWith(port_line, prefix)
162
201
port = int(port_line[len(prefix):])
163
202
url = 'bzr://localhost:%d/' % port
164
203
self.permit_url(url)
165
204
return process, url
167
206
def test_bzr_serve_quiet(self):
168
207
self.make_branch('.')
169
args = ['--port', 'localhost:0', '--quiet']
208
args = ['--listen', 'localhost', '--port', '0', '--quiet']
170
209
out, err = self.run_bzr_serve_then_func(args, retcode=3)
171
self.assertEqual('', out)
172
self.assertEqual('', err)
210
self.assertEqual(b'', out)
211
self.assertEqual(b'', err)
174
213
def test_bzr_serve_inet_readonly(self):
175
"""bzr server should provide a read only filesystem by default."""
214
"""brz server should provide a read only filesystem by default."""
176
215
process, transport = self.start_server_inet()
177
216
self.assertRaises(errors.TransportNotPossible, transport.mkdir, 'adir')
178
217
self.assertInetServerShutsdownCleanly(process)
184
223
process, transport = self.start_server_inet(['--allow-writes'])
186
225
# We get a working branch, and can create a directory
187
branch = BzrDir.open_from_transport(transport).open_branch()
226
branch = ControlDir.open_from_transport(transport).open_branch()
188
227
self.make_read_requests(branch)
189
228
transport.mkdir('adir')
190
229
self.assertInetServerShutsdownCleanly(process)
192
231
def test_bzr_serve_port_readonly(self):
193
"""bzr server should provide a read only filesystem by default."""
232
"""brz server should provide a read only filesystem by default."""
194
233
process, url = self.start_server_port()
195
transport = get_transport(url)
196
self.assertRaises(errors.TransportNotPossible, transport.mkdir, 'adir')
234
t = transport.get_transport_from_url(url)
235
self.assertRaises(errors.TransportNotPossible, t.mkdir, 'adir')
197
236
self.assertServerFinishesCleanly(process)
199
238
def test_bzr_serve_port_readwrite(self):
223
262
# This is a smoke test that the server doesn't crash when run with
224
263
# -Dhpss, and does drop some hpss logging to the file.
225
264
self.make_branch('.')
226
log_fname = os.getcwd() + '/server.log'
227
self._captureVar('BZR_LOG', log_fname)
265
log_fname = self.test_dir + '/server.log'
266
self.overrideEnv('BRZ_LOG', log_fname)
228
267
process, transport = self.start_server_inet(['-Dhpss'])
229
branch = BzrDir.open_from_transport(transport).open_branch()
268
branch = ControlDir.open_from_transport(transport).open_branch()
230
269
self.make_read_requests(branch)
231
270
self.assertInetServerShutsdownCleanly(process)
232
271
f = open(log_fname, 'rb')
233
272
content = f.read()
235
self.assertContainsRe(content, r'hpss request: \[[0-9-]+\]')
274
self.assertContainsRe(content, br'hpss request: \[[0-9-]+\]')
276
def test_bzr_serve_supports_configurable_timeout(self):
277
gs = config.GlobalStack()
278
gs.set('serve.client_timeout', 0.2)
279
# Save the config as the subprocess will use it
281
process, url = self.start_server_port()
282
self.build_tree_contents([('a_file', b'contents\n')])
283
# We can connect and issue a request
284
t = transport.get_transport_from_url(url)
285
self.assertEqual(b'contents\n', t.get_bytes('a_file'))
286
# However, if we just wait for more content from the server, it will
287
# eventually disconnect us.
288
m = t.get_smart_medium()
290
# Now, we wait for timeout to trigger
291
err = process.stderr.readline()
293
b'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', b'contents\n')])
300
# We can connect and issue a request
301
t = transport.get_transport_from_url(url)
302
self.assertEqual(b'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
b'Connection Timeout: disconnecting client after 0.1 seconds\n',
315
self.assertServerFinishesCleanly(process)
317
def test_bzr_serve_graceful_shutdown(self):
318
big_contents = b'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((b'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(b'Requested to stop gracefully\n',
333
process.stderr.readline())
334
self.assertEqual(b'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(b'', m.read_bytes(1))
342
# And the server should be stopping
343
self.assertEqual(0, process.wait())
238
346
class TestCmdServeChrooting(TestBzrServeBase):
240
348
def test_serve_tcp(self):
241
"""'bzr serve' wraps the given --directory in a ChrootServer.
349
"""'brz serve' wraps the given --directory in a ChrootServer.
243
351
So requests that search up through the parent directories (like
244
352
find_repositoryV3) will give "not found" responses, rather than
247
355
t = self.get_transport()
248
356
t.mkdir('server-root')
249
357
self.run_bzr_serve_then_func(
250
['--port', '127.0.0.1:0',
358
['--listen', '127.0.0.1', '--port', '0',
251
359
'--directory', t.local_abspath('server-root'),
252
360
'--allow-writes'],
253
361
func=self.when_server_started)
254
362
# The when_server_started method issued a find_repositoryV3 that should
255
363
# fail with 'norepository' because there are no repositories inside the
257
self.assertEqual(('norepository',), self.client_resp)
365
self.assertEqual((b'norepository',), self.client_resp)
259
367
def when_server_started(self):
260
368
# Connect to the TCP server and issue some requests and see what comes