~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

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

  • Committer: Martin Pool
  • Date: 2009-09-14 02:30:23 UTC
  • mto: This revision was merged to the branch mainline in revision 4693.
  • Revision ID: mbp@sourcefrog.net-20090914023023-ros0f3ndo04j3bww
Clearer docs about bzr help.  (Thanks to Naoki)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006-2010 Canonical Ltd
 
1
# Copyright (C) 2006 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
22
21
import signal
23
22
import subprocess
24
23
import sys
26
25
import threading
27
26
 
28
27
from bzrlib import (
29
 
    builtins,
30
 
    debug,
31
28
    errors,
32
29
    osutils,
33
30
    revision as _mod_revision,
34
 
    urlutils,
 
31
    transport,
35
32
    )
36
33
from bzrlib.branch import Branch
37
34
from bzrlib.bzrdir import BzrDir
 
35
from bzrlib.errors import ParamikoNotPresent
38
36
from bzrlib.smart import client, medium
39
 
from bzrlib.smart.server import BzrServerFactory, SmartTCPServer
40
 
from bzrlib.tests import (
41
 
    TestCaseWithMemoryTransport,
42
 
    TestCaseWithTransport,
43
 
    TestSkipped,
44
 
    )
 
37
from bzrlib.smart.server import SmartTCPServer
 
38
from bzrlib.tests import TestCaseWithTransport, TestSkipped
45
39
from bzrlib.trace import mutter
46
40
from bzrlib.transport import get_transport, remote
47
41
 
48
42
 
49
 
class TestBzrServeBase(TestCaseWithTransport):
50
 
 
51
 
    def run_bzr_serve_then_func(self, serve_args, retcode=0, func=None,
52
 
                                *func_args, **func_kwargs):
53
 
        """Run 'bzr serve', and run the given func in a thread once the server
54
 
        has started.
55
 
        
56
 
        When 'func' terminates, the server will be terminated too.
57
 
        
58
 
        Returns stdout and stderr.
59
 
        """
60
 
        # install hook
61
 
        def on_server_start(backing_urls, tcp_server):
62
 
            t = threading.Thread(
63
 
                target=on_server_start_thread, args=(tcp_server,))
64
 
            t.start()
65
 
        def on_server_start_thread(tcp_server):
66
 
            try:
67
 
                # Run func if set
68
 
                self.tcp_server = tcp_server
69
 
                if not func is None:
70
 
                    try:
71
 
                        func(*func_args, **func_kwargs)
72
 
                    except Exception, e:
73
 
                        # Log errors to make some test failures a little less
74
 
                        # mysterious.
75
 
                        mutter('func broke: %r', e)
76
 
            finally:
77
 
                # Then stop the server
78
 
                mutter('interrupting...')
79
 
                thread.interrupt_main()
80
 
        SmartTCPServer.hooks.install_named_hook(
81
 
            'server_started_ex', on_server_start,
82
 
            'run_bzr_serve_then_func hook')
83
 
        # start a TCP server
84
 
        try:
85
 
            out, err = self.run_bzr(['serve'] + list(serve_args))
86
 
        except KeyboardInterrupt, e:
87
 
            out, err = e.args
88
 
        return out, err
89
 
 
90
 
 
91
 
class TestBzrServe(TestBzrServeBase):
92
 
 
93
 
    def setUp(self):
94
 
        super(TestBzrServe, self).setUp()
95
 
        self.disable_missing_extensions_warning()
 
43
class TestBzrServe(TestCaseWithTransport):
96
44
 
97
45
    def assertInetServerShutsdownCleanly(self, process):
98
46
        """Shutdown the server process looking for errors."""
131
79
            finish_bzr_subprocess, a client for the server, and a transport.
