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."""
33
31
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 (
36
from ...branch import Branch
37
from ...controldir import ControlDir
38
from ...smart import client, medium
39
from ...smart.server import (
41
44
TestCaseWithMemoryTransport,
42
45
TestCaseWithTransport,
45
from bzrlib.trace import mutter
46
from bzrlib.transport import get_transport, remote
47
from ...transport import remote
49
50
class TestBzrServeBase(TestCaseWithTransport):
51
52
def run_bzr_serve_then_func(self, serve_args, retcode=0, func=None,
52
53
*func_args, **func_kwargs):
53
"""Run 'bzr serve', and run the given func in a thread once the server
54
"""Run 'brz serve', and run the given func in a thread once the server
56
57
When 'func' terminates, the server will be terminated too.
58
59
Returns stdout and stderr.
61
def on_server_start(backing_urls, tcp_server):
63
target=on_server_start_thread, args=(tcp_server,))
65
61
def on_server_start_thread(tcp_server):
62
"""This runs concurrently with the server thread.
64
The server is interrupted as soon as ``func`` finishes, even if an
65
exception is encountered.
68
69
self.tcp_server = tcp_server
71
72
func(*func_args, **func_kwargs)
73
except Exception as e:
73
74
# Log errors to make some test failures a little less
75
mutter('func broke: %r', e)
76
trace.mutter('func broke: %r', e)
77
78
# Then stop the server
78
mutter('interrupting...')
79
trace.mutter('interrupting...')
79
80
thread.interrupt_main()
81
# When the hook is fired, it just starts ``on_server_start_thread`` and
83
def on_server_start(backing_urls, tcp_server):
85
target=on_server_start_thread, args=(tcp_server,))
80
88
SmartTCPServer.hooks.install_named_hook(
81
89
'server_started_ex', on_server_start,
82
90
'run_bzr_serve_then_func hook')
91
# It seesm thread.interrupt_main() will not raise KeyboardInterrupt
92
# until after socket.accept returns. So we set the timeout low to make
94
self.overrideAttr(SmartTCPServer, '_ACCEPT_TIMEOUT', 0.1)
83
95
# start a TCP server
85
out, err = self.run_bzr(['serve'] + list(serve_args))
86
except KeyboardInterrupt, e:
97
out, err = self.run_bzr(['serve'] + list(serve_args),
99
except KeyboardInterrupt as e:
100
return (self._last_cmd_stdout.getvalue(),
101
self._last_cmd_stderr.getvalue())
94
108
super(TestBzrServe, self).setUp()
95
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 = ['--listen', 'localhost', '--port', '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)
97
135
def assertInetServerShutsdownCleanly(self, process):
98
136
"""Shutdown the server process looking for errors."""
99
137
# Shutdown the server: the server should shut down when it cannot read
106
144
self.assertEqual('', result[1])
108
146
def assertServerFinishesCleanly(self, process):
109
"""Shutdown the bzr serve instance process looking for errors."""
147
"""Shutdown the brz serve instance process looking for errors."""
110
148
# Shutdown the server
111
149
result = self.finish_bzr_subprocess(process, retcode=3,
112
150
send_signal=signal.SIGINT)
113
151
self.assertEqual('', result[0])
114
self.assertEqual('bzr: interrupted\n', result[1])
152
self.assertEqual('brz: interrupted\n', result[1])
116
154
def make_read_requests(self, branch):
117
155
"""Do some read only requests."""
146
184
return process, transport
148
186
def start_server_port(self, extra_options=()):
149
"""Start a bzr server subprocess.
187
"""Start a brz server subprocess.
151
189
:param extra_options: extra options to give the server.
152
:return: a tuple with the bzr process handle for passing to
190
:return: a tuple with the brz process handle for passing to
153
191
finish_bzr_subprocess, and the base url for the server.
155
193
# Serve from the current directory
156
args = ['serve', '--port', 'localhost:0']
194
args = ['serve', '--listen', 'localhost', '--port', '0']
157
195
args.extend(extra_options)
158
196
process = self.start_bzr_subprocess(args, skip_if_plan_to_signal=True)
159
197
port_line = process.stderr.readline()
163
201
url = 'bzr://localhost:%d/' % port
164
202
self.permit_url(url)
165
203
return process, url
167
205
def test_bzr_serve_quiet(self):
168
206
self.make_branch('.')
169
args = ['--port', 'localhost:0', '--quiet']
207
args = ['--listen', 'localhost', '--port', '0', '--quiet']
170
208
out, err = self.run_bzr_serve_then_func(args, retcode=3)
171
209
self.assertEqual('', out)
172
210
self.assertEqual('', err)
174
212
def test_bzr_serve_inet_readonly(self):
175
"""bzr server should provide a read only filesystem by default."""
213
"""brz server should provide a read only filesystem by default."""
176
214
process, transport = self.start_server_inet()
177
215
self.assertRaises(errors.TransportNotPossible, transport.mkdir, 'adir')
178
216
self.assertInetServerShutsdownCleanly(process)
184
222
process, transport = self.start_server_inet(['--allow-writes'])
186
224
# We get a working branch, and can create a directory
187
branch = BzrDir.open_from_transport(transport).open_branch()
225
branch = ControlDir.open_from_transport(transport).open_branch()
188
226
self.make_read_requests(branch)
189
227
transport.mkdir('adir')
190
228
self.assertInetServerShutsdownCleanly(process)
192
230
def test_bzr_serve_port_readonly(self):
193
"""bzr server should provide a read only filesystem by default."""
231
"""brz server should provide a read only filesystem by default."""
194
232
process, url = self.start_server_port()
195
transport = get_transport(url)
196
self.assertRaises(errors.TransportNotPossible, transport.mkdir, 'adir')
233
t = transport.get_transport_from_url(url)
234
self.assertRaises(errors.TransportNotPossible, t.mkdir, 'adir')
197
235
self.assertServerFinishesCleanly(process)
199
237
def test_bzr_serve_port_readwrite(self):
223
261
# This is a smoke test that the server doesn't crash when run with
224
262
# -Dhpss, and does drop some hpss logging to the file.
225
263
self.make_branch('.')
226
log_fname = os.getcwd() + '/server.log'
227
self._captureVar('BZR_LOG', log_fname)
264
log_fname = self.test_dir + '/server.log'
265
self.overrideEnv('BRZ_LOG', log_fname)
228
266
process, transport = self.start_server_inet(['-Dhpss'])
229
branch = BzrDir.open_from_transport(transport).open_branch()
267
branch = ControlDir.open_from_transport(transport).open_branch()
230
268
self.make_read_requests(branch)
231
269
self.assertInetServerShutsdownCleanly(process)
232
270
f = open(log_fname, 'rb')
235
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
# Save the config as the subprocess will use it
280
process, url = self.start_server_port()
281
self.build_tree_contents([('a_file', 'contents\n')])
282
# We can connect and issue a request
283
t = transport.get_transport_from_url(url)
284
self.assertEqual('contents\n', t.get_bytes('a_file'))
285
# However, if we just wait for more content from the server, it will
286
# eventually disconnect us.
287
m = t.get_smart_medium()
289
# Now, we wait for timeout to trigger
290
err = process.stderr.readline()
292
'Connection Timeout: disconnecting client after 0.2 seconds\n',
294
self.assertServerFinishesCleanly(process)
296
def test_bzr_serve_supports_client_timeout(self):
297
process, url = self.start_server_port(['--client-timeout=0.1'])
298
self.build_tree_contents([('a_file', 'contents\n')])
299
# We can connect and issue a request
300
t = transport.get_transport_from_url(url)
301
self.assertEqual('contents\n', t.get_bytes('a_file'))
302
# However, if we just wait for more content from the server, it will
303
# eventually disconnect us.
304
# TODO: Use something like signal.alarm() so that if the server doesn't
305
# properly handle the timeout, we end up failing the test instead
306
# of hanging forever.
307
m = t.get_smart_medium()
309
# Now, we wait for timeout to trigger
310
err = process.stderr.readline()
312
'Connection Timeout: disconnecting client after 0.1 seconds\n',
314
self.assertServerFinishesCleanly(process)
316
def test_bzr_serve_graceful_shutdown(self):
317
big_contents = 'a'*64*1024
318
self.build_tree_contents([('bigfile', big_contents)])
319
process, url = self.start_server_port(['--client-timeout=1.0'])
320
t = transport.get_transport_from_url(url)
321
m = t.get_smart_medium()
322
c = client._SmartClient(m)
323
# Start, but don't finish a response
324
resp, response_handler = c.call_expecting_body('get', 'bigfile')
325
self.assertEqual(('ok',), resp)
326
# Note: process.send_signal is a Python 2.6ism
327
process.send_signal(signal.SIGHUP)
328
# Wait for the server to notice the signal, and then read the actual
329
# body of the response. That way we know that it is waiting for the
331
self.assertEqual('Requested to stop gracefully\n',
332
process.stderr.readline())
333
self.assertEqual('Waiting for 1 client(s) to finish\n',
334
process.stderr.readline())
335
body = response_handler.read_body_bytes()
336
if body != big_contents:
337
self.fail('Failed to properly read the contents of "bigfile"')
338
# Now that our request is finished, the medium should notice it has
340
self.assertEqual('', m.read_bytes(1))
341
# And the server should be stopping
342
self.assertEqual(0, process.wait())
238
345
class TestCmdServeChrooting(TestBzrServeBase):
240
347
def test_serve_tcp(self):
241
"""'bzr serve' wraps the given --directory in a ChrootServer.
348
"""'brz serve' wraps the given --directory in a ChrootServer.
243
350
So requests that search up through the parent directories (like
244
351
find_repositoryV3) will give "not found" responses, rather than
added
removed
breezy/tests/blackbox/test_serve.py
