← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/http_server.py

  • Committer: Vincent Ladeuil
  • Date: 2010-03-10 09:33:04 UTC
  • mto: (5082.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 5083.
  • Revision ID: v.ladeuil+lp@free.fr-20100310093304-4245t4tazd4sxoav
Cleanup test from overly cautious checks.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/http_server.py
1
 
# Copyright (C) 2006-2011 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
20
20
import posixpath
21
21
import random
22
22
import re
 
23
import select
23
24
import SimpleHTTPServer
24
25
import socket
 
26
import SocketServer
 
27
import sys
 
28
import threading
 
29
import time
 
30
import urllib
25
31
import urlparse
26
32
 
27
 
from bzrlib import urlutils
 
33
from bzrlib import transport
28
34
from bzrlib.tests import test_server
 
35
from bzrlib.transport import local
29
36
 
30
37
 
31
38
class BadWebserverPath(ValueError):
64
71
                self.headers.get('referer', '-'),
65
72
                self.headers.get('user-agent', '-'))
66
73
 
67
 
    def handle(self):
68
 
        SimpleHTTPServer.SimpleHTTPRequestHandler.handle(self)
69
 
        # Some client (pycurl, I'm looking at you) are more picky than others
70
 
        # and require that the socket itself is closed
71
 
        # (SocketServer.StreamRequestHandler only close the two associated
72
 
        # 'makefile' objects)
73
 
        self.connection.close()
74
 
 
75
74
    def handle_one_request(self):
76
75
        """Handle a single HTTP request.
77
76
 
79
78
        connection early to avoid polluting the test results.
80
79
        """
81
80
        try:
82
 
            self._handle_one_request()
 
81
            SimpleHTTPServer.SimpleHTTPRequestHandler.handle_one_request(self)
83
82
        except socket.error, e:
84
83
            # Any socket error should close the connection, but some errors are
85
84
            # due to the client closing early and we don't want to pollute test
90
89
                                     errno.ECONNABORTED, errno.EBADF)):
91
90
                raise
92
91
 
93
 
    error_content_type = 'text/plain'
94
 
    error_message_format = '''\
95
 
Error code: %(code)s.
96
 
Message: %(message)s.
97
 
'''
98
 
 
99
 
    def send_error(self, code, message=None):
100
 
        """Send and log an error reply.
101
 
 
102
 
        We redefine the python-provided version to be able to set a 
103
 
        ``Content-Length`` header as some http/1.1 clients complain otherwise
104
 
        (see bug #568421).
105
 
 
106
 
        :param code: The HTTP error code.
107
 
 
108
 
        :param message: The explanation of the error code, Defaults to a short
109
 
             entry.
110
 
        """
111
 
 
112
 
        if message is None:
113
 
            try:
114
 
                message = self.responses[code][0]
115
 
            except KeyError:
116
 
                message = '???'
117
 
        self.log_error("code %d, message %s", code, message)
118
 
        content = (self.error_message_format %
119
 
                   {'code': code, 'message': message})
120
 
        self.send_response(code, message)
121
 
        self.send_header("Content-Type", self.error_content_type)
122
 
        self.send_header("Content-Length", "%d" % len(content))
123
 
        self.send_header('Connection', 'close')
124
 
        self.end_headers()
125
 
        if self.command != 'HEAD' and code >= 200 and code not in (204, 304):
126
 
            self.wfile.write(content)
127
 
 
128
 
    def _handle_one_request(self):
129
 
        SimpleHTTPServer.SimpleHTTPRequestHandler.handle_one_request(self)
130
 
 
131
 
    _range_regexp = re.compile(r'^(?P<start>\d+)-(?P<end>\d+)?$')
 
92
    _range_regexp = re.compile(r'^(?P<start>\d+)-(?P<end>\d+)$')
132
93
    _tail_regexp = re.compile(r'^-(?P<tail>\d+)$')
133
94
 
134
 
    def _parse_ranges(self, ranges_header, file_size):
