← 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: Vincent Ladeuil
  • Date: 2010-03-02 10:21:39 UTC
  • mfrom: (4797.2.24 2.1)
  • mto: This revision was merged to the branch mainline in revision 5069.
  • Revision ID: v.ladeuil+lp@free.fr-20100302102139-b5cba7h6xu13mekg
Merge 2.1 into trunk including fixes for #331095, #507557, #185103, #524184 and #369501

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/blackbox/test_serve.py
1
 
# Copyright (C) 2006 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
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
 
18
18
"""Tests of the bzr serve command."""
19
19
 
20
20
import os
 
21
import os.path
21
22
import signal
22
23
import subprocess
23
24
import sys
 
25
import thread
24
26
import threading
25
27
 
26
28
from bzrlib import (
 
29
    builtins,
 
30
    debug,
27
31
    errors,
28
32
    osutils,
29
33
    revision as _mod_revision,
 
34
    urlutils,
30
35
    )
31
36
from bzrlib.branch import Branch
32
37
from bzrlib.bzrdir import BzrDir
33
 
from bzrlib.errors import ParamikoNotPresent
34
 
from bzrlib.smart import medium
35
 
from bzrlib.tests import TestCaseWithTransport, TestSkipped
 
38
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
    )
 
45
from bzrlib.trace import mutter
36
46
from bzrlib.transport import get_transport, remote
37
47
 
38
48
 
39
 
class TestBzrServe(TestCaseWithTransport):
 
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()
40
96
 
41
97
    def assertInetServerShutsdownCleanly(self, process):
42
98
        """Shutdown the server process looking for errors."""
48
104
        result = self.finish_bzr_subprocess(process)
49
105
        self.assertEqual('', result[0])
50
106
        self.assertEqual('', result[1])
51
 
    
 
107
 
52
108
    def assertServerFinishesCleanly(self, process):
53
109
        """Shutdown the bzr serve instance process looking for errors."""
54
110
        # Shutdown the server
57
113
        self.assertEqual('', result[0])
58
114
        self.assertEqual('bzr: interrupted\n', result[1])
59
115
 
 
116
    def make_read_requests(self, branch):
 
117
        """Do some read only requests."""
 
118
        branch.lock_read()
 
119
        try:
 
120
            branch.repository.all_revision_ids()
 
121
            self.assertEqual(_mod_revision.NULL_REVISION,
 
122
                             _mod_revision.ensure_null(branch.last_revision()))
 
123
        finally:
 
124
            branch.unlock()
 
125
 
60
126
    def start_server_inet(self, extra_options=()):
61
127
        """Start a bzr server subprocess using the --inet option.
62
128
 
65
131
            finish_bzr_subprocess, a client for the server, and a transport.
66
132
        """
67
133
        # Serve from the current directory
68
 
        process = self.start_bzr_subprocess(['serve', '--inet'])
 
134
        args = ['serve', '--inet']
 
135
        args.extend(extra_options)
 
136
        process = self.start_bzr_subprocess(args)
69
137
 
70
138
        # Connect to the server
71
139
        # We use this url because while this is no valid URL to connect to this
72
140
        # server instance, the transport needs a URL.
 
141
        url = 'bzr://localhost/'
 
142
        self.permit_url(url)
73
143
        client_medium = medium.SmartSimplePipesClientMedium(
74
 
            process.stdout, process.stdin)
75
 
        transport = remote.RemoteTransport(
76
 
            'bzr://localhost/', medium=client_medium)
 
144
            process.stdout, process.stdin, url)
 
145
        transport = remote.RemoteTransport(url, medium=client_medium)
77
146
        return process, transport
78
147
 
79
148
    def start_server_port(self, extra_options=()):
87
156
        args = ['serve', '--port', 'localhost:0']
88
157
        args.extend(extra_options)
89
158
        process = self.start_bzr_subprocess(args, skip_if_plan_to_signal=True)
90
 
        port_line = process.stdout.readline()
 
159
        port_line = process.stderr.readline()
91
160
        prefix = 'listening on port: '
92
161
        self.assertStartsWith(port_line, prefix)
