← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/blackbox/test_serve.py

  • Committer: Andrew Bennetts
  • Date: 2010-07-29 11:17:57 UTC
  • mfrom: (5050.3.17 2.2)
  • mto: This revision was merged to the branch mainline in revision 5365.
  • Revision ID: andrew.bennetts@canonical.com-20100729111757-018h3pcefo7z0dnq
Merge lp:bzr/2.2 into lp:bzr.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/blackbox/test_serve.py
1
 
# Copyright (C) 2006-2011 Canonical Ltd
 
1
# Copyright (C) 2006-2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
18
18
"""Tests of the bzr serve command."""
19
19
 
20
20
import os
 
21
import os.path
21
22
import signal
 
23
import subprocess
22
24
import sys
23
25
import thread
24
26
import threading
25
 
import time
26
27
 
27
28
from bzrlib import (
28
29
    builtins,
29
 
    config,
 
30
    debug,
30
31
    errors,
31
32
    osutils,
32
33
    revision as _mod_revision,
33
 
    trace,
34
34
    transport,
35
35
    urlutils,
36
36
    )
37
37
from bzrlib.branch import Branch
38
38
from bzrlib.bzrdir import BzrDir
39
39
from bzrlib.smart import client, medium
40
 
from bzrlib.smart.server import (
41
 
    BzrServerFactory,
42
 
    SmartTCPServer,
43
 
    )
 
40
from bzrlib.smart.server import BzrServerFactory, SmartTCPServer
44
41
from bzrlib.tests import (
45
42
    TestCaseWithMemoryTransport,
46
43
    TestCaseWithTransport,
 
44
    TestSkipped,
47
45
    )
 
46
from bzrlib.trace import mutter
48
47
from bzrlib.transport import remote
49
48
 
50
49
 
54
53
                                *func_args, **func_kwargs):
55
54
        """Run 'bzr serve', and run the given func in a thread once the server
56
55
        has started.
57
 
 
 
56
        
58
57
        When 'func' terminates, the server will be terminated too.
59
 
 
 
58
        
60
59
        Returns stdout and stderr.
61
60
        """
 
61
        # install hook
 
62
        def on_server_start(backing_urls, tcp_server):
 
63
            t = threading.Thread(
 
64
                target=on_server_start_thread, args=(tcp_server,))
 
65
            t.start()
62
66
        def on_server_start_thread(tcp_server):
63
 
            """This runs concurrently with the server thread.
64
 
 
65
 
            The server is interrupted as soon as ``func`` finishes, even if an
66
 
            exception is encountered.
67
 
            """
68
67
            try:
69
68
                # Run func if set
70
69
                self.tcp_server = tcp_server
71
 
                if func is not None:
 
70
                if not func is None:
72
71
                    try:
73
72
                        func(*func_args, **func_kwargs)
74
73
                    except Exception, e:
75
74
                        # Log errors to make some test failures a little less
76
75
                        # mysterious.
77
 
                        trace.mutter('func broke: %r', e)
 
76
                        mutter('func broke: %r', e)
78
77
            finally:
79
78
                # Then stop the server
80
 
                trace.mutter('interrupting...')
 
79
                mutter('interrupting...')
81
80
                thread.interrupt_main()
82
 
        # When the hook is fired, it just starts ``on_server_start_thread`` and
83
 
        # return
84
 
        def on_server_start(backing_urls, tcp_server):
85
 
            t = threading.Thread(
86
 
                target=on_server_start_thread, args=(tcp_server,))
87
 
            t.start()
88
 
        # install hook
89
81
        SmartTCPServer.hooks.install_named_hook(
90
82
            'server_started_ex', on_server_start,
91
83
            '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
94
 
        # the test faster.
95
 
        self.overrideAttr(SmartTCPServer, '_ACCEPT_TIMEOUT', 0.1)
96
84
        # start a TCP server
97
85
        try:
98
 
            out, err = self.run_bzr(['serve'] + list(serve_args),
99
 
                                    retcode=retcode)
 
86
            out, err = self.run_bzr(['serve'] + list(serve_args))
100
87
        except KeyboardInterrupt, e:
101
88
            out, err = e.args
102
89
        return out, err
108
95
        super(TestBzrServe, self).setUp()
109
96
        self.disable_missing_extensions_warning()
110
97
 
111
 
    def test_server_exception_with_hook(self):
112
 
        """Catch exception from the server in the server_exception hook.
113
 
 
114
 
        We use ``run_bzr_serve_then_func`` without a ``func`` so the server
115
 
        will receive a KeyboardInterrupt exception we want to catch.
116
 
        """
117
 
        def hook(exception):
118
 
            if exception[0] is KeyboardInterrupt:
119
 
                sys.stderr.write('catching KeyboardInterrupt\n')
120
 
                return True
121
 
            else:
122
 
                return False
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)
129
 
 
130
 
    def test_server_exception_no_hook(self):
