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
17
17
from cStringIO import StringIO
20
from SimpleHTTPServer import SimpleHTTPRequestHandler
28
from bzrlib.smart import (
31
from bzrlib.tests import http_server
32
from bzrlib.transport import chroot
35
class HTTPServerWithSmarts(http_server.HttpServer):
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):
36
112
"""HTTPServerWithSmarts extends the HttpServer with POST methods that will
37
113
trigger a smart server to execute with a transport rooted at the rootdir of
41
def __init__(self, protocol_version=None):
42
http_server.HttpServer.__init__(self, SmartRequestHandler,
43
protocol_version=protocol_version)
46
class SmartRequestHandler(http_server.TestingHTTPRequestHandler):
47
"""Extend TestingHTTPRequestHandler to support smart client POSTs.
49
XXX: This duplicates a fair bit of the logic in bzrlib.transport.http.wsgi.
118
HttpServer.__init__(self, SmartRequestHandler)
121
class SmartRequestHandler(TestingHTTPRequestHandler):
122
"""Extend TestingHTTPRequestHandler to support smart client POSTs."""
52
124
def do_POST(self):
53
125
"""Hand the request off to a smart server instance."""
54
backing = transport.get_transport_from_path(
55
self.server.test_case_server._home_dir)
56
chroot_server = chroot.ChrootServer(backing)
57
chroot_server.start_server()
59
t = transport.get_transport_from_url(chroot_server.get_url())
62
chroot_server.stop_server()
64
def do_POST_inner(self, chrooted_transport):
65
126
self.send_response(200)
66
127
self.send_header("Content-type", "application/octet-stream")
67
if not self.path.endswith('.bzr/smart'):
69
'POST to path not ending in .bzr/smart: %r' % (self.path,))
70
t = chrooted_transport.clone(self.path[:-len('.bzr/smart')])
71
# if this fails, we should return 400 bad request, but failure is
72
# failure for now - RBC 20060919
73
data_length = int(self.headers['Content-Length'])
128
transport = get_transport(self.server.test_case_server._home_dir)
74
129
# TODO: We might like to support streaming responses. 1.0 allows no
75
130
# Content-length in this case, so for integrity we should perform our
76
131
# own chunking within the stream.
78
133
# the HTTP chunking as this will allow HTTP persistence safely, even if
79
134
# we have to stop early due to error, but we would also have to use the
80
135
# HTTP trailer facility which may not be widely available.
81
request_bytes = self.rfile.read(data_length)
82
protocol_factory, unused_bytes = medium._get_protocol_factory_for_bytes(
84
136
out_buffer = StringIO()
85
smart_protocol_request = protocol_factory(t, out_buffer.write, '/')
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'])
86
142
# Perhaps there should be a SmartServerHTTPMedium that takes care of
87
143
# feeding the bytes in the http request to the smart_protocol_request,
88
144
# but for now it's simpler to just feed the bytes directly.
89
smart_protocol_request.accept_bytes(unused_bytes)
90
if not (smart_protocol_request.next_read_size() == 0):
91
raise errors.SmartProtocolError(
92
"not finished reading, but all data sent to protocol.")
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.")
93
148
self.send_header("Content-Length", str(len(out_buffer.getvalue())))
94
149
self.end_headers()
95
150
self.wfile.write(out_buffer.getvalue())
98
class TestCaseWithWebserver(tests.TestCaseWithTransport):
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 SingleOnlyRangeRequestHandler(TestingHTTPRequestHandler):
166
"""Only reply to simple range requests, errors out on multiple"""
168
def get_multiple_ranges(self, file, file_size, ranges):
169
"""Refuses the multiple ranges request"""
172
self.send_error(416, "Requested range not satisfiable")
174
(start, end) = ranges[0]
175
return self.get_single_range(file, file_size, start, end)
178
class NoRangeRequestHandler(TestingHTTPRequestHandler):
179
"""Ignore range requests without notice"""
181
# Just bypass the range handling done by TestingHTTPRequestHandler
182
do_GET = SimpleHTTPRequestHandler.do_GET
185
class TestCaseWithWebserver(TestCaseWithTransport):
99
186
"""A support class that provides readonly urls that are http://.
101
188
This is done by forcing the readonly server to be an http
102
189
one. This will currently fail if the primary transport is not
103
190
backed by regular disk files.
106
# These attributes can be overriden or parametrized by daughter clasess if
107
# needed, but must exist so that the create_transport_readonly_server()
108
# method (or any method creating an http(s) server) can propagate it.
109
_protocol_version = None
110
_url_protocol = 'http'
113
193
super(TestCaseWithWebserver, self).setUp()
114
self.transport_readonly_server = http_server.HttpServer
116
def create_transport_readonly_server(self):
117
server = self.transport_readonly_server(
118
protocol_version=self._protocol_version)
119
server._url_protocol = self._url_protocol
194
self.transport_readonly_server = HttpServer
123
197
class TestCaseWithTwoWebservers(TestCaseWithWebserver):
137
211
This is mostly a hook for daughter classes.
139
server = self.transport_secondary_server(
140
protocol_version=self._protocol_version)
141
server._url_protocol = self._url_protocol
213
return self.transport_secondary_server()
144
215
def get_secondary_server(self):
145
216
"""Get the server instance for the secondary transport."""
146
217
if self.__secondary_server is None:
147
218
self.__secondary_server = self.create_transport_secondary_server()
148
self.start_server(self.__secondary_server)
219
self.__secondary_server.setUp()
220
self.addCleanup(self.__secondary_server.tearDown)
149
221
return self.__secondary_server
151
def get_secondary_url(self, relpath=None):
152
base = self.get_secondary_server().get_url()
153
return self._adjust_url(base, relpath)
155
def get_secondary_transport(self, relpath=None):
156
t = transport.get_transport_from_url(self.get_secondary_url(relpath))
157
self.assertTrue(t.is_readonly())
161
class ProxyServer(http_server.HttpServer):
224
class ProxyServer(HttpServer):
162
225
"""A proxy test server for http transports."""
164
227
proxy_requests = True
167
class RedirectRequestHandler(http_server.TestingHTTPRequestHandler):
230
class RedirectRequestHandler(TestingHTTPRequestHandler):
168
231
"""Redirect all request to the specified server"""
170
233
def parse_request(self):
171
234
"""Redirect a single HTTP request to another host"""
172
valid = http_server.TestingHTTPRequestHandler.parse_request(self)
235
valid = TestingHTTPRequestHandler.parse_request(self)
174
237
tcs = self.server.test_case_server
175
238
code, target = tcs.is_redirected(self.path)
236
295
The 'old' server is redirected to the 'new' server.
298
def create_transport_secondary_server(self):
299
"""Create the secondary server redirecting to the primary server"""
300
new = self.get_readonly_server()
301
redirecting = HTTPServerRedirecting()
302
redirecting.redirect_to(new.host, new.port)
240
306
super(TestCaseWithRedirectedWebserver, self).setUp()
241
307
# The redirections will point to the new server
242
308
self.new_server = self.get_readonly_server()
243
# The requests to the old server will be redirected to the new server
309
# The requests to the old server will be redirected
244
310
self.old_server = self.get_secondary_server()
246
def create_transport_secondary_server(self):
247
"""Create the secondary server redirecting to the primary server"""
248
new = self.get_readonly_server()
249
redirecting = HTTPServerRedirecting(
250
protocol_version=self._protocol_version)
251
redirecting.redirect_to(new.host, new.port)
252
redirecting._url_protocol = self._url_protocol
255
def get_old_url(self, relpath=None):
256
base = self.old_server.get_url()
257
return self._adjust_url(base, relpath)
259
def get_old_transport(self, relpath=None):
260
t = transport.get_transport_from_url(self.get_old_url(relpath))
261
self.assertTrue(t.is_readonly())
264
def get_new_url(self, relpath=None):
265
base = self.new_server.get_url()
266
return self._adjust_url(base, relpath)
268
def get_new_transport(self, relpath=None):
269
t = transport.get_transport_from_url(self.get_new_url(relpath))
270
self.assertTrue(t.is_readonly())
274
class AuthRequestHandler(http_server.TestingHTTPRequestHandler):
313
class AuthRequestHandler(TestingHTTPRequestHandler):
275
314
"""Requires an authentication to process requests.
277
316
This is intended to be used with a server that always and
284
323
# - auth_header_recv: the header received containing auth
285
324
# - auth_error_code: the error code to indicate auth required
287
def _require_authentication(self):
288
# Note that we must update test_case_server *before*
289
# sending the error or the client may try to read it
290
# before we have sent the whole error back.
291
tcs = self.server.test_case_server
292
tcs.auth_required_errors += 1
293
self.send_response(tcs.auth_error_code)
294
self.send_header_auth_reqed()
295
# We do not send a body
296
self.send_header('Content-Length', '0')
300
326
def do_GET(self):
301
327
if self.authorized():
302
return http_server.TestingHTTPRequestHandler.do_GET(self)
328
return TestingHTTPRequestHandler.do_GET(self)
304
return self._require_authentication()
330
# Note that we must update test_case_server *before*
331
# sending the error or the client may try to read it
332
# before we have sent the whole error back.
333
tcs = self.server.test_case_server
334
tcs.auth_required_errors += 1
335
self.send_response(tcs.auth_error_code)
336
self.send_header_auth_reqed()
307
if self.authorized():
308
return http_server.TestingHTTPRequestHandler.do_HEAD(self)
310
return self._require_authentication()
340
TestingHTTPRequestHandler.do_GET(self)
313
343
class BasicAuthRequestHandler(AuthRequestHandler):
366
398
self.send_header(tcs.auth_header_sent,header)
369
class DigestAndBasicAuthRequestHandler(DigestAuthRequestHandler):
370
"""Implements a digest and basic authentication of a request.
372
I.e. the server proposes both schemes and the client should choose the best
373
one it can handle, which, in that case, should be digest, the only scheme
377
def send_header_auth_reqed(self):
378
tcs = self.server.test_case_server
379
self.send_header(tcs.auth_header_sent,
380
'Basic realm="%s"' % tcs.auth_realm)
381
header = 'Digest realm="%s", ' % tcs.auth_realm
382
header += 'nonce="%s", algorithm="%s", qop="auth"' % (tcs.auth_nonce,
384
self.send_header(tcs.auth_header_sent,header)
387
class AuthServer(http_server.HttpServer):
401
class AuthServer(HttpServer):
388
402
"""Extends HttpServer with a dictionary of passwords.
390
404
This is used as a base class for various schemes which should
498
507
class HTTPBasicAuthServer(HTTPAuthServer):
499
508
"""An HTTP server requiring basic authentication"""
501
def __init__(self, protocol_version=None):
502
HTTPAuthServer.__init__(self, BasicAuthRequestHandler, 'basic',
503
protocol_version=protocol_version)
511
HTTPAuthServer.__init__(self, BasicAuthRequestHandler, 'basic')
504
512
self.init_http_auth()
507
515
class HTTPDigestAuthServer(DigestAuthServer, HTTPAuthServer):
508
516
"""An HTTP server requiring digest authentication"""
510
def __init__(self, protocol_version=None):
511
DigestAuthServer.__init__(self, DigestAuthRequestHandler, 'digest',
512
protocol_version=protocol_version)
513
self.init_http_auth()
516
class HTTPBasicAndDigestAuthServer(DigestAuthServer, HTTPAuthServer):
517
"""An HTTP server requiring basic or digest authentication"""
519
def __init__(self, protocol_version=None):
520
DigestAuthServer.__init__(self, DigestAndBasicAuthRequestHandler,
522
protocol_version=protocol_version)
523
self.init_http_auth()
524
# We really accept Digest only
525
self.auth_scheme = 'digest'
519
DigestAuthServer.__init__(self, DigestAuthRequestHandler, 'digest')
520
self.init_http_auth()
528
523
class ProxyBasicAuthServer(ProxyAuthServer):
529
524
"""A proxy server requiring basic authentication"""
531
def __init__(self, protocol_version=None):
532
ProxyAuthServer.__init__(self, BasicAuthRequestHandler, 'basic',
533
protocol_version=protocol_version)
527
ProxyAuthServer.__init__(self, BasicAuthRequestHandler, 'basic')
534
528
self.init_proxy_auth()
537
531
class ProxyDigestAuthServer(DigestAuthServer, ProxyAuthServer):
538
532
"""A proxy server requiring basic authentication"""
540
def __init__(self, protocol_version=None):
541
ProxyAuthServer.__init__(self, DigestAuthRequestHandler, 'digest',
542
protocol_version=protocol_version)
543
self.init_proxy_auth()
546
class ProxyBasicAndDigestAuthServer(DigestAuthServer, ProxyAuthServer):
547
"""An proxy server requiring basic or digest authentication"""
549
def __init__(self, protocol_version=None):
550
DigestAuthServer.__init__(self, DigestAndBasicAuthRequestHandler,
552
protocol_version=protocol_version)
553
self.init_proxy_auth()
554
# We really accept Digest only
555
self.auth_scheme = 'digest'
535
ProxyAuthServer.__init__(self, DigestAuthRequestHandler, 'digest')
536
self.init_proxy_auth()
added
removed
bzrlib/tests/HTTPTestUtil.py
