39
41
return 'path %s is not in %s' % self.args
42
class TestingHTTPRequestHandler(SimpleHTTPServer.SimpleHTTPRequestHandler):
44
class TestingHTTPRequestHandler(SimpleHTTPRequestHandler):
43
45
"""Handles one request.
45
A TestingHTTPRequestHandler is instantiated for every request received by
46
the associated server. Note that 'request' here is inherited from the base
47
TCPServer class, for the HTTP server it is really a connection which itself
48
will handle one or several HTTP requests.
47
A TestingHTTPRequestHandler is instantiated for every request
48
received by the associated server.
50
# Default protocol version
51
protocol_version = 'HTTP/1.1'
53
# The Message-like class used to parse the request headers
54
MessageClass = httplib.HTTPMessage
57
SimpleHTTPServer.SimpleHTTPRequestHandler.setup(self)
58
self._cwd = self.server._home_dir
59
tcs = self.server.test_case_server
60
if tcs.protocol_version is not None:
61
# If the test server forced a protocol version, use it
62
self.protocol_version = tcs.protocol_version
64
51
def log_message(self, format, *args):
65
52
tcs = self.server.test_case_server
73
60
def handle_one_request(self):
74
61
"""Handle a single HTTP request.
76
We catch all socket errors occurring when the client close the
77
connection early to avoid polluting the test results.
63
You normally don't need to override this method; see the class
64
__doc__ string for information on how to handle specific HTTP
65
commands such as GET and POST.
80
SimpleHTTPServer.SimpleHTTPRequestHandler.handle_one_request(self)
81
except socket.error, e:
82
# Any socket error should close the connection, but some errors are
83
# due to the client closing early and we don't want to pollute test
84
# results, so we raise only the others.
68
for i in xrange(1,11): # Don't try more than 10 times
70
self.raw_requestline = self.rfile.readline()
71
except socket.error, e:
72
if e.args[0] in (errno.EAGAIN, errno.EWOULDBLOCK):
73
# omitted for now because some tests look at the log of
74
# the server and expect to see no errors. see recent
75
# email thread. -- mbp 20051021.
76
## self.log_message('EAGAIN (%d) while reading from raw_requestline' % i)
82
if not self.raw_requestline:
85
83
self.close_connection = 1
87
or e.args[0] not in (errno.EPIPE, errno.ECONNRESET,
88
errno.ECONNABORTED, errno.EBADF)):
85
if not self.parse_request(): # An error code has been sent, just exit
87
mname = 'do_' + self.command
88
if getattr(self, mname, None) is None:
89
self.send_error(501, "Unsupported method (%r)" % self.command)
91
method = getattr(self, mname)
91
94
_range_regexp = re.compile(r'^(?P<start>\d+)-(?P<end>\d+)$')
92
95
_tail_regexp = re.compile(r'^-(?P<tail>\d+)$')
164
147
def get_multiple_ranges(self, file, file_size, ranges):
165
148
self.send_response(206)
166
149
self.send_header('Accept-Ranges', 'bytes')
167
boundary = '%d' % random.randint(0,0x7FFFFFFF)
168
self.send_header('Content-Type',
169
'multipart/byteranges; boundary=%s' % boundary)
170
boundary_line = '--%s\r\n' % boundary
171
# Calculate the Content-Length
173
for (start, end) in ranges:
174
content_length += len(boundary_line)
175
content_length += self._header_line_length(
176
'Content-type', 'application/octet-stream')
177
content_length += self._header_line_length(
178
'Content-Range', 'bytes %d-%d/%d' % (start, end, file_size))
179
content_length += len('\r\n') # end headers
180
content_length += end - start + 1
181
content_length += len(boundary_line)
182
self.send_header('Content-length', content_length)
150
boundary = "%d" % random.randint(0,0x7FFFFFFF)
151
self.send_header("Content-Type",
152
"multipart/byteranges; boundary=%s" % boundary)
183
153
self.end_headers()
185
# Send the multipart body
186
154
for (start, end) in ranges:
187
self.wfile.write(boundary_line)
188
self.send_header('Content-type', 'application/octet-stream')
189
self.send_header('Content-Range', 'bytes %d-%d/%d'
190
% (start, end, file_size))
155
self.wfile.write("--%s\r\n" % boundary)
156
self.send_header("Content-type", 'application/octet-stream')
157
self.send_header("Content-Range", "bytes %d-%d/%d" % (start,
191
160
self.end_headers()
192
161
self.send_range_content(file, start, end - start + 1)
194
self.wfile.write(boundary_line)
162
self.wfile.write("--%s\r\n" % boundary)
196
164
def do_GET(self):
197
165
"""Serve a GET request.
199
167
Handles the Range header.
202
self.server.test_case_server.GET_request_nb += 1
204
170
path = self.translate_path(self.path)
205
171
ranges_header_value = self.headers.get('Range')
206
172
if ranges_header_value is None or os.path.isdir(path):
207
173
# Let the mother class handle most cases
208
return SimpleHTTPServer.SimpleHTTPRequestHandler.do_GET(self)
174
return SimpleHTTPRequestHandler.do_GET(self)
211
177
# Always read in binary mode. Opening files in text
282
248
return self._translate_path(path)
284
250
def _translate_path(self, path):
285
"""Translate a /-separated PATH to the local filename syntax.
287
Note that we're translating http URLs here, not file URLs.
288
The URL root location is the server's startup directory.
289
Components that mean special things to the local file system
290
(e.g. drive or directory names) are ignored. (XXX They should
291
probably be diagnosed.)
293
Override from python standard library to stop it calling os.getcwd()
295
# abandon query parameters
296
path = urlparse.urlparse(path)[2]
297
path = posixpath.normpath(urllib.unquote(path))
298
path = path.decode('utf-8')
299
words = path.split('/')
300
words = filter(None, words)
302
for num, word in enumerate(words):
251
return SimpleHTTPRequestHandler.translate_path(self, path)
253
if sys.platform == 'win32':
254
# On win32 you cannot access non-ascii filenames without
255
# decoding them into unicode first.
256
# However, under Linux, you can access bytestream paths
257
# without any problems. If this function was always active
258
# it would probably break tests when LANG=C was set
259
def _translate_path(self, path):
260
"""Translate a /-separated PATH to the local filename syntax.
262
For bzr, all url paths are considered to be utf8 paths.
263
On Linux, you can access these paths directly over the bytestream
264
request, but on win32, you must decode them, and access them
267
# abandon query parameters
268
path = urlparse.urlparse(path)[2]
269
path = posixpath.normpath(urllib.unquote(path))
270
path = path.decode('utf-8')
271
words = path.split('/')
272
words = filter(None, words)
304
275
drive, word = os.path.splitdrive(word)
305
head, word = os.path.split(word)
306
if word in (os.curdir, os.pardir): continue
307
path = os.path.join(path, word)
311
class TestingHTTPServerMixin:
313
def __init__(self, test_case_server):
276
head, word = os.path.split(word)
277
if word in (os.curdir, os.pardir): continue
278
path = os.path.join(path, word)
282
class TestingHTTPServer(BaseHTTPServer.HTTPServer):
284
def __init__(self, server_address, RequestHandlerClass,
286
BaseHTTPServer.HTTPServer.__init__(self, server_address,
314
288
# test_case_server can be used to communicate between the
315
289
# tests and the server (or the request handler and the
316
290
# server), allowing dynamic behaviors to be defined from
317
291
# the tests cases.
318
292
self.test_case_server = test_case_server
319
self._home_dir = test_case_server._home_dir
322
"""Called to clean-up the server.
324
Since the server may be (surely is, even) in a blocking listen, we
325
shutdown its socket before closing it.
327
# Note that is this executed as part of the implicit tear down in the
328
# main thread while the server runs in its own thread. The clean way
329
# to tear down the server is to instruct him to stop accepting
330
# connections and wait for the current connection(s) to end
331
# naturally. To end the connection naturally, the http transports
332
# should close their socket when they do not need to talk to the
333
# server anymore. This happens naturally during the garbage collection
334
# phase of the test transport objetcs (the server clients), so we
335
# don't have to worry about them. So, for the server, we must tear
336
# down here, from the main thread, when the test have ended. Note
337
# that since the server is in a blocking operation and since python
338
# use select internally, shutting down the socket is reliable and
341
self.socket.shutdown(socket.SHUT_RDWR)
342
except socket.error, e:
343
# WSAENOTCONN (10057) 'Socket is not connected' is harmless on
344
# windows (occurs before the first connection attempt
347
# 'Socket is not connected' can also occur on OSX, with a
348
# "regular" ENOTCONN (when something went wrong during test case
349
# setup leading to self.setUp() *not* being called but
350
# self.tearDown() still being called -- vila20081106
351
if not len(e.args) or e.args[0] not in (errno.ENOTCONN, 10057):
353
# Let the server properly close the socket
357
class TestingHTTPServer(SocketServer.TCPServer, TestingHTTPServerMixin):
359
def __init__(self, server_address, request_handler_class,
361
TestingHTTPServerMixin.__init__(self, test_case_server)
362
SocketServer.TCPServer.__init__(self, server_address,
363
request_handler_class)
366
class TestingThreadingHTTPServer(SocketServer.ThreadingTCPServer,
367
TestingHTTPServerMixin):
368
"""A threading HTTP test server for HTTP 1.1.
370
Since tests can initiate several concurrent connections to the same http
371
server, we need an independent connection for each of them. We achieve that
372
by spawning a new thread for each connection.
375
def __init__(self, server_address, request_handler_class,
377
TestingHTTPServerMixin.__init__(self, test_case_server)
378
SocketServer.ThreadingTCPServer.__init__(self, server_address,
379
request_handler_class)
380
# Decides how threads will act upon termination of the main
381
# process. This is prophylactic as we should not leave the threads
383
self.daemon_threads = True
386
class HttpServer(transport.Server):
295
class HttpServer(Server):
387
296
"""A test server for http transports.
389
298
Subclasses can provide a specific request handler.
392
# The real servers depending on the protocol
393
http_server_class = {'HTTP/1.0': TestingHTTPServer,
394
'HTTP/1.1': TestingThreadingHTTPServer,
397
301
# Whether or not we proxy the requests (see
398
302
# TestingHTTPRequestHandler.translate_path).
399
303
proxy_requests = False
401
305
# used to form the url that connects to this server
402
306
_url_protocol = 'http'
404
def __init__(self, request_handler=TestingHTTPRequestHandler,
405
protocol_version=None):
408
:param request_handler: a class that will be instantiated to handle an
409
http connection (one or several requests).
411
:param protocol_version: if specified, will override the protocol
412
version of the request handler.
414
transport.Server.__init__(self)
308
# Subclasses can provide a specific request handler
309
def __init__(self, request_handler=TestingHTTPRequestHandler):
310
Server.__init__(self)
415
311
self.request_handler = request_handler
416
312
self.host = 'localhost'
418
314
self._httpd = None
419
self.protocol_version = protocol_version
420
# Allows tests to verify number of GET requests issued
421
self.GET_request_nb = 0
423
def create_httpd(self, serv_cls, rhandler_cls):
424
return serv_cls((self.host, self.port), self.request_handler, self)
427
return "%s(%s:%s)" % \
428
(self.__class__.__name__, self.host, self.port)
430
316
def _get_httpd(self):
431
317
if self._httpd is None:
432
rhandler = self.request_handler
433
# Depending on the protocol version, we will create the approriate
435
if self.protocol_version is None:
436
# Use the request handler one
437
proto_vers = rhandler.protocol_version
439
# Use our own, it will be used to override the request handler
441
proto_vers = self.protocol_version
442
# Create the appropriate server for the required protocol
443
serv_cls = self.http_server_class.get(proto_vers, None)
445
raise httplib.UnknownProtocol(proto_vers)
447
self._httpd = self.create_httpd(serv_cls, rhandler)
318
self._httpd = TestingHTTPServer((self.host, self.port),
319
self.request_handler,
448
321
host, self.port = self._httpd.socket.getsockname()
449
322
return self._httpd
451
324
def _http_start(self):
452
"""Server thread main entry point. """
453
self._http_running = False
456
httpd = self._get_httpd()
457
self._http_base_url = '%s://%s:%s/' % (self._url_protocol,
458
self.host, self.port)
459
self._http_running = True
461
# Whatever goes wrong, we save the exception for the main
462
# thread. Note that since we are running in a thread, no signal
463
# can be received, so we don't care about KeyboardInterrupt.
464
self._http_exception = sys.exc_info()
466
# Release the lock or the main thread will block and the whole
468
self._http_starting.release()
325
httpd = self._get_httpd()
326
self._http_base_url = '%s://%s:%s/' % (self._url_protocol,
329
self._http_starting.release()
330
httpd.socket.settimeout(0.1)
470
# From now on, exceptions are taken care of by the
471
# SocketServer.BaseServer or the request handler.
472
332
while self._http_running:
474
# Really an HTTP connection but the python framework is generic
475
# and call them requests
476
334
httpd.handle_request()
477
335
except socket.timeout:
479
except (socket.error, select.error), e:
480
if e[0] == errno.EBADF:
481
# Starting with python-2.6, handle_request may raise socket
482
# or select exceptions when the server is shut down (as we
488
338
def _get_remote_url(self, path):
489
339
path_parts = path.split(os.path.sep)
504
354
def setUp(self, backing_transport_server=None):
505
355
"""See bzrlib.transport.Server.setUp.
507
357
:param backing_transport_server: The transport that requests over this
508
358
protocol should be forwarded to. Note that this is currently not
509
359
supported for HTTP.
511
361
# XXX: TODO: make the server back onto vfs_server rather than local
513
if not (backing_transport_server is None or \
514
isinstance(backing_transport_server, local.LocalURLServer)):
515
raise AssertionError(
516
"HTTPServer currently assumes local transport, got %s" % \
517
backing_transport_server)
363
assert backing_transport_server is None or \
364
isinstance(backing_transport_server, LocalURLServer), \
365
"HTTPServer currently assumes local transport, got %s" % \
366
backing_transport_server
518
367
self._home_dir = os.getcwdu()
519
368
self._local_path_parts = self._home_dir.split(os.path.sep)
369
self._http_starting = threading.Lock()
370
self._http_starting.acquire()
371
self._http_running = True
520
372
self._http_base_url = None
522
# Create the server thread
523
self._http_starting = threading.Lock()
524
self._http_starting.acquire()
525
373
self._http_thread = threading.Thread(target=self._http_start)
526
374
self._http_thread.setDaemon(True)
527
self._http_exception = None
528
375
self._http_thread.start()
530
376
# Wait for the server thread to start (i.e release the lock)
531
377
self._http_starting.acquire()
533
if self._http_exception is not None:
534
# Something went wrong during server start
535
exc_class, exc_value, exc_tb = self._http_exception
536
raise exc_class, exc_value, exc_tb
537
378
self._http_starting.release()
540
381
def tearDown(self):
541
382
"""See bzrlib.transport.Server.tearDown."""
542
self._httpd.tearDown()
543
383
self._http_running = False
544
# We don't need to 'self._http_thread.join()' here since the thread is
545
# a daemonic one and will be garbage collected anyway. Joining just
546
# slows us down for no added benefit.
384
self._http_thread.join()
548
386
def get_url(self):
549
387
"""See bzrlib.transport.Server.get_url."""
added
removed
bzrlib/tests/HttpServer.py
