~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/HttpServer.py

  • Committer: Ian Clatworthy
  • Date: 2007-12-17 04:49:20 UTC
  • mfrom: (3089.3.17 bzr.ug-tweaks)
  • mto: This revision was merged to the branch mainline in revision 3120.
  • Revision ID: ian.clatworthy@internode.on.net-20071217044920-8fjh9v6m1t93c8dc
Move material out of User Guide into User Reference (Ian Clatworthy)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006-2011 Canonical Ltd
 
1
# Copyright (C) 2006, 2007 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
 
17
import BaseHTTPServer
17
18
import errno
18
 
import httplib
19
19
import os
 
20
from SimpleHTTPServer import SimpleHTTPRequestHandler
 
21
import socket
20
22
import posixpath
21
23
import random
22
24
import re
23
 
import SimpleHTTPServer
24
 
import socket
 
25
import sys
 
26
import threading
 
27
import time
25
28
import urllib
26
29
import urlparse
27
30
 
28
 
from bzrlib.tests import test_server
 
31
from bzrlib.transport import Server
 
32
from bzrlib.transport.local import LocalURLServer
 
33
 
 
34
 
 
35
class WebserverNotAvailable(Exception):
 
36
    pass
29
37
 
30
38
 
31
39
class BadWebserverPath(ValueError):
33
41
        return 'path %s is not in %s' % self.args
34
42
 
35
43
 
36
 
class TestingHTTPRequestHandler(SimpleHTTPServer.SimpleHTTPRequestHandler):
 
44
class TestingHTTPRequestHandler(SimpleHTTPRequestHandler):
37
45
    """Handles one request.
38
46
 
39
 
    A TestingHTTPRequestHandler is instantiated for every request received by
40
 
    the associated server. Note that 'request' here is inherited from the base
41
 
    TCPServer class, for the HTTP server it is really a connection which itself
42
 
    will handle one or several HTTP requests.
 
47
    A TestingHTTPRequestHandler is instantiated for every request
 
48
    received by the associated server.
43
49
    """
44
 
    # Default protocol version
45
 
    protocol_version = 'HTTP/1.1'
46
 
 
47
 
    # The Message-like class used to parse the request headers
48
 
    MessageClass = httplib.HTTPMessage
49
 
 
50
 
    def setup(self):
51
 
        SimpleHTTPServer.SimpleHTTPRequestHandler.setup(self)
52
 
        self._cwd = self.server._home_dir
53
 
        tcs = self.server.test_case_server
54
 
        if tcs.protocol_version is not None:
55
 
            # If the test server forced a protocol version, use it
56
 
            self.protocol_version = tcs.protocol_version
57
50
 
58
51
    def log_message(self, format, *args):
59
52
        tcs = self.server.test_case_server
64
57
                self.headers.get('referer', '-'),
65
58
                self.headers.get('user-agent', '-'))
66
59
 
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
60
    def handle_one_request(self):
76
61
        """Handle a single HTTP request.
77
62
 
79
64
        connection early to avoid polluting the test results.
80
65
        """
81
66
        try:
82
 
            self._handle_one_request()
 
67
            SimpleHTTPRequestHandler.handle_one_request(self)
83
68
        except socket.error, e:
84
 
            # Any socket error should close the connection, but some errors are
85
 
            # due to the client closing early and we don't want to pollute test
86
 
            # results, so we raise only the others.
87
 
            self.close_connection = 1
88
 
            if (len(e.args) == 0
89
 
                or e.args[0] not in (errno.EPIPE, errno.ECONNRESET,
90
 
                                     errno.ECONNABORTED, errno.EBADF)):
 
69
            if (len(e.args) > 0
 
70
                and e.args[0] in (errno.EPIPE, errno.ECONNRESET,
 
71
                                  errno.ECONNABORTED,)):
 
72
                self.close_connection = 1
 
73
                pass
 
74
            else:
91
75
                raise
92
76
 
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
77
    _range_regexp = re.compile(r'^(?P<start>\d+)-(?P<end>\d+)$')
132
78
    _tail_regexp = re.compile(r'^-(?P<tail>\d+)$')
