/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/http_server.py

  • Committer: Jelmer Vernooij
  • Date: 2017-06-10 21:59:15 UTC
  • mto: This revision was merged to the branch mainline in revision 6690.
  • Revision ID: jelmer@jelmer.uk-20170610215915-zcpu0in3r1irx3ml
Move serializer to bzr.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/tests/http_server.py
1
 
# Copyright (C) 2006-2010 Canonical Ltd
 
1
# Copyright (C) 2006-2011 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
20
20
import posixpath
21
21
import random
22
22
import re
23
 
import select
24
23
import SimpleHTTPServer
25
24
import socket
26
 
import SocketServer
27
 
import sys
28
 
import threading
29
 
import time
30
 
import urllib
31
25
import urlparse
32
26
 
33
 
from bzrlib import transport
34
 
from bzrlib.tests import test_server
35
 
from bzrlib.transport import local
 
27
from .. import (
 
28
    osutils,
 
29
    urlutils,
 
30
)
 
31
from . import test_server
36
32
 
37
33
 
38
34
class BadWebserverPath(ValueError):
78
74
        connection early to avoid polluting the test results.
79
75
        """
80
76
        try:
81
 
            SimpleHTTPServer.SimpleHTTPRequestHandler.handle_one_request(self)
82
 
        except socket.error, e:
 
77
            self._handle_one_request()
 
78
        except socket.error as e:
83
79
            # Any socket error should close the connection, but some errors are
84
80
            # due to the client closing early and we don't want to pollute test
85
81
            # results, so we raise only the others.
89
85
                                     errno.ECONNABORTED, errno.EBADF)):
90
86
                raise
91
87
 
92
 
    _range_regexp = re.compile(r'^(?P<start>\d+)-(?P<end>\d+)$')
 
88
    error_content_type = 'text/plain'
 
89
    error_message_format = '''\
 
90
Error code: %(code)s.
 
91
Message: %(message)s.
 
92
'''
 
93
 
 
94
    def send_error(self, code, message=None):
 
95
        """Send and log an error reply.
 
96
 
 
97
        We redefine the python-provided version to be able to set a 
 
98
        ``Content-Length`` header as some http/1.1 clients complain otherwise
 