132
80
        """
133
81
        # Serve from the current directory
134
 
        args = ['serve', '--inet']
135
 
        args.extend(extra_options)
136
 
        process = self.start_bzr_subprocess(args)
 
82
        process = self.start_bzr_subprocess(['serve', '--inet'])
137
83
 
138
84
        # Connect to the server
139
85
        # We use this url because while this is no valid URL to connect to this
140
86
        # server instance, the transport needs a URL.
141
87
        url = 'bzr://localhost/'
142
 
        self.permit_url(url)
143
88
        client_medium = medium.SmartSimplePipesClientMedium(
144
89
            process.stdout, process.stdin, url)
145
90
        transport = remote.RemoteTransport(url, medium=client_medium)
160
105
        prefix = 'listening on port: '
161
106
        self.assertStartsWith(port_line, prefix)
162
107
        port = int(port_line[len(prefix):])
163
 
        url = 'bzr://localhost:%d/' % port
164
 
        self.permit_url(url)
165
 
        return process, url
166
 
    
167
 
    def test_bzr_serve_quiet(self):
168
 
        self.make_branch('.')
169
 
        args = ['--port', 'localhost:0', '--quiet']
170
 
        out, err = self.run_bzr_serve_then_func(args, retcode=3)
171
 
        self.assertEqual('', out)
172
 
        self.assertEqual('', err)
 
108
        return process,'bzr://localhost:%d/' % port
173
109
 
174
110
    def test_bzr_serve_inet_readonly(self):
175
111
        """bzr server should provide a read only filesystem by default."""
183
119
 
184
120
        process, transport = self.start_server_inet(['--allow-writes'])
185
121
 
186
 
        # We get a working branch, and can create a directory
 
122
        # We get a working branch
187
123
        branch = BzrDir.open_from_transport(transport).open_branch()
188
124
        self.make_read_requests(branch)
189
 
        transport.mkdir('adir')
190
125
        self.assertInetServerShutsdownCleanly(process)
191
126
 
192
127
    def test_bzr_serve_port_readonly(self):
219
154
        self.make_read_requests(branch)
220
155
        self.assertServerFinishesCleanly(process)
221
156
 
222
 
    def test_bzr_serve_dhpss(self):
223
 
        # This is a smoke test that the server doesn't crash when run with
224
 
        # -Dhpss, and does drop some hpss logging to the file.
225
 
        self.make_branch('.')
226
 
        log_fname = os.getcwd() + '/server.log'
227
 
        self._captureVar('BZR_LOG', log_fname)
228
 
        process, transport = self.start_server_inet(['-Dhpss'])
229
 
        branch = BzrDir.open_from_transport(transport).open_branch()
230
 
        self.make_read_requests(branch)
231
 
        self.assertInetServerShutsdownCleanly(process)
232
 
        f = open(log_fname, 'rb')
233
 
        content = f.read()
234
 
        f.close()
235
 
        self.assertContainsRe(content, r'hpss request: \[[0-9-]+\]')
236
 
 
237
 
 
238
 
class TestCmdServeChrooting(TestBzrServeBase):
 
157
    def test_bzr_connect_to_bzr_ssh(self):
 
158
        """User acceptance that get_transport of a bzr+ssh:// behaves correctly.
 
159
 
 
160
        bzr+ssh:// should cause bzr to run a remote bzr smart server over SSH.
 