135
 
        """Parse the range header value and returns ranges.
136
 
 
137
 
        RFC2616 14.35 says that syntactically invalid range specifiers MUST be
138
 
        ignored. In that case, we return None instead of a range list.
139
 
 
140
 
        :param ranges_header: The 'Range' header value.
141
 
 
142
 
        :param file_size: The size of the requested file.
143
 
 
144
 
        :return: A list of (start, end) tuples or None if some invalid range
145
 
            specifier is encountered.
 
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.
146
101
        """
 
102
        tail = 0
 
103
        ranges = []
147
104
        if not ranges_header.startswith('bytes='):
148
105
            # Syntactically invalid header
149
 
            return None
 
106
            return 0, []
150
107
 
151
 
        tail = None
152
 
        ranges = []
153
108
        ranges_header = ranges_header[len('bytes='):]
154
109
        for range_str in ranges_header.split(','):
 
110
            # FIXME: RFC2616 says end is optional and default to file_size
155
111
            range_match = self._range_regexp.match(range_str)
156
112
            if range_match is not None:
157
113
                start = int(range_match.group('start'))
158
 
                end_match = range_match.group('end')
159
 
                if end_match is None:
160
 
                    # RFC2616 says end is optional and default to file_size
161
 
                    end = file_size
162
 
                else:
163
 
                    end = int(end_match)
 
114
                end = int(range_match.group('end'))
164
115
                if start > end:
165
116
                    # Syntactically invalid range
166
 
                    return None
 
117
                    return 0, []
167
118
                ranges.append((start, end))
168
119
            else:
169
120
                tail_match = self._tail_regexp.match(range_str)
171
122
                    tail = int(tail_match.group('tail'))
172
123
                else:
173
124
                    # Syntactically invalid range
174
 
                    return None
175
 
        if tail is not None:
176
 
            # Normalize tail into ranges
177
 
            ranges.append((max(0, file_size - tail), file_size))
178
 
 
179
 
        checked_ranges = []
180
 
        for start, end in ranges:
181
 
            if start >= file_size:
182
 
                # RFC2616 14.35, ranges are invalid if start >= file_size
183
 
                return None
184
 
            # RFC2616 14.35, end values should be truncated
185
 
            # to file_size -1 if they exceed it
186
 
            end = min(end, file_size - 1)
187
 
            checked_ranges.append((start, end))
188
 
        return checked_ranges
 
125
                    return 0, []
 
126
        return tail, ranges
189
127
 
190
128
    def _header_line_length(self, keyword, value):
191
129
        header_line = '%s: %s\r\n' % (keyword, value)
275
213
            # mode may cause newline translations, making the
276
214
            # actual size of the content transmitted *less* than
277
215
            # the content-length!
278
 
            f = open(path, 'rb')
 
216
            file = open(path, 'rb')
279
217
        except IOError:
280
218
            self.send_error(404, "File not found")
281
219
            return
282
220
 
283
 
        file_size = os.fstat(f.fileno())[6]
284
 
        ranges = self._parse_ranges(ranges_header_value, file_size)
285
 
        if not ranges:
 
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:
286
245
            # RFC2616 14.16 and 14.35 says that when a server
287
246
            # encounters unsatisfiable range specifiers, it
288
247
            # SHOULD return a 416.
289
 
            f.close()
 
248
            file.close()
290
249
            # FIXME: We SHOULD send a Content-Range header too,
291
250
            # but the implementation of send_error does not
292
251
            # allows that. So far.
295
254
 
296
255
        if len(ranges) == 1:
297
256
            (start, end) = ranges[0]
298
 
            self.get_single_range(f, file_size, start, end)
 
257
            self.get_single_range(file, file_size, start, end)
299
258
        else:
300
 
            self.get_multiple_ranges(f, file_size, ranges)
301
 
        f.close()
 
259
            self.get_multiple_ranges(file, file_size, ranges)
 
260
        file.close()
302
261
 
303
262
    def translate_path(self, path):
304
263
        """Translate a /-separated PATH to the local filename syntax.
336
295
        """
337
296
        # abandon query parameters
338
297
        path = urlparse.urlparse(path)[2]
339
 
        path = posixpath.normpath(urlutils.unquote(path))
 
298
        path = posixpath.normpath(urllib.unquote(path))
