/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 breezy/tests/blackbox/test_serve.py

  • Committer: Jelmer Vernooij
  • Date: 2020-05-24 00:39:50 UTC
  • mto: This revision was merged to the branch mainline in revision 7504.
  • Revision ID: jelmer@jelmer.uk-20200524003950-bbc545r76vc5yajg
Add github action.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/tests/blackbox/test_serve.py
 
1
# Copyright (C) 2006-2011 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
 
 
18
"""Tests of the brz serve command."""
 
19
 
 
20
import os
 
21
import signal
 
22
import sys
 
23
from _thread import interrupt_main
 
24
 
 
25
import threading
 
26
 
 
27
from ... import (
 
28
    builtins,
 
29
    config,
 
30
    errors,
 
31
    osutils,
 
32
    revision as _mod_revision,
 
33
    trace,
 
34
    transport,
 
35
    urlutils,
 
36
    )
 
37
from ...branch import Branch
 
38
from ...controldir import ControlDir
 
39
from ...bzr.smart import client, medium
 
40
from ...bzr.smart.server import (
 
41
    BzrServerFactory,
 
42
    SmartTCPServer,
 
43
    )
 
44
from .. import (
 
45
    TestCaseWithMemoryTransport,
 
46
    TestCaseWithTransport,
 
47
    )
 
48
from ...transport import remote
 
49
 
 
50
 
 
51
class TestBzrServeBase(TestCaseWithTransport):
 
52
 
 
53
    def run_bzr_serve_then_func(self, serve_args, retcode=0, func=None,
 
54
                                *func_args, **func_kwargs):
 
55
        """Run 'brz serve', and run the given func in a thread once the server
 
56
        has started.
 
57
 
 
58
        When 'func' terminates, the server will be terminated too.
 
59
 
 
60
        Returns stdout and stderr.
 
61
        """
 
62
        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
            try:
 
69
                # Run func if set
 
70
                self.tcp_server = tcp_server
 
71
                if func is not None:
 
72
                    try:
 
73
                        func(*func_args, **func_kwargs)
 
74
                    except Exception as e:
 
75
                        # Log errors to make some test failures a little less
 
76
                        # mysterious.
 
77
                        trace.mutter('func broke: %r', e)
 
78
            finally:
 
79
                # Then stop the server
 
80
                trace.mutter('interrupting...')
 
81
                interrupt_main()
 
82
        # When the hook is fired, it just starts ``on_server_start_thread`` and
 
83
        # return
 
84
 
 
85
        def on_server_start(backing_urls, tcp_server):
 
86
            t = threading.Thread(
 
87
                target=on_server_start_thread, args=(tcp_server,))
 
88
            t.start()
 
89
        # install hook
 
90
        SmartTCPServer.hooks.install_named_hook(
 
91
            'server_started_ex', on_server_start,
 
92
            'run_bzr_serve_then_func hook')
 
93
        # It seems interrupt_main() will not raise KeyboardInterrupt
 
94
        # until after socket.accept returns. So we set the timeout low to make
 
95
        # the test faster.
 
96
        self.overrideAttr(SmartTCPServer, '_ACCEPT_TIMEOUT', 0.1)
 
97
        # start a TCP server
 
98
        try:
 
99
            out, err = self.run_bzr(['serve'] + list(serve_args),
 
100
                                    retcode=retcode)
 
101
        except KeyboardInterrupt as e:
 
102
            return (self._last_cmd_stdout.getvalue(),
 
103
                    self._last_cmd_stderr.getvalue())
 
104
        return out, err
 
105
 
 
106
 
 
107
class TestBzrServe(TestBzrServeBase):
 
108
 
 
109
    def setUp(self):
 
110
        super(TestBzrServe, self).setUp()
 
111
        self.disable_missing_extensions_warning()
 
112
 
 
113
    def test_server_exception_with_hook(self):
 
114
        """Catch exception from the server in the server_exception hook.
 
115
 
 
116
        We use ``run_bzr_serve_then_func`` without a ``func`` so the server
 
117
        will receive a KeyboardInterrupt exception we want to catch.
 
118
        """
 
119
        def hook(exception):
 
120
            if exception[0] is KeyboardInterrupt:
 