93
162
        port = int(port_line[len(prefix):])
94
 
        return process,'bzr://localhost:%d/' % port
 
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)
95
173
 
96
174
    def test_bzr_serve_inet_readonly(self):
97
175
        """bzr server should provide a read only filesystem by default."""
105
183
 
106
184
        process, transport = self.start_server_inet(['--allow-writes'])
107
185
 
108
 
        # We get a working branch
 
186
        # We get a working branch, and can create a directory
109
187
        branch = BzrDir.open_from_transport(transport).open_branch()
110
 
        branch.repository.get_revision_graph()
111
 
        self.assertEqual(_mod_revision.NULL_REVISION,
112
 
                         _mod_revision.ensure_null(branch.last_revision()))
 
188
        self.make_read_requests(branch)
 
189
        transport.mkdir('adir')
113
190
        self.assertInetServerShutsdownCleanly(process)
114
191
 
115
192
    def test_bzr_serve_port_readonly(self):
127
204
 
128
205
        # Connect to the server
129
206
        branch = Branch.open(url)
130
 
 
131
 
        # We get a working branch
132
 
        branch.repository.get_revision_graph()
133
 
        self.assertEqual(_mod_revision.NULL_REVISION,
134
 
                         _mod_revision.ensure_null(branch.last_revision()))
135
 
 
 
207
        self.make_read_requests(branch)
136
208
        self.assertServerFinishesCleanly(process)
137
209
 
138
 
    def test_bzr_connect_to_bzr_ssh(self):
139
 
        """User acceptance that get_transport of a bzr+ssh:// behaves correctly.
140
 
 
141
 
        bzr+ssh:// should cause bzr to run a remote bzr smart server over SSH.
142
 
        """
143
 
        try:
144
 
            from bzrlib.transport.sftp import SFTPServer
145
 
        except ParamikoNotPresent:
146
 
            raise TestSkipped('Paramiko not installed')
147
 
        from bzrlib.tests.stub_sftp import StubServer
148
 
        
 
210
    def test_bzr_serve_supports_protocol(self):
149
211
        # Make a branch
150
 
        self.make_branch('a_branch')
151
 
 
152
 
        # Start an SSH server
153
 
        self.command_executed = []
154
 
        # XXX: This is horrible -- we define a really dumb SSH server that
155
 
        # executes commands, and manage the hooking up of stdin/out/err to the
156
 
        # SSH channel ourselves.  Surely this has already been implemented
157
 
        # elsewhere?
158
 
        class StubSSHServer(StubServer):
159
 
 
160
 
            test = self
161
 
 
162
 
            def check_channel_exec_request(self, channel, command):
163
 
                self.test.command_executed.append(command)
164
 
                proc = subprocess.Popen(
165
 
                    command, shell=True, stdin=subprocess.PIPE,
166
 
                    stdout=subprocess.PIPE, stderr=subprocess.PIPE)
167
 
                
168
 
                # XXX: horribly inefficient, not to mention ugly.
169
 
                # Start a thread for each of stdin/out/err, and relay bytes from
170
 
                # the subprocess to channel and vice versa.
171
 
                def ferry_bytes(read, write, close):
172
 
                    while True:
173
 
                        bytes = read(1)
174
 
                        if bytes == '':
175
 
                            close()
176
 
                            break
177
 
                        write(bytes)
178
 
 
179
 
                file_functions = [
180
 
                    (channel.recv, proc.stdin.write, proc.stdin.close),
181
 
                    (proc.stdout.read, channel.sendall, channel.close),
182
 
                    (proc.stderr.read, channel.sendall_stderr, channel.close)]
183
 
                for read, write, close in file_functions:
184
 
                    t = threading.Thread(
185
 
                        target=ferry_bytes, args=(read, write, close))
186
 
                    t.start()
187
 
 
188
 
                return True
189
 
 
190
 
        ssh_server = SFTPServer(StubSSHServer)
191
 
        # XXX: We *don't* want to override the default SSH vendor, so we set
192
 
        # _vendor to what _get_ssh_vendor returns.
193
 
        ssh_server.setUp()
