~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_http.py

  • Committer: Jelmer Vernooij
  • Date: 2012-06-18 11:43:07 UTC
  • mfrom: (6437.54.10 2.5)
  • mto: This revision was merged to the branch mainline in revision 6525.
  • Revision ID: jelmer@samba.org-20120618114307-zeazlym311p38m98
Merge 2.5.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
 
1
# Copyright (C) 2005-2011 Canonical Ltd
2
2
#
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
12
12
#
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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
 
 
17
 
# FIXME: This test should be repeated for each available http client
18
 
# implementation; at the moment we have urllib and pycurl.
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
"""Tests for HTTP implementations.
 
18
 
 
19
This module defines a load_tests() method that parametrize tests classes for
 
20
transport implementation, http protocol versions and authentication schemes.
 
21
"""
19
22
 
20
23
# TODO: Should be renamed to bzrlib.transport.http.tests?
21
24
# TODO: What about renaming to bzrlib.tests.transport.http ?
22
25
 
23
 
from cStringIO import StringIO
24
 
import os
25
 
import select
 
26
import httplib
 
27
import SimpleHTTPServer
26
28
import socket
27
29
import sys
28
30
import threading
29
31
 
30
32
import bzrlib
31
33
from bzrlib import (
 
34
    config,
 
35
    controldir,
 
36
    debug,
32
37
    errors,
33
38
    osutils,
 
39
    remote as _mod_remote,
 
40
    tests,
 
41
    trace,
 
42
    transport,
34
43
    ui,
35
 
    urlutils,
36
44
    )
37
45
from bzrlib.tests import (
38
 
    TestCase,
39
 
    TestUIFactory,
40
 
    TestSkipped,
41
 
    StringIOWrapper,
42
 
    )
43
 
from bzrlib.tests.HttpServer import (
44
 
    HttpServer,
45
 
    HttpServer_PyCurl,
46
 
    HttpServer_urllib,
47
 
    )
48
 
from bzrlib.tests.HTTPTestUtil import (
49
 
    BadProtocolRequestHandler,
50
 
    BadStatusRequestHandler,
51
 
    ForbiddenRequestHandler,
52
 
    HTTPBasicAuthServer,
53
 
    HTTPDigestAuthServer,
54
 
    HTTPServerRedirecting,
55
 
    InvalidStatusRequestHandler,
56
 
    LimitedRangeHTTPServer,
57
 
    NoRangeRequestHandler,
58
 
    ProxyBasicAuthServer,
59
 
    ProxyDigestAuthServer,
60
 
    ProxyServer,
61
 
    SingleRangeRequestHandler,
62
 
    SingleOnlyRangeRequestHandler,
63
 
    TestCaseWithRedirectedWebserver,
64
 
    TestCaseWithTwoWebservers,
65
 
    TestCaseWithWebserver,
66
 
    WallRequestHandler,
 
46
    features,
 
47
    http_server,
 
48
    http_utils,
 
49
    test_server,
 
50
    )
 
51
from bzrlib.tests.scenarios import (
 
52
    load_tests_apply_scenarios,
 
53
    multiply_scenarios,
67
54
    )
68
55
from bzrlib.transport import (
69
 
    _CoalescedOffset,
70
 
    do_catching_redirections,
71
 
    get_transport,
72
 
    Transport,
 
56
    http,
 
57
    remote,
73
58
    )
74
59
from bzrlib.transport.http import (
75
 
    extract_auth,
76
 
    HttpTransportBase,
 
60
    _urllib,
77
61
    _urllib2_wrappers,
78
62
    )
79
 
from bzrlib.transport.http._urllib import HttpTransport_urllib
80
 
from bzrlib.transport.http._urllib2_wrappers import (
81
 
    PasswordManager,
82
 
    ProxyHandler,
83
 
    Request,
84
 
    )
 
63
 
 
64
 
 
65
if features.pycurl.available():
 
66
    from bzrlib.transport.http._pycurl import PyCurlTransport
 
67
 
 
68
 
 
69
load_tests = load_tests_apply_scenarios
 
70
 
 
71
 
 
72
def vary_by_http_client_implementation():
 
73
    """Test the two libraries we can use, pycurl and urllib."""
 
74
    transport_scenarios = [
 
75
        ('urllib', dict(_transport=_urllib.HttpTransport_urllib,
 
76
                        _server=http_server.HttpServer_urllib,
 
77
                        _url_protocol='http+urllib',)),
 
78
        ]
 
79
    if features.pycurl.available():
 
80
        transport_scenarios.append(
 
81
            ('pycurl', dict(_transport=PyCurlTransport,
 
82
                            _server=http_server.HttpServer_PyCurl,
 
83
                            _url_protocol='http+pycurl',)))
 
84
    return transport_scenarios
 
85
 
 
86
 
 
87
def vary_by_http_protocol_version():
 
88
    """Test on http/1.0 and 1.1"""
 
89
    return [
 
90
        ('HTTP/1.0',  dict(_protocol_version='HTTP/1.0')),
 
91
        ('HTTP/1.1',  dict(_protocol_version='HTTP/1.1')),
 
92
        ]
 
93
 
 
94
 
 
95
def vary_by_http_auth_scheme():
 
96
    scenarios = [
 
97
        ('basic', dict(_auth_server=http_utils.HTTPBasicAuthServer)),
 
98
        ('digest', dict(_auth_server=http_utils.HTTPDigestAuthServer)),
 
99
        ('basicdigest',
 
100
            dict(_auth_server=http_utils.HTTPBasicAndDigestAuthServer)),
 
101
        ]
 
102
    # Add some attributes common to all scenarios
 
103
    for scenario_id, scenario_dict in scenarios:
 
104
        scenario_dict.update(_auth_header='Authorization',
 
105
                             _username_prompt_prefix='',
 
106
                             _password_prompt_prefix='')
 
107
    return scenarios
 
108
 
 
109
 
 
110
def vary_by_http_proxy_auth_scheme():
 
111
    scenarios = [
 
112
        ('proxy-basic', dict(_auth_server=http_utils.ProxyBasicAuthServer)),
 
113
        ('proxy-digest', dict(_auth_server=http_utils.ProxyDigestAuthServer)),
 
114
        ('proxy-basicdigest',
 
115
            dict(_auth_server=http_utils.ProxyBasicAndDigestAuthServer)),
 
116
        ]
 
117
    # Add some attributes common to all scenarios
 
118
    for scenario_id, scenario_dict in scenarios:
 
119
        scenario_dict.update(_auth_header='Proxy-Authorization',
 
120
                             _username_prompt_prefix='Proxy ',
 
121
                             _password_prompt_prefix='Proxy ')
 
122
    return scenarios
 
123
 
 
124
 
 
125
def vary_by_http_activity():
 
126
    activity_scenarios = [
 
127
        ('urllib,http', dict(_activity_server=ActivityHTTPServer,
 
128
                            _transport=_urllib.HttpTransport_urllib,)),
 
129
        ]
 
130
    if features.pycurl.available():
 
131
        activity_scenarios.append(
 
132
            ('pycurl,http', dict(_activity_server=ActivityHTTPServer,
 
133
                                _transport=PyCurlTransport,)),)
 
134
    if features.HTTPSServerFeature.available():
 
135
        # FIXME: Until we have a better way to handle self-signed certificates
 
136
        # (like allowing them in a test specific authentication.conf for
 
137
        # example), we need some specialized pycurl/urllib transport for tests.
 
138
        # -- vila 2012-01-20
 
139
        from bzrlib.tests import (
 
140
            ssl_certs,
 
141
            )
 
142
        class HTTPS_urllib_transport(_urllib.HttpTransport_urllib):
 
143
 
 
144
            def __init__(self, base, _from_transport=None):
 
145
                super(HTTPS_urllib_transport, self).__init__(
 
146
                    base, _from_transport=_from_transport,
 
147
                    ca_certs=ssl_certs.build_path('ca.crt'))
 
148
 
 
149
        activity_scenarios.append(
 
150
            ('urllib,https', dict(_activity_server=ActivityHTTPSServer,
 
151
                                  _transport=HTTPS_urllib_transport,)),)
 
152
        if features.pycurl.available():
 
153
            class HTTPS_pycurl_transport(PyCurlTransport):
 
154
 
 
155
                def __init__(self, base, _from_transport=None):
 
156
                    super(HTTPS_pycurl_transport, self).__init__(
 
157
                        base, _from_transport)
 
158
                    self.cabundle = str(ssl_certs.build_path('ca.crt'))
 
159
 
 
160
            activity_scenarios.append(
 
161
                ('pycurl,https', dict(_activity_server=ActivityHTTPSServer,
 
162
                                    _transport=HTTPS_pycurl_transport,)),)
 
163
    return activity_scenarios
85
164
 
86
165
 
87
166
class FakeManager(object):
95
174
 
96
175
class RecordingServer(object):
97
176
    """A fake HTTP server.
98
 
    
 
177
 
99
178
    It records the bytes sent to it, and replies with a 200.
100
179
    """
101
180
 
102
 
    def __init__(self, expect_body_tail=None):
 
181
    def __init__(self, expect_body_tail=None, scheme=''):
103
182
        """Constructor.
104
183
 
105
184
        :type expect_body_tail: str
110
189
        self.host = None
111
190
        self.port = None
112
191
        self.received_bytes = ''
113
 
 
114
 
    def setUp(self):
 
192
        self.scheme = scheme
 
193
 
 
194
    def get_url(self):
 
195
        return '%s://%s:%s/' % (self.scheme, self.host, self.port)
 
196
 
 
197
    def start_server(self):
115
198
        self._sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
116
199
        self._sock.bind(('127.0.0.1', 0))
117
200
        self.host, self.port = self._sock.getsockname()
118
201
        self._ready = threading.Event()
119
 
        self._thread = threading.Thread(target=self._accept_read_and_reply)
120
 
        self._thread.setDaemon(True)
 
202
        self._thread = test_server.TestThread(
 
203
            sync_event=self._ready, target=self._accept_read_and_reply)
121
204
        self._thread.start()
122
 
        self._ready.wait(5)
 
205
        if 'threads' in tests.selftest_debug_flags:
 
206
            sys.stderr.write('Thread started: %s\n' % (self._thread.ident,))
 
207
        self._ready.wait()
123
208
 
124
209
    def _accept_read_and_reply(self):
125
210
        self._sock.listen(1)
126
211
        self._ready.set()
127
 
        self._sock.settimeout(5)
128
 
        try:
129
 
            conn, address = self._sock.accept()
130
 
            # On win32, the accepted connection will be non-blocking to start
131
 
            # with because we're using settimeout.
132
 
            conn.setblocking(True)
 
212
        conn, address = self._sock.accept()
 
213
        if self._expect_body_tail is not None:
133
214
            while not self.received_bytes.endswith(self._expect_body_tail):
134
215
                self.received_bytes += conn.recv(4096)
135
216
            conn.sendall('HTTP/1.1 200 OK\r\n')
136
 
        except socket.timeout:
137
 
            # Make sure the client isn't stuck waiting for us to e.g. accept.
 
217
        try:
138
218
            self._sock.close()
139
219
        except socket.error:
140
220
            # The client may have already closed the socket.
141
221
            pass
142
222
 
143
 
    def tearDown(self):
 
223
    def stop_server(self):
144
224
        try:
145
 
            self._sock.close()
 
225
            # Issue a fake connection to wake up the server and allow it to
 
226
            # finish quickly
 
227
            fake_conn = osutils.connect_socket((self.host, self.port))
 
228
            fake_conn.close()
146
229
        except socket.error:
147
230
            # We might have already closed it.  We don't care.
148
231
            pass
149
232
        self.host = None
150
233
        self.port = None
 
234
        self._thread.join()
 
235
        if 'threads' in tests.selftest_debug_flags:
 
236
            sys.stderr.write('Thread  joined: %s\n' % (self._thread.ident,))
 
237
 
 
238
 
 
239
class TestAuthHeader(tests.TestCase):
 
240
 
 
241
    def parse_header(self, header, auth_handler_class=None):
 
242
        if auth_handler_class is None:
 
243
            auth_handler_class = _urllib2_wrappers.AbstractAuthHandler
 
244
        self.auth_handler =  auth_handler_class()
 
245
        return self.auth_handler._parse_auth_header(header)
 
246
 
 
247
    def test_empty_header(self):
 
248
        scheme, remainder = self.parse_header('')
 
249
        self.assertEqual('', scheme)
 
250
        self.assertIs(None, remainder)
 
251
 
 
252
    def test_negotiate_header(self):
 
253
        scheme, remainder = self.parse_header('Negotiate')
 
254
        self.assertEqual('negotiate', scheme)
 
255
        self.assertIs(None, remainder)
 
256
 
 
257
    def test_basic_header(self):
 
258
        scheme, remainder = self.parse_header(
 
259
            'Basic realm="Thou should not pass"')
 
260
        self.assertEqual('basic', scheme)
 
261
        self.assertEqual('realm="Thou should not pass"', remainder)
 
262
 
 
263
    def test_basic_extract_realm(self):
 
264
        scheme, remainder = self.parse_header(
 
265
            'Basic realm="Thou should not pass"',
 
266
            _urllib2_wrappers.BasicAuthHandler)
 
267
        match, realm = self.auth_handler.extract_realm(remainder)
 
268
        self.assertTrue(match is not None)
 
269
        self.assertEqual('Thou should not pass', realm)
 
270
 
 
271
    def test_digest_header(self):
 
272
        scheme, remainder = self.parse_header(
 
273
            'Digest realm="Thou should not pass"')
 
274
        self.assertEqual('digest', scheme)
 
275
        self.assertEqual('realm="Thou should not pass"', remainder)
 
276
 
 
277
 
 
278
class TestHTTPRangeParsing(tests.TestCase):
 
279
 
 
280
    def setUp(self):
 
281
        super(TestHTTPRangeParsing, self).setUp()
 
282
        # We focus on range  parsing here and ignore everything else
 
283
        class RequestHandler(http_server.TestingHTTPRequestHandler):
 
284
            def setup(self): pass
 
285
            def handle(self): pass
 
286
            def finish(self): pass
 
287
 
 
288
        self.req_handler = RequestHandler(None, None, None)
 
289
 
 
290
    def assertRanges(self, ranges, header, file_size):
 
291
        self.assertEquals(ranges,
 
292
                          self.req_handler._parse_ranges(header, file_size))
 
293
 
 
294
    def test_simple_range(self):
 
295
        self.assertRanges([(0,2)], 'bytes=0-2', 12)
 
296
 
 
297
    def test_tail(self):
 
298
        self.assertRanges([(8, 11)], 'bytes=-4', 12)
 
299
 
 
300
    def test_tail_bigger_than_file(self):
 
301
        self.assertRanges([(0, 11)], 'bytes=-99', 12)
 
302
 
 
303
    def test_range_without_end(self):
 
304
        self.assertRanges([(4, 11)], 'bytes=4-', 12)
 
305
 
 
306
    def test_invalid_ranges(self):
 
307
        self.assertRanges(None, 'bytes=12-22', 12)
 
308
        self.assertRanges(None, 'bytes=1-3,12-22', 12)
 
309
        self.assertRanges(None, 'bytes=-', 12)
 
310
 
 
311
 
 
312
class TestHTTPServer(tests.TestCase):
 
313
    """Test the HTTP servers implementations."""
 
314
 
 
315
    def test_invalid_protocol(self):
 
316
        class BogusRequestHandler(http_server.TestingHTTPRequestHandler):
 
317
 
 
318
            protocol_version = 'HTTP/0.1'
 
319
 
 
320
        self.assertRaises(httplib.UnknownProtocol,
 
321
                          http_server.HttpServer, BogusRequestHandler)
 
322
 
 
323
    def test_force_invalid_protocol(self):
 
324
        self.assertRaises(httplib.UnknownProtocol,
 
325
                          http_server.HttpServer, protocol_version='HTTP/0.1')
 
326
 
 
327
    def test_server_start_and_stop(self):
 
328
        server = http_server.HttpServer()
 
329
        self.addCleanup(server.stop_server)
 
330
        server.start_server()
 
331
        self.assertTrue(server.server is not None)
 
332
        self.assertTrue(server.server.serving is not None)
 
333
        self.assertTrue(server.server.serving)
 
334
 
 
335
    def test_create_http_server_one_zero(self):
 
336
        class RequestHandlerOneZero(http_server.TestingHTTPRequestHandler):
 
337
 
 
338
            protocol_version = 'HTTP/1.0'
 
339
 
 
340
        server = http_server.HttpServer(RequestHandlerOneZero)
 
341
        self.start_server(server)
 
342
        self.assertIsInstance(server.server, http_server.TestingHTTPServer)
 
343
 
 
344
    def test_create_http_server_one_one(self):
 
345
        class RequestHandlerOneOne(http_server.TestingHTTPRequestHandler):
 
346
 
 
347
            protocol_version = 'HTTP/1.1'
 
348
 
 
349
        server = http_server.HttpServer(RequestHandlerOneOne)
 
350
        self.start_server(server)
 
351
        self.assertIsInstance(server.server,
 
352
                              http_server.TestingThreadingHTTPServer)
 
353
 
 
354
    def test_create_http_server_force_one_one(self):
 
355
        class RequestHandlerOneZero(http_server.TestingHTTPRequestHandler):
 
356
 
 
357
            protocol_version = 'HTTP/1.0'
 
358
 
 
359
        server = http_server.HttpServer(RequestHandlerOneZero,
 
360
                                        protocol_version='HTTP/1.1')
 
361
        self.start_server(server)
 
362
        self.assertIsInstance(server.server,
 
363
                              http_server.TestingThreadingHTTPServer)
 
364
 
 
365
    def test_create_http_server_force_one_zero(self):
 
366
        class RequestHandlerOneOne(http_server.TestingHTTPRequestHandler):
 
367
 
 
368
            protocol_version = 'HTTP/1.1'
 
369
 
 
370
        server = http_server.HttpServer(RequestHandlerOneOne,
 
371
                                        protocol_version='HTTP/1.0')
 
372
        self.start_server(server)
 
373
        self.assertIsInstance(server.server,
 
374
                              http_server.TestingHTTPServer)
151
375
 
152
376
 
153
377
class TestWithTransport_pycurl(object):
154
378
    """Test case to inherit from if pycurl is present"""
155
379
 
156
380
    def _get_pycurl_maybe(self):
157
 
        try:
158
 
            from bzrlib.transport.http._pycurl import PyCurlTransport
159
 
            return PyCurlTransport
160
 
        except errors.DependencyNotPresent:
161
 
            raise TestSkipped('pycurl not present')
 
381
        self.requireFeature(features.pycurl)
 
382
        return PyCurlTransport
162
383
 
163
384
    _transport = property(_get_pycurl_maybe)
164
385
 
165
386
 
166
 
class TestHttpUrls(TestCase):
 
387
class TestHttpUrls(tests.TestCase):
167
388
 
168
389
    # TODO: This should be moved to authorization tests once they
169
390
    # are written.
170
391
 
171
392
    def test_url_parsing(self):
172
393
        f = FakeManager()
173
 
        url = extract_auth('http://example.com', f)
174
 
        self.assertEquals('http://example.com', url)
175
 
        self.assertEquals(0, len(f.credentials))
176
 
        url = extract_auth('http://user:pass@www.bazaar-vcs.org/bzr/bzr.dev', f)
177
 
        self.assertEquals('http://www.bazaar-vcs.org/bzr/bzr.dev', url)
178
 
        self.assertEquals(1, len(f.credentials))
179
 
        self.assertEquals([None, 'www.bazaar-vcs.org', 'user', 'pass'],
180
 
                          f.credentials[0])
181
 
 
182
 
 
183
 
class TestHttpTransportUrls(object):
184
 
    """Test the http urls.
