/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

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

  • Committer: Martin Pool
  • Date: 2009-12-14 06:06:59 UTC
  • mfrom: (4889 +trunk)
  • mto: This revision was merged to the branch mainline in revision 4891.
  • Revision ID: mbp@sourcefrog.net-20091214060659-1ucv8hpnky0cbnaj
merge trunk

Show diffs side-by-side

added added

removed removed

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