~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_http.py

  • Committer: Vincent Ladeuil
  • Date: 2017-01-17 13:48:10 UTC
  • mfrom: (6615.3.6 merges)
  • mto: This revision was merged to the branch mainline in revision 6620.
  • Revision ID: v.ladeuil+lp@free.fr-20170117134810-j9p3lidfy6pfyfsc
Merge 2.7, resolving conflicts

Show diffs side-by-side

added added

removed removed

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