185
 
 
186
 
    This MUST be used by daughter classes that also inherit from
187
 
    TestCase.
188
 
 
189
 
    We can't inherit directly from TestCase or the
190
 
    test framework will try to create an instance which cannot
191
 
    run, its implementation being incomplete.
192
 
    """
 
394
        url = http.extract_auth('http://example.com', f)
 
395
        self.assertEqual('http://example.com', url)
 
396
        self.assertEqual(0, len(f.credentials))
 
397
        url = http.extract_auth(
 
398
            'http://user:pass@example.com/bzr/bzr.dev', f)
 
399
        self.assertEqual('http://example.com/bzr/bzr.dev', url)
 
400
        self.assertEqual(1, len(f.credentials))
 
401
        self.assertEqual([None, 'example.com', 'user', 'pass'],
 
402
                         f.credentials[0])
 
403
 
 
404
 
 
405
class TestHttpTransportUrls(tests.TestCase):
 
406
    """Test the http urls."""
 
407
 
 
408
    scenarios = vary_by_http_client_implementation()
193
409
 
194
410
    def test_abs_url(self):
195
411
        """Construction of absolute http URLs"""
196
 
        t = self._transport('http://bazaar-vcs.org/bzr/bzr.dev/')
 
412
        t = self._transport('http://example.com/bzr/bzr.dev/')
197
413
        eq = self.assertEqualDiff
198
 
        eq(t.abspath('.'), 'http://bazaar-vcs.org/bzr/bzr.dev')
199
 
        eq(t.abspath('foo/bar'), 'http://bazaar-vcs.org/bzr/bzr.dev/foo/bar')
200
 
        eq(t.abspath('.bzr'), 'http://bazaar-vcs.org/bzr/bzr.dev/.bzr')
 
414
        eq(t.abspath('.'), 'http://example.com/bzr/bzr.dev')
 
415
        eq(t.abspath('foo/bar'), 'http://example.com/bzr/bzr.dev/foo/bar')
 
416
        eq(t.abspath('.bzr'), 'http://example.com/bzr/bzr.dev/.bzr')
201
417
        eq(t.abspath('.bzr/1//2/./3'),
202
 
           'http://bazaar-vcs.org/bzr/bzr.dev/.bzr/1/2/3')
 
418
           'http://example.com/bzr/bzr.dev/.bzr/1/2/3')
203
419
 
204
420
    def test_invalid_http_urls(self):
205
421
        """Trap invalid construction of urls"""
206
 
        t = self._transport('http://bazaar-vcs.org/bzr/bzr.dev/')
207
 
        self.assertRaises(ValueError, t.abspath, '.bzr/')
208
 
        t = self._transport('http://http://bazaar-vcs.org/bzr/bzr.dev/')
209
 
        self.assertRaises((errors.InvalidURL, errors.ConnectionError),
210
 
                          t.has, 'foo/bar')
 
422
        self._transport('http://example.com/bzr/bzr.dev/')
 
423
        self.assertRaises(errors.InvalidURL,
 
424
                          self._transport,
 
425
                          'http://http://example.com/bzr/bzr.dev/')
211
426
 
212
427
    def test_http_root_urls(self):
213
428
        """Construction of URLs from server root"""
214
 
        t = self._transport('http://bzr.ozlabs.org/')
 
429
        t = self._transport('http://example.com/')
215
430
        eq = self.assertEqualDiff
216
431
        eq(t.abspath('.bzr/tree-version'),
217
 
           'http://bzr.ozlabs.org/.bzr/tree-version')
 
432
           'http://example.com/.bzr/tree-version')
218
433
 
219
434
    def test_http_impl_urls(self):
220
435
        """There are servers which ask for particular clients to connect"""
221
436
        server = self._server()
 
437
        server.start_server()
222
438
        try:
223
 
            server.setUp()
224
439
            url = server.get_url()
225
 
            self.assertTrue(url.startswith('%s://' % self._qualified_prefix))
 
440
            self.assertTrue(url.startswith('%s://' % self._url_protocol))
226
441
        finally:
227
 
            server.tearDown()
228
 
 
229
 
 
230
 
class TestHttpUrls_urllib(TestHttpTransportUrls, TestCase):
231
 
    """Test http urls with urllib"""
232
 
 
233
 
    _transport = HttpTransport_urllib
234
 
    _server = HttpServer_urllib
235
 
    _qualified_prefix = 'http+urllib'
236
 
 
237
 
 
238
 
class TestHttpUrls_pycurl(TestWithTransport_pycurl, TestHttpTransportUrls,
239
 
                          TestCase):
240
 
    """Test http urls with pycurl"""
241
 
 
242
 
    _server = HttpServer_PyCurl
243
 
    _qualified_prefix = 'http+pycurl'
 
442
            server.stop_server()
 
443
 
 
444
 
 
445
class TestHttps_pycurl(TestWithTransport_pycurl, tests.TestCase):
244
446
 
245
447
    # TODO: This should really be moved into another pycurl
246
448
    # specific test. When https tests will be implemented, take
252
454
        https by supplying a fake version_info that do not
253
455
        support it.
254
456
        """
255
 
        try:
256
 
            import pycurl
257
 
        except ImportError:
258
 
            raise TestSkipped('pycurl not present')
259
 
        # Now that we have pycurl imported, we can fake its version_info
260
 
        # This was taken from a windows pycurl without SSL
261
 
        # (thanks to bialix)
262
 
        pycurl.version_info = lambda : (2,
263
 
                                        '7.13.2',
264
 
                                        462082,
265
 
                                        'i386-pc-win32',
266
 
                                        2576,
267
 
                                        None,
268
 
                                        0,
269
 
                                        None,
270
 
                                        ('ftp', 'gopher', 'telnet',
271
 
                                         'dict', 'ldap', 'http', 'file'),
272
 
                                        None,
273
 
                                        0,
274
 
                                        None)
 
457
        self.requireFeature(features.pycurl)
 
458
        # Import the module locally now that we now it's available.
 
459
        pycurl = features.pycurl.module
 
460
 
 
461
        self.overrideAttr(pycurl, 'version_info',
 
462
                          # Fake the pycurl version_info This was taken from
 
463
                          # a windows pycurl without SSL (thanks to bialix)
 
464
                          lambda : (2,
 
465
                                    '7.13.2',
 
466
                                    462082,
 
467
                                    'i386-pc-win32',
 
468
                                    2576,
 
469
                                    None,
 
470
                                    0,
 
471
                                    None,
 
472
                                    ('ftp', 'gopher', 'telnet',
 
473
                                     'dict', 'ldap', 'http', 'file'),
 
474
                                    None,
 
475
                                    0,
 
476
                                    None))
275
477
        self.assertRaises(errors.DependencyNotPresent, self._transport,
276
478
                          'https://launchpad.net')
277
479
 
278
 
class TestHttpConnections(object):
279
 
    """Test the http connections.
280
 
 
281
 
    This MUST be used by daughter classes that also inherit from
282
 
    TestCaseWithWebserver.
283
 
 
284
 
    We can't inherit directly from TestCaseWithWebserver or the
285
 
    test framework will try to create an instance which cannot
286
 
    run, its implementation being incomplete.
287
 
    """
 
480
 
 
481
class TestHTTPConnections(http_utils.TestCaseWithWebserver):
 
482
    """Test the http connections."""
 
483
 
 
484
    scenarios = multiply_scenarios(
 
485
        vary_by_http_client_implementation(),
 
486
        vary_by_http_protocol_version(),
 
487
        )
288
488
 
289
489
    def setUp(self):
290
 
        TestCaseWithWebserver.setUp(self)
291
 
        self.build_tree(['xxx', 'foo/', 'foo/bar'], line_endings='binary',
 
490
        http_utils.TestCaseWithWebserver.setUp(self)
 
491
        self.build_tree(['foo/', 'foo/bar'], line_endings='binary',
292
492
                        transport=self.get_transport())
293
493
 
294
494
    def test_http_has(self):
295
495
        server = self.get_readonly_server()
296
 
        t = self._transport(server.get_url())
 
496
        t = self.get_readonly_transport()
297
497
        self.assertEqual(t.has('foo/bar'), True)
298
498
        self.assertEqual(len(server.logs), 1)
299
499
        self.assertContainsRe(server.logs[0],
301
501
 
302
502
    def test_http_has_not_found(self):
303
503
        server = self.get_readonly_server()
304
 
        t = self._transport(server.get_url())
 
504
        t = self.get_readonly_transport()
305
505
        self.assertEqual(t.has('not-found'), False)
306
506
        self.assertContainsRe(server.logs[1],
307
507
            r'"HEAD /not-found HTTP/1.." 404 - "-" "bzr/')
308
508
 
309
509
    def test_http_get(self):
310
510
        server = self.get_readonly_server()
311
 
        t = self._transport(server.get_url())
 
511
        t = self.get_readonly_transport()
312
512
        fp = t.get('foo/bar')
313
513
        self.assertEqualDiff(
314
514
            fp.read(),
318
518
            '"GET /foo/bar HTTP/1.1" 200 - "-" "bzr/%s'
319
519
            % bzrlib.__version__) > -1)
320
520
 
321
 
    def test_get_smart_medium(self):
322
 
        # For HTTP, get_smart_medium should return the transport object.
323
 
        server = self.get_readonly_server()
324
 
        http_transport = self._transport(server.get_url())
325
 
        medium = http_transport.get_smart_medium()
326
 
        self.assertIs(medium, http_transport)
327
 
 
328
521
    def test_has_on_bogus_host(self):
329
522
        # Get a free address and don't 'accept' on it, so that we
330
523
        # can be sure there is no http handler there, but set a
340
533
            socket.setdefaulttimeout(default_timeout)
341
534
 
342
535
 
343
 
class TestHttpConnections_urllib(TestHttpConnections, TestCaseWithWebserver):
344
 
    """Test http connections with urllib"""
345
 
 
346
 
    _transport = HttpTransport_urllib
347
 
 
348
 
 
349
 
 
350
 
class TestHttpConnections_pycurl(TestWithTransport_pycurl,
351
 
                                 TestHttpConnections,
352
 
                                 TestCaseWithWebserver):
353
 
    """Test http connections with pycurl"""
354
 
 
355
 
 
356
 
class TestHttpTransportRegistration(TestCase):
 
536
class TestHttpTransportRegistration(tests.TestCase):
357
537
    """Test registrations of various http implementations"""
358
538
 
 
539
    scenarios = vary_by_http_client_implementation()
 
540
 
359
541
    def test_http_registered(self):
360
 
        # urlllib should always be present
361
 
        t = get_transport('http+urllib://bzr.google.com/')
362
 
        self.assertIsInstance(t, Transport)
363
 
        self.assertIsInstance(t, HttpTransport_urllib)
364
 
 
365
 
 
366
 
class TestPost(object):
367
 
 
368
 
    def _test_post_body_is_received(self, scheme):
369
 
        server = RecordingServer(expect_body_tail='end-of-body')
370
 
        server.setUp()
371
 
        self.addCleanup(server.tearDown)
372
 
        url = '%s://%s:%s/' % (scheme, server.host, server.port)
373
 
        try:
374
 
            http_transport = get_transport(url)
375
 
        except errors.UnsupportedProtocol:
376
 
            raise TestSkipped('%s not available' % scheme)
 
542
        t = transport.get_transport_from_url(
 
543
            '%s://foo.com/' % self._url_protocol)
 
544
        self.assertIsInstance(t, transport.Transport)
 
545
        self.assertIsInstance(t, self._transport)
 
546
 
 
547
 
 
548
class TestPost(tests.TestCase):
 
549
 
 
550
    scenarios = multiply_scenarios(
 
551
        vary_by_http_client_implementation(),
 
552
        vary_by_http_protocol_version(),
 
553
        )
 
554
 
 
555
    def test_post_body_is_received(self):
 
556
        server = RecordingServer(expect_body_tail='end-of-body',
 
557
                                 scheme=self._url_protocol)
 
558
        self.start_server(server)
 
559
        url = server.get_url()
 
560
        # FIXME: needs a cleanup -- vila 20100611
 
561
        http_transport = transport.get_transport_from_url(url)
377
562
        code, response = http_transport._post('abc def end-of-body')
378
563
        self.assertTrue(
379
564
            server.received_bytes.startswith('POST /.bzr/smart HTTP/1.'))
380
565
        self.assertTrue('content-length: 19\r' in server.received_bytes.lower())
 
566
        self.assertTrue('content-type: application/octet-stream\r'
 
567
                        in server.received_bytes.lower())
381
568
        # The transport should not be assuming that the server can accept
382
569
        # chunked encoding the first time it connects, because HTTP/1.1, so we
383
570
        # check for the literal string.
385
572
            server.received_bytes.endswith('\r\n\r\nabc def end-of-body'))
386
573
 
387
574
 
388
 
class TestPost_urllib(TestCase, TestPost):
389
 
    """TestPost for urllib implementation"""
390
 
 
391
 
    _transport = HttpTransport_urllib
392
 
 
393
 
    def test_post_body_is_received_urllib(self):
394
 
        self._test_post_body_is_received('http+urllib')
395
 
 
396
 
 
397
 
class TestPost_pycurl(TestWithTransport_pycurl, TestCase, TestPost):
398
 
    """TestPost for pycurl implementation"""
399
 
 
400
 
    def test_post_body_is_received_pycurl(self):
401
 
        self._test_post_body_is_received('http+pycurl')
402
 
 
403
 
 
404
 
class TestRangeHeader(TestCase):
 
575
class TestRangeHeader(tests.TestCase):
405
576
    """Test range_header method"""
406
577
 
407
578
    def check_header(self, value, ranges=[], tail=0):
408
579
        offsets = [ (start, end - start + 1) for start, end in ranges]
409
 
        coalesce = Transport._coalesce_offsets
 
580
        coalesce = transport.Transport._coalesce_offsets
410
581
        coalesced = list(coalesce(offsets, limit=0, fudge_factor=0))
411
 
        range_header = HttpTransportBase._range_header
 
582
        range_header = http.HttpTransportBase._range_header
412
583
        self.assertEqual(value, range_header(coalesced, tail))
413
584
 
414
585
    def test_range_header_single(self):
429
600
                          tail=50)
430
601
 
431
602
 
432
 
class TestWallServer(object):
 
603
class TestSpecificRequestHandler(http_utils.TestCaseWithWebserver):
 
604
    """Tests a specific request handler.
 
605
 
 
606
    Daughter classes are expected to override _req_handler_class
 
607
    """
 
608
 
 
609
    scenarios = multiply_scenarios(
 
610
        vary_by_http_client_implementation(),
 
611
        vary_by_http_protocol_version(),
 
612
        )
 
613
 
 
614
    # Provide a useful default
 
615
    _req_handler_class = http_server.TestingHTTPRequestHandler
 
616
 
 
617
    def create_transport_readonly_server(self):
 
618
        server = http_server.HttpServer(self._req_handler_class,
 
619
                                        protocol_version=self._protocol_version)
 
620
        server._url_protocol = self._url_protocol
 
621
        return server
 
622
 
 
623
    def _testing_pycurl(self):
 
624
        # TODO: This is duplicated for lots of the classes in this file
 
625
        return (features.pycurl.available()
 
626
                and self._transport == PyCurlTransport)
 
627
 
 
628
 
 
629
class WallRequestHandler(http_server.TestingHTTPRequestHandler):
 
630
    """Whatever request comes in, close the connection"""
 
631
 
 
632
    def _handle_one_request(self):
 
633
        """Handle a single HTTP request, by abruptly closing the connection"""
 
634
        self.close_connection = 1
 
635
 
 
636
 
 
637
class TestWallServer(TestSpecificRequestHandler):
433
638
    """Tests exceptions during the connection phase"""
434
639
 
435
 
    def create_transport_readonly_server(self):
436
 
        return HttpServer(WallRequestHandler)
 
640
    _req_handler_class = WallRequestHandler
437
641
 
438
642
    def test_http_has(self):
439
 
        server = self.get_readonly_server()
440
 
        t = self._transport(server.get_url())
 
643
        t = self.get_readonly_transport()
441
644
        # Unfortunately httplib (see HTTPResponse._read_status
442
645
        # for details) make no distinction between a closed
443
646
        # socket and badly formatted status line, so we can't
444
647
        # just test for ConnectionError, we have to test
445
 
        # InvalidHttpResponse too.
