~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-06-18 06:54:24 UTC
  • mto: This revision was merged to the branch mainline in revision 2551.
  • Revision ID: mbp@sourcefrog.net-20070618065424-awsn4t4tv2bi4okt
Remove duplicated commit use case documentation

Show diffs side-by-side

added added

removed removed

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