121
                sys.stderr.write(b'catching KeyboardInterrupt\n')
 
122
                return True
 
123
            else:
 
124
                return False
 
125
        SmartTCPServer.hooks.install_named_hook(
 
126
            'server_exception', hook,
 
127
            'test_server_except_hook hook')
 
128
        args = ['--listen', 'localhost', '--port', '0', '--quiet']
 
129
        out, err = self.run_bzr_serve_then_func(args, retcode=0)
 
130
        self.assertEqual('catching KeyboardInterrupt\n', err)
 
131
 
 
132
    def test_server_exception_no_hook(self):
 
133
        """test exception without hook returns error"""
 
134
        args = []
 
135
        out, err = self.run_bzr_serve_then_func(args, retcode=3)
 
136
 
 
137
    def assertInetServerShutsdownCleanly(self, process):
 
138
        """Shutdown the server process looking for errors."""
 
139
        # Shutdown the server: the server should shut down when it cannot read
 
140
        # from stdin anymore.
 
141
        process.stdin.close()
 
142
        # Hide stdin from the subprocess module, so it won't fail to close it.
 
143
        process.stdin = None
 
144
        result = self.finish_bzr_subprocess(process)
 
145
        self.assertEqual(b'', result[0])
 
146
        self.assertEqual(b'', result[1])
 
147
 
 
148
    def assertServerFinishesCleanly(self, process):
 
149
        """Shutdown the brz serve instance process looking for errors."""
 
150
        # Shutdown the server
 
151
        result = self.finish_bzr_subprocess(process, retcode=3,
 
152
                                            send_signal=signal.SIGINT)
 
153
        self.assertEqual(b'', result[0])
 
154
        self.assertEqual(b'brz: interrupted\n', result[1])
 
155
 
 
156
    def make_read_requests(self, branch):
 
157
        """Do some read only requests."""
 
158
        with branch.lock_read():
 
159
            branch.repository.all_revision_ids()
 
160
            self.assertEqual(_mod_revision.NULL_REVISION,
 
161
                             _mod_revision.ensure_null(branch.last_revision()))
 
162
 
 
163
    def start_server_inet(self, extra_options=()):
 
164
        """Start a brz server subprocess using the --inet option.
 
165
 
 
166
        :param extra_options: extra options to give the server.
 
167
        :return: a tuple with the brz process handle for passing to
 
168
            finish_bzr_subprocess, a client for the server, and a transport.
 
169
        """
 
170
        # Serve from the current directory
 
171
        args = ['serve', '--inet']
 
172
        args.extend(extra_options)
 
173
        process = self.start_bzr_subprocess(args)
 
174
 
 
175
        # Connect to the server
 
176
        # We use this url because while this is no valid URL to connect to this
 
177
        # server instance, the transport needs a URL.
 
178
        url = 'bzr://localhost/'
 
179
        self.permit_url(url)
 
180
        client_medium = medium.SmartSimplePipesClientMedium(
 
181
            process.stdout, process.stdin, url)
 
182
        transport = remote.RemoteTransport(url, medium=client_medium)
 
183
        return process, transport
 
184
 
 
185
    def start_server_port(self, extra_options=()):
 
186
        """Start a brz server subprocess.
 
187
 
 
188
        :param extra_options: extra options to give the server.
 
189
        :return: a tuple with the brz process handle for passing to
 
190
            finish_bzr_subprocess, and the base url for the server.
 
191
        """
 
192
        # Serve from the current directory
 
193
        args = ['serve', '--listen', 'localhost', '--port', '0']
 
194
        args.extend(extra_options)
 
195
        process = self.start_bzr_subprocess(args, skip_if_plan_to_signal=True)
 
196
        port_line = process.stderr.readline()
 
197
        prefix = b'listening on port: '
 
198
        self.assertStartsWith(port_line, prefix)
 
199
        port = int(port_line[len(prefix):])
 
200
        url = 'bzr://localhost:%d/' % port
 
201
        self.permit_url(url)
 
202
        return process, url
 
203
 
 
204
    def test_bzr_serve_quiet(self):
 
205
        self.make_branch('.')
 
206
        args = ['--listen', 'localhost', '--port', '0', '--quiet']
 