161
        """
 
162
        try:
 
163
            from bzrlib.transport.sftp import SFTPServer
 
164
        except ParamikoNotPresent:
 
165
            raise TestSkipped('Paramiko not installed')
 
166
        from bzrlib.tests.stub_sftp import StubServer
 
167
 
 
168
        # Make a branch
 
169
        self.make_branch('a_branch')
 
170
 
 
171
        # Start an SSH server
 
172
        self.command_executed = []
 
173
        # XXX: This is horrible -- we define a really dumb SSH server that
 
174
        # executes commands, and manage the hooking up of stdin/out/err to the
 
175
        # SSH channel ourselves.  Surely this has already been implemented
 
176
        # elsewhere?
 
177
        class StubSSHServer(StubServer):
 
178
 
 
179
            test = self
 
180
 
 
181
            def check_channel_exec_request(self, channel, command):
 
182
                self.test.command_executed.append(command)
 
183
                proc = subprocess.Popen(
 
184
                    command, shell=True, stdin=subprocess.PIPE,
 
185
                    stdout=subprocess.PIPE, stderr=subprocess.PIPE)
 
186
 
 
187
                # XXX: horribly inefficient, not to mention ugly.
 
188
                # Start a thread for each of stdin/out/err, and relay bytes from
 
189
                # the subprocess to channel and vice versa.
 
190
                def ferry_bytes(read, write, close):
 
191
                    while True:
 
192
                        bytes = read(1)
 
193
                        if bytes == '':
 
194
                            close()
 
195
                            break
 
196
                        write(bytes)
 
197
 
 
198
                file_functions = [
 
199
                    (channel.recv, proc.stdin.write, proc.stdin.close),
 
200
                    (proc.stdout.read, channel.sendall, channel.close),
 
201
                    (proc.stderr.read, channel.sendall_stderr, channel.close)]
 
202
                for read, write, close in file_functions:
 
203
                    t = threading.Thread(
 
204
                        target=ferry_bytes, args=(read, write, close))
 
205
                    t.start()
 
206
 
 
207
                return True
 
208
 
 
209
        ssh_server = SFTPServer(StubSSHServer)
 
210
        # XXX: We *don't* want to override the default SSH vendor, so we set
 
211
        # _vendor to what _get_ssh_vendor returns.
 
212
        self.start_server(ssh_server)
 
213
        port = ssh_server._listener.port
 
214
 
 
215
        # Access the branch via a bzr+ssh URL.  The BZR_REMOTE_PATH environment
 
216
        # variable is used to tell bzr what command to run on the remote end.
 
217
        path_to_branch = osutils.abspath('a_branch')
 
218
 
 
219
        orig_bzr_remote_path = os.environ.get('BZR_REMOTE_PATH')
 
220
        bzr_remote_path = self.get_bzr_path()
 
221
        if sys.platform == 'win32':
 
222
            bzr_remote_path = sys.executable + ' ' + self.get_bzr_path()
 
223
        os.environ['BZR_REMOTE_PATH'] = bzr_remote_path
 
224
        try:
 
225
            if sys.platform == 'win32':
 
226
                path_to_branch = os.path.splitdrive(path_to_branch)[1]
 
227
            branch = Branch.open(
 
228
                'bzr+ssh://fred:secret@localhost:%d%s' % (port, path_to_branch))
 
229
            self.make_read_requests(branch)
 
230
            # Check we can perform write operations
 
231
            branch.bzrdir.root_transport.mkdir('foo')
 
232
        finally:
 
233
            # Restore the BZR_REMOTE_PATH environment variable back to its
 
234
            # original state.
 
235
            if orig_bzr_remote_path is None:
 
236
                del os.environ['BZR_REMOTE_PATH']
 
237
            else:
 
238
                os.environ['BZR_REMOTE_PATH'] = orig_bzr_remote_path
 
239
 
 
240
        self.assertEqual(
 
241
            ['%s serve --inet --directory=/ --allow-writes'
 
242
             % bzr_remote_path],
 
243
            self.command_executed)
 
244
 
 
245
 
 
246
class TestCmdServeChrooting(TestCaseWithTransport):
239
247
 
240
248
    def test_serve_tcp(self):
241
249
        """'bzr serve' wraps the given --directory in a ChrootServer.
247
255
        t = self.get_transport()
248
256
        t.mkdir('server-root')
249
257
        self.run_bzr_serve_then_func(
250
 
            ['--port', '127.0.0.1:0',
251
 
             '--directory', t.local_abspath('server-root'),
 
258
            ['--port', '0', '--directory', t.local_abspath('server-root'),
252
259
             '--allow-writes'],
253
 
            func=self.when_server_started)
 
260
            self.when_server_started)
254
261
        # The when_server_started method issued a find_repositoryV3 that should
255
262
        # fail with 'norepository' because there are no repositories inside the
256
263
        # --directory.
257
264
        self.assertEqual(('norepository',), self.client_resp)
 
265
        
 
266
    def run_bzr_serve_then_func(self, serve_args, func, *func_args,
 
267
            **func_kwargs):
 
268
        """Run 'bzr serve', and run the given func in a thread once the server
 
269
        has started.
 
270
        
 
271
        When 'func' terminates, the server will be terminated too.
 
272
        """
 
273
        # install hook
 
274
        def on_server_start(backing_urls, tcp_server):
 
275
            t = threading.Thread(
 
276
                target=on_server_start_thread, args=(tcp_server,))
 
277
            t.start()
 
278
        def on_server_start_thread(tcp_server):
 
279
            try:
 
