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
19
from SimpleHTTPServer import SimpleHTTPRequestHandler
24
from bzrlib.tests import TestCaseWithTransport
25
from bzrlib.tests.HttpServer import (
27
TestingHTTPRequestHandler,
29
from bzrlib.transport import (
32
from bzrlib.smart import protocol
35
class WallRequestHandler(TestingHTTPRequestHandler):
36
"""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(),
38
35
def handle_one_request(self):
39
"""Handle a single HTTP request, by abruptly closing the connection"""
40
self.close_connection = 1
43
class BadStatusRequestHandler(TestingHTTPRequestHandler):
44
"""Whatever request comes in, returns a bad status"""
46
def parse_request(self):
47
"""Fakes handling a single HTTP request, returns a bad status"""
48
ignored = TestingHTTPRequestHandler.parse_request(self)
50
self.send_response(0, "Bad status")
52
except socket.error, e:
53
# We don't want to pollute the test results with
54
# spurious server errors while test succeed. In our
55
# case, it may occur that the test has already read
56
# the 'Bad Status' and closed the socket while we are
57
# still trying to send some headers... So the test is
58
# ok, but if we raise the exception, the output is
59
# dirty. So we don't raise, but we close the
60
# connection, just to be safe :)
61
spurious = [errno.EPIPE,
65
if (len(e.args) > 0) and (e.args[0] in spurious):
66
self.close_connection = 1
73
class InvalidStatusRequestHandler(TestingHTTPRequestHandler):
74
"""Whatever request comes in, returns am invalid status"""
76
def parse_request(self):
77
"""Fakes handling a single HTTP request, returns a bad status"""
78
ignored = TestingHTTPRequestHandler.parse_request(self)
79
self.wfile.write("Invalid status line\r\n")
83
class BadProtocolRequestHandler(TestingHTTPRequestHandler):
84
"""Whatever request comes in, returns a bad protocol version"""
86
def parse_request(self):
87
"""Fakes handling a single HTTP request, returns a bad status"""
88
ignored = TestingHTTPRequestHandler.parse_request(self)
89
# Returns an invalid protocol version, but curl just
90
# ignores it and those cannot be tested.
91
self.wfile.write("%s %d %s\r\n" % ('HTTP/0.0',
93
'Look at my protocol version'))
97
class ForbiddenRequestHandler(TestingHTTPRequestHandler):
98
"""Whatever request comes in, returns a 403 code"""
100
def parse_request(self):
101
"""Handle a single HTTP request, by replying we cannot handle it"""
102
ignored = TestingHTTPRequestHandler.parse_request(self)
107
class HTTPServerWithSmarts(HttpServer):
108
"""HTTPServerWithSmarts extends the HttpServer with POST methods that will
109
trigger a smart server to execute with a transport rooted at the rootdir of
114
HttpServer.__init__(self, SmartRequestHandler)
117
class SmartRequestHandler(TestingHTTPRequestHandler):
118
"""Extend TestingHTTPRequestHandler to support smart client POSTs."""
121
"""Hand the request off to a smart server instance."""
122
self.send_response(200)
123
self.send_header("Content-type", "application/octet-stream")
124
transport = get_transport(self.server.test_case_server._home_dir)
125
# TODO: We might like to support streaming responses. 1.0 allows no
126
# Content-length in this case, so for integrity we should perform our
127
# own chunking within the stream.
128
# 1.1 allows chunked responses, and in this case we could chunk using
129
# the HTTP chunking as this will allow HTTP persistence safely, even if
130
# we have to stop early due to error, but we would also have to use the
131
# HTTP trailer facility which may not be widely available.
132
out_buffer = StringIO()
133
smart_protocol_request = protocol.SmartServerRequestProtocolOne(
134
transport, out_buffer.write)
135
# if this fails, we should return 400 bad request, but failure is
136
# failure for now - RBC 20060919
137
data_length = int(self.headers['Content-Length'])
138
# Perhaps there should be a SmartServerHTTPMedium that takes care of
139
# feeding the bytes in the http request to the smart_protocol_request,
140
# but for now it's simpler to just feed the bytes directly.
141
smart_protocol_request.accept_bytes(self.rfile.read(data_length))
142
assert smart_protocol_request.next_read_size() == 0, (
143
"not finished reading, but all data sent to protocol.")
144
self.send_header("Content-Length", str(len(out_buffer.getvalue())))
146
self.wfile.write(out_buffer.getvalue())
149
class SingleRangeRequestHandler(TestingHTTPRequestHandler):
150
"""Always reply to range request as if they were single.
152
Don't be explicit about it, just to annoy the clients.
155
def get_multiple_ranges(self, file, file_size, ranges):
156
"""Answer as if it was a single range request and ignores the rest"""
157
(start, end) = ranges[0]
158
return self.get_single_range(file, file_size, start, end)
161
class NoRangeRequestHandler(TestingHTTPRequestHandler):
162
"""Ignore range requests without notice"""
164
# Just bypass the range handling done by TestingHTTPRequestHandler
165
do_GET = SimpleHTTPRequestHandler.do_GET
168
class TestCaseWithWebserver(TestCaseWithTransport):
169
"""A support class that provides readonly urls that are http://.
171
This is done by forcing the readonly server to be an http
172
one. This will currently fail if the primary transport is not
173
backed by regular disk files.
176
super(TestCaseWithWebserver, self).setUp()
177
self.transport_readonly_server = HttpServer
180
class TestCaseWithTwoWebservers(TestCaseWithWebserver):
181
"""A support class providing readonly urls on two servers that are http://.
183
We set up two webservers to allows various tests involving
184
proxies or redirections from one server to the other.
187
super(TestCaseWithTwoWebservers, self).setUp()
188
self.transport_secondary_server = HttpServer
189
self.__secondary_server = None
191
def create_transport_secondary_server(self):
192
"""Create a transport server from class defined at init.
194
This is mostly a hook for daughter classes.
196
return self.transport_secondary_server()
198
def get_secondary_server(self):
199
"""Get the server instance for the secondary transport."""
200
if self.__secondary_server is None:
201
self.__secondary_server = self.create_transport_secondary_server()
202
self.__secondary_server.setUp()
203
self.addCleanup(self.__secondary_server.tearDown)
204
return self.__secondary_server
207
class FakeProxyRequestHandler(TestingHTTPRequestHandler):
208
"""Append a '-proxied' suffix to file served"""
210
def translate_path(self, path):
211
# We need to act as a proxy and accept absolute urls,
212
# which SimpleHTTPRequestHandler (grand parent) is not
213
# ready for. So we just drop the protocol://host:port
214
# part in front of the request-url (because we know we
215
# would not forward the request to *another* proxy).
217
# So we do what SimpleHTTPRequestHandler.translate_path
218
# do beginning with python 2.4.3: abandon query
219
# parameters, scheme, host port, etc (which ensure we
220
# provide the right behaviour on all python versions).
221
path = urlparse.urlparse(path)[2]
222
# And now, we can apply *our* trick to proxy files
223
self.path += '-proxied'
224
# An finally we leave our mother class do whatever it
225
# wants with the path
226
return TestingHTTPRequestHandler.translate_path(self, path)
229
class RedirectRequestHandler(TestingHTTPRequestHandler):
230
"""Redirect all request to the specified server"""
232
def parse_request(self):
233
"""Redirect a single HTTP request to another host"""
234
valid = TestingHTTPRequestHandler.parse_request(self)
236
tcs = self.server.test_case_server
237
code, target = tcs.is_redirected(self.path)
238
if code is not None and target is not None:
239
# Redirect as instructed
240
self.send_response(code)
241
self.send_header('Location', target)
243
return False # The job is done
245
# We leave the parent class serve the request
250
class HTTPServerRedirecting(HttpServer):
251
"""An HttpServer redirecting to another server """
253
def __init__(self, request_handler=RedirectRequestHandler):
254
HttpServer.__init__(self, request_handler)
255
# redirections is a list of tuples (source, target, code)
256
# - source is a regexp for the paths requested
257
# - target is a replacement for re.sub describing where
258
# the request will be redirected
259
# - code is the http error code associated to the
260
# redirection (301 permanent, 302 temporarry, etc
261
self.redirections = []
263
def redirect_to(self, host, port):
264
"""Redirect all requests to a specific host:port"""
265
self.redirections = [('(.*)',
266
r'http://%s:%s\1' % (host, port) ,
269
def is_redirected(self, path):
270
"""Is the path redirected by this server.
272
:param path: the requested relative path
274
:returns: a tuple (code, target) if a matching
275
redirection is found, (None, None) otherwise.
279
for (rsource, rtarget, rcode) in self.redirections:
280
target, match = re.subn(rsource, rtarget, path)
283
break # The first match wins
289
class TestCaseWithRedirectedWebserver(TestCaseWithTwoWebservers):
290
"""A support class providing redirections from one server to another.
292
We set up two webservers to allows various tests involving
294
The 'old' server is redirected to the 'new' server.
297
def create_transport_secondary_server(self):
298
"""Create the secondary server redirecting to the primary server"""
299
new = self.get_readonly_server()
300
redirecting = HTTPServerRedirecting()
301
redirecting.redirect_to(new.host, new.port)
305
super(TestCaseWithRedirectedWebserver, self).setUp()
306
# The redirections will point to the new server
307
self.new_server = self.get_readonly_server()
308
# The requests to the old server will be redirected
309
self.old_server = self.get_secondary_server()
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):])
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()
142
self._http_running = False
143
self._http_thread.join()
144
TestCaseInTempDir.tearDown(self)
added
removed
bzrlib/selftest/HTTPTestUtil.py