133
79
 
164
110
                    return 0, []
165
111
        return tail, ranges
166
112
 
167
 
    def _header_line_length(self, keyword, value):
168
 
        header_line = '%s: %s\r\n' % (keyword, value)
169
 
        return len(header_line)
170
 
 
171
 
    def send_head(self):
172
 
        """Overrides base implementation to work around a bug in python2.5."""
173
 
        path = self.translate_path(self.path)
174
 
        if os.path.isdir(path) and not self.path.endswith('/'):
175
 
            # redirect browser - doing basically what apache does when
176
 
            # DirectorySlash option is On which is quite common (braindead, but
177
 
            # common)
178
 
            self.send_response(301)
179
 
            self.send_header("Location", self.path + "/")
180
 
            # Indicates that the body is empty for HTTP/1.1 clients
181
 
            self.send_header('Content-Length', '0')
182
 
            self.end_headers()
183
 
            return None
184
 
 
185
 
        return SimpleHTTPServer.SimpleHTTPRequestHandler.send_head(self)
186
 
 
187
113
    def send_range_content(self, file, start, length):
188
114
        file.seek(start)
189
115
        self.wfile.write(file.read(length))
204
130
    def get_multiple_ranges(self, file, file_size, ranges):
205
131
        self.send_response(206)
206
132
        self.send_header('Accept-Ranges', 'bytes')
207
 
        boundary = '%d' % random.randint(0,0x7FFFFFFF)
208
 
        self.send_header('Content-Type',
209
 
                         'multipart/byteranges; boundary=%s' % boundary)
210
 
        boundary_line = '--%s\r\n' % boundary
211
 
        # Calculate the Content-Length
212
 
        content_length = 0
213
 
        for (start, end) in ranges:
214
 
            content_length += len(boundary_line)
215
 
            content_length += self._header_line_length(
216
 
                'Content-type', 'application/octet-stream')
217
 
            content_length += self._header_line_length(
218
 
                'Content-Range', 'bytes %d-%d/%d' % (start, end, file_size))
219
 
            content_length += len('\r\n') # end headers
220
 
            content_length += end - start + 1
221
 
        content_length += len(boundary_line)
222
 
        self.send_header('Content-length', content_length)
 
133
        boundary = "%d" % random.randint(0,0x7FFFFFFF)
 
134
        self.send_header("Content-Type",
 
135
                         "multipart/byteranges; boundary=%s" % boundary)
223
136
        self.end_headers()
224
 
 
225
 
        # Send the multipart body
226
137
        for (start, end) in ranges:
227
 
            self.wfile.write(boundary_line)
228
 
            self.send_header('Content-type', 'application/octet-stream')
229
 
            self.send_header('Content-Range', 'bytes %d-%d/%d'
230
 
                             % (start, end, file_size))
 
138
            self.wfile.write("--%s\r\n" % boundary)
 
139
            self.send_header("Content-type", 'application/octet-stream')
 
140
            self.send_header("Content-Range", "bytes %d-%d/%d" % (start,
 
141
                                                                  end,
 
142
                                                                  file_size))
231
143
            self.end_headers()
232
144
            self.send_range_content(file, start, end - start + 1)
233
145
        # Final boundary
234
 
        self.wfile.write(boundary_line)
 
146
        self.wfile.write("--%s\r\n" % boundary)
235
147
 
236
148
    def do_GET(self):