207
        out, err = self.run_bzr_serve_then_func(args, retcode=3)
 
208
        self.assertEqual('', out)
 
209
        self.assertEqual('', err)
 
210
 
 
211
    def test_bzr_serve_inet_readonly(self):
 
212
        """brz server should provide a read only filesystem by default."""
 
213
        process, transport = self.start_server_inet()
 
214
        self.assertRaises(errors.TransportNotPossible, transport.mkdir, 'adir')
 
215
        self.assertInetServerShutsdownCleanly(process)
 
216
 
 
217
    def test_bzr_serve_inet_readwrite(self):
 
218
        # Make a branch
 
219
        self.make_branch('.')
 
220
 
 
221
        process, transport = self.start_server_inet(['--allow-writes'])
 
222
 
 
223
        # We get a working branch, and can create a directory
 
224
        branch = ControlDir.open_from_transport(transport).open_branch()
 
225
        self.make_read_requests(branch)
 
226
        transport.mkdir('adir')
 
227
        self.assertInetServerShutsdownCleanly(process)
 
228
 
 
229
    def test_bzr_serve_port_readonly(self):
 
230
        """brz server should provide a read only filesystem by default."""
 
231
        process, url = self.start_server_port()
 
232
        t = transport.get_transport_from_url(url)
 
233
        self.assertRaises(errors.TransportNotPossible, t.mkdir, 'adir')
 
234
        self.assertServerFinishesCleanly(process)
 
235
 
 
236
    def test_bzr_serve_port_readwrite(self):
 
237
        # Make a branch
 
238
        self.make_branch('.')
 
239
 
 
240
        process, url = self.start_server_port(['--allow-writes'])
 
241
 
 
242
        # Connect to the server
 
243
        branch = Branch.open(url)
 
244
        self.make_read_requests(branch)
 
245
        self.assertServerFinishesCleanly(process)
 
246
 
 
247
    def test_bzr_serve_supports_protocol(self):
 
248
        # Make a branch
 
249
        self.make_branch('.')
 
250
 
 
251
        process, url = self.start_server_port(['--allow-writes',
 
252
                                               '--protocol=bzr'])
 
253
 
 
254
        # Connect to the server
 
255
        branch = Branch.open(url)
 
256
        self.make_read_requests(branch)
 
257
        self.assertServerFinishesCleanly(process)
 
258
 
 
259
    def test_bzr_serve_dhpss(self):
 
260
        # This is a smoke test that the server doesn't crash when run with
 
261
        # -Dhpss, and does drop some hpss logging to the file.
 
262
        self.make_branch('.')
 
263
        log_fname = self.test_dir + '/server.log'
 
264
        self.overrideEnv('BRZ_LOG', log_fname)
 
265
        process, transport = self.start_server_inet(['-Dhpss'])
 
266
        branch = ControlDir.open_from_transport(transport).open_branch()
 
267
        self.make_read_requests(branch)
 
268
        self.assertInetServerShutsdownCleanly(process)
 
269
        f = open(log_fname, 'rb')
 
270
        content = f.read()
 
271
        f.close()
 
272
        self.assertContainsRe(content, br'hpss request: \[[0-9-]+\]')
 
273
 
 
274
    def test_bzr_serve_supports_configurable_timeout(self):
 
275
        gs = config.GlobalStack()
 
276
        gs.set('serve.client_timeout', 0.2)
 
277
        # Save the config as the subprocess will use it
 
278
        gs.store.save()
 
279
        process, url = self.start_server_port()
 
280
        self.build_tree_contents([('a_file', b'contents\n')])
 
281
        # We can connect and issue a request
 
282
        t = transport.get_transport_from_url(url)
 
283
        self.assertEqual(b'contents\n', t.get_bytes('a_file'))
 
284
        # However, if we just wait for more content from the server, it will
 
285
        # eventually disconnect us.
 
286
        m = t.get_smart_medium()
 
287
        m.read_bytes(1)
 
288
        # Now, we wait for timeout to trigger
 
289
        err = process.stderr.readline()
 
290
        self.assertEqual(
 
291
            b'Connection Timeout: disconnecting client after 0.2 seconds\n',
 
292
            err)
 