340
299
        path = path.decode('utf-8')
341
300
        words = path.split('/')
342
301
        words = filter(None, words)
360
319
        self.test_case_server = test_case_server
361
320
        self._home_dir = test_case_server._home_dir
362
321
 
363
 
 
364
 
class TestingHTTPServer(test_server.TestingTCPServer, TestingHTTPServerMixin):
 
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):
365
359
 
366
360
    def __init__(self, server_address, request_handler_class,
367
361
                 test_case_server):
368
 
        test_server.TestingTCPServer.__init__(self, server_address,
369
 
                                              request_handler_class)
370
362
        TestingHTTPServerMixin.__init__(self, test_case_server)
371
 
 
372
 
 
373
 
class TestingThreadingHTTPServer(test_server.TestingThreadingTCPServer,
 
363
        SocketServer.TCPServer.__init__(self, server_address,
 
364
                                        request_handler_class)
 
365
 
 
366
 
 
367
class TestingThreadingHTTPServer(SocketServer.ThreadingTCPServer,
374
368
                                 TestingHTTPServerMixin):
375
369
    """A threading HTTP test server for HTTP 1.1.
376
370
 
378
372
    server, we need an independent connection for each of them. We achieve that
379
373
    by spawning a new thread for each connection.
380
374
    """
 
375
 
381
376
    def __init__(self, server_address, request_handler_class,
382
377
                 test_case_server):
383
 
        test_server.TestingThreadingTCPServer.__init__(self, server_address,
384
 
                                                       request_handler_class)
385
378
        TestingHTTPServerMixin.__init__(self, test_case_server)
386
 
 
387
 
 
388
 
class HttpServer(test_server.TestingTCPServerInAThread):
 
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):
389
405
    """A test server for http transports.
390
406
 
391
407
    Subclasses can provide a specific request handler.
413
429
        :param protocol_version: if specified, will override the protocol
414
430
            version of the request handler.
415
431
        """
416
 
        # Depending on the protocol version, we will create the approriate
417
 
        # server
418
 
        if protocol_version is None:
419
 
            # Use the request handler one
420
 
            proto_vers = request_handler.protocol_version
421
 
        else:
422
 
            # Use our own, it will be used to override the request handler
423
 
            # one too.
424
 
            proto_vers = protocol_version
425
 
        # Get the appropriate server class for the required protocol
426
 
        serv_cls = self.http_server_class.get(proto_vers, None)
427
 
        if serv_cls is None:
428
 
            raise httplib.UnknownProtocol(proto_vers)
 
432
        transport.Server.__init__(self)
 
433
        self.request_handler = request_handler
429
434
        self.host = 'localhost'
430
435
        self.port = 0
431
 
        super(HttpServer, self).__init__((self.host, self.port),
432
 
                                         serv_cls,
433
 
                                         request_handler)
434
 
        self.protocol_version = proto_vers
 
436
        self._httpd = None
 
437
        self.protocol_version = protocol_version
435
438
        # Allows tests to verify number of GET requests issued
436
439
        self.GET_request_nb = 0
437
 
        self._http_base_url = None
438
 
        self.logs = []
439
 
 
440
 
    def create_server(self):
441
 
        return self.server_class(
442
 
            (self.host, self.port), self.request_handler_class, self)
 
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
443
508
 
444
509
    def _get_remote_url(self, path):
445
510
        path_parts = path.split(os.path.sep)
470
535
                or isinstance(backing_transport_server,
471
536
                              test_server.LocalURLServer)):
472
537
            raise AssertionError(
473
 
                "HTTPServer currently assumes local transport, got %s" %
 
538
                "HTTPServer currently assumes local transport, got %s" % \
474
539
                backing_transport_server)
475
540
        self._home_dir = os.getcwdu()
476
541
        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()
477
560
        self.logs = []
478
561
 
479
 
        super(HttpServer, self).start_server()
480
 
        self._http_base_url = '%s://%s:%s/' % (
481
 
            self._url_protocol, self.host, self.port)
 
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.
482
568
 
483
569
    def get_url(self):
484
570
        """See bzrlib.transport.Server.get_url."""