237
149
        """Serve a GET request.
245
157
        ranges_header_value = self.headers.get('Range')
246
158
        if ranges_header_value is None or os.path.isdir(path):
247
159
            # Let the mother class handle most cases
248
 
            return SimpleHTTPServer.SimpleHTTPRequestHandler.do_GET(self)
 
160
            return SimpleHTTPRequestHandler.do_GET(self)
249
161
 
250
162
        try:
251
163
            # Always read in binary mode. Opening files in text
252
164
            # mode may cause newline translations, making the
253
165
            # actual size of the content transmitted *less* than
254
166
            # the content-length!
255
 
            f = open(path, 'rb')
 
167
            file = open(path, 'rb')
256
168
        except IOError:
257
169
            self.send_error(404, "File not found")
258
170
            return
259
171
 
260
 
        file_size = os.fstat(f.fileno())[6]
 
172
        file_size = os.fstat(file.fileno())[6]
261
173
        tail, ranges = self.parse_ranges(ranges_header_value)
262
174
        # Normalize tail into ranges
263
175
        if tail != 0:
284
196
            # RFC2616 14.16 and 14.35 says that when a server
285
197
            # encounters unsatisfiable range specifiers, it
286
198
            # SHOULD return a 416.
287
 
            f.close()
 
199
            file.close()
288
200
            # FIXME: We SHOULD send a Content-Range header too,
289
201
            # but the implementation of send_error does not
290
202
            # allows that. So far.
293
205
 
294
206
        if len(ranges) == 1:
295
207
            (start, end) = ranges[0]
296
 
            self.get_single_range(f, file_size, start, end)
 
208
            self.get_single_range(file, file_size, start, end)
297
209
        else:
298
 
            self.get_multiple_ranges(f, file_size, ranges)
299
 
        f.close()
 
210
            self.get_multiple_ranges(file, file_size, ranges)
 
211
        file.close()
300
212
 
301
213
    def translate_path(self, path):
302
214
        """Translate a /-separated PATH to the local filename syntax.
322
234
        return self._translate_path(path)
323
235
 
324
236
    def _translate_path(self, path):
325
 
        """Translate a /-separated PATH to the local filename syntax.
326
 
 
327
 
        Note that we're translating http URLs here, not file URLs.
328
 
        The URL root location is the server's startup directory.
329
 
        Components that mean special things to the local file system
330
 
        (e.g. drive or directory names) are ignored.  (XXX They should
331
 
        probably be diagnosed.)
332
 
 
333
 
        Override from python standard library to stop it calling os.getcwd()
334
 
        """
335
 
        # abandon query parameters
336
 
        path = urlparse.urlparse(path)[2]
337
 
        path = posixpath.normpath(urllib.unquote(path))
338
 
        path = path.decode('utf-8')
339
 
        words = path.split('/')
340
 
        words = filter(None, words)
341
 
        path = self._cwd
342
 
        for num, word in enumerate(words):
343
 
            if num == 0:
 
237
        return SimpleHTTPRequestHandler.translate_path(self, path)
 
238
 
 
239
    if sys.platform == 'win32':
 
240
        # On win32 you cannot access non-ascii filenames without
 
241
        # decoding them into unicode first.
 
242
        # However, under Linux, you can access bytestream paths
 
243
        # without any problems. If this function was always active
 
244
        # it would probably break tests when LANG=C was set
 
245
        def _translate_path(self, path):
 
246
            """Translate a /-separated PATH to the local filename syntax.
 
247
 
 
248
            For bzr, all url paths are considered to be utf8 paths.
 
249
            On Linux, you can access these paths directly over the bytestream
 
250
            request, but on win32, you must decode them, and access them
 
251
            as Unicode files.
 
252
            """
 
253
            # abandon query parameters
 
254
            path = urlparse.urlparse(path)[2]
 
255
            path = posixpath.normpath(urllib.unquote(path))
 
256
            path = path.decode('utf-8')
 
257
            words = path.split('/')
 
258
            words = filter(None, words)
 
259
            path = os.getcwdu()
 
260
            for word in words:
344
261
                drive, word = os.path.splitdrive(word)
345
 
            head, word = os.path.split(word)
346
 
            if word in (os.curdir, os.pardir): continue
347
 
            path = os.path.join(path, word)
348
 
        return path
349
 
 
350
 
 
351
 
class TestingHTTPServerMixin:
352
 
 
353
 
    def __init__(self, test_case_server):
 
262
                head, word = os.path.split(word)
 
263
                if word in (os.curdir, os.pardir): continue
 
264
                path = os.path.join(path, word)
 
265
            return path
 
266
 
 
267
 
 
268
class TestingHTTPServer(BaseHTTPServer.HTTPServer):
 
269
 
 
270
    def __init__(self, server_address, RequestHandlerClass,
 
271
                 test_case_server):
 
