42
40
return 'path %s is not in %s' % self.args
45
class TestingHTTPRequestHandler(SimpleHTTPServer.SimpleHTTPRequestHandler):
46
"""Handles one request.
48
A TestingHTTPRequestHandler is instantiated for every request received by
49
the associated server. Note that 'request' here is inherited from the base
50
TCPServer class, for the HTTP server it is really a connection which itself
51
will handle one or several HTTP requests.
53
# Default protocol version
54
protocol_version = 'HTTP/1.1'
56
# The Message-like class used to parse the request headers
57
MessageClass = httplib.HTTPMessage
60
SimpleHTTPServer.SimpleHTTPRequestHandler.setup(self)
61
tcs = self.server.test_case_server
62
if tcs.protocol_version is not None:
63
# If the test server forced a protocol version, use it
64
self.protocol_version = tcs.protocol_version
43
class TestingHTTPRequestHandler(SimpleHTTPRequestHandler):
66
45
def log_message(self, format, *args):
67
tcs = self.server.test_case_server
68
tcs.log('webserver - %s - - [%s] %s "%s" "%s"',
69
self.address_string(),
70
self.log_date_time_string(),
72
self.headers.get('referer', '-'),
73
self.headers.get('user-agent', '-'))
46
self.server.test_case.log('webserver - %s - - [%s] %s "%s" "%s"',
47
self.address_string(),
48
self.log_date_time_string(),
50
self.headers.get('referer', '-'),
51
self.headers.get('user-agent', '-'))
75
53
def handle_one_request(self):
76
54
"""Handle a single HTTP request.
78
We catch all socket errors occurring when the client close the
79
connection early to avoid polluting the test results.
56
You normally don't need to override this method; see the class
57
__doc__ string for information on how to handle specific HTTP
58
commands such as GET and POST.
82
SimpleHTTPServer.SimpleHTTPRequestHandler.handle_one_request(self)
83
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.
61
for i in xrange(1,11): # Don't try more than 10 times
63
self.raw_requestline = self.rfile.readline()
64
except socket.error, e:
65
if e.args[0] in (errno.EAGAIN, errno.EWOULDBLOCK):
66
# omitted for now because some tests look at the log of
67
# the server and expect to see no errors. see recent
68
# email thread. -- mbp 20051021.
69
## self.log_message('EAGAIN (%d) while reading from raw_requestline' % i)
75
if not self.raw_requestline:
87
76
self.close_connection = 1
89
or e.args[0] not in (errno.EPIPE, errno.ECONNRESET,
90
errno.ECONNABORTED, errno.EBADF)):
78
if not self.parse_request(): # An error code has been sent, just exit
80
mname = 'do_' + self.command
81
if getattr(self, mname, None) is None:
82
self.send_error(501, "Unsupported method (%r)" % self.command)
84
method = getattr(self, mname)
93
87
_range_regexp = re.compile(r'^(?P<start>\d+)-(?P<end>\d+)$')
94
88
_tail_regexp = re.compile(r'^-(?P<tail>\d+)$')
166
140
def get_multiple_ranges(self, file, file_size, ranges):
167
141
self.send_response(206)
168
142
self.send_header('Accept-Ranges', 'bytes')
169
boundary = '%d' % random.randint(0,0x7FFFFFFF)
170
self.send_header('Content-Type',
171
'multipart/byteranges; boundary=%s' % boundary)
172
boundary_line = '--%s\r\n' % boundary
173
# Calculate the Content-Length
175
for (start, end) in ranges:
176
content_length += len(boundary_line)
177
content_length += self._header_line_length(
178
'Content-type', 'application/octet-stream')
179
content_length += self._header_line_length(
180
'Content-Range', 'bytes %d-%d/%d' % (start, end, file_size))
181
content_length += len('\r\n') # end headers
182
content_length += end - start # + 1
183
content_length += len(boundary_line)
184
self.send_header('Content-length', content_length)
143
boundary = "%d" % random.randint(0,0x7FFFFFFF)
144
self.send_header("Content-Type",
145
"multipart/byteranges; boundary=%s" % boundary)
185
146
self.end_headers()
187
# Send the multipart body
188
147
for (start, end) in ranges:
189
self.wfile.write(boundary_line)
190
self.send_header('Content-type', 'application/octet-stream')
191
self.send_header('Content-Range', 'bytes %d-%d/%d'
192
% (start, end, file_size))
148
self.wfile.write("--%s\r\n" % boundary)
149
self.send_header("Content-type", 'application/octet-stream')
150
self.send_header("Content-Range", "bytes %d-%d/%d" % (start,
193
153
self.end_headers()
194
154
self.send_range_content(file, start, end - start + 1)
196
self.wfile.write(boundary_line)
155
self.wfile.write("--%s\r\n" % boundary)
198
158
def do_GET(self):
199
159
"""Serve a GET request.
201
161
Handles the Range header.
204
self.server.test_case_server.GET_request_nb += 1
206
164
path = self.translate_path(self.path)
207
165
ranges_header_value = self.headers.get('Range')
208
166
if ranges_header_value is None or os.path.isdir(path):
209
167
# Let the mother class handle most cases
210
return SimpleHTTPServer.SimpleHTTPRequestHandler.do_GET(self)
168
return SimpleHTTPRequestHandler.do_GET(self)
213
171
# Always read in binary mode. Opening files in text
260
218
self.get_multiple_ranges(file, file_size, ranges)
263
def translate_path(self, path):
264
"""Translate a /-separated PATH to the local filename syntax.
266
If the server requires it, proxy the path before the usual translation
268
if self.server.test_case_server.proxy_requests:
269
# We need to act as a proxy and accept absolute urls,
270
# which SimpleHTTPRequestHandler (parent) is not
271
# ready for. So we just drop the protocol://host:port
272
# part in front of the request-url (because we know
273
# we would not forward the request to *another*
276
# So we do what SimpleHTTPRequestHandler.translate_path
277
# do beginning with python 2.4.3: abandon query
278
# parameters, scheme, host port, etc (which ensure we
279
# provide the right behaviour on all python versions).
280
path = urlparse.urlparse(path)[2]
281
# And now, we can apply *our* trick to proxy files
284
return self._translate_path(path)
286
def _translate_path(self, path):
287
return SimpleHTTPServer.SimpleHTTPRequestHandler.translate_path(
290
221
if sys.platform == 'win32':
291
222
# On win32 you cannot access non-ascii filenames without
292
223
# decoding them into unicode first.
293
224
# However, under Linux, you can access bytestream paths
294
225
# without any problems. If this function was always active
295
226
# it would probably break tests when LANG=C was set
296
def _translate_path(self, path):
227
def translate_path(self, path):
297
228
"""Translate a /-separated PATH to the local filename syntax.
299
230
For bzr, all url paths are considered to be utf8 paths.
319
class TestingHTTPServerMixin:
321
def __init__(self, test_case_server):
322
# test_case_server can be used to communicate between the
323
# tests and the server (or the request handler and the
324
# server), allowing dynamic behaviors to be defined from
326
self.test_case_server = test_case_server
329
"""Called to clean-up the server.
331
Since the server may be (surely is, even) in a blocking listen, we
332
shutdown its socket before closing it.
334
# Note that is this executed as part of the implicit tear down in the
335
# main thread while the server runs in its own thread. The clean way
336
# to tear down the server is to instruct him to stop accepting
337
# connections and wait for the current connection(s) to end
338
# naturally. To end the connection naturally, the http transports
339
# should close their socket when they do not need to talk to the
340
# server anymore. This happens naturally during the garbage collection
341
# phase of the test transport objetcs (the server clients), so we
342
# don't have to worry about them. So, for the server, we must tear
343
# down here, from the main thread, when the test have ended. Note
344
# that since the server is in a blocking operation and since python
345
# use select internally, shutting down the socket is reliable and
348
self.socket.shutdown(socket.SHUT_RDWR)
349
except socket.error, e:
350
# WSAENOTCONN (10057) 'Socket is not connected' is harmless on
351
# windows (occurs before the first connection attempt
353
if not len(e.args) or e.args[0] != 10057:
355
# Let the server properly close the socket
358
class TestingHTTPServer(SocketServer.TCPServer, TestingHTTPServerMixin):
360
def __init__(self, server_address, request_handler_class,
362
TestingHTTPServerMixin.__init__(self, test_case_server)
363
SocketServer.TCPServer.__init__(self, server_address,
364
request_handler_class)
367
class TestingThreadingHTTPServer(SocketServer.ThreadingTCPServer,
368
TestingHTTPServerMixin):
369
"""A threading HTTP test server for HTTP 1.1.
371
Since tests can initiate several concurrent connections to the same http
372
server, we need an independent connection for each of them. We achieve that
373
by spawning a new thread for each connection.
376
def __init__(self, server_address, request_handler_class,
378
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
384
self.daemon_threads = True
387
class HttpServer(transport.Server):
250
class TestingHTTPServer(BaseHTTPServer.HTTPServer):
251
def __init__(self, server_address, RequestHandlerClass, test_case):
252
BaseHTTPServer.HTTPServer.__init__(self, server_address,
254
self.test_case = test_case
257
class HttpServer(Server):
388
258
"""A test server for http transports.
390
260
Subclasses can provide a specific request handler.
393
# The real servers depending on the protocol
394
http_server_class = {'HTTP/1.0': TestingHTTPServer,
395
'HTTP/1.1': TestingThreadingHTTPServer,
398
# Whether or not we proxy the requests (see
399
# TestingHTTPRequestHandler.translate_path).
400
proxy_requests = False
402
263
# used to form the url that connects to this server
403
264
_url_protocol = 'http'
405
def __init__(self, request_handler=TestingHTTPRequestHandler,
406
protocol_version=None):
409
:param request_handler: a class that will be instantiated to handle an
410
http connection (one or several requests).
412
:param protocol_version: if specified, will override the protocol
413
version of the request handler.
415
transport.Server.__init__(self)
266
# Subclasses can provide a specific request handler
267
def __init__(self, request_handler=TestingHTTPRequestHandler):
268
Server.__init__(self)
416
269
self.request_handler = request_handler
417
self.host = 'localhost'
420
self.protocol_version = protocol_version
421
# Allows tests to verify number of GET requests issued
422
self.GET_request_nb = 0
424
271
def _get_httpd(self):
425
if self._httpd is None:
426
rhandler = self.request_handler
427
# Depending on the protocol version, we will create the approriate
429
if self.protocol_version is None:
430
# Use the request handler one
431
proto_vers = rhandler.protocol_version
433
# Use our own, it will be used to override the request handler
435
proto_vers = self.protocol_version
436
# Create the appropriate server for the required protocol
437
serv_cls = self.http_server_class.get(proto_vers, None)
439
raise httplib.UnknownProtocol(proto_vers)
441
self._httpd = serv_cls((self.host, self.port), rhandler, self)
442
host, self.port = self._httpd.socket.getsockname()
272
return TestingHTTPServer(('localhost', 0),
273
self.request_handler,
445
276
def _http_start(self):
446
"""Server thread main entry point. """
447
self._http_running = False
450
httpd = self._get_httpd()
451
self._http_base_url = '%s://%s:%s/' % (self._url_protocol,
452
self.host, self.port)
453
self._http_running = True
455
# Whatever goes wrong, we save the exception for the main
456
# thread. Note that since we are running in a thread, no signal
457
# can be received, so we don't care about KeyboardInterrupt.
458
self._http_exception = sys.exc_info()
460
# Release the lock or the main thread will block and the whole
462
self._http_starting.release()
278
httpd = self._get_httpd()
279
host, self.port = httpd.socket.getsockname()
280
self._http_base_url = '%s://localhost:%s/' % (self._url_protocol,
282
self._http_starting.release()
283
httpd.socket.settimeout(0.1)
464
# From now on, exceptions are taken care of by the
465
# SocketServer.BaseServer or the request handler.
466
285
while self._http_running:
468
# Really an HTTP connection but the python framework is generic
469
# and call them requests
470
287
httpd.handle_request()
471
288
except socket.timeout:
487
304
"""Capture Server log output."""
488
305
self.logs.append(format % args)
490
def setUp(self, backing_transport_server=None):
491
"""See bzrlib.transport.Server.setUp.
493
:param backing_transport_server: The transport that requests over this
494
protocol should be forwarded to. Note that this is currently not
497
# XXX: TODO: make the server back onto vfs_server rather than local
499
assert backing_transport_server is None or \
500
isinstance(backing_transport_server, local.LocalURLServer), \
501
"HTTPServer currently assumes local transport, got %s" % \
502
backing_transport_server
308
"""See bzrlib.transport.Server.setUp."""
503
309
self._home_dir = os.getcwdu()
504
310
self._local_path_parts = self._home_dir.split(os.path.sep)
311
self._http_starting = threading.Lock()
312
self._http_starting.acquire()
313
self._http_running = True
505
314
self._http_base_url = None
507
# Create the server thread
508
self._http_starting = threading.Lock()
509
self._http_starting.acquire()
510
315
self._http_thread = threading.Thread(target=self._http_start)
511
316
self._http_thread.setDaemon(True)
512
self._http_exception = None
513
317
self._http_thread.start()
515
318
# Wait for the server thread to start (i.e release the lock)
516
319
self._http_starting.acquire()
518
if self._http_exception is not None:
519
# Something went wrong during server start
520
exc_class, exc_value, exc_tb = self._http_exception
521
raise exc_class, exc_value, exc_tb
522
320
self._http_starting.release()
525
323
def tearDown(self):
526
324
"""See bzrlib.transport.Server.tearDown."""
527
self._httpd.tearDown()
528
325
self._http_running = False
529
# We don't need to 'self._http_thread.join()' here since the thread is
530
# a daemonic one and will be garbage collected anyway. Joining just
531
# slows us down for no added benefit.
326
self._http_thread.join()
533
328
def get_url(self):
534
329
"""See bzrlib.transport.Server.get_url."""
added
removed
bzrlib/tests/HttpServer.py