99
        (see bug #568421).
 
100
 
 
101
        :param code: The HTTP error code.
 
102
 
 
103
        :param message: The explanation of the error code, Defaults to a short
 
104
             entry.
 
105
        """
 
106
 
 
107
        if message is None:
 
108
            try:
 
109
                message = self.responses[code][0]
 
110
            except KeyError:
 
111
                message = '???'
 
112
        self.log_error("code %d, message %s", code, message)
 
113
        content = (self.error_message_format %
 
114
                   {'code': code, 'message': message})
 
115
        self.send_response(code, message)
 
116
        self.send_header("Content-Type", self.error_content_type)
 
117
        self.send_header("Content-Length", "%d" % len(content))
 
118
        self.send_header('Connection', 'close')
 
119
        self.end_headers()
 
120
        if self.command != 'HEAD' and code >= 200 and code not in (204, 304):
 
121
            self.wfile.write(content)
 
122
 
 
123
    def _handle_one_request(self):
 
124
        SimpleHTTPServer.SimpleHTTPRequestHandler.handle_one_request(self)
 
125
 
 
126
    _range_regexp = re.compile(r'^(?P<start>\d+)-(?P<end>\d+)?$')
93
127
    _tail_regexp = re.compile(r'^-(?P<tail>\d+)$')
94
128
 
95
 
    def parse_ranges(self, ranges_header):
96
 
        """Parse the range header value and returns ranges and tail.
97
 
 
98
 
        RFC2616 14.35 says that syntactically invalid range
99
 
        specifiers MUST be ignored. In that case, we return 0 for
100
 
        tail and [] for ranges.
 
129
    def _parse_ranges(self, ranges_header, file_size):
 
130
        """Parse the range header value and returns ranges.
 
131
 
 
132
        RFC2616 14.35 says that syntactically invalid range specifiers MUST be
 
133
        ignored. In that case, we return None instead of a range list.
 
134
 
 
135
        :param ranges_header: The 'Range' header value.
 
136
 
 
137
        :param file_size: The size of the requested file.
 
138
 
 
139
        :return: A list of (start, end) tuples or None if some invalid range
 
140
            specifier is encountered.
101
141
        """
102
 
        tail = 0
103
 
        ranges = []
104
142
        if not ranges_header.startswith('bytes='):
105
143
            # Syntactically invalid header
106
 
            return 0, []
 
144
            return None
107
145
 
 
146
        tail = None
 
147
        ranges = []
108
148
        ranges_header = ranges_header[len('bytes='):]
109
149
        for range_str in ranges_header.split(','):
110
 
            # FIXME: RFC2616 says end is optional and default to file_size
111
150
            range_match = self._range_regexp.match(range_str)
112
151
            if range_match is not None:
113
152
                start = int(range_match.group('start'))
114
 
                end = int(range_match.group('end'))
 
153
                end_match = range_match.group('end')
 
154
                if end_match is None:
 
155
                    # RFC2616 says end is optional and default to file_size
 
156
                    end = file_size
 
157
                else:
 
158
                    end = int(end_match)
115
159
                if start > end:
116
160
                    # Syntactically invalid range
117
 
                    return 0, []
 
161
                    return None
118
162
                ranges.append((start, end))
119
163
            else:
120
164
                tail_match = self._tail_regexp.match(range_str)
122
166
                    tail = int(tail_match.group('tail'))
123
167
                else:
124
168
                    # Syntactically invalid range
125
 
                    return 0, []
126
 
        return tail, ranges
 
169
                    return None
 
170
        if tail is not None:
 
171
            # Normalize tail into ranges
 
172
            ranges.append((max(0, file_size - tail), file_size))
 
173
 
 
174
        checked_ranges = []
 
175
        for start, end in ranges:
 
176
            if start >= file_size:
 
177
                # RFC2616 14.35, ranges are invalid if start >= file_size
 
178
                return None
 
179
            # RFC2616 14.35, end values should be truncated
 
180
            # to file_size -1 if they exceed it
 
181
            end = min(end, file_size - 1)
 
182
            checked_ranges.append((start, end))
 
183
        return checked_ranges
127
184
 
128
185
    def _header_line_length(self, keyword, value):
129
186
        header_line = '%s: %s\r\n' % (keyword, value)
213
270
            # mode may cause newline translations, making the
214
271
            # actual size of the content transmitted *less* than
215
272
            # the content-length!
216
 
            file = open(path, 'rb')
 
273
            f = open(path, 'rb')
217
274
        except IOError:
218
275
            self.send_error(404, "File not found")
219
276
            return
220
277
 
221
 
        file_size = os.fstat(file.fileno())[6]
222
 
        tail, ranges = self.parse_ranges(ranges_header_value)
223
 
        # Normalize tail into ranges
224
 
        if tail != 0:
225
 
            ranges.append((file_size - tail, file_size))
226
 
 
227
 
        self._satisfiable_ranges = True
228
 
        if len(ranges) == 0:
229
 
            self._satisfiable_ranges = False
230
 
        else:
231
 
            def check_range(range_specifier):
232
 
                start, end = range_specifier
233
 
                # RFC2616 14.35, ranges are invalid if start >= file_size
234
 
                if start >= file_size:
235
 
                    self._satisfiable_ranges = False # Side-effect !
236
 
                    return 0, 0
237
 
                # RFC2616 14.35, end values should be truncated
238
 
                # to file_size -1 if they exceed it
239
 
                end = min(end, file_size - 1)
240
 
                return start, end
241
 
 
242
 
            ranges = map(check_range, ranges)
243
 
 
244
 
        if not self._satisfiable_ranges:
 
278
        file_size = os.fstat(f.fileno())[6]
 
279
        ranges = self._parse_ranges(ranges_header_value, file_size)
 
280
        if not ranges:
245
281
            # RFC2616 14.16 and 14.35 says that when a server
246
282
            # encounters unsatisfiable range specifiers, it
247
283
            # SHOULD return a 416.
248
 
            file.close()
 
284
            f.close()
249
285
            # FIXME: We SHOULD send a Content-Range header too,
250
286
            # but the implementation of send_error does not
251
287
            # allows that. So far.
254
290
 
255
291
        if len(ranges) == 1:
256
292
            (start, end) = ranges[0]
257
 
            self.get_single_range(file, file_size, start, end)
 
293
            self.get_single_range(f, file_size, start, end)
258
294
        else:
259
 
            self.get_multiple_ranges(file, file_size, ranges)
260
 
        file.close()
 
295
            self.get_multiple_ranges(f, file_size, ranges)
 
296
        f.close()
261
297
 
262
298
    def translate_path(self, path):
263
299
        """Translate a /-separated PATH to the local filename syntax.
295
331
        """
296
332
        # abandon query parameters
297
333
        path = urlparse.urlparse(path)[2]
298
 
        path = posixpath.normpath(urllib.unquote(path))
 
334
        path = posixpath.normpath(urlutils.unquote(path))
299
335
        path = path.decode('utf-8')
300
336
        words = path.split('/')
301
 
        words = filter(None, words)
302
337
        path = self._cwd
303
 
        for num, word in enumerate(words):
 
338
        for num, word in enumerate(w for w in words if w):
304
339
            if num == 0:
305
340
                drive, word = os.path.splitdrive(word)
306
341
            head, word = os.path.split(word)
319
354
        self.test_case_server = test_case_server
320
355
        self._home_dir = test_case_server._home_dir
321
356
 
322
 
    def stop_server(self):
323
 
         """Called to clean-up the server.
324
 
 
325
 
         Since the server may be (surely is, even) in a blocking listen, we
326
 
         shutdown its socket before closing it.
327
 
         """
328
 
         # Note that is this executed as part of the implicit tear down in the
329
 
         # main thread while the server runs in its own thread. The clean way
330
 
         # to tear down the server is to instruct him to stop accepting
331
 
         # connections and wait for the current connection(s) to end
332
 
         # naturally. To end the connection naturally, the http transports
333
 
         # should close their socket when they do not need to talk to the
334
 
         # server anymore. This happens naturally during the garbage collection
335
 
         # phase of the test transport objetcs (the server clients), so we
336
 
         # don't have to worry about them.  So, for the server, we must tear
337
 
         # down here, from the main thread, when the test have ended.  Note
338
 
         # that since the server is in a blocking operation and since python
339
 
         # use select internally, shutting down the socket is reliable and
340
 
         # relatively clean.
341
 
         try:
342
 
             self.socket.shutdown(socket.SHUT_RDWR)
343
 
         except socket.error, e:
344
 
             # WSAENOTCONN (10057) 'Socket is not connected' is harmless on
345
 
             # windows (occurs before the first connection attempt
346
 
             # vila--20071230)
347
 
 
348
 
             # 'Socket is not connected' can also occur on OSX, with a
349
 
             # "regular" ENOTCONN (when something went wrong during test case
350
 
             # setup leading to self.setUp() *not* being called but
351
 
             # self.stop_server() still being called -- vila20081106
352
 
             if not len(e.args) or e.args[0] not in (errno.ENOTCONN, 10057):
353
 
                 raise
354
 
         # Let the server properly close the socket
355
 
         self.server_close()
356
 
 
357
 
 
358
 
class TestingHTTPServer(SocketServer.TCPServer, TestingHTTPServerMixin):
 
357
 
 
358
class TestingHTTPServer(test_server.TestingTCPServer, TestingHTTPServerMixin):
359
359
 
360
360
    def __init__(self, server_address, request_handler_class,
361
361
                 test_case_server):
 
362
        test_server.TestingTCPServer.__init__(self, server_address,
 
363
                                              request_handler_class)
362
364
        TestingHTTPServerMixin.__init__(self, test_case_server)
363
 
        SocketServer.TCPServer.__init__(self, server_address,
364
 
                                        request_handler_class)
365
 
 
366
 
 
367
 
class TestingThreadingHTTPServer(SocketServer.ThreadingTCPServer,
 
365
 
 
366
 
 
367
class TestingThreadingHTTPServer(test_server.TestingThreadingTCPServer,
368
368
                                 TestingHTTPServerMixin):
369
369
    """A threading HTTP test server for HTTP 1.1.
370
370
 
372
372
    server, we need an independent connection for each of them. We achieve that
373
373
    by spawning a new thread for each connection.
374
374
    """
375
 
 
376
375
    def __init__(self, server_address, request_handler_class,
377
376
                 test_case_server):
 
377
        test_server.TestingThreadingTCPServer.__init__(self, server_address,
 
378
                                                       request_handler_class)
378
379
        TestingHTTPServerMixin.__init__(self, test_case_server)
379
 
        SocketServer.ThreadingTCPServer.__init__(self, server_address,
380
 
                                                 request_handler_class)
381
 
        # Decides how threads will act upon termination of the main
382
 
        # process. This is prophylactic as we should not leave the threads
383
 
        # lying around.
384
 
        self.daemon_threads = True
385
 
 
386
 
    def process_request_thread(self, request, client_address):
387
 
        SocketServer.ThreadingTCPServer.process_request_thread(
388
 
            self, request, client_address)
389
 
        # Under some circumstances (as in bug #383920), we need to force the
390
 
        # shutdown as python delays it until gc occur otherwise and the client
391
 
        # may hang.
392
 
        try:
393
 
            # The request process has been completed, the thread is about to
394
 
            # die, let's shutdown the socket if we can.
395
 
            request.shutdown(socket.SHUT_RDWR)
396
 
        except (socket.error, select.error), e:
397
 
            if e[0] in (errno.EBADF, errno.ENOTCONN):
398
 
                # Right, the socket is already down
399
 
                pass
400
 
            else:
401
 
                raise
402
 
 
403
 
 
404
 
class HttpServer(transport.Server):
 
380
 
 
381
 
 
382
class HttpServer(test_server.TestingTCPServerInAThread):
405
383
    """A test server for http transports.
406
384
 
407
385
    Subclasses can provide a specific request handler.
429
407
        :param protocol_version: if specified, will override the protocol
430
408
            version of the request handler.
431
409
        """
432
 
        transport.Server.__init__(self)
433
 
        self.request_handler = request_handler
 
410
        # Depending on the protocol version, we will create the approriate
 
411
        # server
 
412
        if protocol_version is None:
 
413
            # Use the request handler one
 
414
            proto_vers = request_handler.protocol_version
 
415
        else:
 
416
            # Use our own, it will be used to override the request handler
 
417
            # one too.
 
418
            proto_vers = protocol_version
 
419
        # Get the appropriate server class for the required protocol
 
420
        serv_cls = self.http_server_class.get(proto_vers, None)
 
421
        if serv_cls is None:
 
422
            raise httplib.UnknownProtocol(proto_vers)
434
423
        self.host = 'localhost'
435
424
        self.port = 0
436
 
        self._httpd = None
437
 
        self.protocol_version = protocol_version
 
425
        super(HttpServer, self).__init__((self.host, self.port),
 
426
                                         serv_cls,
 
427
                                         request_handler)
 
428
        self.protocol_version = proto_vers
438
429
        # Allows tests to verify number of GET requests issued
439
430
        self.GET_request_nb = 0
440
 
 
441
 
    def create_httpd(self, serv_cls, rhandler_cls):
442
 
        return serv_cls((self.host, self.port), self.request_handler, self)
443
 
 
444
 
    def __repr__(self):
445
 
        return "%s(%s:%s)" % \
446
 
            (self.__class__.__name__, self.host, self.port)
447
 
 
448
 
    def _get_httpd(self):
449
 
        if self._httpd is None:
450
 
            rhandler = self.request_handler
451
 
            # Depending on the protocol version, we will create the approriate
452
 
            # server
453
 
            if self.protocol_version is None:
454
 
                # Use the request handler one
455
 
                proto_vers = rhandler.protocol_version
456
 
            else:
457
 
                # Use our own, it will be used to override the request handler
458
 
                # one too.
459
 
                proto_vers = self.protocol_version
460
 
            # Create the appropriate server for the required protocol
461
 
            serv_cls = self.http_server_class.get(proto_vers, None)
462
 
            if serv_cls is None:
463
 
                raise httplib.UnknownProtocol(proto_vers)
464
 
            else:
465
 
                self._httpd = self.create_httpd(serv_cls, rhandler)
466
 
            self.host, self.port = self._httpd.socket.getsockname()
467
 
        return self._httpd
468
 
 
469
 
    def _http_start(self):
470
 
        """Server thread main entry point. """
471
 
        self._http_running = False
472
 
        try:
473
 
            try:
474
 
                httpd = self._get_httpd()
475
 
                self._http_base_url = '%s://%s:%s/' % (self._url_protocol,
476
 
                                                       self.host, self.port)
477
 
                self._http_running = True
478
 
            except:
479
 
                # Whatever goes wrong, we save the exception for the main
480
 
                # thread. Note that since we are running in a thread, no signal
481
 
                # can be received, so we don't care about KeyboardInterrupt.
482
 
                self._http_exception = sys.exc_info()
483
 
        finally:
484
 
            # Release the lock or the main thread will block and the whole
485
 
            # process will hang.
486
 
            self._http_starting.release()
487
 
 
488
 
        # From now on, exceptions are taken care of by the
489
 
        # SocketServer.BaseServer or the request handler.
490
 
        while self._http_running:
491
 
            try:
492
 
                # Really an HTTP connection but the python framework is generic
493
 
                # and call them requests
494
 
                httpd.handle_request()
495
 
            except socket.timeout:
496
 
                pass
497
 
            except (socket.error, select.error), e:
498
 
                if (e[0] == errno.EBADF
499
 
                    or (sys.platform == 'win32' and e[0] == 10038)):
500
 
                    # Starting with python-2.6, handle_request may raise socket
501
 
                    # or select exceptions when the server is shut down (as we
502
 
                    # do).
503
 
                    # 10038 = WSAENOTSOCK
504
 
                    # http://msdn.microsoft.com/en-us/library/ms740668%28VS.85%29.aspx
505
 
                    pass
506
 
                else:
507
 
                    raise
 
431
        self._http_base_url = None
 
432
        self.logs = []
 
433
 
 
434
    def create_server(self):
 
435
        return self.server_class(
 
436
            (self.host, self.port), self.request_handler_class, self)
508
437
 
509
438
    def _get_remote_url(self, path):
510
439
        path_parts = path.split(os.path.sep)
523
452
        self.logs.append(format % args)
524
453
 
525
454
    def start_server(self, backing_transport_server=None):
526
 
        """See bzrlib.transport.Server.start_server.
 
455
        """See breezy.transport.Server.start_server.
527
456
 
528
457
        :param backing_transport_server: The transport that requests over this
529
458
            protocol should be forwarded to. Note that this is currently not
535
464
                or isinstance(backing_transport_server,
536
465
                              test_server.LocalURLServer)):
537
466
            raise AssertionError(
538
 
                "HTTPServer currently assumes local transport, got %s" % \
 
467
                "HTTPServer currently assumes local transport, got %s" %
539
468
                backing_transport_server)
540
 
        self._home_dir = os.getcwdu()
 
469
        self._home_dir = osutils.getcwd()
541
470
        self._local_path_parts = self._home_dir.split(os.path.sep)
542
 
        self._http_base_url = None
543
 
 
544
 
        # Create the server thread
545
 
        self._http_starting = threading.Lock()
546
 
        self._http_starting.acquire()
547
 
        self._http_thread = threading.Thread(target=self._http_start)
548
 
        self._http_thread.setDaemon(True)
549
 
        self._http_exception = None
550
 
        self._http_thread.start()
551
 
 
552
 
        # Wait for the server thread to start (i.e release the lock)
553
 
        self._http_starting.acquire()
554
 
 
555
 
        if self._http_exception is not None:
556
 
            # Something went wrong during server start
557
 
            exc_class, exc_value, exc_tb = self._http_exception
558
 
            raise exc_class, exc_value, exc_tb
559
 
        self._http_starting.release()
560
471
        self.logs = []
561
472
 
562
 
    def stop_server(self):
563
 
        self._httpd.stop_server()
564
 
        self._http_running = False
565
 
        # We don't need to 'self._http_thread.join()' here since the thread is
566
 
        # a daemonic one and will be garbage collected anyway. Joining just
567
 
        # slows us down for no added benefit.
 
473
        super(HttpServer, self).start_server()
 
474
        self._http_base_url = '%s://%s:%s/' % (
 
475
            self._url_protocol, self.host, self.port)
568
476
 
569
477
    def get_url(self):
570
 
        """See bzrlib.transport.Server.get_url."""
 
478
        """See breezy.transport.Server.get_url."""
571
479
        return self._get_remote_url(self._home_dir)
572
480
 
573
481
    def get_bogus_url(self):
574
 
        """See bzrlib.transport.Server.get_bogus_url."""
 
482
        """See breezy.transport.Server.get_bogus_url."""
575
483
        # this is chosen to try to prevent trouble with proxies, weird dns,
576
484
        # etc
577
485
        return self._url_protocol + '://127.0.0.1:1/'
586
494
 
587
495
    # urls returned by this server should require the urllib client impl
588
496
    _url_protocol = 'http+urllib'
589
 
 
590
 
 
591
 
class HttpServer_PyCurl(HttpServer):
592
 
    """Subclass of HttpServer that gives http+pycurl urls.
593
 
 
594
 
    This is for use in testing: connections to this server will always go
595
 
    through pycurl where possible.
596
 
    """
597
 
 
598
 
    # We don't care about checking the pycurl availability as
599
 
    # this server will be required only when pycurl is present
600
 
 
601
 
    # urls returned by this server should require the pycurl client impl
602
 
    _url_protocol = 'http+pycurl'