272
        BaseHTTPServer.HTTPServer.__init__(self, server_address,
 
273
                                           RequestHandlerClass)
354
274
        # test_case_server can be used to communicate between the
355
275
        # tests and the server (or the request handler and the
356
276
        # server), allowing dynamic behaviors to be defined from
357
277
        # the tests cases.
358
278
        self.test_case_server = test_case_server
359
 
        self._home_dir = test_case_server._home_dir
360
 
 
361
 
 
362
 
class TestingHTTPServer(test_server.TestingTCPServer, TestingHTTPServerMixin):
363
 
 
364
 
    def __init__(self, server_address, request_handler_class,
365
 
                 test_case_server):
366
 
        test_server.TestingTCPServer.__init__(self, server_address,
367
 
                                              request_handler_class)
368
 
        TestingHTTPServerMixin.__init__(self, test_case_server)
369
 
 
370
 
 
371
 
class TestingThreadingHTTPServer(test_server.TestingThreadingTCPServer,
372
 
                                 TestingHTTPServerMixin):
373
 
    """A threading HTTP test server for HTTP 1.1.
374
 
 
375
 
    Since tests can initiate several concurrent connections to the same http
376
 
    server, we need an independent connection for each of them. We achieve that
377
 
    by spawning a new thread for each connection.
378
 
    """
379
 
    def __init__(self, server_address, request_handler_class,
380
 
                 test_case_server):
381
 
        test_server.TestingThreadingTCPServer.__init__(self, server_address,
382
 
                                                       request_handler_class)
383
 
        TestingHTTPServerMixin.__init__(self, test_case_server)
384
 
 
385
 
 
386
 
class HttpServer(test_server.TestingTCPServerInAThread):
 
279
 
 
280
    def server_close(self):
 
281
        """Called to clean-up the server.
 
282
 
 
283
        Since the server may be in a blocking read, we shutdown the socket
 
284
        before closing it.
 
285
        """
 
286
        self.socket.shutdown(socket.SHUT_RDWR)
 
287
        BaseHTTPServer.HTTPServer.server_close(self)
 
288
 
 
289
 
 
290
class HttpServer(Server):
387
291
    """A test server for http transports.
388
292
 
389
293
    Subclasses can provide a specific request handler.
390
294
    """
391
295
 
392
 
    # The real servers depending on the protocol
393
 
    http_server_class = {'HTTP/1.0': TestingHTTPServer,
394
 
                         'HTTP/1.1': TestingThreadingHTTPServer,
395
 
                         }
396
 
 
397
296
    # Whether or not we proxy the requests (see
398
297
    # TestingHTTPRequestHandler.translate_path).
399
298
    proxy_requests = False
401
300
    # used to form the url that connects to this server
402
301
    _url_protocol = 'http'
403
302
 
404
 
    def __init__(self, request_handler=TestingHTTPRequestHandler,
405
 
                 protocol_version=None):
406
 
        """Constructor.
407
 
 
408
 
        :param request_handler: a class that will be instantiated to handle an
409
 
            http connection (one or several requests).
410
 
 
411
 
        :param protocol_version: if specified, will override the protocol
412
 
            version of the request handler.
413
 
        """
414
 
        # Depending on the protocol version, we will create the approriate
415
 
        # server
416
 
        if protocol_version is None:
417
 
            # Use the request handler one
418
 
            proto_vers = request_handler.protocol_version
419
 
        else:
420
 
            # Use our own, it will be used to override the request handler
421
 
            # one too.
422
 
            proto_vers = protocol_version
423
 
        # Get the appropriate server class for the required protocol
424
 
        serv_cls = self.http_server_class.get(proto_vers, None)
425
 
        if serv_cls is None:
426
 
            raise httplib.UnknownProtocol(proto_vers)
 
303
    # Subclasses can provide a specific request handler
 
304
    def __init__(self, request_handler=TestingHTTPRequestHandler):
 
305
        Server.__init__(self)
 
306
        self.request_handler = request_handler
427
307
        self.host = 'localhost'
428
308
        self.port = 0