293
        self.assertServerFinishesCleanly(process)
 
294
 
 
295
    def test_bzr_serve_supports_client_timeout(self):
 
296
        process, url = self.start_server_port(['--client-timeout=0.1'])
 
297
        self.build_tree_contents([('a_file', b'contents\n')])
 
298
        # We can connect and issue a request
 
299
        t = transport.get_transport_from_url(url)
 
300
        self.assertEqual(b'contents\n', t.get_bytes('a_file'))
 
301
        # However, if we just wait for more content from the server, it will
 
302
        # eventually disconnect us.
 
303
        # TODO: Use something like signal.alarm() so that if the server doesn't
 
304
        #       properly handle the timeout, we end up failing the test instead
 
305
        #       of hanging forever.
 
306
        m = t.get_smart_medium()
 
307
        m.read_bytes(1)
 
308
        # Now, we wait for timeout to trigger
 
309
        err = process.stderr.readline()
 
310
        self.assertEqual(
 
311
            b'Connection Timeout: disconnecting client after 0.1 seconds\n',
 
312
            err)
 
313
        self.assertServerFinishesCleanly(process)
 
314
 
 
315
    def test_bzr_serve_graceful_shutdown(self):
 
316
        big_contents = b'a' * 64 * 1024
 
317
        self.build_tree_contents([('bigfile', big_contents)])
 
318
        process, url = self.start_server_port(['--client-timeout=1.0'])
 
319
        t = transport.get_transport_from_url(url)
 
320
        m = t.get_smart_medium()
 
321
        c = client._SmartClient(m)
 
322
        # Start, but don't finish a response
 
323
        resp, response_handler = c.call_expecting_body(b'get', b'bigfile')
 
324
        self.assertEqual((b'ok',), resp)
 
325
        # Note: process.send_signal is a Python 2.6ism
 
326
        process.send_signal(signal.SIGHUP)
 
327
        # Wait for the server to notice the signal, and then read the actual
 
328
        # body of the response. That way we know that it is waiting for the
 
329
        # request to finish
 
330
        self.assertEqual(b'Requested to stop gracefully\n',
 
331
                         process.stderr.readline())
 
332
        self.assertIn(process.stderr.readline(),
 
333
                      (b'', b'Waiting for 1 client(s) to finish\n'))
 
334
        body = response_handler.read_body_bytes()
 
335
        if body != big_contents:
 
336
            self.fail('Failed to properly read the contents of "bigfile"')
 
337
        # Now that our request is finished, the medium should notice it has
 
338
        # been disconnected.
 
339
        self.assertEqual(b'', m.read_bytes(1))
 
340
        # And the server should be stopping
 
341
        self.assertEqual(0, process.wait())
 
342
 
 
343
 
 
344
class TestCmdServeChrooting(TestBzrServeBase):
 
345
 
 
346
    def test_serve_tcp(self):
 
347
        """'brz serve' wraps the given --directory in a ChrootServer.
 
348
 
 
349
        So requests that search up through the parent directories (like
 
350
        find_repositoryV3) will give "not found" responses, rather than
 
351
        InvalidURLJoin or jail break errors.
 
352
        """
 
353
        t = self.get_transport()
 
354
        t.mkdir('server-root')
 
355
        self.run_bzr_serve_then_func(
 
356
            ['--listen', '127.0.0.1', '--port', '0',
 
357
             '--directory', t.local_abspath('server-root'),
 
358
             '--allow-writes'],
 
359
            func=self.when_server_started)
 
360
        # The when_server_started method issued a find_repositoryV3 that should
 
361
        # fail with 'norepository' because there are no repositories inside the
 
362
        # --directory.
 
363
        self.assertEqual((b'norepository',), self.client_resp)
 
364
 
 
365
    def when_server_started(self):
 
366
        # Connect to the TCP server and issue some requests and see what comes
 
367
        # back.
 
368
        client_medium = medium.SmartTCPClientMedium(
 
369
            '127.0.0.1', self.tcp_server.port,
 
370
            'bzr://localhost:%d/' % (self.tcp_server.port,))
 
371
        smart_client = client._SmartClient(client_medium)
 
