~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_http.py

  • Committer: Martin Pool
  • Date: 2007-07-13 04:22:17 UTC
  • mto: This revision was merged to the branch mainline in revision 2618.
  • Revision ID: mbp@sourcefrog.net-20070713042217-mnkwb9przs8x2de0
Move bencode tests from within their module into our test suite

Show diffs side-by-side

added added

removed removed

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