1
# Copyright (C) 2005 Canonical Ltd
1
# Copyright (C) 2005 by Canonical Ltd
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
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
from cStringIO import StringIO
20
from SimpleHTTPServer import SimpleHTTPRequestHandler
28
from bzrlib.smart import protocol
29
from bzrlib.tests import TestCaseWithTransport
30
from bzrlib.tests.HttpServer import (
32
TestingHTTPRequestHandler,
34
from bzrlib.transport import (
39
class WallRequestHandler(TestingHTTPRequestHandler):
40
"""Whatever request comes in, close the connection"""
17
import BaseHTTPServer, SimpleHTTPServer, socket, errno, time
18
from bzrlib.selftest import TestCaseInTempDir
21
class WebserverNotAvailable(Exception):
24
class BadWebserverPath(ValueError):
26
return 'path %s is not in %s' % self.args
28
class TestingHTTPRequestHandler(SimpleHTTPServer.SimpleHTTPRequestHandler):
29
def log_message(self, format, *args):
30
self.server.test_case.log("webserver - %s - - [%s] %s" %
31
(self.address_string(),
32
self.log_date_time_string(),
42
35
def handle_one_request(self):
43
"""Handle a single HTTP request, by abruptly closing the connection"""
44
self.close_connection = 1
47
class BadStatusRequestHandler(TestingHTTPRequestHandler):
48
"""Whatever request comes in, returns a bad status"""
50
def parse_request(self):
51
"""Fakes handling a single HTTP request, returns a bad status"""
52
ignored = TestingHTTPRequestHandler.parse_request(self)
54
self.send_response(0, "Bad status")
56
except socket.error, e:
57
# We don't want to pollute the test results with
58
# spurious server errors while test succeed. In our
59
# case, it may occur that the test has already read
60
# the 'Bad Status' and closed the socket while we are
61
# still trying to send some headers... So the test is
62
# ok, but if we raise the exception, the output is
63
# dirty. So we don't raise, but we close the
64
# connection, just to be safe :)
65
spurious = [errno.EPIPE,
69
if (len(e.args) > 0) and (e.args[0] in spurious):
70
self.close_connection = 1
77
class InvalidStatusRequestHandler(TestingHTTPRequestHandler):
78
"""Whatever request comes in, returns am invalid status"""
80
def parse_request(self):
81
"""Fakes handling a single HTTP request, returns a bad status"""
82
ignored = TestingHTTPRequestHandler.parse_request(self)
83
self.wfile.write("Invalid status line\r\n")
87
class BadProtocolRequestHandler(TestingHTTPRequestHandler):
88
"""Whatever request comes in, returns a bad protocol version"""
90
def parse_request(self):
91
"""Fakes handling a single HTTP request, returns a bad status"""
92
ignored = TestingHTTPRequestHandler.parse_request(self)
93
# Returns an invalid protocol version, but curl just
94
# ignores it and those cannot be tested.
95
self.wfile.write("%s %d %s\r\n" % ('HTTP/0.0',
97
'Look at my protocol version'))
101
class ForbiddenRequestHandler(TestingHTTPRequestHandler):
102
"""Whatever request comes in, returns a 403 code"""
104
def parse_request(self):
105
"""Handle a single HTTP request, by replying we cannot handle it"""
106
ignored = TestingHTTPRequestHandler.parse_request(self)
111
class HTTPServerWithSmarts(HttpServer):
112
"""HTTPServerWithSmarts extends the HttpServer with POST methods that will
113
trigger a smart server to execute with a transport rooted at the rootdir of
118
HttpServer.__init__(self, SmartRequestHandler)
121
class SmartRequestHandler(TestingHTTPRequestHandler):
122
"""Extend TestingHTTPRequestHandler to support smart client POSTs."""
125
"""Hand the request off to a smart server instance."""
126
self.send_response(200)
127
self.send_header("Content-type", "application/octet-stream")
128
transport = get_transport(self.server.test_case_server._home_dir)
129
# TODO: We might like to support streaming responses. 1.0 allows no
130
# Content-length in this case, so for integrity we should perform our
131
# own chunking within the stream.
132
# 1.1 allows chunked responses, and in this case we could chunk using
133
# the HTTP chunking as this will allow HTTP persistence safely, even if
134
# we have to stop early due to error, but we would also have to use the
135
# HTTP trailer facility which may not be widely available.
136
out_buffer = StringIO()
137
smart_protocol_request = protocol.SmartServerRequestProtocolOne(
138
transport, out_buffer.write)
139
# if this fails, we should return 400 bad request, but failure is
140
# failure for now - RBC 20060919
141
data_length = int(self.headers['Content-Length'])
142
# Perhaps there should be a SmartServerHTTPMedium that takes care of
143
# feeding the bytes in the http request to the smart_protocol_request,
144
# but for now it's simpler to just feed the bytes directly.
145
smart_protocol_request.accept_bytes(self.rfile.read(data_length))
146
assert smart_protocol_request.next_read_size() == 0, (
147
"not finished reading, but all data sent to protocol.")
148
self.send_header("Content-Length", str(len(out_buffer.getvalue())))
150
self.wfile.write(out_buffer.getvalue())
153
class LimitedRangeRequestHandler(TestingHTTPRequestHandler):
154
"""Errors out when range specifiers exceed the limit"""
156
def get_multiple_ranges(self, file, file_size, ranges):
157
"""Refuses the multiple ranges request"""
158
tcs = self.server.test_case_server
159
if tcs.range_limit is not None and len(ranges) > tcs.range_limit:
161
# Emulate apache behavior
162
self.send_error(400, "Bad Request")
164
return TestingHTTPRequestHandler.get_multiple_ranges(self, file,
168
tcs = self.server.test_case_server
169
tcs.GET_request_nb += 1
170
return TestingHTTPRequestHandler.do_GET(self)
173
class LimitedRangeHTTPServer(HttpServer):
174
"""An HttpServer erroring out on requests with too much range specifiers"""
176
def __init__(self, request_handler=LimitedRangeRequestHandler,
178
HttpServer.__init__(self, request_handler)
179
self.range_limit = range_limit
180
self.GET_request_nb = 0
183
class SingleRangeRequestHandler(TestingHTTPRequestHandler):
184
"""Always reply to range request as if they were single.
186
Don't be explicit about it, just to annoy the clients.
189
def get_multiple_ranges(self, file, file_size, ranges):
190
"""Answer as if it was a single range request and ignores the rest"""
191
(start, end) = ranges[0]
192
return self.get_single_range(file, file_size, start, end)
195
class SingleOnlyRangeRequestHandler(TestingHTTPRequestHandler):
196
"""Only reply to simple range requests, errors out on multiple"""
198
def get_multiple_ranges(self, file, file_size, ranges):
199
"""Refuses the multiple ranges request"""
202
self.send_error(416, "Requested range not satisfiable")
204
(start, end) = ranges[0]
205
return self.get_single_range(file, file_size, start, end)
208
class NoRangeRequestHandler(TestingHTTPRequestHandler):
209
"""Ignore range requests without notice"""
211
# Just bypass the range handling done by TestingHTTPRequestHandler
212
do_GET = SimpleHTTPRequestHandler.do_GET
215
class TestCaseWithWebserver(TestCaseWithTransport):
216
"""A support class that provides readonly urls that are http://.
218
This is done by forcing the readonly server to be an http
219
one. This will currently fail if the primary transport is not
220
backed by regular disk files.
223
super(TestCaseWithWebserver, self).setUp()
224
self.transport_readonly_server = HttpServer
227
class TestCaseWithTwoWebservers(TestCaseWithWebserver):
228
"""A support class providing readonly urls on two servers that are http://.
230
We set up two webservers to allows various tests involving
231
proxies or redirections from one server to the other.
234
super(TestCaseWithTwoWebservers, self).setUp()
235
self.transport_secondary_server = HttpServer
236
self.__secondary_server = None
238
def create_transport_secondary_server(self):
239
"""Create a transport server from class defined at init.
241
This is mostly a hook for daughter classes.
243
return self.transport_secondary_server()
245
def get_secondary_server(self):
246
"""Get the server instance for the secondary transport."""
247
if self.__secondary_server is None:
248
self.__secondary_server = self.create_transport_secondary_server()
249
self.__secondary_server.setUp()
250
self.addCleanup(self.__secondary_server.tearDown)
251
return self.__secondary_server
254
class ProxyServer(HttpServer):
255
"""A proxy test server for http transports."""
257
proxy_requests = True
260
class RedirectRequestHandler(TestingHTTPRequestHandler):
261
"""Redirect all request to the specified server"""
263
def parse_request(self):
264
"""Redirect a single HTTP request to another host"""
265
valid = TestingHTTPRequestHandler.parse_request(self)
267
tcs = self.server.test_case_server
268
code, target = tcs.is_redirected(self.path)
269
if code is not None and target is not None:
270
# Redirect as instructed
271
self.send_response(code)
272
self.send_header('Location', target)
274
return False # The job is done
276
# We leave the parent class serve the request
281
class HTTPServerRedirecting(HttpServer):
282
"""An HttpServer redirecting to another server """
284
def __init__(self, request_handler=RedirectRequestHandler):
285
HttpServer.__init__(self, request_handler)
286
# redirections is a list of tuples (source, target, code)
287
# - source is a regexp for the paths requested
288
# - target is a replacement for re.sub describing where
289
# the request will be redirected
290
# - code is the http error code associated to the
291
# redirection (301 permanent, 302 temporarry, etc
292
self.redirections = []
294
def redirect_to(self, host, port):
295
"""Redirect all requests to a specific host:port"""
296
self.redirections = [('(.*)',
297
r'http://%s:%s\1' % (host, port) ,
300
def is_redirected(self, path):
301
"""Is the path redirected by this server.
303
:param path: the requested relative path
305
:returns: a tuple (code, target) if a matching
306
redirection is found, (None, None) otherwise.
310
for (rsource, rtarget, rcode) in self.redirections:
311
target, match = re.subn(rsource, rtarget, path)
314
break # The first match wins
320
class TestCaseWithRedirectedWebserver(TestCaseWithTwoWebservers):
321
"""A support class providing redirections from one server to another.
323
We set up two webservers to allows various tests involving
325
The 'old' server is redirected to the 'new' server.
328
def create_transport_secondary_server(self):
329
"""Create the secondary server redirecting to the primary server"""
330
new = self.get_readonly_server()
331
redirecting = HTTPServerRedirecting()
332
redirecting.redirect_to(new.host, new.port)
336
super(TestCaseWithRedirectedWebserver, self).setUp()
337
# The redirections will point to the new server
338
self.new_server = self.get_readonly_server()
339
# The requests to the old server will be redirected
340
self.old_server = self.get_secondary_server()
343
class AuthRequestHandler(TestingHTTPRequestHandler):
344
"""Requires an authentication to process requests.
346
This is intended to be used with a server that always and
347
only use one authentication scheme (implemented by daughter
351
# The following attributes should be defined in the server
352
# - auth_header_sent: the header name sent to require auth
353
# - auth_header_recv: the header received containing auth
354
# - auth_error_code: the error code to indicate auth required
357
if self.authorized():
358
return TestingHTTPRequestHandler.do_GET(self)
36
"""Handle a single HTTP request.
38
You normally don't need to override this method; see the class
39
__doc__ string for information on how to handle specific HTTP
40
commands such as GET and POST.
43
for i in xrange(1,11): # Don't try more than 10 times
45
self.raw_requestline = self.rfile.readline()
46
except socket.error, e:
47
if e.args[0] == errno.EAGAIN:
48
self.log_message('EAGAIN (%d) while reading from raw_requestline' % i)
54
if not self.raw_requestline:
55
self.close_connection = 1
57
if not self.parse_request(): # An error code has been sent, just exit
59
mname = 'do_' + self.command
60
if not hasattr(self, mname):
61
self.send_error(501, "Unsupported method (%r)" % self.command)
63
method = getattr(self, mname)
66
class TestingHTTPServer(BaseHTTPServer.HTTPServer):
67
def __init__(self, server_address, RequestHandlerClass, test_case):
68
BaseHTTPServer.HTTPServer.__init__(self, server_address,
70
self.test_case = test_case
73
class TestCaseWithWebserver(TestCaseInTempDir):
74
"""Derived class that starts a localhost-only webserver
75
(in addition to what TestCaseInTempDir does).
77
This is useful for testing RemoteBranch.
80
_HTTP_PORTS = range(13000, 0x8000)
82
def _http_start(self):
83
import SimpleHTTPServer, BaseHTTPServer, socket, errno
85
for port in self._HTTP_PORTS:
87
httpd = TestingHTTPServer(('localhost', port),
88
TestingHTTPRequestHandler,
90
except socket.error, e:
91
if e.args[0] == errno.EADDRINUSE:
93
print >>sys.stderr, "Cannot run webserver :-("
99
raise WebserverNotAvailable("Cannot run webserver :-( "
100
"no free ports in range %s..%s" %
101
(_HTTP_PORTS[0], _HTTP_PORTS[-1]))
103
self._http_base_url = 'http://localhost:%s/' % port
104
self._http_starting.release()
105
httpd.socket.settimeout(0.1)
107
while self._http_running:
109
httpd.handle_request()
110
except socket.timeout:
113
def get_remote_url(self, path):
116
path_parts = path.split(os.path.sep)
117
if os.path.isabs(path):
118
if path_parts[:len(self._local_path_parts)] != \
119
self._local_path_parts:
120
raise BadWebserverPath(path, self.test_dir)
121
remote_path = '/'.join(path_parts[len(self._local_path_parts):])
360
# Note that we must update test_case_server *before*
361
# sending the error or the client may try to read it
362
# before we have sent the whole error back.
363
tcs = self.server.test_case_server
364
tcs.auth_required_errors += 1
365
self.send_response(tcs.auth_error_code)
366
self.send_header_auth_reqed()
371
class BasicAuthRequestHandler(AuthRequestHandler):
372
"""Implements the basic authentication of a request"""
374
def authorized(self):
375
tcs = self.server.test_case_server
376
if tcs.auth_scheme != 'basic':
379
auth_header = self.headers.get(tcs.auth_header_recv, None)
381
scheme, raw_auth = auth_header.split(' ', 1)
382
if scheme.lower() == tcs.auth_scheme:
383
user, password = raw_auth.decode('base64').split(':')
384
return tcs.authorized(user, password)
388
def send_header_auth_reqed(self):
389
tcs = self.server.test_case_server
390
self.send_header(tcs.auth_header_sent,
391
'Basic realm="%s"' % tcs.auth_realm)
394
# FIXME: We could send an Authentication-Info header too when
395
# the authentication is succesful
397
class DigestAuthRequestHandler(AuthRequestHandler):
398
"""Implements the digest authentication of a request.
400
We need persistence for some attributes and that can't be
401
achieved here since we get instantiated for each request. We
402
rely on the DigestAuthServer to take care of them.
405
def authorized(self):
406
tcs = self.server.test_case_server
407
if tcs.auth_scheme != 'digest':
410
auth_header = self.headers.get(tcs.auth_header_recv, None)
411
if auth_header is None:
413
scheme, auth = auth_header.split(None, 1)
414
if scheme.lower() == tcs.auth_scheme:
415
auth_dict = urllib2.parse_keqv_list(urllib2.parse_http_list(auth))
417
return tcs.digest_authorized(auth_dict, self.command)
421
def send_header_auth_reqed(self):
422
tcs = self.server.test_case_server
423
header = 'Digest realm="%s", ' % tcs.auth_realm
424
header += 'nonce="%s", algorithm="%s", qop="auth"' % (tcs.auth_nonce,
426
self.send_header(tcs.auth_header_sent,header)
429
class AuthServer(HttpServer):
430
"""Extends HttpServer with a dictionary of passwords.
432
This is used as a base class for various schemes which should
433
all use or redefined the associated AuthRequestHandler.
435
Note that no users are defined by default, so add_user should
436
be called before issuing the first request.
439
# The following attributes should be set dy daughter classes
440
# and are used by AuthRequestHandler.
441
auth_header_sent = None
442
auth_header_recv = None
443
auth_error_code = None
444
auth_realm = "Thou should not pass"
446
def __init__(self, request_handler, auth_scheme):
447
HttpServer.__init__(self, request_handler)
448
self.auth_scheme = auth_scheme
449
self.password_of = {}
450
self.auth_required_errors = 0
452
def add_user(self, user, password):
453
"""Declare a user with an associated password.
455
password can be empty, use an empty string ('') in that
458
self.password_of[user] = password
460
def authorized(self, user, password):
461
"""Check that the given user provided the right password"""
462
expected_password = self.password_of.get(user, None)
463
return expected_password is not None and password == expected_password
466
# FIXME: There is some code duplication with
467
# _urllib2_wrappers.py.DigestAuthHandler. If that duplciation
468
# grows, it may require a refactoring. Also, we don't implement
469
# SHA algorithm nor MD5-sess here, but that does not seem worth
471
class DigestAuthServer(AuthServer):
472
"""A digest authentication server"""
476
def __init__(self, request_handler, auth_scheme):
477
AuthServer.__init__(self, request_handler, auth_scheme)
479
def digest_authorized(self, auth, command):
480
nonce = auth['nonce']
481
if nonce != self.auth_nonce:
483
realm = auth['realm']
484
if realm != self.auth_realm:
486
user = auth['username']
487
if not self.password_of.has_key(user):
489
algorithm= auth['algorithm']
490
if algorithm != 'MD5':
496
password = self.password_of[user]
498
# Recalculate the response_digest to compare with the one
500
A1 = '%s:%s:%s' % (user, realm, password)
501
A2 = '%s:%s' % (command, auth['uri'])
503
H = lambda x: md5.new(x).hexdigest()
504
KD = lambda secret, data: H("%s:%s" % (secret, data))
506
nonce_count = int(auth['nc'], 16)
508
ncvalue = '%08x' % nonce_count
510
cnonce = auth['cnonce']
511
noncebit = '%s:%s:%s:%s:%s' % (nonce, ncvalue, cnonce, qop, H(A2))
512
response_digest = KD(H(A1), noncebit)
514
return response_digest == auth['response']
516
class HTTPAuthServer(AuthServer):
517
"""An HTTP server requiring authentication"""
519
def init_http_auth(self):
520
self.auth_header_sent = 'WWW-Authenticate'
521
self.auth_header_recv = 'Authorization'
522
self.auth_error_code = 401
525
class ProxyAuthServer(AuthServer):
526
"""A proxy server requiring authentication"""
528
def init_proxy_auth(self):
529
self.proxy_requests = True
530
self.auth_header_sent = 'Proxy-Authenticate'
531
self.auth_header_recv = 'Proxy-Authorization'
532
self.auth_error_code = 407
535
class HTTPBasicAuthServer(HTTPAuthServer):
536
"""An HTTP server requiring basic authentication"""
539
HTTPAuthServer.__init__(self, BasicAuthRequestHandler, 'basic')
540
self.init_http_auth()
543
class HTTPDigestAuthServer(DigestAuthServer, HTTPAuthServer):
544
"""An HTTP server requiring digest authentication"""
547
DigestAuthServer.__init__(self, DigestAuthRequestHandler, 'digest')
548
self.init_http_auth()
551
class ProxyBasicAuthServer(ProxyAuthServer):
552
"""A proxy server requiring basic authentication"""
555
ProxyAuthServer.__init__(self, BasicAuthRequestHandler, 'basic')
556
self.init_proxy_auth()
559
class ProxyDigestAuthServer(DigestAuthServer, ProxyAuthServer):
560
"""A proxy server requiring basic authentication"""
563
ProxyAuthServer.__init__(self, DigestAuthRequestHandler, 'digest')
564
self.init_proxy_auth()
123
remote_path = '/'.join(path_parts)
125
self._http_starting.acquire()
126
self._http_starting.release()
127
return self._http_base_url + remote_path
130
TestCaseInTempDir.setUp(self)
132
self._local_path_parts = self.test_dir.split(os.path.sep)
133
self._http_starting = threading.Lock()
134
self._http_starting.acquire()
135
self._http_running = True
136
self._http_base_url = None
137
self._http_thread = threading.Thread(target=self._http_start)
138
self._http_thread.setDaemon(True)
139
self._http_thread.start()
140
self._http_proxy = os.environ.get("http_proxy")
141
if self._http_proxy is not None:
142
del os.environ["http_proxy"]
145
self._http_running = False
146
self._http_thread.join()
147
if self._http_proxy is not None:
149
os.environ["http_proxy"] = self._http_proxy
150
TestCaseInTempDir.tearDown(self)
added
removed
bzrlib/selftest/HTTPTestUtil.py