372
        resp = smart_client.call('mkdir', 'foo', '')
 
373
        resp = smart_client.call('BzrDirFormat.initialize', 'foo/')
 
374
        try:
 
375
            resp = smart_client.call('BzrDir.find_repositoryV3', 'foo/')
 
376
        except errors.ErrorFromSmartServer as e:
 
377
            resp = e.error_tuple
 
378
        self.client_resp = resp
 
379
        client_medium.disconnect()
 
380
 
 
381
 
 
382
class TestUserdirExpansion(TestCaseWithMemoryTransport):
 
383
 
 
384
    @staticmethod
 
385
    def fake_expanduser(path):
 
386
        """A simple, environment-independent, function for the duration of this
 
387
        test.
 
388
 
 
389
        Paths starting with a path segment of '~user' will expand to start with
 
390
        '/home/user/'.  Every other path will be unchanged.
 
391
        """
 
392
        if path.split('/', 1)[0] == '~user':
 
393
            return '/home/user' + path[len('~user'):]
 
394
        return path
 
395
 
 
396
    def make_test_server(self, base_path='/'):
 
397
        """Make and start a BzrServerFactory, backed by a memory transport, and
 
398
        creat '/home/user' in that transport.
 
399
        """
 
400
        bzr_server = BzrServerFactory(
 
401
            self.fake_expanduser, lambda t: base_path)
 
402
        mem_transport = self.get_transport()
 
403
        mem_transport.mkdir('home')
 
404
        mem_transport.mkdir('home/user')
 
405
        bzr_server.set_up(mem_transport, None, None, inet=True, timeout=4.0)
 
406
        self.addCleanup(bzr_server.tear_down)
 
407
        return bzr_server
 
408
 
 
409
    def test_bzr_serve_expands_userdir(self):
 
410
        bzr_server = self.make_test_server()
 
411
        self.assertTrue(bzr_server.smart_server.backing_transport.has('~user'))
 
412
 
 
413
    def test_bzr_serve_does_not_expand_userdir_outside_base(self):
 
414
        bzr_server = self.make_test_server('/foo')
 
415
        self.assertFalse(
 
416
            bzr_server.smart_server.backing_transport.has('~user'))
 
417
 
 
418
    def test_get_base_path(self):
 
419
        """cmd_serve will turn the --directory option into a LocalTransport
 
420
        (optionally decorated with 'readonly+').  BzrServerFactory can
 
421
        determine the original --directory from that transport.
 
422
        """
 
423
        # URLs always include the trailing slash, and get_base_path returns it
 
424
        base_dir = osutils.abspath('/a/b/c') + '/'
 
425
        base_url = urlutils.local_path_to_url(base_dir) + '/'
 
426
        # Define a fake 'protocol' to capture the transport that cmd_serve
 
427
        # passes to serve_bzr.
 
428
 
 
429
        def capture_transport(transport, host, port, inet, timeout):
 
430
            self.bzr_serve_transport = transport
 
431
        cmd = builtins.cmd_serve()
 
432
        # Read-only
 
433
        cmd.run(directory=base_dir, protocol=capture_transport)
 
434
        server_maker = BzrServerFactory()
 
435
        self.assertEqual(
 
436
            'readonly+%s' % base_url, self.bzr_serve_transport.base)
 
437
        self.assertEqual(
 
438
            base_dir, server_maker.get_base_path(self.bzr_serve_transport))
 
439
        # Read-write
 
440
        cmd.run(directory=base_dir, protocol=capture_transport,
 
441
                allow_writes=True)
 
442
        server_maker = BzrServerFactory()
 
443
        self.assertEqual(base_url, self.bzr_serve_transport.base)
 
444
        self.assertEqual(base_dir,
 
445
                         server_maker.get_base_path(self.bzr_serve_transport))
 
446
        # Read-only, from a URL
 
447
        cmd.run(directory=base_url, protocol=capture_transport)
 
448
        server_maker = BzrServerFactory()
 
449
        self.assertEqual(
 
450
            'readonly+%s' % base_url, self.bzr_serve_transport.base)
 
451
        self.assertEqual(
 
452
            base_dir, server_maker.get_base_path(self.bzr_serve_transport))