~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_http.py

  • Committer: Patch Queue Manager
  • Date: 2016-04-21 04:10:52 UTC
  • mfrom: (6616.1.1 fix-en-user-guide)
  • Revision ID: pqm@pqm.ubuntu.com-20160421041052-clcye7ns1qcl2n7w
(richard-wilbur) Ensure build of English use guide always uses English text
 even when user's locale specifies a different language. (Jelmer Vernooij)

Show diffs side-by-side

added added

removed removed

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