429
 
        super(HttpServer, self).__init__((self.host, self.port),
430
 
                                         serv_cls,
431
 
                                         request_handler)
432
 
        self.protocol_version = proto_vers
 
309
        self._httpd = None
433
310
        # Allows tests to verify number of GET requests issued
434
311
        self.GET_request_nb = 0
435
 
        self._http_base_url = None
436
 
        self.logs = []
437
 
 
438
 
    def create_server(self):
439
 
        return self.server_class(
440
 
            (self.host, self.port), self.request_handler_class, self)
 
312
 
 
313
    def _get_httpd(self):
 
314
        if self._httpd is None:
 
315
            self._httpd = TestingHTTPServer((self.host, self.port),
 
316
                                            self.request_handler,
 
317
                                            self)
 
318
            host, self.port = self._httpd.socket.getsockname()
 
319
        return self._httpd
 
320
 
 
321
    def _http_start(self):
 
322
        httpd = self._get_httpd()
 
323
        self._http_base_url = '%s://%s:%s/' % (self._url_protocol,
 
324
                                               self.host,
 
325
                                               self.port)
 
326
        self._http_starting.release()
 
327
 
 
328
        while self._http_running:
 
329
            try:
 
330
                httpd.handle_request()
 
331
            except socket.timeout:
 
332
                pass
441
333
 
442
334
    def _get_remote_url(self, path):
443
335
        path_parts = path.split(os.path.sep)
455
347
        """Capture Server log output."""
456
348
        self.logs.append(format % args)
457
349
 
458
 
    def start_server(self, backing_transport_server=None):
459
 
        """See bzrlib.transport.Server.start_server.
460
 
 
 
350
    def setUp(self, backing_transport_server=None):
 
351
        """See bzrlib.transport.Server.setUp.
 
352
        
461
353
        :param backing_transport_server: The transport that requests over this
462
354
            protocol should be forwarded to. Note that this is currently not
463
355
            supported for HTTP.
464
356
        """
465
357
        # XXX: TODO: make the server back onto vfs_server rather than local
466
358
        # disk.
467
 
        if not (backing_transport_server is None
468
 
                or isinstance(backing_transport_server,
469
 
                              test_server.LocalURLServer)):
470
 
            raise AssertionError(
471
 
                "HTTPServer currently assumes local transport, got %s" %
472
 
                backing_transport_server)
 
359
        assert backing_transport_server is None or \
 
360
            isinstance(backing_transport_server, LocalURLServer), \
 
361
            "HTTPServer currently assumes local transport, got %s" % \
 
362
            backing_transport_server
473
363
        self._home_dir = os.getcwdu()
474
364
        self._local_path_parts = self._home_dir.split(os.path.sep)
 
365
        self._http_starting = threading.Lock()
 
366
        self._http_starting.acquire()
 
367
        self._http_running = True
 
368
        self._http_base_url = None
 
369
        self._http_thread = threading.Thread(target=self._http_start)
 
370
        self._http_thread.setDaemon(True)
 
371
        self._http_thread.start()
 
372
        # Wait for the server thread to start (i.e release the lock)
 
373
        self._http_starting.acquire()
 
374
        self._http_starting.release()
475
375
        self.logs = []
476
376
 
477
 
        super(HttpServer, self).start_server()
478
 
        self._http_base_url = '%s://%s:%s/' % (
479
 
            self._url_protocol, self.host, self.port)
 
377
    def tearDown(self):
 
378
        """See bzrlib.transport.Server.tearDown."""
 
379
        self._httpd.server_close()
 
380
        self._http_running = False
 
381
        self._http_thread.join()
480
382
 
481
383
    def get_url(self):
482
384
        """See bzrlib.transport.Server.get_url."""
486
388
        """See bzrlib.transport.Server.get_bogus_url."""
487
389
        # this is chosen to try to prevent trouble with proxies, weird dns,
488
390
        # etc
489
 
        return self._url_protocol + '://127.0.0.1:1/'
 
391
        return 'http://127.0.0.1:1/'
490
392
 
491
393
 
492
394
class HttpServer_urllib(HttpServer):