131
 
        """test exception without hook returns error"""
132
 
        args = []
133
 
        out, err = self.run_bzr_serve_then_func(args, retcode=3)
134
 
 
135
98
    def assertInetServerShutsdownCleanly(self, process):
136
99
        """Shutdown the server process looking for errors."""
137
100
        # Shutdown the server: the server should shut down when it cannot read
201
164
        url = 'bzr://localhost:%d/' % port
202
165
        self.permit_url(url)
203
166
        return process, url
204
 
 
 
167
    
205
168
    def test_bzr_serve_quiet(self):
206
169
        self.make_branch('.')
207
170
        args = ['--port', 'localhost:0', '--quiet']
230
193
    def test_bzr_serve_port_readonly(self):
231
194
        """bzr server should provide a read only filesystem by default."""
232
195
        process, url = self.start_server_port()
233
 
        t = transport.get_transport_from_url(url)
 
196
        t = transport.get_transport(url)
234
197
        self.assertRaises(errors.TransportNotPossible, t.mkdir, 'adir')
235
198
        self.assertServerFinishesCleanly(process)
236
199
 
262
225
        # -Dhpss, and does drop some hpss logging to the file.
263
226
        self.make_branch('.')
264
227
        log_fname = os.getcwd() + '/server.log'
265
 
        self.overrideEnv('BZR_LOG', log_fname)
 
228
        self._captureVar('BZR_LOG', log_fname)
266
229
        process, transport = self.start_server_inet(['-Dhpss'])
267
230
        branch = BzrDir.open_from_transport(transport).open_branch()
268
231
        self.make_read_requests(branch)
272
235
        f.close()
273
236
        self.assertContainsRe(content, r'hpss request: \[[0-9-]+\]')
274
237
 
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()
289
 
        m.read_bytes(1)
290
 
        # Now, we wait for timeout to trigger
291
 
        err = process.stderr.readline()
292
 
        self.assertEqual(
293
 
            'Connection Timeout: disconnecting client after 0.2 seconds\n',
294
 
            err)
295
 
        self.assertServerFinishesCleanly(process)
296
 
 
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()
309
 
        m.read_bytes(1)
310
 
        # Now, we wait for timeout to trigger
311
 
        err = process.stderr.readline()
312
 
        self.assertEqual(
313
 
            'Connection Timeout: disconnecting client after 0.1 seconds\n',
314
 
            err)
315
 
        self.assertServerFinishesCleanly(process)
316
 
 
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
331
 
        # request to finish
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
340
 
        # been disconnected.
341
 
        self.assertEqual('', m.read_bytes(1))
342
 
        # And the server should be stopping
343
 
        self.assertEqual(0, process.wait())
344
 
 
345
238
 
346
239
class TestCmdServeChrooting(TestBzrServeBase):
347
240
 
383
276
 
384
277
class TestUserdirExpansion(TestCaseWithMemoryTransport):
385
278
 
386
 
    @staticmethod
387
 
    def fake_expanduser(path):
 
279
    def fake_expanduser(self, path):
388
280
        """A simple, environment-independent, function for the duration of this
389
281
        test.
390
282
 
403
295
            self.fake_expanduser, lambda t: base_path)
404
296
        mem_transport = self.get_transport()
405
297
        mem_transport.mkdir_multi(['home', 'home/user'])
406
 
        bzr_server.set_up(mem_transport, None, None, inet=True, timeout=4.0)
 
298
        bzr_server.set_up(mem_transport, None, None, inet=True)
407
299
        self.addCleanup(bzr_server.tear_down)
408
300
        return bzr_server
409
301
 
425
317
        base_url = urlutils.local_path_to_url(base_dir) + '/'
426
318
        # Define a fake 'protocol' to capture the transport that cmd_serve
427
319
        # passes to serve_bzr.
428
 
        def capture_transport(transport, host, port, inet, timeout):
 
320
        def capture_transport(transport, host, port, inet):
429
321
            self.bzr_serve_transport = transport
430
322
        cmd = builtins.cmd_serve()
431
323
        # Read-only
442
334
        self.assertEqual(base_url, self.bzr_serve_transport.base)
443
335
        self.assertEqual(base_dir,
444
336
            server_maker.get_base_path(self.bzr_serve_transport))
 
337