446
 
        self.assertRaises((errors.ConnectionError, errors.InvalidHttpResponse),
 
648
        # InvalidHttpResponse too. And pycurl may raise ConnectionReset
 
649
        # instead of ConnectionError too.
 
650
        self.assertRaises(( errors.ConnectionError, errors.ConnectionReset,
 
651
                            errors.InvalidHttpResponse),
447
652
                          t.has, 'foo/bar')
448
653
 
449
654
    def test_http_get(self):
450
 
        server = self.get_readonly_server()
451
 
        t = self._transport(server.get_url())
452
 
        self.assertRaises((errors.ConnectionError, errors.InvalidHttpResponse),
 
655
        t = self.get_readonly_transport()
 
656
        self.assertRaises((errors.ConnectionError, errors.ConnectionReset,
 
657
                           errors.InvalidHttpResponse),
453
658
                          t.get, 'foo/bar')
454
659
 
455
660
 
456
 
class TestWallServer_urllib(TestWallServer, TestCaseWithWebserver):
457
 
    """Tests "wall" server for urllib implementation"""
458
 
 
459
 
    _transport = HttpTransport_urllib
460
 
 
461
 
 
462
 
class TestWallServer_pycurl(TestWithTransport_pycurl,
463
 
                            TestWallServer,
464
 
                            TestCaseWithWebserver):
465
 
    """Tests "wall" server for pycurl implementation"""
466
 
 
467
 
 
468
 
class TestBadStatusServer(object):
 
661
class BadStatusRequestHandler(http_server.TestingHTTPRequestHandler):
 
662
    """Whatever request comes in, returns a bad status"""
 
663
 
 
664
    def parse_request(self):
 
665
        """Fakes handling a single HTTP request, returns a bad status"""
 
666
        ignored = http_server.TestingHTTPRequestHandler.parse_request(self)
 
667
        self.send_response(0, "Bad status")
 
668
        self.close_connection = 1
 
669
        return False
 
670
 
 
671
 
 
672
class TestBadStatusServer(TestSpecificRequestHandler):
469
673
    """Tests bad status from server."""
470
674
 
471
 
    def create_transport_readonly_server(self):
472
 
        return HttpServer(BadStatusRequestHandler)
 
675
    _req_handler_class = BadStatusRequestHandler
473
676
 
474
677
    def test_http_has(self):
475
 
        server = self.get_readonly_server()
476
 
        t = self._transport(server.get_url())
 
678
        t = self.get_readonly_transport()
477
679
        self.assertRaises(errors.InvalidHttpResponse, t.has, 'foo/bar')
478
680
 
479
681
    def test_http_get(self):
480
 
        server = self.get_readonly_server()
481
 
        t = self._transport(server.get_url())
 
682
        t = self.get_readonly_transport()
482
683
        self.assertRaises(errors.InvalidHttpResponse, t.get, 'foo/bar')
483
684
 
484
685
 
485
 
class TestBadStatusServer_urllib(TestBadStatusServer, TestCaseWithWebserver):
486
 
    """Tests bad status server for urllib implementation"""
487
 
 
488
 
    _transport = HttpTransport_urllib
489
 
 
490
 
 
491
 
class TestBadStatusServer_pycurl(TestWithTransport_pycurl,
492
 
                                 TestBadStatusServer,
493
 
                                 TestCaseWithWebserver):
494
 
    """Tests bad status server for pycurl implementation"""
 
686
class InvalidStatusRequestHandler(http_server.TestingHTTPRequestHandler):
 
687
    """Whatever request comes in, returns an invalid status"""
 
688
 
 
689
    def parse_request(self):
 
690
        """Fakes handling a single HTTP request, returns a bad status"""
 
691
        ignored = http_server.TestingHTTPRequestHandler.parse_request(self)
 
692
        self.wfile.write("Invalid status line\r\n")
 
693
        # If we don't close the connection pycurl will hang. Since this is a
 
694
        # stress test we don't *have* to respect the protocol, but we don't
 
695
        # have to sabotage it too much either.
 
696
        self.close_connection = True
 
697
        return False
495
698
 
496
699
 
497
700
class TestInvalidStatusServer(TestBadStatusServer):
500
703
    Both implementations raises the same error as for a bad status.
501
704
    """
502
705
 
503
 
    def create_transport_readonly_server(self):
504
 
        return HttpServer(InvalidStatusRequestHandler)
505
 
 
506
 
 
507
 
class TestInvalidStatusServer_urllib(TestInvalidStatusServer,
508
 
                                     TestCaseWithWebserver):
509
 
    """Tests invalid status server for urllib implementation"""
510
 
 
511
 
    _transport = HttpTransport_urllib
512
 
 
513
 
 
514
 
class TestInvalidStatusServer_pycurl(TestWithTransport_pycurl,
515
 
                                     TestInvalidStatusServer,
516
 
                                     TestCaseWithWebserver):
517
 
    """Tests invalid status server for pycurl implementation"""
518
 
 
519
 
 
520
 
class TestBadProtocolServer(object):
 
706
    _req_handler_class = InvalidStatusRequestHandler
 
707
 
 
708
 
 
709
class BadProtocolRequestHandler(http_server.TestingHTTPRequestHandler):
 
710
    """Whatever request comes in, returns a bad protocol version"""
 
711
 
 
712
    def parse_request(self):
 
713
        """Fakes handling a single HTTP request, returns a bad status"""
 
714
        ignored = http_server.TestingHTTPRequestHandler.parse_request(self)
 
715
        # Returns an invalid protocol version, but curl just
 
716
        # ignores it and those cannot be tested.
 
717
        self.wfile.write("%s %d %s\r\n" % ('HTTP/0.0',
 
718
                                           404,
 
719
                                           'Look at my protocol version'))
 
720
        return False
 
721
 
 
722
 
 
723
class TestBadProtocolServer(TestSpecificRequestHandler):
521
724
    """Tests bad protocol from server."""
522
725
 
523
 
    def create_transport_readonly_server(self):
524
 
        return HttpServer(BadProtocolRequestHandler)
 
726
    _req_handler_class = BadProtocolRequestHandler
 
727
 
 
728
    def setUp(self):
 
729
        if self._testing_pycurl():
 
730
            raise tests.TestNotApplicable(
 
731
                "pycurl doesn't check the protocol version")
 
732
        super(TestBadProtocolServer, self).setUp()
525
733
 
526
734
    def test_http_has(self):
527
 
        server = self.get_readonly_server()
528
 
        t = self._transport(server.get_url())
 
735
        t = self.get_readonly_transport()
529
736
        self.assertRaises(errors.InvalidHttpResponse, t.has, 'foo/bar')
530
737
 
531
738
    def test_http_get(self):
532
 
        server = self.get_readonly_server()
533
 
        t = self._transport(server.get_url())
 
739
        t = self.get_readonly_transport()
534
740
        self.assertRaises(errors.InvalidHttpResponse, t.get, 'foo/bar')
535
741
 
536
742
 
537
 
class TestBadProtocolServer_urllib(TestBadProtocolServer,
538
 
                                   TestCaseWithWebserver):
539
 
    """Tests bad protocol server for urllib implementation"""
540
 
 
541
 
    _transport = HttpTransport_urllib
542
 
 
543
 
# curl don't check the protocol version
544
 
#class TestBadProtocolServer_pycurl(TestWithTransport_pycurl,
545
 
#                                   TestBadProtocolServer,
546
 
#                                   TestCaseWithWebserver):
547
 
#    """Tests bad protocol server for pycurl implementation"""
548
 
 
549
 
 
550
 
class TestForbiddenServer(object):
 
743
class ForbiddenRequestHandler(http_server.TestingHTTPRequestHandler):
 
744
    """Whatever request comes in, returns a 403 code"""
 
745
 
 
746
    def parse_request(self):
 
747
        """Handle a single HTTP request, by replying we cannot handle it"""
 
748
        ignored = http_server.TestingHTTPRequestHandler.parse_request(self)
 
749
        self.send_error(403)
 
750
        return False
 
751
 
 
752
 
 
753
class TestForbiddenServer(TestSpecificRequestHandler):
551
754
    """Tests forbidden server"""
552
755
 
553
 
    def create_transport_readonly_server(self):
554
 
        return HttpServer(ForbiddenRequestHandler)
 
756
    _req_handler_class = ForbiddenRequestHandler
555
757
 
556
758
    def test_http_has(self):
557
 
        server = self.get_readonly_server()
558
 
        t = self._transport(server.get_url())
 
759
        t = self.get_readonly_transport()
559
760
        self.assertRaises(errors.TransportError, t.has, 'foo/bar')
560
761
 
561
762
    def test_http_get(self):
562
 
        server = self.get_readonly_server()
563
 
        t = self._transport(server.get_url())
 
763
        t = self.get_readonly_transport()
564
764
        self.assertRaises(errors.TransportError, t.get, 'foo/bar')
565
765
 
566
766
 
567
 
class TestForbiddenServer_urllib(TestForbiddenServer, TestCaseWithWebserver):
568
 
    """Tests forbidden server for urllib implementation"""
569
 
 
570
 
    _transport = HttpTransport_urllib
571
 
 
572
 
 
573
 
class TestForbiddenServer_pycurl(TestWithTransport_pycurl,
574
 
                                 TestForbiddenServer,
575
 
                                 TestCaseWithWebserver):
576
 
    """Tests forbidden server for pycurl implementation"""
577
 
 
578
 
 
579
 
class TestRecordingServer(TestCase):
 
767
class TestRecordingServer(tests.TestCase):
580
768
 
581
769
    def test_create(self):
582
770
        server = RecordingServer(expect_body_tail=None)
584
772
        self.assertEqual(None, server.host)
585
773
        self.assertEqual(None, server.port)
586
774
 
587
 
    def test_setUp_and_tearDown(self):
 
775
    def test_setUp_and_stop(self):
588
776
        server = RecordingServer(expect_body_tail=None)
589
 
        server.setUp()
 
777
        server.start_server()
590
778
        try:
591
779
            self.assertNotEqual(None, server.host)
592
780
            self.assertNotEqual(None, server.port)
593
781
        finally:
594
 
            server.tearDown()
 
782
            server.stop_server()
595
783
        self.assertEqual(None, server.host)
596
784
        self.assertEqual(None, server.port)
597
785
 
598
786
    def test_send_receive_bytes(self):
599
 
        server = RecordingServer(expect_body_tail='c')
600
 
        server.setUp()
601
 
        self.addCleanup(server.tearDown)
 
787
        server = RecordingServer(expect_body_tail='c', scheme='http')
 
788
        self.start_server(server)
602
789
        sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
603
790
        sock.connect((server.host, server.port))
604
791
        sock.sendall('abc')
607
794
        self.assertEqual('abc', server.received_bytes)
608
795
 
609
796
 
610
 
class TestRangeRequestServer(object):
 
797
class TestRangeRequestServer(TestSpecificRequestHandler):
611
798
    """Tests readv requests against server.
612
799
 
613
 
    This MUST be used by daughter classes that also inherit from
614
 
    TestCaseWithWebserver.
615
 
 
616
 
    We can't inherit directly from TestCaseWithWebserver or the
617
 
    test framework will try to create an instance which cannot
618
 
    run, its implementation being incomplete.
 
800
    We test against default "normal" server.
619
801
    """
620
802
 
621
803
    def setUp(self):
622
 
        TestCaseWithWebserver.setUp(self)
 
804
        super(TestRangeRequestServer, self).setUp()
623
805
        self.build_tree_contents([('a', '0123456789')],)
624
806
 
625
807
    def test_readv(self):
626
 
        server = self.get_readonly_server()
627
 
        t = self._transport(server.get_url())
 
808
        t = self.get_readonly_transport()
628
809
        l = list(t.readv('a', ((0, 1), (1, 1), (3, 2), (9, 1))))
629
810
        self.assertEqual(l[0], (0, '0'))
630
811
        self.assertEqual(l[1], (1, '1'))
632
813
        self.assertEqual(l[3], (9, '9'))
633
814
 
634
815
    def test_readv_out_of_order(self):
635
 
        server = self.get_readonly_server()
636
 
        t = self._transport(server.get_url())
 
816
        t = self.get_readonly_transport()
637
817
        l = list(t.readv('a', ((1, 1), (9, 1), (0, 1), (3, 2))))
638
818
        self.assertEqual(l[0], (1, '1'))
639
819
        self.assertEqual(l[1], (9, '9'))
641
821
        self.assertEqual(l[3], (3, '34'))
642
822
 
643
823
    def test_readv_invalid_ranges(self):
644
 
        server = self.get_readonly_server()
645
 
        t = self._transport(server.get_url())
 
824
        t = self.get_readonly_transport()
646
825
 
647
826
        # This is intentionally reading off the end of the file
648
827
        # since we are sure that it cannot get there
654
833
        self.assertListRaises((errors.InvalidRange, errors.ShortReadvError,),
655
834
                              t.readv, 'a', [(12,2)])
656
835
 
 
836
    def test_readv_multiple_get_requests(self):
 
837
        server = self.get_readonly_server()
 
838
        t = self.get_readonly_transport()
 
839
        # force transport to issue multiple requests
 
840
        t._max_readv_combine = 1
 
841
        t._max_get_ranges = 1
 
842
        l = list(t.readv('a', ((0, 1), (1, 1), (3, 2), (9, 1))))
 
843
        self.assertEqual(l[0], (0, '0'))
 
844
        self.assertEqual(l[1], (1, '1'))
 
845
        self.assertEqual(l[2], (3, '34'))
 
846
        self.assertEqual(l[3], (9, '9'))
 
847
        # The server should have issued 4 requests
 
848
        self.assertEqual(4, server.GET_request_nb)
 
849
 
 
850
    def test_readv_get_max_size(self):
 
851
        server = self.get_readonly_server()
 
852
        t = self.get_readonly_transport()
 
853
        # force transport to issue multiple requests by limiting the number of
 
854
        # bytes by request. Note that this apply to coalesced offsets only, a
 
855
        # single range will keep its size even if bigger than the limit.
 
856
        t._get_max_size = 2
 
857
        l = list(t.readv('a', ((0, 1), (1, 1), (2, 4), (6, 4))))
 
858
        self.assertEqual(l[0], (0, '0'))
 
859
        self.assertEqual(l[1], (1, '1'))
 
860
        self.assertEqual(l[2], (2, '2345'))
 
861
        self.assertEqual(l[3], (6, '6789'))
 
862
        # The server should have issued 3 requests
 
863
        self.assertEqual(3, server.GET_request_nb)
 
864
 
 
865
    def test_complete_readv_leave_pipe_clean(self):
 
866
        server = self.get_readonly_server()
 
867
        t = self.get_readonly_transport()
 
868
        # force transport to issue multiple requests
 
869
        t._get_max_size = 2
 
870
        list(t.readv('a', ((0, 1), (1, 1), (2, 4), (6, 4))))
 
871
        # The server should have issued 3 requests
 
872
        self.assertEqual(3, server.GET_request_nb)
 
873
        self.assertEqual('0123456789', t.get_bytes('a'))
 
874
        self.assertEqual(4, server.GET_request_nb)
 
875
 
 
876
    def test_incomplete_readv_leave_pipe_clean(self):
 
877
        server = self.get_readonly_server()
 
878
        t = self.get_readonly_transport()
 
879
        # force transport to issue multiple requests
 
880
        t._get_max_size = 2
 
881
        # Don't collapse readv results into a list so that we leave unread
 
882
        # bytes on the socket
 
883
        ireadv = iter(t.readv('a', ((0, 1), (1, 1), (2, 4), (6, 4))))
 
884
        self.assertEqual((0, '0'), ireadv.next())
 
885
        # The server should have issued one request so far
 
886
        self.assertEqual(1, server.GET_request_nb)
 
887
        self.assertEqual('0123456789', t.get_bytes('a'))
 
888
        # get_bytes issued an additional request, the readv pending ones are
 
889
        # lost
 
890
        self.assertEqual(2, server.GET_request_nb)
 
891
 
 
892
 
 
893
class SingleRangeRequestHandler(http_server.TestingHTTPRequestHandler):
 
894
    """Always reply to range request as if they were single.
 
895
 
 
896
    Don't be explicit about it, just to annoy the clients.
 
897
    """
 
898
 
 
899
    def get_multiple_ranges(self, file, file_size, ranges):
 
900
        """Answer as if it was a single range request and ignores the rest"""
 
901
        (start, end) = ranges[0]
 
902
        return self.get_single_range(file, file_size, start, end)
 
903
 
657
904
 
658
905
class TestSingleRangeRequestServer(TestRangeRequestServer):
659
906
    """Test readv against a server which accept only single range requests"""
660
907
 
661
 
    def create_transport_readonly_server(self):
662
 
        return HttpServer(SingleRangeRequestHandler)
663
 
 
664
 
 
665
 
class TestSingleRangeRequestServer_urllib(TestSingleRangeRequestServer,
666
 
                                          TestCaseWithWebserver):
667
 
    """Tests single range requests accepting server for urllib implementation"""
668
 
 
669
 
    _transport = HttpTransport_urllib
670
 
 
671
 
 
672
 
class TestSingleRangeRequestServer_pycurl(TestWithTransport_pycurl,
673
 
                                          TestSingleRangeRequestServer,
674
 
                                          TestCaseWithWebserver):
675
 
    """Tests single range requests accepting server for pycurl implementation"""
 
908
    _req_handler_class = SingleRangeRequestHandler
 
909
 
 
910
 
 
911
class SingleOnlyRangeRequestHandler(http_server.TestingHTTPRequestHandler):
 
912
    """Only reply to simple range requests, errors out on multiple"""
 
913
 
 
914
    def get_multiple_ranges(self, file, file_size, ranges):
 
915
        """Refuses the multiple ranges request"""
 
916
        if len(ranges) > 1:
 
917
            file.close()
 
918
            self.send_error(416, "Requested range not satisfiable")
 
919
            return
 
920
        (start, end) = ranges[0]
 
921
        return self.get_single_range(file, file_size, start, end)
676
922
 
677
923
 
678
924
class TestSingleOnlyRangeRequestServer(TestRangeRequestServer):
679
925
    """Test readv against a server which only accept single range requests"""
680
926
 
681
 
    def create_transport_readonly_server(self):
682
 
        return HttpServer(SingleOnlyRangeRequestHandler)
683
 
 
684
 
 
685
 
class TestSingleOnlyRangeRequestServer_urllib(TestSingleOnlyRangeRequestServer,
686
 
                                              TestCaseWithWebserver):
687
 
    """Tests single range requests accepting server for urllib implementation"""
688
 
 
689
 
    _transport = HttpTransport_urllib
690
 
 
691
 
 
692
 
class TestSingleOnlyRangeRequestServer_pycurl(TestWithTransport_pycurl,
693
 
                                              TestSingleOnlyRangeRequestServer,
694
 
                                              TestCaseWithWebserver):
695
 
    """Tests single range requests accepting server for pycurl implementation"""
 
927
    _req_handler_class = SingleOnlyRangeRequestHandler
 
928
 
 
929
 
 
930
class NoRangeRequestHandler(http_server.TestingHTTPRequestHandler):
 
931
    """Ignore range requests without notice"""
 
932
 
 
933
    def do_GET(self):
 
934
        # Update the statistics
 
935
        self.server.test_case_server.GET_request_nb += 1
 
936
        # Just bypass the range handling done by TestingHTTPRequestHandler
 
937
        return SimpleHTTPServer.SimpleHTTPRequestHandler.do_GET(self)
696
938
 
697
939
 
698
940
class TestNoRangeRequestServer(TestRangeRequestServer):
699
941
    """Test readv against a server which do not accept range requests"""
700
942
 
701
 
    def create_transport_readonly_server(self):
702
 
        return HttpServer(NoRangeRequestHandler)
703
 
 
704
 
 
705
 
class TestNoRangeRequestServer_urllib(TestNoRangeRequestServer,
706
 
                                      TestCaseWithWebserver):
707
 
    """Tests range requests refusing server for urllib implementation"""
708
 
 
709
 
    _transport = HttpTransport_urllib
710
 
 
711
 
 
712
 
class TestNoRangeRequestServer_pycurl(TestWithTransport_pycurl,
713
 
                               TestNoRangeRequestServer,
714
 
                               TestCaseWithWebserver):
715
 
    """Tests range requests refusing server for pycurl implementation"""
716
 
 
717
 
 
718
 
class TestLimitedRangeRequestServer(object):
719
 
    """Tests readv requests against server that errors out on too much ranges.
720
 
 
721
 
    This MUST be used by daughter classes that also inherit from
722
 
    TestCaseWithWebserver.
723
 
 
724
 
    We can't inherit directly from TestCaseWithWebserver or the
725
 
    test framework will try to create an instance which cannot
726
 
    run, its implementation being incomplete.
 
943
    _req_handler_class = NoRangeRequestHandler
 
944
 
 
945
 
 
946
class MultipleRangeWithoutContentLengthRequestHandler(
 
947
    http_server.TestingHTTPRequestHandler):
 
948
    """Reply to multiple range requests without content length header."""
 
949
 
 
950
    def get_multiple_ranges(self, file, file_size, ranges):
 
951
        self.send_response(206)
 
952
        self.send_header('Accept-Ranges', 'bytes')
 
953
        # XXX: this is strange; the 'random' name below seems undefined and
 
954
        # yet the tests pass -- mbp 2010-10-11 bug 658773
 
955
        boundary = "%d" % random.randint(0,0x7FFFFFFF)
 
956
        self.send_header("Content-Type",
 
957
                         "multipart/byteranges; boundary=%s" % boundary)
 
958
        self.end_headers()
 
959
        for (start, end) in ranges:
 
960
            self.wfile.write("--%s\r\n" % boundary)
 
961
            self.send_header("Content-type", 'application/octet-stream')
 
962
            self.send_header("Content-Range", "bytes %d-%d/%d" % (start,
 
963
                                                                  end,
 
964
                                                                  file_size))
 
965
            self.end_headers()
 
966
            self.send_range_content(file, start, end - start + 1)
 
967
        # Final boundary
 
968
        self.wfile.write("--%s\r\n" % boundary)
 
969
 
 
970
 
 
971
class TestMultipleRangeWithoutContentLengthServer(TestRangeRequestServer):
 
972
 
 
973
    _req_handler_class = MultipleRangeWithoutContentLengthRequestHandler
 
974
 
 
975
 
 
976
class TruncatedMultipleRangeRequestHandler(
 
977
    http_server.TestingHTTPRequestHandler):
 
978
    """Reply to multiple range requests truncating the last ones.
 
979
 
 
980
    This server generates responses whose Content-Length describes all the
 
981
    ranges, but fail to include the last ones leading to client short reads.
 
982
    This has been observed randomly with lighttpd (bug #179368).
727
983
    """
728
984
 
 
985
    _truncated_ranges = 2
 
986
 
 
987
    def get_multiple_ranges(self, file, file_size, ranges):
 
988
        self.send_response(206)
 
989
        self.send_header('Accept-Ranges', 'bytes')
 
990
        boundary = 'tagada'
 
991
        self.send_header('Content-Type',
 
992
                         'multipart/byteranges; boundary=%s' % boundary)
 
993
        boundary_line = '--%s\r\n' % boundary
 
994
        # Calculate the Content-Length
 
995
        content_length = 0
 
996
        for (start, end) in ranges:
 
997
            content_length += len(boundary_line)
 
998
            content_length += self._header_line_length(
 
999
                'Content-type', 'application/octet-stream')
 
1000
            content_length += self._header_line_length(
 
1001
                'Content-Range', 'bytes %d-%d/%d' % (start, end, file_size))
 
1002
            content_length += len('\r\n') # end headers
 
1003
            content_length += end - start # + 1
 
1004
        content_length += len(boundary_line)
 
1005
        self.send_header('Content-length', content_length)
 
1006
        self.end_headers()
 
1007
 
 
1008
        # Send the multipart body
 
1009
        cur = 0
 
1010
        for (start, end) in ranges:
 
1011
            self.wfile.write(boundary_line)
 
1012
            self.send_header('Content-type', 'application/octet-stream')
 
1013
            self.send_header('Content-Range', 'bytes %d-%d/%d'
 
1014
                             % (start, end, file_size))
 
1015
            self.end_headers()
 
1016
            if cur + self._truncated_ranges >= len(ranges):
 
1017
                # Abruptly ends the response and close the connection
 
1018
                self.close_connection = 1
 
1019
                return
 
1020
            self.send_range_content(file, start, end - start + 1)
 
1021
            cur += 1
 
1022
        # Final boundary
 
1023
        self.wfile.write(boundary_line)
 
1024
 
 
1025
 
 
1026
class TestTruncatedMultipleRangeServer(TestSpecificRequestHandler):
 
1027
 
 
1028
    _req_handler_class = TruncatedMultipleRangeRequestHandler
 
1029
 
 
1030
    def setUp(self):
 
1031
        super(TestTruncatedMultipleRangeServer, self).setUp()
 
1032
        self.build_tree_contents([('a', '0123456789')],)
 
1033
 
 
1034
    def test_readv_with_short_reads(self):
 
1035
        server = self.get_readonly_server()
 
1036
        t = self.get_readonly_transport()
 
1037
        # Force separate ranges for each offset
 
1038
        t._bytes_to_read_before_seek = 0
 
1039
        ireadv = iter(t.readv('a', ((0, 1), (2, 1), (4, 2), (9, 1))))
 
1040
        self.assertEqual((0, '0'), ireadv.next())
 
1041
        self.assertEqual((2, '2'), ireadv.next())
 
1042
        if not self._testing_pycurl():
 
1043
            # Only one request have been issued so far (except for pycurl that
 
1044
            # try to read the whole response at once)
 
1045
            self.assertEqual(1, server.GET_request_nb)
 
1046
        self.assertEqual((4, '45'), ireadv.next())
 
1047
        self.assertEqual((9, '9'), ireadv.next())
 
1048
        # Both implementations issue 3 requests but:
 
1049
        # - urllib does two multiple (4 ranges, then 2 ranges) then a single
 
1050
        #   range,
 
1051
        # - pycurl does two multiple (4 ranges, 4 ranges) then a single range
 
1052
        self.assertEqual(3, server.GET_request_nb)
 
1053
        # Finally the client have tried a single range request and stays in
 
1054
        # that mode
 
1055
        self.assertEqual('single', t._range_hint)
 
1056
 
 
1057
 
 
1058
class TruncatedBeforeBoundaryRequestHandler(
 
1059
    http_server.TestingHTTPRequestHandler):
 
1060
    """Truncation before a boundary, like in bug 198646"""
 
1061
 
 
1062
    _truncated_ranges = 1
 
1063
 
 
1064
    def get_multiple_ranges(self, file, file_size, ranges):
 
1065
        self.send_response(206)
 
1066
        self.send_header('Accept-Ranges', 'bytes')
 
1067
        boundary = 'tagada'
 
1068
        self.send_header('Content-Type',
 
1069
                         'multipart/byteranges; boundary=%s' % boundary)
 
1070
        boundary_line = '--%s\r\n' % boundary
 
1071
        # Calculate the Content-Length
 
1072
        content_length = 0
 
1073
        for (start, end) in ranges:
 
1074
            content_length += len(boundary_line)
 
1075
            content_length += self._header_line_length(
 
1076
                'Content-type', 'application/octet-stream')
 
1077
            content_length += self._header_line_length(
 
1078
                'Content-Range', 'bytes %d-%d/%d' % (start, end, file_size))
 
1079
            content_length += len('\r\n') # end headers
 
1080
            content_length += end - start # + 1
 
1081
        content_length += len(boundary_line)
 
1082
        self.send_header('Content-length', content_length)
 
1083
        self.end_headers()
 
1084
 
 
1085
        # Send the multipart body
 
1086
        cur = 0
 
1087
        for (start, end) in ranges:
 
1088
            if cur + self._truncated_ranges >= len(ranges):
 
1089
                # Abruptly ends the response and close the connection
 
1090
                self.close_connection = 1
 
1091
                return
 
1092
            self.wfile.write(boundary_line)
 
1093
            self.send_header('Content-type', 'application/octet-stream')
 
1094
            self.send_header('Content-Range', 'bytes %d-%d/%d'
 
1095
                             % (start, end, file_size))
 
1096
            self.end_headers()
 
1097
            self.send_range_content(file, start, end - start + 1)
 
1098
            cur += 1
 
1099
        # Final boundary
 
1100
        self.wfile.write(boundary_line)
 
1101
 
 
1102
 
 
1103
class TestTruncatedBeforeBoundary(TestSpecificRequestHandler):
 
1104
    """Tests the case of bug 198646, disconnecting before a boundary."""
 
1105
 
 
1106
    _req_handler_class = TruncatedBeforeBoundaryRequestHandler
 
1107
 
 
1108
    def setUp(self):
 
1109
        super(TestTruncatedBeforeBoundary, self).setUp()
 
1110
        self.build_tree_contents([('a', '0123456789')],)
 
1111
 
 
1112
    def test_readv_with_short_reads(self):
 
1113
        server = self.get_readonly_server()
 
1114
        t = self.get_readonly_transport()
 
1115
        # Force separate ranges for each offset
 
1116
        t._bytes_to_read_before_seek = 0
 
1117
        ireadv = iter(t.readv('a', ((0, 1), (2, 1), (4, 2), (9, 1))))
 
1118
        self.assertEqual((0, '0'), ireadv.next())
 
1119
        self.assertEqual((2, '2'), ireadv.next())
 
1120
        self.assertEqual((4, '45'), ireadv.next())
 
1121
        self.assertEqual((9, '9'), ireadv.next())
 
1122
 
 
1123
 
 
1124
class LimitedRangeRequestHandler(http_server.TestingHTTPRequestHandler):
 
1125
    """Errors out when range specifiers exceed the limit"""
 
1126
 
 
1127
    def get_multiple_ranges(self, file, file_size, ranges):
 
1128
        """Refuses the multiple ranges request"""
 
1129
        tcs = self.server.test_case_server
 
1130
        if tcs.range_limit is not None and len(ranges) > tcs.range_limit:
 
1131
            file.close()
 
1132
            # Emulate apache behavior
 
1133
            self.send_error(400, "Bad Request")
 
1134
            return
 
1135
        return http_server.TestingHTTPRequestHandler.get_multiple_ranges(
 
1136
            self, file, file_size, ranges)
 
1137
 
 
1138
 
 
1139
class LimitedRangeHTTPServer(http_server.HttpServer):
 
1140
    """An HttpServer erroring out on requests with too much range specifiers"""
 
1141
 
 
1142
    def __init__(self, request_handler=LimitedRangeRequestHandler,
 
1143
                 protocol_version=None,
 
1144
                 range_limit=None):
 
1145
        http_server.HttpServer.__init__(self, request_handler,
 
1146
                                        protocol_version=protocol_version)
 
1147
        self.range_limit = range_limit
 
1148
 
 
1149
 
 
1150
class TestLimitedRangeRequestServer(http_utils.TestCaseWithWebserver):
 
1151
    """Tests readv requests against a server erroring out on too much ranges."""
 
1152
 
 
1153
    scenarios = multiply_scenarios(
 
1154
        vary_by_http_client_implementation(),
 
1155
        vary_by_http_protocol_version(),
 
1156
        )
 
1157
 
 
1158
    # Requests with more range specifiers will error out
729
1159
    range_limit = 3
730
1160
 
731
1161
    def create_transport_readonly_server(self):
732
 
        # Requests with more range specifiers will error out
733
 
        return LimitedRangeHTTPServer(range_limit=self.range_limit)
734
 
 
735
 
    def get_transport(self):
736
 
        return self._transport(self.get_readonly_server().get_url())
 
1162
        return LimitedRangeHTTPServer(range_limit=self.range_limit,
 
1163
                                      protocol_version=self._protocol_version)
737
1164
 
738
1165
    def setUp(self):
739
 
        TestCaseWithWebserver.setUp(self)
 
1166
        http_utils.TestCaseWithWebserver.setUp(self)
740
1167
        # We need to manipulate ranges that correspond to real chunks in the
741
1168
        # response, so we build a content appropriately.
742
 
        filler = ''.join(['abcdefghij' for _ in range(102)])
 
1169
        filler = ''.join(['abcdefghij' for x in range(102)])
743
1170
        content = ''.join(['%04d' % v + filler for v in range(16)])
744
1171
        self.build_tree_contents([('a', content)],)
745
1172
 
746
1173
    def test_few_ranges(self):
747
 
        t = self.get_transport()
 
1174
        t = self.get_readonly_transport()
748
1175
        l = list(t.readv('a', ((0, 4), (1024, 4), )))
749
1176
        self.assertEqual(l[0], (0, '0000'))
750
1177
        self.assertEqual(l[1], (1024, '0001'))
751
1178
        self.assertEqual(1, self.get_readonly_server().GET_request_nb)
752
1179
 
753
 
    def test_a_lot_of_ranges(self):
754
 
        t = self.get_transport()
 
1180
    def test_more_ranges(self):
 
1181
        t = self.get_readonly_transport()
755
1182
        l = list(t.readv('a', ((0, 4), (1024, 4), (4096, 4), (8192, 4))))
756
1183
        self.assertEqual(l[0], (0, '0000'))
757
1184
        self.assertEqual(l[1], (1024, '0001'))
758
1185
        self.assertEqual(l[2], (4096, '0004'))
759
1186
        self.assertEqual(l[3], (8192, '0008'))
760
1187
        # The server will refuse to serve the first request (too much ranges),
761
 
        # a second request will succeeds.
 
1188
        # a second request will succeed.
762
1189
        self.assertEqual(2, self.get_readonly_server().GET_request_nb)
763
1190
 
764
1191
 
765
 
class TestLimitedRangeRequestServer_urllib(TestLimitedRangeRequestServer,
766
 
                                          TestCaseWithWebserver):
767
 
    """Tests limited range requests server for urllib implementation"""
768
 
 
769
 
    _transport = HttpTransport_urllib
770
 
 
771
 
 
772
 
class TestLimitedRangeRequestServer_pycurl(TestWithTransport_pycurl,
773
 
                                          TestLimitedRangeRequestServer,
774
 
                                          TestCaseWithWebserver):
775
 
    """Tests limited range requests server for pycurl implementation"""
776
 
 
777
 
 
778
 
 
779
 
class TestHttpProxyWhiteBox(TestCase):
 
1192
class TestHttpProxyWhiteBox(tests.TestCase):
780
1193
    """Whitebox test proxy http authorization.
781
1194
 
782
1195
    Only the urllib implementation is tested here.
783
1196
    """
784
1197
 
785
 
    def setUp(self):
786
 
        TestCase.setUp(self)
787
 
        self._old_env = {}
788
 
 
789
 
    def tearDown(self):
790
 
        self._restore_env()
791
 
 
792
 
    def _install_env(self, env):
793
 
        for name, value in env.iteritems():
794
 
            self._old_env[name] = osutils.set_or_unset_env(name, value)
795
 
 
796
 
    def _restore_env(self):
797
 
        for name, value in self._old_env.iteritems():
798
 
            osutils.set_or_unset_env(name, value)
799
 
 
800
1198
    def _proxied_request(self):
801
 
        handler = ProxyHandler(PasswordManager())
802
 
        request = Request('GET','http://baz/buzzle')
 
1199
        handler = _urllib2_wrappers.ProxyHandler()
 
1200
        request = _urllib2_wrappers.Request('GET', 'http://baz/buzzle')
803
1201
        handler.set_proxy(request, 'http')
804
1202
        return request
805
1203
 
 
1204
    def assertEvaluateProxyBypass(self, expected, host, no_proxy):
 
1205
        handler = _urllib2_wrappers.ProxyHandler()
 
1206
        self.assertEquals(expected,
 
1207
                          handler.evaluate_proxy_bypass(host, no_proxy))
 
1208
 
806
1209
    def test_empty_user(self):
807
 
        self._install_env({'http_proxy': 'http://bar.com'})
 
1210
        self.overrideEnv('http_proxy', 'http://bar.com')
 
1211
        request = self._proxied_request()
 
1212
        self.assertFalse(request.headers.has_key('Proxy-authorization'))
 
1213
 
 
1214
    def test_user_with_at(self):
 
1215
        self.overrideEnv('http_proxy',
 
1216
                         'http://username@domain:password@proxy_host:1234')
808
1217
        request = self._proxied_request()
809
1218
        self.assertFalse(request.headers.has_key('Proxy-authorization'))
810
1219
 
811
1220
    def test_invalid_proxy(self):
812
1221
        """A proxy env variable without scheme"""
813
 
        self._install_env({'http_proxy': 'host:1234'})
 
1222
        self.overrideEnv('http_proxy', 'host:1234')
814
1223
        self.assertRaises(errors.InvalidURL, self._proxied_request)
815
1224
 
816
 
 
817
 
class TestProxyHttpServer(object):
 
1225
    def test_evaluate_proxy_bypass_true(self):
 
1226
        """The host is not proxied"""
 
1227
        self.assertEvaluateProxyBypass(True, 'example.com', 'example.com')
 
1228
        self.assertEvaluateProxyBypass(True, 'bzr.example.com', '*example.com')
 
1229
 
 
1230
    def test_evaluate_proxy_bypass_false(self):
 
1231
        """The host is proxied"""
 
1232
        self.assertEvaluateProxyBypass(False, 'bzr.example.com', None)
 
1233
 
 
1234
    def test_evaluate_proxy_bypass_unknown(self):
 
1235
        """The host is not explicitly proxied"""
 
1236
        self.assertEvaluateProxyBypass(None, 'example.com', 'not.example.com')
 
1237
        self.assertEvaluateProxyBypass(None, 'bzr.example.com', 'example.com')
 
1238
 
 
1239
    def test_evaluate_proxy_bypass_empty_entries(self):
 
1240
        """Ignore empty entries"""
 
1241
        self.assertEvaluateProxyBypass(None, 'example.com', '')
 
1242
        self.assertEvaluateProxyBypass(None, 'example.com', ',')
 
1243
        self.assertEvaluateProxyBypass(None, 'example.com', 'foo,,bar')
 
1244
 
 
1245
 
 
1246
class TestProxyHttpServer(http_utils.TestCaseWithTwoWebservers):
818
1247
    """Tests proxy server.
819
1248
 
820
 
    This MUST be used by daughter classes that also inherit from
821
 
    TestCaseWithTwoWebservers.
822
 
 
823
 
    We can't inherit directly from TestCaseWithTwoWebservers or
824
 
    the test framework will try to create an instance which
825
 
    cannot run, its implementation being incomplete.
826
 
 
827
1249
    Be aware that we do not setup a real proxy here. Instead, we
828
1250
    check that the *connection* goes through the proxy by serving
829
1251
    different content (the faked proxy server append '-proxied'
830
1252
    to the file names).
831
1253
    """
832
1254
 
 
1255
    scenarios = multiply_scenarios(
 
1256
        vary_by_http_client_implementation(),
 
1257
        vary_by_http_protocol_version(),
 
1258
        )
 
1259
 
833
1260
    # FIXME: We don't have an https server available, so we don't
834
 
    # test https connections.
835
 
 
836
 
    # FIXME: Once the test suite is better fitted to test
837
 
    # authorization schemes, test proxy authorizations too (see
838
 
    # bug #83954).
 
1261
    # test https connections. --vila toolongago
839
1262
 
840
1263
    def setUp(self):
841
 
        TestCaseWithTwoWebservers.setUp(self)
 
1264
        super(TestProxyHttpServer, self).setUp()
 
1265
        self.transport_secondary_server = http_utils.ProxyServer
842
1266
        self.build_tree_contents([('foo', 'contents of foo\n'),
843
1267
                                  ('foo-proxied', 'proxied contents of foo\n')])
844
1268
        # Let's setup some attributes for tests
845
 
        self.server = self.get_readonly_server()
846
 
        self.proxy_address = '%s:%d' % (self.server.host, self.server.port)
847
 
        self.no_proxy_host = self.proxy_address
 
1269
        server = self.get_readonly_server()
 
1270
        self.server_host_port = '%s:%d' % (server.host, server.port)
 
1271
        if self._testing_pycurl():
 
1272
            # Oh my ! pycurl does not check for the port as part of
 
1273
            # no_proxy :-( So we just test the host part
 
1274
            self.no_proxy_host = server.host
 
1275
        else:
 
1276
            self.no_proxy_host = self.server_host_port
848
1277
        # The secondary server is the proxy
849
 
        self.proxy = self.get_secondary_server()
850
 
        self.proxy_url = self.proxy.get_url()
851
 
        self._old_env = {}
852
 
 
853
 
    def create_transport_secondary_server(self):
854
 
        """Creates an http server that will serve files with
855
 
        '-proxied' appended to their names.
856
 
        """
857
 
        return ProxyServer()
858
 
 
859
 
    def _install_env(self, env):
860
 
        for name, value in env.iteritems():
861
 
            self._old_env[name] = osutils.set_or_unset_env(name, value)
862
 
 
863
 
    def _restore_env(self):
864
 
        for name, value in self._old_env.iteritems():
865
 
            osutils.set_or_unset_env(name, value)
866
 
 
867
 
    def proxied_in_env(self, env):
868
 
        self._install_env(env)
869
 
        url = self.server.get_url()
870
 
        t = self._transport(url)
871
 
        try:
872
 
            self.assertEqual(t.get('foo').read(), 'proxied contents of foo\n')
873
 
        finally:
874
 
            self._restore_env()
875
 
 
876
 
    def not_proxied_in_env(self, env):
877
 
        self._install_env(env)
878
 
        url = self.server.get_url()
879
 
        t = self._transport(url)
880
 
        try:
881
 
            self.assertEqual(t.get('foo').read(), 'contents of foo\n')
882
 
        finally:
883
 
            self._restore_env()
 
1278
        self.proxy_url = self.get_secondary_url()
 
1279
 
 
1280
    def _testing_pycurl(self):
 
1281
        # TODO: This is duplicated for lots of the classes in this file
 
1282
        return (features.pycurl.available()
 
1283
                and self._transport == PyCurlTransport)
 
1284
 
 
1285
    def assertProxied(self):
 
1286
        t = self.get_readonly_transport()
 
1287
        self.assertEqual('proxied contents of foo\n', t.get('foo').read())
 
1288
 
 
1289
    def assertNotProxied(self):
 
1290
        t = self.get_readonly_transport()
 
1291
        self.assertEqual('contents of foo\n', t.get('foo').read())
884
1292
 
885
1293
    def test_http_proxy(self):
886
 
        self.proxied_in_env({'http_proxy': self.proxy_url})
 
1294
        self.overrideEnv('http_proxy', self.proxy_url)
 
1295
        self.assertProxied()
887
1296
 
888
1297
    def test_HTTP_PROXY(self):
889
 
        self.proxied_in_env({'HTTP_PROXY': self.proxy_url})
 
1298
        if self._testing_pycurl():
 
1299
            # pycurl does not check HTTP_PROXY for security reasons
 
1300
            # (for use in a CGI context that we do not care
 
1301
            # about. Should we ?)
 
1302
            raise tests.TestNotApplicable(
 
1303
                'pycurl does not check HTTP_PROXY for security reasons')
 
1304
        self.overrideEnv('HTTP_PROXY', self.proxy_url)
 
1305
        self.assertProxied()
890
1306
 
891
1307
    def test_all_proxy(self):
892
 
        self.proxied_in_env({'all_proxy': self.proxy_url})
 
1308
        self.overrideEnv('all_proxy', self.proxy_url)
 
1309
        self.assertProxied()
893
1310
 
894
1311
    def test_ALL_PROXY(self):
895
 
        self.proxied_in_env({'ALL_PROXY': self.proxy_url})
 
1312
        self.overrideEnv('ALL_PROXY', self.proxy_url)
 
1313
        self.assertProxied()
896
1314
 
897
1315
    def test_http_proxy_with_no_proxy(self):
898
 
        self.not_proxied_in_env({'http_proxy': self.proxy_url,
899
 
                                 'no_proxy': self.no_proxy_host})
 
1316
        self.overrideEnv('no_proxy', self.no_proxy_host)
 
1317
        self.overrideEnv('http_proxy', self.proxy_url)
 
1318
        self.assertNotProxied()
900
1319
 
901
1320
    def test_HTTP_PROXY_with_NO_PROXY(self):
902
 
        self.not_proxied_in_env({'HTTP_PROXY': self.proxy_url,
903
 
                                 'NO_PROXY': self.no_proxy_host})
 
1321
        if self._testing_pycurl():
 
1322
            raise tests.TestNotApplicable(
 
1323
                'pycurl does not check HTTP_PROXY for security reasons')
 
1324
        self.overrideEnv('NO_PROXY', self.no_proxy_host)
 
1325
        self.overrideEnv('HTTP_PROXY', self.proxy_url)
 
1326
        self.assertNotProxied()
904
1327
 
905
1328
    def test_all_proxy_with_no_proxy(self):
906
 
        self.not_proxied_in_env({'all_proxy': self.proxy_url,
907
 
                                 'no_proxy': self.no_proxy_host})
 
1329
        self.overrideEnv('no_proxy', self.no_proxy_host)
 
1330
        self.overrideEnv('all_proxy', self.proxy_url)
 
1331
        self.assertNotProxied()
908
1332
 
909
1333
    def test_ALL_PROXY_with_NO_PROXY(self):
910
 
        self.not_proxied_in_env({'ALL_PROXY': self.proxy_url,
911
 
                                 'NO_PROXY': self.no_proxy_host})
912
 
 
913
 
    def test_http_proxy_without_scheme(self):
914
 
        self.assertRaises(errors.InvalidURL,
915
 
                          self.proxied_in_env,
916
 
                          {'http_proxy': self.proxy_address})
917
 
 
918
 
 
919
 
class TestProxyHttpServer_urllib(TestProxyHttpServer,
920
 
                                 TestCaseWithTwoWebservers):
921
 
    """Tests proxy server for urllib implementation"""
922
 
 
923
 
    _transport = HttpTransport_urllib
924
 
 
925
 
 
926
 
class TestProxyHttpServer_pycurl(TestWithTransport_pycurl,
927
 
                                 TestProxyHttpServer,
928
 
                                 TestCaseWithTwoWebservers):
929
 
    """Tests proxy server for pycurl implementation"""
930
 
 
931
 
    def setUp(self):
932
 
        TestProxyHttpServer.setUp(self)
933
 
        # Oh my ! pycurl does not check for the port as part of
934
 
        # no_proxy :-( So we just test the host part
935
 
        self.no_proxy_host = 'localhost'
936
 
 
937
 
    def test_HTTP_PROXY(self):
938
 
        # pycurl do not check HTTP_PROXY for security reasons
939
 
        # (for use in a CGI context that we do not care
940
 
        # about. Should we ?)
941
 
        raise TestSkipped()
942
 
 
943
 
    def test_HTTP_PROXY_with_NO_PROXY(self):
944
 
        raise TestSkipped()
945
 
 
946
 
    def test_http_proxy_without_scheme(self):
947
 
        # pycurl *ignores* invalid proxy env variables. If that
948
 
        # ever change in the future, this test will fail
949
 
        # indicating that pycurl do not ignore anymore such
950
 
        # variables.
951
 
        self.not_proxied_in_env({'http_proxy': self.proxy_address})
952
 
 
953
 
 
954
 
class TestRanges(object):
955
 
    """Test the Range header in GET methods..
956
 
 
957
 
    This MUST be used by daughter classes that also inherit from
958
 
    TestCaseWithWebserver.
959
 
 
960
 
    We can't inherit directly from TestCaseWithWebserver or the
961
 
    test framework will try to create an instance which cannot
962
 
    run, its implementation being incomplete.
963
 
    """
964
 
 
965
 
    def setUp(self):
966
 
        TestCaseWithWebserver.setUp(self)
 
1334
        self.overrideEnv('NO_PROXY', self.no_proxy_host)
 
1335
        self.overrideEnv('ALL_PROXY', self.proxy_url)
 
1336
        self.assertNotProxied()
 
1337
 
 
1338
    def test_http_proxy_without_scheme(self):
 
1339
        self.overrideEnv('http_proxy', self.server_host_port)
 
1340
        if self._testing_pycurl():
 
1341
            # pycurl *ignores* invalid proxy env variables. If that ever change
 
1342
            # in the future, this test will fail indicating that pycurl do not
 
1343
            # ignore anymore such variables.
 
1344
            self.assertNotProxied()
 
1345
        else:
 
1346
            self.assertRaises(errors.InvalidURL, self.assertProxied)
 
1347
 
 
1348
 
 
1349
class TestRanges(http_utils.TestCaseWithWebserver):
 
1350
    """Test the Range header in GET methods."""
 
1351
 
 
1352
    scenarios = multiply_scenarios(
 
1353
        vary_by_http_client_implementation(),
 
1354
        vary_by_http_protocol_version(),
 
1355
        )
 
1356
 
 
1357
    def setUp(self):
 
1358
        http_utils.TestCaseWithWebserver.setUp(self)
967
1359
        self.build_tree_contents([('a', '0123456789')],)
968
 
        server = self.get_readonly_server()
969
 
        self.transport = self._transport(server.get_url())
 
1360
 
 
1361
    def create_transport_readonly_server(self):
 
1362
        return http_server.HttpServer(protocol_version=self._protocol_version)
970
1363
 
971
1364
    def _file_contents(self, relpath, ranges):
 
1365
        t = self.get_readonly_transport()
972
1366
        offsets = [ (start, end - start + 1) for start, end in ranges]
973
 
        coalesce = self.transport._coalesce_offsets
 
1367
        coalesce = t._coalesce_offsets
974
1368
        coalesced = list(coalesce(offsets, limit=0, fudge_factor=0))
975
 
        code, data = self.transport._get(relpath, coalesced)
 
1369
        code, data = t._get(relpath, coalesced)
976
1370
        self.assertTrue(code in (200, 206),'_get returns: %d' % code)
977
1371
        for start, end in ranges:
978
1372
            data.seek(start)
979
1373
            yield data.read(end - start + 1)
980
1374
 
981
1375
    def _file_tail(self, relpath, tail_amount):
982
 
        code, data = self.transport._get(relpath, [], tail_amount)
 
1376
        t = self.get_readonly_transport()
 
1377
        code, data = t._get(relpath, [], tail_amount)
983
1378
        self.assertTrue(code in (200, 206),'_get returns: %d' % code)
984
 
        data.seek(-tail_amount + 1, 2)
 
1379
        data.seek(-tail_amount, 2)
985
1380
        return data.read(tail_amount)
986
1381
 
987
1382
    def test_range_header(self):
988
1383
        # Valid ranges
989
1384
        map(self.assertEqual,['0', '234'],
990
1385
            list(self._file_contents('a', [(0,0), (2,4)])),)
991
 
        # Tail
 
1386
 
 
1387
    def test_range_header_tail(self):
992
1388
        self.assertEqual('789', self._file_tail('a', 3))
993
 
        # Syntactically invalid range
994
 
        self.assertListRaises(errors.InvalidRange,
 
1389
 
 
1390
    def test_syntactically_invalid_range_header(self):
 
1391
        self.assertListRaises(errors.InvalidHttpRange,
995
1392
                          self._file_contents, 'a', [(4, 3)])
996
 
        # Semantically invalid range
997
 
        self.assertListRaises(errors.InvalidRange,
 
1393
 
 
1394
    def test_semantically_invalid_range_header(self):
 
1395
        self.assertListRaises(errors.InvalidHttpRange,
998
1396
                          self._file_contents, 'a', [(42, 128)])
999
1397
 
1000
1398
 
1001
 
class TestRanges_urllib(TestRanges, TestCaseWithWebserver):
1002
 
    """Test the Range header in GET methods for urllib implementation"""
1003
 
 
1004
 
    _transport = HttpTransport_urllib
1005
 
 
1006
 
 
1007
 
class TestRanges_pycurl(TestWithTransport_pycurl,
1008
 
                        TestRanges,
1009
 
                        TestCaseWithWebserver):
1010
 
    """Test the Range header in GET methods for pycurl implementation"""
1011
 
 
1012
 
 
1013
 
class TestHTTPRedirections(object):
1014
 
    """Test redirection between http servers.
1015
 
 
1016
 
    This MUST be used by daughter classes that also inherit from
1017
 
    TestCaseWithRedirectedWebserver.
1018
 
 
1019
 
    We can't inherit directly from TestCaseWithTwoWebservers or the
1020
 
    test framework will try to create an instance which cannot
1021
 
    run, its implementation being incomplete. 
1022
 
    """
1023
 
 
1024
 
    def create_transport_secondary_server(self):
1025
 
        """Create the secondary server redirecting to the primary server"""
1026
 
        new = self.get_readonly_server()
1027
 
 
1028
 
        redirecting = HTTPServerRedirecting()
1029
 
        redirecting.redirect_to(new.host, new.port)
1030
 
        return redirecting
 
1399
class TestHTTPRedirections(http_utils.TestCaseWithRedirectedWebserver):
 
1400
    """Test redirection between http servers."""
 
1401
 
 
1402
    scenarios = multiply_scenarios(
 
1403
        vary_by_http_client_implementation(),
 
1404
        vary_by_http_protocol_version(),
 
1405
        )
1031
1406
 
1032
1407
    def setUp(self):
1033
1408
        super(TestHTTPRedirections, self).setUp()
1036
1411
                                  '# Bazaar revision bundle v0.9\n#\n')
1037
1412
                                  ],)
1038
1413
 
1039
 
        self.old_transport = self._transport(self.old_server.get_url())
1040
 
 
1041
1414
    def test_redirected(self):
1042
 
        self.assertRaises(errors.RedirectRequested, self.old_transport.get, 'a')
1043
 
        t = self._transport(self.new_server.get_url())
1044
 
        self.assertEqual('0123456789', t.get('a').read())
1045
 
 
1046
 
    def test_read_redirected_bundle_from_url(self):
1047
 
        from bzrlib.bundle import read_bundle_from_url
1048
 
        url = self.old_transport.abspath('bundle')
1049
 
        bundle = read_bundle_from_url(url)
1050
 
        # If read_bundle_from_url was successful we get an empty bundle
1051
 
        self.assertEqual([], bundle.revisions)
1052
 
 
1053
 
 
1054
 
class TestHTTPRedirections_urllib(TestHTTPRedirections,
1055
 
                                  TestCaseWithRedirectedWebserver):
1056
 
    """Tests redirections for urllib implementation"""
1057
 
 
1058
 
    _transport = HttpTransport_urllib
1059
 
 
1060
 
 
1061
 
 
1062
 
class TestHTTPRedirections_pycurl(TestWithTransport_pycurl,
1063
 
                                  TestHTTPRedirections,
1064
 
                                  TestCaseWithRedirectedWebserver):
1065
 
    """Tests redirections for pycurl implementation"""
1066
 
 
1067
 
 
1068
 
class RedirectedRequest(Request):
1069
 
    """Request following redirections"""
1070
 
 
1071
 
    init_orig = Request.__init__
 
1415
        self.assertRaises(errors.RedirectRequested,
 
1416
                          self.get_old_transport().get, 'a')
 
1417
        self.assertEqual('0123456789', self.get_new_transport().get('a').read())
 
1418
 
 
1419
 
 
1420
class RedirectedRequest(_urllib2_wrappers.Request):
 
1421
    """Request following redirections. """
 
1422
 
 
1423
    init_orig = _urllib2_wrappers.Request.__init__
1072
1424
 
1073
1425
    def __init__(self, method, url, *args, **kwargs):
1074
 
        RedirectedRequest.init_orig(self, method, url, args, kwargs)
 
1426
        """Constructor.
 
1427
 
 
1428
        """
 
1429
        # Since the tests using this class will replace
 
1430
        # _urllib2_wrappers.Request, we can't just call the base class __init__
 
1431
        # or we'll loop.
 
1432
        RedirectedRequest.init_orig(self, method, url, *args, **kwargs)
1075
1433
        self.follow_redirections = True
1076
1434
 
1077
1435
 
1078
 
class TestHTTPSilentRedirections_urllib(TestCaseWithRedirectedWebserver):
1079
 
    """Test redirections provided by urllib.
 
1436
def install_redirected_request(test):
 
1437
    test.overrideAttr(_urllib2_wrappers, 'Request', RedirectedRequest)
 
1438
 
 
1439
 
 
1440
def cleanup_http_redirection_connections(test):
 
1441
    # Some sockets are opened but never seen by _urllib, so we trap them at
 
1442
    # the _urllib2_wrappers level to be able to clean them up.
 
1443
    def socket_disconnect(sock):
 
1444
        try:
 
1445
            sock.shutdown(socket.SHUT_RDWR)
 
1446
            sock.close()
 
1447
        except socket.error:
 
1448
            pass
 
1449
    def connect(connection):
 
1450
        test.http_connect_orig(connection)
 
1451
        test.addCleanup(socket_disconnect, connection.sock)
 
1452
    test.http_connect_orig = test.overrideAttr(
 
1453
        _urllib2_wrappers.HTTPConnection, 'connect', connect)
 
1454
    def connect(connection):
 
1455
        test.https_connect_orig(connection)
 
1456
        test.addCleanup(socket_disconnect, connection.sock)
 
1457
    test.https_connect_orig = test.overrideAttr(
 
1458
        _urllib2_wrappers.HTTPSConnection, 'connect', connect)
 
1459
 
 
1460
 
 
1461
class TestHTTPSilentRedirections(http_utils.TestCaseWithRedirectedWebserver):
 
1462
    """Test redirections.
1080
1463
 
1081
1464
    http implementations do not redirect silently anymore (they
1082
1465
    do not redirect at all in fact). The mechanism is still in
1089
1472
    -- vila 20070212
1090
1473
    """
1091
1474
 
1092
 
    _transport = HttpTransport_urllib
 
1475
    scenarios = multiply_scenarios(
 
1476
        vary_by_http_client_implementation(),
 
1477
        vary_by_http_protocol_version(),
 
1478
        )
1093
1479
 
1094
1480
    def setUp(self):
1095
 
        super(TestHTTPSilentRedirections_urllib, self).setUp()
1096
 
        self.setup_redirected_request()
1097
 
        self.addCleanup(self.cleanup_redirected_request)
 
1481
        if (features.pycurl.available()
 
1482
            and self._transport == PyCurlTransport):
 
1483
            raise tests.TestNotApplicable(
 
1484
                "pycurl doesn't redirect silently anymore")
 
1485
        super(TestHTTPSilentRedirections, self).setUp()
 
1486
        install_redirected_request(self)
 
1487
        cleanup_http_redirection_connections(self)
1098
1488
        self.build_tree_contents([('a','a'),
1099
1489
                                  ('1/',),
1100
1490
                                  ('1/a', 'redirected once'),
1108
1498
                                  ('5/a', 'redirected 5 times'),
1109
1499
                                  ],)
1110
1500
 
1111
 
        self.old_transport = self._transport(self.old_server.get_url())
1112
 
 
1113
 
    def setup_redirected_request(self):
1114
 
        self.original_class = _urllib2_wrappers.Request
1115
 
        _urllib2_wrappers.Request = RedirectedRequest
1116
 
 
1117
 
    def cleanup_redirected_request(self):
1118
 
        _urllib2_wrappers.Request = self.original_class
1119
 
 
1120
 
    def create_transport_secondary_server(self):
1121
 
        """Create the secondary server, redirections are defined in the tests"""
1122
 
        return HTTPServerRedirecting()
1123
 
 
1124
1501
    def test_one_redirection(self):
1125
 
        t = self.old_transport
1126
 
 
1127
 
        req = RedirectedRequest('GET', t.abspath('a'))
1128
 
        req.follow_redirections = True
 
1502
        t = self.get_old_transport()
 
1503
        req = RedirectedRequest('GET', t._remote_path('a'))
1129
1504
        new_prefix = 'http://%s:%s' % (self.new_server.host,
1130
1505
                                       self.new_server.port)
1131
1506
        self.old_server.redirections = \
1132
1507
            [('(.*)', r'%s/1\1' % (new_prefix), 301),]
1133
 
        self.assertEquals('redirected once',t._perform(req).read())
 
1508
        self.assertEqual('redirected once', t._perform(req).read())
1134
1509
 
1135
1510
    def test_five_redirections(self):
1136
 
        t = self.old_transport
1137
 
 
1138
 
        req = RedirectedRequest('GET', t.abspath('a'))
1139
 
        req.follow_redirections = True
 
1511
        t = self.get_old_transport()
 
1512
        req = RedirectedRequest('GET', t._remote_path('a'))
1140
1513
        old_prefix = 'http://%s:%s' % (self.old_server.host,
1141
1514
                                       self.old_server.port)
1142
1515
        new_prefix = 'http://%s:%s' % (self.new_server.host,
1143
1516
                                       self.new_server.port)
1144
 
        self.old_server.redirections = \
1145
 
            [('/1(.*)', r'%s/2\1' % (old_prefix), 302),
1146
 
             ('/2(.*)', r'%s/3\1' % (old_prefix), 303),
1147
 
             ('/3(.*)', r'%s/4\1' % (old_prefix), 307),
1148
 
             ('/4(.*)', r'%s/5\1' % (new_prefix), 301),
1149
 
             ('(/[^/]+)', r'%s/1\1' % (old_prefix), 301),
1150
 
             ]
1151
 
        self.assertEquals('redirected 5 times',t._perform(req).read())
1152
 
 
1153
 
 
1154
 
class TestDoCatchRedirections(TestCaseWithRedirectedWebserver):
1155
 
    """Test transport.do_catching_redirections.
1156
 
 
1157
 
    We arbitrarily choose to use urllib transports
1158
 
    """
1159
 
 
1160
 
    _transport = HttpTransport_urllib
 
1517
        self.old_server.redirections = [
 
1518
            ('/1(.*)', r'%s/2\1' % (old_prefix), 302),
 
1519
            ('/2(.*)', r'%s/3\1' % (old_prefix), 303),
 
1520
            ('/3(.*)', r'%s/4\1' % (old_prefix), 307),
 
1521
            ('/4(.*)', r'%s/5\1' % (new_prefix), 301),
 
1522
            ('(/[^/]+)', r'%s/1\1' % (old_prefix), 301),
 
1523
            ]
 
1524
        self.assertEqual('redirected 5 times', t._perform(req).read())
 
1525
 
 
1526
 
 
1527
class TestDoCatchRedirections(http_utils.TestCaseWithRedirectedWebserver):
 
1528
    """Test transport.do_catching_redirections."""
 
1529
 
 
1530
    scenarios = multiply_scenarios(
 
1531
        vary_by_http_client_implementation(),
 
1532
        vary_by_http_protocol_version(),
 
1533
        )
1161
1534
 
1162
1535
    def setUp(self):
1163
1536
        super(TestDoCatchRedirections, self).setUp()
1164
1537
        self.build_tree_contents([('a', '0123456789'),],)
1165
 
 
1166
 
        self.old_transport = self._transport(self.old_server.get_url())
1167
 
 
1168
 
    def get_a(self, transport):
1169
 
        return transport.get('a')
 
1538
        cleanup_http_redirection_connections(self)
 
1539
 
 
1540
        self.old_transport = self.get_old_transport()
 
1541
 
 
1542
    def get_a(self, t):
 
1543
        return t.get('a')
1170
1544
 
1171
1545
    def test_no_redirection(self):
1172
 
        t = self._transport(self.new_server.get_url())
 
1546
        t = self.get_new_transport()
1173
1547
 
1174
1548
        # We use None for redirected so that we fail if redirected
1175
 
        self.assertEquals('0123456789',
1176
 
                          do_catching_redirections(self.get_a, t, None).read())
 
1549
        self.assertEqual('0123456789',
 
1550
                         transport.do_catching_redirections(
 
1551
                self.get_a, t, None).read())
1177
1552
 
1178
1553
    def test_one_redirection(self):
1179
1554
        self.redirections = 0
1180
1555
 
1181
 
        def redirected(transport, exception, redirection_notice):
 
1556
        def redirected(t, exception, redirection_notice):
1182
1557
            self.redirections += 1
1183
 
            dir, file = urlutils.split(exception.target)
1184
 
            return self._transport(dir)
 
1558
            redirected_t = t._redirected_to(exception.source, exception.target)
 
1559
            return redirected_t
1185
1560
 
1186
 
        self.assertEquals('0123456789',
1187
 
                          do_catching_redirections(self.get_a,
1188
 
                                                   self.old_transport,
1189
 
                                                   redirected
1190
 
                                                   ).read())
1191
 
        self.assertEquals(1, self.redirections)
 
1561
        self.assertEqual('0123456789',
 
1562
                         transport.do_catching_redirections(
 
1563
                self.get_a, self.old_transport, redirected).read())
 
1564
        self.assertEqual(1, self.redirections)
1192
1565
 
1193
1566
    def test_redirection_loop(self):
1194
1567
 
1198
1571
            # a/a/a
1199
1572
            return self.old_transport.clone(exception.target)
1200
1573
 
1201
 
        self.assertRaises(errors.TooManyRedirections, do_catching_redirections,
 
1574
        self.assertRaises(errors.TooManyRedirections,
 
1575
                          transport.do_catching_redirections,
1202
1576
                          self.get_a, self.old_transport, redirected)
1203
1577
 
1204
1578
 
1205
 
class TestAuth(object):
1206
 
    """Test some authentication scheme specified by daughter class.
1207
 
 
1208
 
    This MUST be used by daughter classes that also inherit from
1209
 
    either TestCaseWithWebserver or TestCaseWithTwoWebservers.
1210
 
    """
 
1579
def _setup_authentication_config(**kwargs):
 
1580
    conf = config.AuthenticationConfig()
 
1581
    conf._get_config().update({'httptest': kwargs})
 
1582
    conf._save()
 
1583
 
 
1584
 
 
1585
class TestUrllib2AuthHandler(tests.TestCaseWithTransport):
 
1586
    """Unit tests for glue by which urllib2 asks us for authentication"""
 
1587
 
 
1588
    def test_get_user_password_without_port(self):
 
1589
        """We cope if urllib2 doesn't tell us the port.
 
1590
 
 
1591
        See https://bugs.launchpad.net/bzr/+bug/654684
 
1592
        """
 
1593
        user = 'joe'
 
1594
        password = 'foo'
 
1595
        _setup_authentication_config(scheme='http', host='localhost',
 
1596
                                     user=user, password=password)
 
1597
        handler = _urllib2_wrappers.HTTPAuthHandler()
 
1598
        got_pass = handler.get_user_password(dict(
 
1599
            user='joe',
 
1600
            protocol='http',
 
1601
            host='localhost',
 
1602
            path='/',
 
1603
            realm='Realm',
 
1604
            ))
 
1605
        self.assertEquals((user, password), got_pass)
 
1606
 
 
1607
 
 
1608
class TestAuth(http_utils.TestCaseWithWebserver):
 
1609
    """Test authentication scheme"""
 
1610
 
 
1611
    scenarios = multiply_scenarios(
 
1612
        vary_by_http_client_implementation(),
 
1613
        vary_by_http_protocol_version(),
 
1614
        vary_by_http_auth_scheme(),
 
1615
        )
1211
1616
 
1212
1617
    def setUp(self):
1213
 
        """Set up the test environment
1214
 
 
1215
 
        Daughter classes should set up their own environment
1216
 
        (including self.server) and explicitely call this
1217
 
        method. This is needed because we want to reuse the same
1218
 
        tests for proxy and no-proxy accesses which have
1219
 
        different ways of setting self.server.
1220
 
        """
 
1618
        super(TestAuth, self).setUp()
 
1619
        self.server = self.get_readonly_server()
1221
1620
        self.build_tree_contents([('a', 'contents of a\n'),
1222
1621
                                  ('b', 'contents of b\n'),])
1223
 
        self.old_factory = ui.ui_factory
1224
 
        # The following has the unfortunate side-effect of hiding any ouput
1225
 
        # during the tests (including pdb prompts). Feel free to comment them
1226
 
        # for debugging purposes but leave them in place, there are needed to
1227
 
        # run the tests without any console
1228
 
        self.old_stdout = sys.stdout
1229
 
        sys.stdout = StringIOWrapper()
1230
 
        self.addCleanup(self.restoreUIFactory)
1231
 
 
1232
 
    def restoreUIFactory(self):
1233
 
        ui.ui_factory = self.old_factory
1234
 
        sys.stdout = self.old_stdout
1235
 
 
1236
 
    def get_user_url(self, user=None, password=None):
 
1622
 
 
1623
    def create_transport_readonly_server(self):
 
1624
        server = self._auth_server(protocol_version=self._protocol_version)
 
1625
        server._url_protocol = self._url_protocol
 
1626
        return server
 
1627
 
 
1628
    def _testing_pycurl(self):
 
1629
        # TODO: This is duplicated for lots of the classes in this file
 
1630
        return (features.pycurl.available()
 
1631
                and self._transport == PyCurlTransport)
 
1632
 
 
1633
    def get_user_url(self, user, password):
1237
1634
        """Build an url embedding user and password"""
1238
1635
        url = '%s://' % self.server._url_protocol
1239
1636
        if user is not None:
1244
1641
        url += '%s:%s/' % (self.server.host, self.server.port)
1245
1642
        return url
1246
1643
 
 
1644
    def get_user_transport(self, user, password):
 
1645
        t = transport.get_transport_from_url(
 
1646
            self.get_user_url(user, password))
 
1647
        return t
 
1648
 
1247
1649
    def test_no_user(self):
1248
1650
        self.server.add_user('joe', 'foo')
1249
 
        t = self.get_user_transport()
 
1651
        t = self.get_user_transport(None, None)
1250
1652
        self.assertRaises(errors.InvalidHttpResponse, t.get, 'a')
1251
1653
        # Only one 'Authentication Required' error should occur
1252
1654
        self.assertEqual(1, self.server.auth_required_errors)
1282
1684
        # initial 'who are you' and 'this is not you, who are you')
1283
1685
        self.assertEqual(2, self.server.auth_required_errors)
1284
1686
 
 
1687
    def test_prompt_for_username(self):
 
1688
        if self._testing_pycurl():
 
1689
            raise tests.TestNotApplicable(
 
1690
                'pycurl cannot prompt, it handles auth by embedding'
 
1691
                ' user:pass in urls only')
 
1692
 
 
1693
        self.server.add_user('joe', 'foo')
 
1694
        t = self.get_user_transport(None, None)
 
1695
        stdout = tests.StringIOWrapper()
 
1696
        stderr = tests.StringIOWrapper()
 
1697
        ui.ui_factory = tests.TestUIFactory(stdin='joe\nfoo\n',
 
1698
                                            stdout=stdout, stderr=stderr)
 
1699
        self.assertEqual('contents of a\n',t.get('a').read())
 
1700
        # stdin should be empty
 
1701
        self.assertEqual('', ui.ui_factory.stdin.readline())
 
1702
        stderr.seek(0)
 
1703
        expected_prompt = self._expected_username_prompt(t._unqualified_scheme)
 
1704
        self.assertEqual(expected_prompt, stderr.read(len(expected_prompt)))
 
1705
        self.assertEqual('', stdout.getvalue())
 
1706
        self._check_password_prompt(t._unqualified_scheme, 'joe',
 
1707
                                    stderr.readline())
 
1708
 
1285
1709
    def test_prompt_for_password(self):
 
1710
        if self._testing_pycurl():
 
1711
            raise tests.TestNotApplicable(
 
1712
                'pycurl cannot prompt, it handles auth by embedding'
 
1713
                ' user:pass in urls only')
 
1714
 
1286
1715
        self.server.add_user('joe', 'foo')
1287
1716
        t = self.get_user_transport('joe', None)
1288
 
        ui.ui_factory = TestUIFactory(stdin='foo\n')
1289
 
        self.assertEqual('contents of a\n',t.get('a').read())
 
1717
        stdout = tests.StringIOWrapper()
 
1718
        stderr = tests.StringIOWrapper()
 
1719
        ui.ui_factory = tests.TestUIFactory(stdin='foo\n',
 
1720
                                            stdout=stdout, stderr=stderr)
 
1721
        self.assertEqual('contents of a\n', t.get('a').read())
1290
1722
        # stdin should be empty
1291
1723
        self.assertEqual('', ui.ui_factory.stdin.readline())
 
1724
        self._check_password_prompt(t._unqualified_scheme, 'joe',
 
1725
                                    stderr.getvalue())
 
1726
        self.assertEqual('', stdout.getvalue())
1292
1727
        # And we shouldn't prompt again for a different request
1293
1728
        # against the same transport.
1294
1729
        self.assertEqual('contents of b\n',t.get('b').read())
1298
1733
        # Only one 'Authentication Required' error should occur
1299
1734
        self.assertEqual(1, self.server.auth_required_errors)
1300
1735
 
1301
 
 
1302
 
class TestHTTPAuth(TestAuth):
1303
 
    """Test HTTP authentication schemes.
1304
 
 
1305
 
    Daughter classes MUST inherit from TestCaseWithWebserver too.
1306
 
    """
1307
 
 
1308
 
    _auth_header = 'Authorization'
1309
 
 
1310
 
    def setUp(self):
1311
 
        TestCaseWithWebserver.setUp(self)
1312
 
        self.server = self.get_readonly_server()
1313
 
        TestAuth.setUp(self)
1314
 
 
1315
 
    def get_user_transport(self, user=None, password=None):
1316
 
        return self._transport(self.get_user_url(user, password))
 
1736
    def _check_password_prompt(self, scheme, user, actual_prompt):
 
1737
        expected_prompt = (self._password_prompt_prefix
 
1738
                           + ("%s %s@%s:%d, Realm: '%s' password: "
 
1739
                              % (scheme.upper(),
 
1740
                                 user, self.server.host, self.server.port,
 
1741
                                 self.server.auth_realm)))
 
1742
        self.assertEqual(expected_prompt, actual_prompt)
 
1743
 
 
1744
    def _expected_username_prompt(self, scheme):
 
1745
        return (self._username_prompt_prefix
 
1746
                + "%s %s:%d, Realm: '%s' username: " % (scheme.upper(),
 
1747
                                 self.server.host, self.server.port,
 
1748
                                 self.server.auth_realm))
 
1749
 
 
1750
    def test_no_prompt_for_password_when_using_auth_config(self):
 
1751
        if self._testing_pycurl():
 
1752
            raise tests.TestNotApplicable(
 
1753
                'pycurl does not support authentication.conf'
 
1754
                ' since it cannot prompt')
 
1755
 
 
1756
        user =' joe'
 
1757
        password = 'foo'
 
1758
        stdin_content = 'bar\n'  # Not the right password
 
1759
        self.server.add_user(user, password)
 
1760
        t = self.get_user_transport(user, None)
 
1761
        ui.ui_factory = tests.TestUIFactory(stdin=stdin_content,
 
1762
                                            stderr=tests.StringIOWrapper())
 
1763
        # Create a minimal config file with the right password
 
1764
        _setup_authentication_config(scheme='http', port=self.server.port,
 
1765
                                     user=user, password=password)
 
1766
        # Issue a request to the server to connect
 
1767
        self.assertEqual('contents of a\n',t.get('a').read())
 
1768
        # stdin should have  been left untouched
 
1769
        self.assertEqual(stdin_content, ui.ui_factory.stdin.readline())
 
1770
        # Only one 'Authentication Required' error should occur
 
1771
        self.assertEqual(1, self.server.auth_required_errors)
 
1772
 
 
1773
    def test_changing_nonce(self):
 
1774
        if self._auth_server not in (http_utils.HTTPDigestAuthServer,
 
1775
                                     http_utils.ProxyDigestAuthServer):
 
1776
            raise tests.TestNotApplicable('HTTP/proxy auth digest only test')
 
1777
        if self._testing_pycurl():
 
1778
            self.knownFailure(
 
1779
                'pycurl does not handle a nonce change')
 
1780
        self.server.add_user('joe', 'foo')
 
1781
        t = self.get_user_transport('joe', 'foo')
 
1782
        self.assertEqual('contents of a\n', t.get('a').read())
 
1783
        self.assertEqual('contents of b\n', t.get('b').read())
 
1784
        # Only one 'Authentication Required' error should have
 
1785
        # occured so far
 
1786
        self.assertEqual(1, self.server.auth_required_errors)
 
1787
        # The server invalidates the current nonce
 
1788
        self.server.auth_nonce = self.server.auth_nonce + '. No, now!'
 
1789
        self.assertEqual('contents of a\n', t.get('a').read())
 
1790
        # Two 'Authentication Required' errors should occur (the
 
1791
        # initial 'who are you' and a second 'who are you' with the new nonce)
 
1792
        self.assertEqual(2, self.server.auth_required_errors)
 
1793
 
 
1794
    def test_user_from_auth_conf(self):
 
1795
        if self._testing_pycurl():
 
1796
            raise tests.TestNotApplicable(
 
1797
                'pycurl does not support authentication.conf')
 
1798
        user = 'joe'
 
1799
        password = 'foo'
 
1800
        self.server.add_user(user, password)
 
1801
        _setup_authentication_config(scheme='http', port=self.server.port,
 
1802
                                     user=user, password=password)
 
1803
        t = self.get_user_transport(None, None)
 
1804
        # Issue a request to the server to connect
 
1805
        self.assertEqual('contents of a\n', t.get('a').read())
 
1806
        # Only one 'Authentication Required' error should occur
 
1807
        self.assertEqual(1, self.server.auth_required_errors)
 
1808
 
 
1809
    def test_no_credential_leaks_in_log(self):
 
1810
        self.overrideAttr(debug, 'debug_flags', set(['http']))
 
1811
        user = 'joe'
 
1812
        password = 'very-sensitive-password'
 
1813
        self.server.add_user(user, password)
 
1814
        t = self.get_user_transport(user, password)
 
1815
        # Capture the debug calls to mutter
 
1816
        self.mutters = []
 
1817
        def mutter(*args):
 
1818
            lines = args[0] % args[1:]
 
1819
            # Some calls output multiple lines, just split them now since we
 
1820
            # care about a single one later.
 
1821
            self.mutters.extend(lines.splitlines())
 
1822
        self.overrideAttr(trace, 'mutter', mutter)
 
1823
        # Issue a request to the server to connect
 
1824
        self.assertEqual(True, t.has('a'))
 
1825
        # Only one 'Authentication Required' error should occur
 
1826
        self.assertEqual(1, self.server.auth_required_errors)
 
1827
        # Since the authentification succeeded, there should be a corresponding
 
1828
        # debug line
 
1829
        sent_auth_headers = [line for line in self.mutters
 
1830
                             if line.startswith('> %s' % (self._auth_header,))]
 
1831
        self.assertLength(1, sent_auth_headers)
 
1832
        self.assertStartsWith(sent_auth_headers[0],
 
1833
                              '> %s: <masked>' % (self._auth_header,))
1317
1834
 
1318
1835
 
1319
1836
class TestProxyAuth(TestAuth):
1320
1837
    """Test proxy authentication schemes.
1321
1838
 
1322
 
    Daughter classes MUST also inherit from TestCaseWithWebserver.
 
1839
    This inherits from TestAuth to tweak the setUp and filter some failing
 
1840
    tests.
1323
1841
    """
1324
 
    _auth_header = 'Proxy-authorization'
 
1842
 
 
1843
    scenarios = multiply_scenarios(
 
1844
        vary_by_http_client_implementation(),
 
1845
        vary_by_http_protocol_version(),
 
1846
        vary_by_http_proxy_auth_scheme(),
 
1847
        )
1325
1848
 
1326
1849
    def setUp(self):
1327
 
        TestCaseWithWebserver.setUp(self)
1328
 
        self.server = self.get_readonly_server()
1329
 
        self._old_env = {}
1330
 
        self.addCleanup(self._restore_env)
1331
 
        TestAuth.setUp(self)
 
1850
        super(TestProxyAuth, self).setUp()
1332
1851
        # Override the contents to avoid false positives
1333
1852
        self.build_tree_contents([('a', 'not proxied contents of a\n'),
1334
1853
                                  ('b', 'not proxied contents of b\n'),
1336
1855
                                  ('b-proxied', 'contents of b\n'),
1337
1856
                                  ])
1338
1857
 
1339
 
    def get_user_transport(self, user=None, password=None):
1340
 
        self._install_env({'all_proxy': self.get_user_url(user, password)})
1341
 
        return self._transport(self.server.get_url())
1342
 
 
1343
 
    def _install_env(self, env):
1344
 
        for name, value in env.iteritems():
1345
 
            self._old_env[name] = osutils.set_or_unset_env(name, value)
1346
 
 
1347
 
    def _restore_env(self):
1348
 
        for name, value in self._old_env.iteritems():
1349
 
            osutils.set_or_unset_env(name, value)
1350
 
 
1351
 
 
1352
 
class TestHTTPBasicAuth(TestHTTPAuth, TestCaseWithWebserver):
1353
 
    """Test http basic authentication scheme"""
1354
 
 
1355
 
    _transport = HttpTransport_urllib
1356
 
 
1357
 
    def create_transport_readonly_server(self):
1358
 
        return HTTPBasicAuthServer()
1359
 
 
1360
 
 
1361
 
class TestHTTPProxyBasicAuth(TestProxyAuth, TestCaseWithWebserver):
1362
 
    """Test proxy basic authentication scheme"""
1363
 
 
1364
 
    _transport = HttpTransport_urllib
1365
 
 
1366
 
    def create_transport_readonly_server(self):
1367
 
        return ProxyBasicAuthServer()
1368
 
 
1369
 
 
1370
 
class TestDigestAuth(object):
1371
 
    """Digest Authentication specific tests"""
1372
 
 
1373
 
    def test_changing_nonce(self):
1374
 
        self.server.add_user('joe', 'foo')
1375
 
        t = self.get_user_transport('joe', 'foo')
1376
 
        self.assertEqual('contents of a\n', t.get('a').read())
1377
 
        self.assertEqual('contents of b\n', t.get('b').read())
1378
 
        # Only one 'Authentication Required' error should have
1379
 
        # occured so far
1380
 
        self.assertEqual(1, self.server.auth_required_errors)
1381
 
        # The server invalidates the current nonce
1382
 
        self.server.auth_nonce = self.server.auth_nonce + '. No, now!'
1383
 
        self.assertEqual('contents of a\n', t.get('a').read())
1384
 
        # Two 'Authentication Required' errors should occur (the
1385
 
        # initial 'who are you' and a second 'who are you' with the new nonce)
1386
 
        self.assertEqual(2, self.server.auth_required_errors)
1387
 
 
1388
 
 
1389
 
class TestHTTPDigestAuth(TestHTTPAuth, TestDigestAuth, TestCaseWithWebserver):
1390
 
    """Test http digest authentication scheme"""
1391
 
 
1392
 
    _transport = HttpTransport_urllib
1393
 
 
1394
 
    def create_transport_readonly_server(self):
1395
 
        return HTTPDigestAuthServer()
1396
 
 
1397
 
 
1398
 
class TestHTTPProxyDigestAuth(TestProxyAuth, TestDigestAuth,
1399
 
                              TestCaseWithWebserver):
1400
 
    """Test proxy digest authentication scheme"""
1401
 
 
1402
 
    _transport = HttpTransport_urllib
1403
 
 
1404
 
    def create_transport_readonly_server(self):
1405
 
        return ProxyDigestAuthServer()
 
1858
    def get_user_transport(self, user, password):
 
1859
        self.overrideEnv('all_proxy', self.get_user_url(user, password))
 
1860
        return TestAuth.get_user_transport(self, user, password)
 
1861
 
 
1862
    def test_empty_pass(self):
 
1863
        if self._testing_pycurl():
 
1864
            import pycurl
 
1865
            if pycurl.version_info()[1] < '7.16.0':
 
1866
                self.knownFailure(
 
1867
                    'pycurl < 7.16.0 does not handle empty proxy passwords')
 
1868
        super(TestProxyAuth, self).test_empty_pass()
 
1869
 
 
1870
 
 
1871
class SampleSocket(object):
 
1872
    """A socket-like object for use in testing the HTTP request handler."""
 
1873
 
 
1874
    def __init__(self, socket_read_content):
 
1875
        """Constructs a sample socket.
 
1876
 
 
1877
        :param socket_read_content: a byte sequence
 
1878
        """
 
1879
        # Use plain python StringIO so we can monkey-patch the close method to
 
1880
        # not discard the contents.
 
1881
        from StringIO import StringIO
 
1882
        self.readfile = StringIO(socket_read_content)
 
1883
        self.writefile = StringIO()
 
1884
        self.writefile.close = lambda: None
 
1885
        self.close = lambda: None
 
1886
 
 
1887
    def makefile(self, mode='r', bufsize=None):
 
1888
        if 'r' in mode:
 
1889
            return self.readfile
 
1890
        else:
 
1891
            return self.writefile
 
1892
 
 
1893
 
 
1894
class SmartHTTPTunnellingTest(tests.TestCaseWithTransport):
 
1895
 
 
1896
    scenarios = multiply_scenarios(
 
1897
        vary_by_http_client_implementation(),
 
1898
        vary_by_http_protocol_version(),
 
1899
        )
 
1900
 
 
1901
    def setUp(self):
 
1902
        super(SmartHTTPTunnellingTest, self).setUp()
 
1903
        # We use the VFS layer as part of HTTP tunnelling tests.
 
1904
        self.overrideEnv('BZR_NO_SMART_VFS', None)
 
1905
        self.transport_readonly_server = http_utils.HTTPServerWithSmarts
 
1906
        self.http_server = self.get_readonly_server()
 
1907
 
 
1908
    def create_transport_readonly_server(self):
 
1909
        server = http_utils.HTTPServerWithSmarts(
 
1910
            protocol_version=self._protocol_version)
 
1911
        server._url_protocol = self._url_protocol
 
1912
        return server
 
1913
 
 
1914
    def test_open_controldir(self):
 
1915
        branch = self.make_branch('relpath')
 
1916
        url = self.http_server.get_url() + 'relpath'
 
1917
        bd = controldir.ControlDir.open(url)
 
1918
        self.addCleanup(bd.transport.disconnect)
 
1919
        self.assertIsInstance(bd, _mod_remote.RemoteBzrDir)
 
1920
 
 
1921
    def test_bulk_data(self):
 
1922
        # We should be able to send and receive bulk data in a single message.
 
1923
        # The 'readv' command in the smart protocol both sends and receives
 
1924
        # bulk data, so we use that.
 
1925
        self.build_tree(['data-file'])
 
1926
        http_transport = transport.get_transport_from_url(
 
1927
            self.http_server.get_url())
 
1928
        medium = http_transport.get_smart_medium()
 
1929
        # Since we provide the medium, the url below will be mostly ignored
 
1930
        # during the test, as long as the path is '/'.
 
1931
        remote_transport = remote.RemoteTransport('bzr://fake_host/',
 
1932
                                                  medium=medium)
 
1933
        self.assertEqual(
 
1934
            [(0, "c")], list(remote_transport.readv("data-file", [(0,1)])))
 
1935
 
 
1936
    def test_http_send_smart_request(self):
 
1937
 
 
1938
        post_body = 'hello\n'
 
1939
        expected_reply_body = 'ok\x012\n'
 
1940
 
 
1941
        http_transport = transport.get_transport_from_url(
 
1942
            self.http_server.get_url())
 
1943
        medium = http_transport.get_smart_medium()
 
1944
        response = medium.send_http_smart_request(post_body)
 
1945
        reply_body = response.read()
 
1946
        self.assertEqual(expected_reply_body, reply_body)
 
1947
 
 
1948
    def test_smart_http_server_post_request_handler(self):
 
1949
        httpd = self.http_server.server
 
1950
 
 
1951
        socket = SampleSocket(
 
1952
            'POST /.bzr/smart %s \r\n' % self._protocol_version
 
1953
            # HTTP/1.1 posts must have a Content-Length (but it doesn't hurt
 
1954
            # for 1.0)
 
1955
            + 'Content-Length: 6\r\n'
 
1956
            '\r\n'
 
1957
            'hello\n')
 
1958
        # Beware: the ('localhost', 80) below is the
 
1959
        # client_address parameter, but we don't have one because
 
1960
        # we have defined a socket which is not bound to an
 
1961
        # address. The test framework never uses this client
 
1962
        # address, so far...
 
1963
        request_handler = http_utils.SmartRequestHandler(socket,
 
1964
                                                         ('localhost', 80),
 
1965
                                                         httpd)
 
1966
        response = socket.writefile.getvalue()
 
1967
        self.assertStartsWith(response, '%s 200 ' % self._protocol_version)
 
1968
        # This includes the end of the HTTP headers, and all the body.
 
1969
        expected_end_of_response = '\r\n\r\nok\x012\n'
 
1970
        self.assertEndsWith(response, expected_end_of_response)
 
1971
 
 
1972
 
 
1973
class ForbiddenRequestHandler(http_server.TestingHTTPRequestHandler):
 
1974
    """No smart server here request handler."""
 
1975
 
 
1976
    def do_POST(self):
 
1977
        self.send_error(403, "Forbidden")
 
1978
 
 
1979
 
 
1980
class SmartClientAgainstNotSmartServer(TestSpecificRequestHandler):
 
1981
    """Test smart client behaviour against an http server without smarts."""
 
1982
 
 
1983
    _req_handler_class = ForbiddenRequestHandler
 
1984
 
 
1985
    def test_probe_smart_server(self):
 
1986
        """Test error handling against server refusing smart requests."""
 
1987
        t = self.get_readonly_transport()
 
1988
        # No need to build a valid smart request here, the server will not even
 
1989
        # try to interpret it.
 
1990
        self.assertRaises(errors.SmartProtocolError,
 
1991
                          t.get_smart_medium().send_http_smart_request,
 
1992
                          'whatever')
 
1993
 
 
1994
 
 
1995
class Test_redirected_to(tests.TestCase):
 
1996
 
 
1997
    scenarios = vary_by_http_client_implementation()
 
1998
 
 
1999
    def test_redirected_to_subdir(self):
 
2000
        t = self._transport('http://www.example.com/foo')
 
2001
        r = t._redirected_to('http://www.example.com/foo',
 
2002
                             'http://www.example.com/foo/subdir')
 
2003
        self.assertIsInstance(r, type(t))
 
2004
        # Both transports share the some connection
 
2005
        self.assertEqual(t._get_connection(), r._get_connection())
 
2006
        self.assertEquals('http://www.example.com/foo/subdir/', r.base)
 
2007
 
 
2008
    def test_redirected_to_self_with_slash(self):
 
2009
        t = self._transport('http://www.example.com/foo')
 
2010
        r = t._redirected_to('http://www.example.com/foo',
 
2011
                             'http://www.example.com/foo/')
 
2012
        self.assertIsInstance(r, type(t))
 
2013
        # Both transports share the some connection (one can argue that we
 
2014
        # should return the exact same transport here, but that seems
 
2015
        # overkill).
 
2016
        self.assertEqual(t._get_connection(), r._get_connection())
 
2017
 
 
2018
    def test_redirected_to_host(self):
 
2019
        t = self._transport('http://www.example.com/foo')
 
2020
        r = t._redirected_to('http://www.example.com/foo',
 
2021
                             'http://foo.example.com/foo/subdir')
 
2022
        self.assertIsInstance(r, type(t))
 
2023
        self.assertEquals('http://foo.example.com/foo/subdir/',
 
2024
            r.external_url())
 
2025
 
 
2026
    def test_redirected_to_same_host_sibling_protocol(self):
 
2027
        t = self._transport('http://www.example.com/foo')
 
2028
        r = t._redirected_to('http://www.example.com/foo',
 
2029
                             'https://www.example.com/foo')
 
2030
        self.assertIsInstance(r, type(t))
 
2031
        self.assertEquals('https://www.example.com/foo/',
 
2032
            r.external_url())
 
2033
 
 
2034
    def test_redirected_to_same_host_different_protocol(self):
 
2035
        t = self._transport('http://www.example.com/foo')
 
2036
        r = t._redirected_to('http://www.example.com/foo',
 
2037
                             'ftp://www.example.com/foo')
 
2038
        self.assertNotEquals(type(r), type(t))
 
2039
        self.assertEquals('ftp://www.example.com/foo/', r.external_url())
 
2040
 
 
2041
    def test_redirected_to_same_host_specific_implementation(self):
 
2042
        t = self._transport('http://www.example.com/foo')
 
2043
        r = t._redirected_to('http://www.example.com/foo',
 
2044
                             'https+urllib://www.example.com/foo')
 
2045
        self.assertEquals('https://www.example.com/foo/', r.external_url())
 
2046
 
 
2047
    def test_redirected_to_different_host_same_user(self):
 
2048
        t = self._transport('http://joe@www.example.com/foo')
 
2049
        r = t._redirected_to('http://www.example.com/foo',
 
2050
                             'https://foo.example.com/foo')
 
2051
        self.assertIsInstance(r, type(t))
 
2052
        self.assertEqual(t._parsed_url.user, r._parsed_url.user)
 
2053
        self.assertEquals('https://joe@foo.example.com/foo/', r.external_url())
 
2054
 
 
2055
 
 
2056
class PredefinedRequestHandler(http_server.TestingHTTPRequestHandler):
 
2057
    """Request handler for a unique and pre-defined request.
 
2058
 
 
2059
    The only thing we care about here is how many bytes travel on the wire. But
 
2060
    since we want to measure it for a real http client, we have to send it
 
2061
    correct responses.
 
2062
 
 
2063
    We expect to receive a *single* request nothing more (and we won't even
 
2064
    check what request it is, we just measure the bytes read until an empty
 
2065
    line.
 
2066
    """
 
2067
 
 
2068
    def _handle_one_request(self):
 
2069
        tcs = self.server.test_case_server
 
2070
        requestline = self.rfile.readline()
 
2071
        headers = self.MessageClass(self.rfile, 0)
 
2072
        # We just read: the request, the headers, an empty line indicating the
 
2073
        # end of the headers.
 
2074
        bytes_read = len(requestline)
 
2075
        for line in headers.headers:
 
2076
            bytes_read += len(line)
 
2077
        bytes_read += len('\r\n')
 
2078
        if requestline.startswith('POST'):
 
2079
            # The body should be a single line (or we don't know where it ends
 
2080
            # and we don't want to issue a blocking read)
 
2081
            body = self.rfile.readline()
 
2082
            bytes_read += len(body)
 
2083
        tcs.bytes_read = bytes_read
 
2084
 
 
2085
        # We set the bytes written *before* issuing the write, the client is
 
2086
        # supposed to consume every produced byte *before* checking that value.
 
2087
 
 
2088
        # Doing the oppposite may lead to test failure: we may be interrupted
 
2089
        # after the write but before updating the value. The client can then
 
2090
        # continue and read the value *before* we can update it. And yes,
 
2091
        # this has been observed -- vila 20090129
 
2092
        tcs.bytes_written = len(tcs.canned_response)
 
2093
        self.wfile.write(tcs.canned_response)
 
2094
 
 
2095
 
 
2096
class ActivityServerMixin(object):
 
2097
 
 
2098
    def __init__(self, protocol_version):
 
2099
        super(ActivityServerMixin, self).__init__(
 
2100
            request_handler=PredefinedRequestHandler,
 
2101
            protocol_version=protocol_version)
 
2102
        # Bytes read and written by the server
 
2103
        self.bytes_read = 0
 
2104
        self.bytes_written = 0
 
2105
        self.canned_response = None
 
2106
 
 
2107
 
 
2108
class ActivityHTTPServer(ActivityServerMixin, http_server.HttpServer):
 
2109
    pass
 
2110
 
 
2111
 
 
2112
if features.HTTPSServerFeature.available():
 
2113
    from bzrlib.tests import https_server
 
2114
    class ActivityHTTPSServer(ActivityServerMixin, https_server.HTTPSServer):
 
2115
        pass
 
2116
 
 
2117
 
 
2118
class TestActivityMixin(object):
 
2119
    """Test socket activity reporting.
 
2120
 
 
2121
    We use a special purpose server to control the bytes sent and received and
 
2122
    be able to predict the activity on the client socket.
 
2123
    """
 
2124
 
 
2125
    def setUp(self):
 
2126
        tests.TestCase.setUp(self)
 
2127
        self.server = self._activity_server(self._protocol_version)
 
2128
        self.server.start_server()
 
2129
        self.addCleanup(self.server.stop_server)
 
2130
        _activities = {} # Don't close over self and create a cycle
 
2131
        def report_activity(t, bytes, direction):
 
2132
            count = _activities.get(direction, 0)
 
2133
            count += bytes
 
2134
            _activities[direction] = count
 
2135
        self.activities = _activities
 
2136
        # We override at class level because constructors may propagate the
 
2137
        # bound method and render instance overriding ineffective (an
 
2138
        # alternative would be to define a specific ui factory instead...)
 
2139
        self.overrideAttr(self._transport, '_report_activity', report_activity)
 
2140
 
 
2141
    def get_transport(self):
 
2142
        t = self._transport(self.server.get_url())
 
2143
        # FIXME: Needs cleanup -- vila 20100611
 
2144
        return t
 
2145
 
 
2146
    def assertActivitiesMatch(self):
 
2147
        self.assertEqual(self.server.bytes_read,
 
2148
                         self.activities.get('write', 0), 'written bytes')
 
2149
        self.assertEqual(self.server.bytes_written,
 
2150
                         self.activities.get('read', 0), 'read bytes')
 
2151
 
 
2152
    def test_get(self):
 
2153
        self.server.canned_response = '''HTTP/1.1 200 OK\r
 
2154
Date: Tue, 11 Jul 2006 04:32:56 GMT\r
 
2155
Server: Apache/2.0.54 (Fedora)\r
 
2156
Last-Modified: Sun, 23 Apr 2006 19:35:20 GMT\r
 
2157
ETag: "56691-23-38e9ae00"\r
 
2158
Accept-Ranges: bytes\r
 
2159
Content-Length: 35\r
 
2160
Connection: close\r
 
2161
Content-Type: text/plain; charset=UTF-8\r
 
2162
\r
 
2163
Bazaar-NG meta directory, format 1
 
2164
'''
 
2165
        t = self.get_transport()
 
2166
        self.assertEqual('Bazaar-NG meta directory, format 1\n',
 
2167
                         t.get('foo/bar').read())
 
2168
        self.assertActivitiesMatch()
 
2169
 
 
2170
    def test_has(self):
 
2171
        self.server.canned_response = '''HTTP/1.1 200 OK\r
 
2172
Server: SimpleHTTP/0.6 Python/2.5.2\r
 
2173
Date: Thu, 29 Jan 2009 20:21:47 GMT\r
 
2174
Content-type: application/octet-stream\r
 
2175
Content-Length: 20\r
 
2176
Last-Modified: Thu, 29 Jan 2009 20:21:47 GMT\r
 
2177
\r
 
2178
'''
 
2179
        t = self.get_transport()
 
2180
        self.assertTrue(t.has('foo/bar'))
 
2181
        self.assertActivitiesMatch()
 
2182
 
 
2183
    def test_readv(self):
 
2184
        self.server.canned_response = '''HTTP/1.1 206 Partial Content\r
 
2185
Date: Tue, 11 Jul 2006 04:49:48 GMT\r
 
2186
Server: Apache/2.0.54 (Fedora)\r
 
2187
Last-Modified: Thu, 06 Jul 2006 20:22:05 GMT\r
 
2188
ETag: "238a3c-16ec2-805c5540"\r
 
2189
Accept-Ranges: bytes\r
 
2190
Content-Length: 1534\r
 
2191
Connection: close\r
 
2192
Content-Type: multipart/byteranges; boundary=418470f848b63279b\r
 
2193
\r
 
2194
\r
 
2195
--418470f848b63279b\r
 
2196
Content-type: text/plain; charset=UTF-8\r
 
2197
Content-range: bytes 0-254/93890\r
 
2198
\r
 
2199
mbp@sourcefrog.net-20050309040815-13242001617e4a06
 
2200
mbp@sourcefrog.net-20050309040929-eee0eb3e6d1e7627
 
2201
mbp@sourcefrog.net-20050309040957-6cad07f466bb0bb8
 
2202
mbp@sourcefrog.net-20050309041501-c840e09071de3b67
 
2203
mbp@sourcefrog.net-20050309044615-c24a3250be83220a
 
2204
\r
 
2205
--418470f848b63279b\r
 
2206
Content-type: text/plain; charset=UTF-8\r
 
2207
Content-range: bytes 1000-2049/93890\r
 
2208
\r
 
2209
40-fd4ec249b6b139ab
 
2210
mbp@sourcefrog.net-20050311063625-07858525021f270b
 
2211
mbp@sourcefrog.net-20050311231934-aa3776aff5200bb9
 
2212
mbp@sourcefrog.net-20050311231953-73aeb3a131c3699a
 
2213
mbp@sourcefrog.net-20050311232353-f5e33da490872c6a
 
2214
mbp@sourcefrog.net-20050312071639-0a8f59a34a024ff0
 
2215
mbp@sourcefrog.net-20050312073432-b2c16a55e0d6e9fb
 
2216
mbp@sourcefrog.net-20050312073831-a47c3335ece1920f
 
2217
mbp@sourcefrog.net-20050312085412-13373aa129ccbad3
 
2218
mbp@sourcefrog.net-20050313052251-2bf004cb96b39933
 
2219
mbp@sourcefrog.net-20050313052856-3edd84094687cb11
 
2220
mbp@sourcefrog.net-20050313053233-e30a4f28aef48f9d
 
2221
mbp@sourcefrog.net-20050313053853-7c64085594ff3072
 
2222
mbp@sourcefrog.net-20050313054757-a86c3f5871069e22
 
2223
mbp@sourcefrog.net-20050313061422-418f1f73b94879b9
 
2224
mbp@sourcefrog.net-20050313120651-497bd231b19df600
 
2225
mbp@sourcefrog.net-20050314024931-eae0170ef25a5d1a
 
2226
mbp@sourcefrog.net-20050314025438-d52099f915fe65fc
 
2227
mbp@sourcefrog.net-20050314025539-637a636692c055cf
 
2228
mbp@sourcefrog.net-20050314025737-55eb441f430ab4ba
 
2229
mbp@sourcefrog.net-20050314025901-d74aa93bb7ee8f62
 
2230
mbp@source\r
 
2231
--418470f848b63279b--\r
 
2232
'''
 
2233
        t = self.get_transport()
 
2234
        # Remember that the request is ignored and that the ranges below
 
2235
        # doesn't have to match the canned response.
 
2236
        l = list(t.readv('/foo/bar', ((0, 255), (1000, 1050))))
 
2237
        self.assertEqual(2, len(l))
 
2238
        self.assertActivitiesMatch()
 
2239
 
 
2240
    def test_post(self):
 
2241
        self.server.canned_response = '''HTTP/1.1 200 OK\r
 
2242
Date: Tue, 11 Jul 2006 04:32:56 GMT\r
 
2243
Server: Apache/2.0.54 (Fedora)\r
 
2244
Last-Modified: Sun, 23 Apr 2006 19:35:20 GMT\r
 
2245
ETag: "56691-23-38e9ae00"\r
 
2246
Accept-Ranges: bytes\r
 
2247
Content-Length: 35\r
 
2248
Connection: close\r
 
2249
Content-Type: text/plain; charset=UTF-8\r
 
2250
\r
 
2251
lalala whatever as long as itsssss
 
2252
'''
 
2253
        t = self.get_transport()
 
2254
        # We must send a single line of body bytes, see
 
2255
        # PredefinedRequestHandler._handle_one_request
 
2256
        code, f = t._post('abc def end-of-body\n')
 
2257
        self.assertEqual('lalala whatever as long as itsssss\n', f.read())
 
2258
        self.assertActivitiesMatch()
 
2259
 
 
2260
 
 
2261
class TestActivity(tests.TestCase, TestActivityMixin):
 
2262
 
 
2263
    scenarios = multiply_scenarios(
 
2264
        vary_by_http_activity(),
 
2265
        vary_by_http_protocol_version(),
 
2266
        )
 
2267
 
 
2268
    def setUp(self):
 
2269
        TestActivityMixin.setUp(self)
 
2270
 
 
2271
 
 
2272
class TestNoReportActivity(tests.TestCase, TestActivityMixin):
 
2273
 
 
2274
    # Unlike TestActivity, we are really testing ReportingFileSocket and
 
2275
    # ReportingSocket, so we don't need all the parametrization. Since
 
2276
    # ReportingFileSocket and ReportingSocket are wrappers, it's easier to
 
2277
    # test them through their use by the transport than directly (that's a
 
2278
    # bit less clean but far more simpler and effective).
 
2279
    _activity_server = ActivityHTTPServer
 
2280
    _protocol_version = 'HTTP/1.1'
 
2281
 
 
2282
    def setUp(self):
 
2283
        self._transport =_urllib.HttpTransport_urllib
 
2284
        TestActivityMixin.setUp(self)
 
2285
 
 
2286
    def assertActivitiesMatch(self):
 
2287
        # Nothing to check here
 
2288
        pass
 
2289
 
 
2290
 
 
2291
class TestAuthOnRedirected(http_utils.TestCaseWithRedirectedWebserver):
 
2292
    """Test authentication on the redirected http server."""
 
2293
 
 
2294
    scenarios = vary_by_http_protocol_version()
 
2295
 
 
2296
    _auth_header = 'Authorization'
 
2297
    _password_prompt_prefix = ''
 
2298
    _username_prompt_prefix = ''
 
2299
    _auth_server = http_utils.HTTPBasicAuthServer
 
2300
    _transport = _urllib.HttpTransport_urllib
 
2301
 
 
2302
    def setUp(self):
 
2303
        super(TestAuthOnRedirected, self).setUp()
 
2304
        self.build_tree_contents([('a','a'),
 
2305
                                  ('1/',),
 
2306
                                  ('1/a', 'redirected once'),
 
2307
                                  ],)
 
2308
        new_prefix = 'http://%s:%s' % (self.new_server.host,
 
2309
                                       self.new_server.port)
 
2310
        self.old_server.redirections = [
 
2311
            ('(.*)', r'%s/1\1' % (new_prefix), 301),]
 
2312
        self.old_transport = self.get_old_transport()
 
2313
        self.new_server.add_user('joe', 'foo')
 
2314
        cleanup_http_redirection_connections(self)
 
2315
 
 
2316
    def create_transport_readonly_server(self):
 
2317
        server = self._auth_server(protocol_version=self._protocol_version)
 
2318
        server._url_protocol = self._url_protocol
 
2319
        return server
 
2320
 
 
2321
    def get_a(self, t):
 
2322
        return t.get('a')
 
2323
 
 
2324
    def test_auth_on_redirected_via_do_catching_redirections(self):
 
2325
        self.redirections = 0
 
2326
 
 
2327
        def redirected(t, exception, redirection_notice):
 
2328
            self.redirections += 1
 
2329
            redirected_t = t._redirected_to(exception.source, exception.target)
 
2330
            self.addCleanup(redirected_t.disconnect)
 
2331
            return redirected_t
 
2332
 
 
2333
        stdout = tests.StringIOWrapper()
 
2334
        stderr = tests.StringIOWrapper()
 
2335
        ui.ui_factory = tests.TestUIFactory(stdin='joe\nfoo\n',
 
2336
                                            stdout=stdout, stderr=stderr)
 
2337
        self.assertEqual('redirected once',
 
2338
                         transport.do_catching_redirections(
 
2339
                self.get_a, self.old_transport, redirected).read())
 
2340
        self.assertEqual(1, self.redirections)
 
2341
        # stdin should be empty
 
2342
        self.assertEqual('', ui.ui_factory.stdin.readline())
 
2343
        # stdout should be empty, stderr will contains the prompts
 
2344
        self.assertEqual('', stdout.getvalue())
 
2345
 
 
2346
    def test_auth_on_redirected_via_following_redirections(self):
 
2347
        self.new_server.add_user('joe', 'foo')
 
2348
        stdout = tests.StringIOWrapper()
 
2349
        stderr = tests.StringIOWrapper()
 
2350
        ui.ui_factory = tests.TestUIFactory(stdin='joe\nfoo\n',
 
2351
                                            stdout=stdout, stderr=stderr)
 
2352
        t = self.old_transport
 
2353
        req = RedirectedRequest('GET', t.abspath('a'))
 
2354
        new_prefix = 'http://%s:%s' % (self.new_server.host,
 
2355
                                       self.new_server.port)
 
2356
        self.old_server.redirections = [
 
2357
            ('(.*)', r'%s/1\1' % (new_prefix), 301),]
 
2358
        self.assertEqual('redirected once', t._perform(req).read())
 
2359
        # stdin should be empty
 
2360
        self.assertEqual('', ui.ui_factory.stdin.readline())
 
2361
        # stdout should be empty, stderr will contains the prompts
 
2362
        self.assertEqual('', stdout.getvalue())
1406
2363