280
                # Run func
 
281
                self.tcp_server = tcp_server
 
282
                try:
 
283
                    func(*func_args, **func_kwargs)
 
284
                except Exception, e:
 
285
                    # Log errors to make some test failures a little less
 
286
                    # mysterious.
 
287
                    mutter('func broke: %r', e)
 
288
            finally:
 
289
                # Then stop the server
 
290
                mutter('interrupting...')
 
291
                thread.interrupt_main()
 
292
        SmartTCPServer.hooks.install_named_hook(
 
293
            'server_started_ex', on_server_start,
 
294
            'run_bzr_serve_then_func hook')
 
295
        # start a TCP server
 
296
        try:
 
297
            self.run_bzr(['serve'] + list(serve_args))
 
298
        except KeyboardInterrupt:
 
299
            pass
258
300
 
259
301
    def when_server_started(self):
260
302
        # Connect to the TCP server and issue some requests and see what comes
273
315
        client_medium.disconnect()
274
316
 
275
317
 
276
 
class TestUserdirExpansion(TestCaseWithMemoryTransport):
277
 
 
278
 
    def fake_expanduser(self, path):
279
 
        """A simple, environment-independent, function for the duration of this
280
 
        test.
281
 
 
282
 
        Paths starting with a path segment of '~user' will expand to start with
283
 
        '/home/user/'.  Every other path will be unchanged.
284
 
        """
285
 
        if path.split('/', 1)[0] == '~user':
286
 
            return '/home/user' + path[len('~user'):]
287
 
        return path
288
 
 
289
 
    def make_test_server(self, base_path='/'):
290
 
        """Make and start a BzrServerFactory, backed by a memory transport, and
291
 
        creat '/home/user' in that transport.
292
 
        """
293
 
        bzr_server = BzrServerFactory(
294
 
            self.fake_expanduser, lambda t: base_path)
295
 
        mem_transport = self.get_transport()
296
 
        mem_transport.mkdir_multi(['home', 'home/user'])
297
 
        bzr_server.set_up(mem_transport, None, None, inet=True)
298
 
        self.addCleanup(bzr_server.tear_down)
299
 
        return bzr_server
300
 
 
301
 
    def test_bzr_serve_expands_userdir(self):
302
 
        bzr_server = self.make_test_server()
303
 
        self.assertTrue(bzr_server.smart_server.backing_transport.has('~user'))
304
 
 
305
 
    def test_bzr_serve_does_not_expand_userdir_outside_base(self):
306
 
        bzr_server = self.make_test_server('/foo')
307
 
        self.assertFalse(bzr_server.smart_server.backing_transport.has('~user'))
308
 
 
309
 
    def test_get_base_path(self):
310
 
        """cmd_serve will turn the --directory option into a LocalTransport
311
 
        (optionally decorated with 'readonly+').  BzrServerFactory can
312
 
        determine the original --directory from that transport.
313
 
        """
314
 
        # URLs always include the trailing slash, and get_base_path returns it
315
 
        base_dir = osutils.abspath('/a/b/c') + '/'
316
 
        base_url = urlutils.local_path_to_url(base_dir) + '/'
317
 
        # Define a fake 'protocol' to capture the transport that cmd_serve
318
 
        # passes to serve_bzr.
319
 
        def capture_transport(transport, host, port, inet):
320
 
            self.bzr_serve_transport = transport
321
 
        cmd = builtins.cmd_serve()
322
 
        # Read-only
323
 
        cmd.run(directory=base_dir, protocol=capture_transport)
324
 
        server_maker = BzrServerFactory()
325
 
        self.assertEqual(
326
 
            'readonly+%s' % base_url, self.bzr_serve_transport.base)
327
 
        self.assertEqual(
328
 
            base_dir, server_maker.get_base_path(self.bzr_serve_transport))
329
 
        # Read-write
330
 
        cmd.run(directory=base_dir, protocol=capture_transport,
331
 
            allow_writes=True)
332
 
        server_maker = BzrServerFactory()
333
 
        self.assertEqual(base_url, self.bzr_serve_transport.base)
334
 
        self.assertEqual(base_dir,
335
 
            server_maker.get_base_path(self.bzr_serve_transport))
336
318