1
# Copyright (C) 2005 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
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"""
42
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 SingleRangeRequestHandler(TestingHTTPRequestHandler):
154
"""Always reply to range request as if they were single.
156
Don't be explicit about it, just to annoy the clients.
159
def get_multiple_ranges(self, file, file_size, ranges):
160
"""Answer as if it was a single range request and ignores the rest"""
161
(start, end) = ranges[0]
162
return self.get_single_range(file, file_size, start, end)
165
class NoRangeRequestHandler(TestingHTTPRequestHandler):
166
"""Ignore range requests without notice"""
168
# Just bypass the range handling done by TestingHTTPRequestHandler
169
do_GET = SimpleHTTPRequestHandler.do_GET
172
class TestCaseWithWebserver(TestCaseWithTransport):
173
"""A support class that provides readonly urls that are http://.
175
This is done by forcing the readonly server to be an http
176
one. This will currently fail if the primary transport is not
177
backed by regular disk files.
180
super(TestCaseWithWebserver, self).setUp()
181
self.transport_readonly_server = HttpServer
184
class TestCaseWithTwoWebservers(TestCaseWithWebserver):
185
"""A support class providing readonly urls on two servers that are http://.
187
We set up two webservers to allows various tests involving
188
proxies or redirections from one server to the other.
191
super(TestCaseWithTwoWebservers, self).setUp()
192
self.transport_secondary_server = HttpServer
193
self.__secondary_server = None
195
def create_transport_secondary_server(self):
196
"""Create a transport server from class defined at init.
198
This is mostly a hook for daughter classes.
200
return self.transport_secondary_server()
202
def get_secondary_server(self):
203
"""Get the server instance for the secondary transport."""
204
if self.__secondary_server is None:
205
self.__secondary_server = self.create_transport_secondary_server()
206
self.__secondary_server.setUp()
207
self.addCleanup(self.__secondary_server.tearDown)
208
return self.__secondary_server
211
class ProxyServer(HttpServer):
212
"""A proxy test server for http transports."""
214
proxy_requests = True
217
class RedirectRequestHandler(TestingHTTPRequestHandler):
218
"""Redirect all request to the specified server"""
220
def parse_request(self):
221
"""Redirect a single HTTP request to another host"""
222
valid = TestingHTTPRequestHandler.parse_request(self)
224
tcs = self.server.test_case_server
225
code, target = tcs.is_redirected(self.path)
226
if code is not None and target is not None:
227
# Redirect as instructed
228
self.send_response(code)
229
self.send_header('Location', target)
231
return False # The job is done
233
# We leave the parent class serve the request
238
class HTTPServerRedirecting(HttpServer):
239
"""An HttpServer redirecting to another server """
241
def __init__(self, request_handler=RedirectRequestHandler):
242
HttpServer.__init__(self, request_handler)
243
# redirections is a list of tuples (source, target, code)
244
# - source is a regexp for the paths requested
245
# - target is a replacement for re.sub describing where
246
# the request will be redirected
247
# - code is the http error code associated to the
248
# redirection (301 permanent, 302 temporarry, etc
249
self.redirections = []
251
def redirect_to(self, host, port):
252
"""Redirect all requests to a specific host:port"""
253
self.redirections = [('(.*)',
254
r'http://%s:%s\1' % (host, port) ,
257
def is_redirected(self, path):
258
"""Is the path redirected by this server.
260
:param path: the requested relative path
262
:returns: a tuple (code, target) if a matching
263
redirection is found, (None, None) otherwise.
267
for (rsource, rtarget, rcode) in self.redirections:
268
target, match = re.subn(rsource, rtarget, path)
271
break # The first match wins
277
class TestCaseWithRedirectedWebserver(TestCaseWithTwoWebservers):
278
"""A support class providing redirections from one server to another.
280
We set up two webservers to allows various tests involving
282
The 'old' server is redirected to the 'new' server.
285
def create_transport_secondary_server(self):
286
"""Create the secondary server redirecting to the primary server"""
287
new = self.get_readonly_server()
288
redirecting = HTTPServerRedirecting()
289
redirecting.redirect_to(new.host, new.port)
293
super(TestCaseWithRedirectedWebserver, self).setUp()
294
# The redirections will point to the new server
295
self.new_server = self.get_readonly_server()
296
# The requests to the old server will be redirected
297
self.old_server = self.get_secondary_server()
300
class AuthRequestHandler(TestingHTTPRequestHandler):
301
"""Requires an authentication to process requests.
303
This is intended to be used with a server that always and
304
only use one authentication scheme (implemented by daughter
308
# The following attributes should be defined in the server
309
# - auth_header_sent: the header name sent to require auth
310
# - auth_header_recv: the header received containing auth
311
# - auth_error_code: the error code to indicate auth required
314
if self.authorized():
315
return TestingHTTPRequestHandler.do_GET(self)
317
# Note that we must update test_case_server *before*
318
# sending the error or the client may try to read it
319
# before we have sent the whole error back.
320
tcs = self.server.test_case_server
321
tcs.auth_required_errors += 1
322
self.send_response(tcs.auth_error_code)
323
self.send_header_auth_reqed()
327
TestingHTTPRequestHandler.do_GET(self)
330
class BasicAuthRequestHandler(AuthRequestHandler):
331
"""Implements the basic authentication of a request"""
333
def authorized(self):
334
tcs = self.server.test_case_server
335
if tcs.auth_scheme != 'basic':
338
auth_header = self.headers.get(tcs.auth_header_recv, None)
340
scheme, raw_auth = auth_header.split(' ', 1)
341
if scheme.lower() == tcs.auth_scheme:
342
user, password = raw_auth.decode('base64').split(':')
343
return tcs.authorized(user, password)
347
def send_header_auth_reqed(self):
348
tcs = self.server.test_case_server
349
self.send_header(tcs.auth_header_sent,
350
'Basic realm="%s"' % tcs.auth_realm)
353
# FIXME: We should send an Authentication-Info header too when
354
# the autheticaion is succesful
356
class DigestAuthRequestHandler(AuthRequestHandler):
357
"""Implements the digest authentication of a request.
359
We need persistence for some attributes and that can't be
360
achieved here since we get instantiated for each request. We
361
rely on the DigestAuthServer to take care of them.
364
def authorized(self):
365
tcs = self.server.test_case_server
366
if tcs.auth_scheme != 'digest':
369
auth_header = self.headers.get(tcs.auth_header_recv, None)
370
if auth_header is None:
372
scheme, auth = auth_header.split(None, 1)
373
if scheme.lower() == tcs.auth_scheme:
374
auth_dict = urllib2.parse_keqv_list(urllib2.parse_http_list(auth))
376
return tcs.digest_authorized(auth_dict, self.command)
380
def send_header_auth_reqed(self):
381
tcs = self.server.test_case_server
382
header = 'Digest realm="%s", ' % tcs.auth_realm
383
header += 'nonce="%s", algorithm=%s, qop=auth' % (tcs.auth_nonce, 'MD5')
384
self.send_header(tcs.auth_header_sent,header)
387
class AuthServer(HttpServer):
388
"""Extends HttpServer with a dictionary of passwords.
390
This is used as a base class for various schemes which should
391
all use or redefined the associated AuthRequestHandler.
393
Note that no users are defined by default, so add_user should
394
be called before issuing the first request.
397
# The following attributes should be set dy daughter classes
398
# and are used by AuthRequestHandler.
399
auth_header_sent = None
400
auth_header_recv = None
401
auth_error_code = None
402
auth_realm = "Thou should not pass"
404
def __init__(self, request_handler, auth_scheme):
405
HttpServer.__init__(self, request_handler)
406
self.auth_scheme = auth_scheme
407
self.password_of = {}
408
self.auth_required_errors = 0
410
def add_user(self, user, password):
411
"""Declare a user with an associated password.
413
password can be empty, use an empty string ('') in that
416
self.password_of[user] = password
418
def authorized(self, user, password):
419
"""Check that the given user provided the right password"""
420
expected_password = self.password_of.get(user, None)
421
return expected_password is not None and password == expected_password
424
class DigestAuthServer(AuthServer):
425
"""A digest authentication server"""
427
auth_nonce = 'rRQ+Lp4uBAA=301b77beb156b6158b73dee026b8be23302292b4'
429
def __init__(self, request_handler, auth_scheme):
430
AuthServer.__init__(self, request_handler, auth_scheme)
432
def digest_authorized(self, auth, command):
433
realm = auth['realm']
434
if realm != self.auth_realm:
436
user = auth['username']
437
if not self.password_of.has_key(user):
439
algorithm= auth['algorithm']
440
if algorithm != 'MD5':
446
password = self.password_of[user]
448
# Recalculate the response_digest to compare with the one
450
A1 = '%s:%s:%s' % (user, realm, password)
451
A2 = '%s:%s' % (command, auth['uri'])
453
H = lambda x: md5.new(x).hexdigest()
454
KD = lambda secret, data: H("%s:%s" % (secret, data))
456
nonce = auth['nonce']
457
nonce_count = int(auth['nc'], 16)
459
ncvalue = '%08x' % nonce_count
461
cnonce = auth['cnonce']
462
noncebit = '%s:%s:%s:%s:%s' % (nonce, ncvalue, cnonce, qop, H(A2))
463
response_digest = KD(H(A1), noncebit)
465
return response_digest == auth['response']
467
class HTTPAuthServer(AuthServer):
468
"""An HTTP server requiring authentication"""
470
def init_http_auth(self):
471
self.auth_header_sent = 'WWW-Authenticate'
472
self.auth_header_recv = 'Authorization'
473
self.auth_error_code = 401
476
class ProxyAuthServer(AuthServer):
477
"""A proxy server requiring authentication"""
479
def init_proxy_auth(self):
480
self.proxy_requests = True
481
self.auth_header_sent = 'Proxy-Authenticate'
482
self.auth_header_recv = 'Proxy-Authorization'
483
self.auth_error_code = 407
486
class HTTPBasicAuthServer(HTTPAuthServer):
487
"""An HTTP server requiring basic authentication"""
490
HTTPAuthServer.__init__(self, BasicAuthRequestHandler, 'basic')
491
self.init_http_auth()
494
class HTTPDigestAuthServer(DigestAuthServer, HTTPAuthServer):
495
"""An HTTP server requiring digest authentication"""
498
DigestAuthServer.__init__(self, DigestAuthRequestHandler, 'digest')
499
self.init_http_auth()
502
class ProxyBasicAuthServer(ProxyAuthServer):
503
"""A proxy server requiring basic authentication"""
506
ProxyAuthServer.__init__(self, BasicAuthRequestHandler, 'basic')
507
self.init_proxy_auth()
510
class ProxyDigestAuthServer(DigestAuthServer, ProxyAuthServer):
511
"""A proxy server requiring basic authentication"""
514
ProxyAuthServer.__init__(self, DigestAuthRequestHandler, 'digest')
515
self.init_proxy_auth()
added
removed
bzrlib/tests/HTTPTestUtil.py