194
 
        self.addCleanup(ssh_server.tearDown)
195
 
        port = ssh_server._listener.port
196
 
 
197
 
        # Access the branch via a bzr+ssh URL.  The BZR_REMOTE_PATH environment
198
 
        # variable is used to tell bzr what command to run on the remote end.
199
 
        path_to_branch = osutils.abspath('a_branch')
200
 
        
201
 
        orig_bzr_remote_path = os.environ.get('BZR_REMOTE_PATH')
202
 
        bzr_remote_path = self.get_bzr_path()
203
 
        if sys.platform == 'win32':
204
 
            bzr_remote_path = sys.executable + ' ' + self.get_bzr_path()
205
 
        os.environ['BZR_REMOTE_PATH'] = bzr_remote_path
 
212
        self.make_branch('.')
 
213
 
 
214
        process, url = self.start_server_port(['--allow-writes',
 
215
                                               '--protocol=bzr'])
 
216
 
 
217
        # Connect to the server
 
218
        branch = Branch.open(url)
 
219
        self.make_read_requests(branch)
 
220
        self.assertServerFinishesCleanly(process)
 
221
 
 
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):
 
239
 
 
240
    def test_serve_tcp(self):
 
241
        """'bzr serve' wraps the given --directory in a ChrootServer.
 
242
 
 
243
        So requests that search up through the parent directories (like
 
244
        find_repositoryV3) will give "not found" responses, rather than
 
245
        InvalidURLJoin or jail break errors.
 
246
        """
 
247
        t = self.get_transport()
 
248
        t.mkdir('server-root')
 
249
        self.run_bzr_serve_then_func(
 
250
            ['--port', '127.0.0.1:0',
 
251
             '--directory', t.local_abspath('server-root'),
 
252
             '--allow-writes'],
 
253
            func=self.when_server_started)
 
254
        # The when_server_started method issued a find_repositoryV3 that should
 
255
        # fail with 'norepository' because there are no repositories inside the
 
256
        # --directory.
 
257
        self.assertEqual(('norepository',), self.client_resp)
 
258
 
 
259
    def when_server_started(self):
 
260
        # Connect to the TCP server and issue some requests and see what comes
 
261
        # back.
 
262
        client_medium = medium.SmartTCPClientMedium(
 
263
            '127.0.0.1', self.tcp_server.port,
 
264
            'bzr://localhost:%d/' % (self.tcp_server.port,))
 
265
        smart_client = client._SmartClient(client_medium)
 
266
        resp = smart_client.call('mkdir', 'foo', '')
 
267
        resp = smart_client.call('BzrDirFormat.initialize', 'foo/')
206
268
        try:
207
 
            if sys.platform == 'win32':
208
 
                path_to_branch = os.path.splitdrive(path_to_branch)[1]
209
 
            branch = Branch.open(
210
 
                'bzr+ssh://fred:secret@localhost:%d%s' % (port, path_to_branch))
211
 
            
212
 
            branch.repository.get_revision_graph()
213
 
            self.assertEqual(_mod_revision.NULL_REVISION,
214
 
                             _mod_revision.ensure_null(branch.last_revision()))
215
 
            # Check we can perform write operations
216
 
            branch.bzrdir.root_transport.mkdir('foo')
217
 
        finally:
218
 
            # Restore the BZR_REMOTE_PATH environment variable back to its
219
 
            # original state.
220
 
            if orig_bzr_remote_path is None:
221
 
                del os.environ['BZR_REMOTE_PATH']
222
 
            else:
223
 
                os.environ['BZR_REMOTE_PATH'] = orig_bzr_remote_path
224
 
 
225
 
        self.assertEqual(
226
 
            ['%s serve --inet --directory=/ --allow-writes'
227
 
             % bzr_remote_path],
228
 
            self.command_executed)
229
 
        
 
269
            resp = smart_client.call('BzrDir.find_repositoryV3', 'foo/')
 
270
        except errors.ErrorFromSmartServer, e:
 
271
            resp = e.error_tuple
 
272
        self.client_resp = resp
 
273
        client_medium.disconnect()
 
274
 
 
275
 
 
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