~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_transport.py

  • Committer: Vincent Ladeuil
  • Date: 2007-10-22 15:18:24 UTC
  • mto: (2961.1.1 trunk)
  • mto: This revision was merged to the branch mainline in revision 2962.
  • Revision ID: v.ladeuil+lp@free.fr-20071022151824-eol757lk393ofc38
AuthenticationConfig can be queried for logins too (first step).

* bzrlib/transport/ssh.py:
(_paramiko_auth): Try to get a user from AuthenticationConfig.

* bzrlib/smtp_connection.py:
(SMTPConnection._authenticate): Try to get a user from
AuthenticationConfig.

* bzrlib/transport/ftp.py:
(FtpTransport._create_connection): Try to get a user from
AuthenticationConfig. Credentials are now (user, password) instead
of just password.

* bzrlib/tests/test_ftp_transport.py:
(TestFTPServerUI._add_authorized_user): Cleanup by refactoring.

* bzrlib/config.py:
(AuthenticationConfig.get_user): New method to get logins.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2004, 2005, 2006, 2007 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
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
 
 
18
from cStringIO import StringIO
 
19
 
 
20
import bzrlib
 
21
from bzrlib import (
 
22
    errors,
 
23
    osutils,
 
24
    urlutils,
 
25
    )
 
26
from bzrlib.errors import (DependencyNotPresent,
 
27
                           FileExists,
 
28
                           InvalidURLJoin,
 
29
                           NoSuchFile,
 
30
                           PathNotChild,
 
31
                           ReadError,
 
32
                           UnsupportedProtocol,
 
33
                           )
 
34
from bzrlib.tests import TestCase, TestCaseInTempDir
 
35
from bzrlib.transport import (_clear_protocol_handlers,
 
36
                              _CoalescedOffset,
 
37
                              ConnectedTransport,
 
38
                              _get_protocol_handlers,
 
39
                              _set_protocol_handlers,
 
40
                              _get_transport_modules,
 
41
                              get_transport,
 
42
                              LateReadError,
 
43
                              register_lazy_transport,
 
44
                              register_transport_proto,
 
45
                              Transport,
 
46
                              )
 
47
from bzrlib.transport.chroot import ChrootServer
 
48
from bzrlib.transport.memory import MemoryTransport
 
49
from bzrlib.transport.local import (LocalTransport,
 
50
                                    EmulatedWin32LocalTransport)
 
51
from bzrlib.transport.remote import (
 
52
    BZR_DEFAULT_PORT,
 
53
    RemoteTCPTransport
 
54
    )
 
55
 
 
56
 
 
57
# TODO: Should possibly split transport-specific tests into their own files.
 
58
 
 
59
 
 
60
class TestTransport(TestCase):
 
61
    """Test the non transport-concrete class functionality."""
 
62
 
 
63
    def test__get_set_protocol_handlers(self):
 
64
        handlers = _get_protocol_handlers()
 
65
        self.assertNotEqual([], handlers.keys( ))
 
66
        try:
 
67
            _clear_protocol_handlers()
 
68
            self.assertEqual([], _get_protocol_handlers().keys())
 
69
        finally:
 
70
            _set_protocol_handlers(handlers)
 
71
 
 
72
    def test_get_transport_modules(self):
 
73
        handlers = _get_protocol_handlers()
 
74
        # don't pollute the current handlers
 
75
        _clear_protocol_handlers()
 
76
        class SampleHandler(object):
 
77
            """I exist, isnt that enough?"""
 
78
        try:
 
79
            _clear_protocol_handlers()
 
80
            register_transport_proto('foo')
 
81
            register_lazy_transport('foo', 'bzrlib.tests.test_transport', 'TestTransport.SampleHandler')
 
82
            register_transport_proto('bar')
 
83
            register_lazy_transport('bar', 'bzrlib.tests.test_transport', 'TestTransport.SampleHandler')
 
84
            self.assertEqual([SampleHandler.__module__, 'bzrlib.transport.chroot'],
 
85
                             _get_transport_modules())
 
86
        finally:
 
87
            _set_protocol_handlers(handlers)
 
88
 
 
89
    def test_transport_dependency(self):
 
90
        """Transport with missing dependency causes no error"""
 
91
        saved_handlers = _get_protocol_handlers()
 
92
        # don't pollute the current handlers
 
93
        _clear_protocol_handlers()
 
94
        try:
 
95
            register_transport_proto('foo')
 
96
            register_lazy_transport('foo', 'bzrlib.tests.test_transport',
 
97
                    'BadTransportHandler')
 
98
            try:
 
99
                get_transport('foo://fooserver/foo')
 
100
            except UnsupportedProtocol, e:
 
101
                e_str = str(e)
 
102
                self.assertEquals('Unsupported protocol'
 
103
                                  ' for url "foo://fooserver/foo":'
 
104
                                  ' Unable to import library "some_lib":'
 
105
                                  ' testing missing dependency', str(e))
 
106
            else:
 
107
                self.fail('Did not raise UnsupportedProtocol')
 
108
        finally:
 
109
            # restore original values
 
110
            _set_protocol_handlers(saved_handlers)
 
111
            
 
112
    def test_transport_fallback(self):
 
113
        """Transport with missing dependency causes no error"""
 
114
        saved_handlers = _get_protocol_handlers()
 
115
        try:
 
116
            _clear_protocol_handlers()
 
117
            register_transport_proto('foo')
 
118
            register_lazy_transport('foo', 'bzrlib.tests.test_transport',
 
119
                    'BackupTransportHandler')
 
120
            register_lazy_transport('foo', 'bzrlib.tests.test_transport',
 
121
                    'BadTransportHandler')
 
122
            t = get_transport('foo://fooserver/foo')
 
123
            self.assertTrue(isinstance(t, BackupTransportHandler))
 
124
        finally:
 
125
            _set_protocol_handlers(saved_handlers)
 
126
 
 
127
    def test_LateReadError(self):
 
128
        """The LateReadError helper should raise on read()."""
 
129
        a_file = LateReadError('a path')
 
130
        try:
 
131
            a_file.read()
 
132
        except ReadError, error:
 
133
            self.assertEqual('a path', error.path)
 
134
        self.assertRaises(ReadError, a_file.read, 40)
 
135
        a_file.close()
 
136
 
 
137
    def test__combine_paths(self):
 
138
        t = Transport('/')
 
139
        self.assertEqual('/home/sarah/project/foo',
 
140
                         t._combine_paths('/home/sarah', 'project/foo'))
 
141
        self.assertEqual('/etc',
 
142
                         t._combine_paths('/home/sarah', '../../etc'))
 
143
        self.assertEqual('/etc',
 
144
                         t._combine_paths('/home/sarah', '../../../etc'))
 
145
        self.assertEqual('/etc',
 
146
                         t._combine_paths('/home/sarah', '/etc'))
 
147
 
 
148
    def test_local_abspath_non_local_transport(self):
 
149
        # the base implementation should throw
 
150
        t = MemoryTransport()
 
151
        e = self.assertRaises(errors.NotLocalUrl, t.local_abspath, 't')
 
152
        self.assertEqual('memory:///t is not a local path.', str(e))
 
153
 
 
154
 
 
155
class TestCoalesceOffsets(TestCase):
 
156
    
 
157
    def check(self, expected, offsets, limit=0, fudge=0):
 
158
        coalesce = Transport._coalesce_offsets
 
159
        exp = [_CoalescedOffset(*x) for x in expected]
 
160
        out = list(coalesce(offsets, limit=limit, fudge_factor=fudge))
 
161
        self.assertEqual(exp, out)
 
162
 
 
163
    def test_coalesce_empty(self):
 
164
        self.check([], [])
 
165
 
 
166
    def test_coalesce_simple(self):
 
167
        self.check([(0, 10, [(0, 10)])], [(0, 10)])
 
168
 
 
169
    def test_coalesce_unrelated(self):
 
170
        self.check([(0, 10, [(0, 10)]),
 
171
                    (20, 10, [(0, 10)]),
 
172
                   ], [(0, 10), (20, 10)])
 
173
            
 
174
    def test_coalesce_unsorted(self):
 
175
        self.check([(20, 10, [(0, 10)]),
 
176
                    (0, 10, [(0, 10)]),
 
177
                   ], [(20, 10), (0, 10)])
 
178
 
 
179
    def test_coalesce_nearby(self):
 
180
        self.check([(0, 20, [(0, 10), (10, 10)])],
 
181
                   [(0, 10), (10, 10)])
 
182
 
 
183
    def test_coalesce_overlapped(self):
 
184
        self.check([(0, 15, [(0, 10), (5, 10)])],
 
185
                   [(0, 10), (5, 10)])
 
186
 
 
187
    def test_coalesce_limit(self):
 
188
        self.check([(10, 50, [(0, 10), (10, 10), (20, 10),
 
189
                              (30, 10), (40, 10)]),
 
190
                    (60, 50, [(0, 10), (10, 10), (20, 10),
 
191
                              (30, 10), (40, 10)]),
 
192
                   ], [(10, 10), (20, 10), (30, 10), (40, 10),
 
193
                       (50, 10), (60, 10), (70, 10), (80, 10),
 
194
                       (90, 10), (100, 10)],
 
195
                    limit=5)
 
196
 
 
197
    def test_coalesce_no_limit(self):
 
198
        self.check([(10, 100, [(0, 10), (10, 10), (20, 10),
 
199
                               (30, 10), (40, 10), (50, 10),
 
200
                               (60, 10), (70, 10), (80, 10),
 
201
                               (90, 10)]),
 
202
                   ], [(10, 10), (20, 10), (30, 10), (40, 10),
 
203
                       (50, 10), (60, 10), (70, 10), (80, 10),
 
204
                       (90, 10), (100, 10)])
 
205
 
 
206
    def test_coalesce_fudge(self):
 
207
        self.check([(10, 30, [(0, 10), (20, 10)]),
 
208
                    (100, 10, [(0, 10),]),
 
209
                   ], [(10, 10), (30, 10), (100, 10)],
 
210
                   fudge=10
 
211
                  )
 
212
 
 
213
 
 
214
class TestMemoryTransport(TestCase):
 
215
 
 
216
    def test_get_transport(self):
 
217
        MemoryTransport()
 
218
 
 
219
    def test_clone(self):
 
220
        transport = MemoryTransport()
 
221
        self.assertTrue(isinstance(transport, MemoryTransport))
 
222
        self.assertEqual("memory:///", transport.clone("/").base)
 
223
 
 
224
    def test_abspath(self):
 
225
        transport = MemoryTransport()
 
226
        self.assertEqual("memory:///relpath", transport.abspath('relpath'))
 
227
 
 
228
    def test_abspath_of_root(self):
 
229
        transport = MemoryTransport()
 
230
        self.assertEqual("memory:///", transport.base)
 
231
        self.assertEqual("memory:///", transport.abspath('/'))
 
232
 
 
233
    def test_abspath_of_relpath_starting_at_root(self):
 
234
        transport = MemoryTransport()
 
235
        self.assertEqual("memory:///foo", transport.abspath('/foo'))
 
236
 
 
237
    def test_append_and_get(self):
 
238
        transport = MemoryTransport()
 
239
        transport.append_bytes('path', 'content')
 
240
        self.assertEqual(transport.get('path').read(), 'content')
 
241
        transport.append_file('path', StringIO('content'))
 
242
        self.assertEqual(transport.get('path').read(), 'contentcontent')
 
243
 
 
244
    def test_put_and_get(self):
 
245
        transport = MemoryTransport()
 
246
        transport.put_file('path', StringIO('content'))
 
247
        self.assertEqual(transport.get('path').read(), 'content')
 
248
        transport.put_bytes('path', 'content')
 
249
        self.assertEqual(transport.get('path').read(), 'content')
 
250
 
 
251
    def test_append_without_dir_fails(self):
 
252
        transport = MemoryTransport()
 
253
        self.assertRaises(NoSuchFile,
 
254
                          transport.append_bytes, 'dir/path', 'content')
 
255
 
 
256
    def test_put_without_dir_fails(self):
 
257
        transport = MemoryTransport()
 
258
        self.assertRaises(NoSuchFile,
 
259
                          transport.put_file, 'dir/path', StringIO('content'))
 
260
 
 
261
    def test_get_missing(self):
 
262
        transport = MemoryTransport()
 
263
        self.assertRaises(NoSuchFile, transport.get, 'foo')
 
264
 
 
265
    def test_has_missing(self):
 
266
        transport = MemoryTransport()
 
267
        self.assertEquals(False, transport.has('foo'))
 
268
 
 
269
    def test_has_present(self):
 
270
        transport = MemoryTransport()
 
271
        transport.append_bytes('foo', 'content')
 
272
        self.assertEquals(True, transport.has('foo'))
 
273
 
 
274
    def test_list_dir(self):
 
275
        transport = MemoryTransport()
 
276
        transport.put_bytes('foo', 'content')
 
277
        transport.mkdir('dir')
 
278
        transport.put_bytes('dir/subfoo', 'content')
 
279
        transport.put_bytes('dirlike', 'content')
 
280
 
 
281
        self.assertEquals(['dir', 'dirlike', 'foo'], sorted(transport.list_dir('.')))
 
282
        self.assertEquals(['subfoo'], sorted(transport.list_dir('dir')))
 
283
 
 
284
    def test_mkdir(self):
 
285
        transport = MemoryTransport()
 
286
        transport.mkdir('dir')
 
287
        transport.append_bytes('dir/path', 'content')
 
288
        self.assertEqual(transport.get('dir/path').read(), 'content')
 
289
 
 
290
    def test_mkdir_missing_parent(self):
 
291
        transport = MemoryTransport()
 
292
        self.assertRaises(NoSuchFile,
 
293
                          transport.mkdir, 'dir/dir')
 
294
 
 
295
    def test_mkdir_twice(self):
 
296
        transport = MemoryTransport()
 
297
        transport.mkdir('dir')
 
298
        self.assertRaises(FileExists, transport.mkdir, 'dir')
 
299
 
 
300
    def test_parameters(self):
 
301
        transport = MemoryTransport()
 
302
        self.assertEqual(True, transport.listable())
 
303
        self.assertEqual(False, transport.is_readonly())
 
304
 
 
305
    def test_iter_files_recursive(self):
 
306
        transport = MemoryTransport()
 
307
        transport.mkdir('dir')
 
308
        transport.put_bytes('dir/foo', 'content')
 
309
        transport.put_bytes('dir/bar', 'content')
 
310
        transport.put_bytes('bar', 'content')
 
311
        paths = set(transport.iter_files_recursive())
 
312
        self.assertEqual(set(['dir/foo', 'dir/bar', 'bar']), paths)
 
313
 
 
314
    def test_stat(self):
 
315
        transport = MemoryTransport()
 
316
        transport.put_bytes('foo', 'content')
 
317
        transport.put_bytes('bar', 'phowar')
 
318
        self.assertEqual(7, transport.stat('foo').st_size)
 
319
        self.assertEqual(6, transport.stat('bar').st_size)
 
320
 
 
321
 
 
322
class ChrootDecoratorTransportTest(TestCase):
 
323
    """Chroot decoration specific tests."""
 
324
 
 
325
    def test_abspath(self):
 
326
        # The abspath is always relative to the chroot_url.
 
327
        server = ChrootServer(get_transport('memory:///foo/bar/'))
 
328
        server.setUp()
 
329
        transport = get_transport(server.get_url())
 
330
        self.assertEqual(server.get_url(), transport.abspath('/'))
 
331
 
 
332
        subdir_transport = transport.clone('subdir')
 
333
        self.assertEqual(server.get_url(), subdir_transport.abspath('/'))
 
334
        server.tearDown()
 
335
 
 
336
    def test_clone(self):
 
337
        server = ChrootServer(get_transport('memory:///foo/bar/'))
 
338
        server.setUp()
 
339
        transport = get_transport(server.get_url())
 
340
        # relpath from root and root path are the same
 
341
        relpath_cloned = transport.clone('foo')
 
342
        abspath_cloned = transport.clone('/foo')
 
343
        self.assertEqual(server, relpath_cloned.server)
 
344
        self.assertEqual(server, abspath_cloned.server)
 
345
        server.tearDown()
 
346
    
 
347
    def test_chroot_url_preserves_chroot(self):
 
348
        """Calling get_transport on a chroot transport's base should produce a
 
349
        transport with exactly the same behaviour as the original chroot
 
350
        transport.
 
351
 
 
352
        This is so that it is not possible to escape a chroot by doing::
 
353
            url = chroot_transport.base
 
354
            parent_url = urlutils.join(url, '..')
 
355
            new_transport = get_transport(parent_url)
 
356
        """
 
357
        server = ChrootServer(get_transport('memory:///path/subpath'))
 
358
        server.setUp()
 
359
        transport = get_transport(server.get_url())
 
360
        new_transport = get_transport(transport.base)
 
361
        self.assertEqual(transport.server, new_transport.server)
 
362
        self.assertEqual(transport.base, new_transport.base)
 
363
        server.tearDown()
 
364
        
 
365
    def test_urljoin_preserves_chroot(self):
 
366
        """Using urlutils.join(url, '..') on a chroot URL should not produce a
 
367
        URL that escapes the intended chroot.
 
368
 
 
369
        This is so that it is not possible to escape a chroot by doing::
 
370
            url = chroot_transport.base
 
371
            parent_url = urlutils.join(url, '..')
 
372
            new_transport = get_transport(parent_url)
 
373
        """
 
374
        server = ChrootServer(get_transport('memory:///path/'))
 
375
        server.setUp()
 
376
        transport = get_transport(server.get_url())
 
377
        self.assertRaises(
 
378
            InvalidURLJoin, urlutils.join, transport.base, '..')
 
379
        server.tearDown()
 
380
 
 
381
 
 
382
class ChrootServerTest(TestCase):
 
383
 
 
384
    def test_construct(self):
 
385
        backing_transport = MemoryTransport()
 
386
        server = ChrootServer(backing_transport)
 
387
        self.assertEqual(backing_transport, server.backing_transport)
 
388
 
 
389
    def test_setUp(self):
 
390
        backing_transport = MemoryTransport()
 
391
        server = ChrootServer(backing_transport)
 
392
        server.setUp()
 
393
        self.assertTrue(server.scheme in _get_protocol_handlers().keys())
 
394
 
 
395
    def test_tearDown(self):
 
396
        backing_transport = MemoryTransport()
 
397
        server = ChrootServer(backing_transport)
 
398
        server.setUp()
 
399
        server.tearDown()
 
400
        self.assertFalse(server.scheme in _get_protocol_handlers().keys())
 
401
 
 
402
    def test_get_url(self):
 
403
        backing_transport = MemoryTransport()
 
404
        server = ChrootServer(backing_transport)
 
405
        server.setUp()
 
406
        self.assertEqual('chroot-%d:///' % id(server), server.get_url())
 
407
        server.tearDown()
 
408
 
 
409
 
 
410
class ReadonlyDecoratorTransportTest(TestCase):
 
411
    """Readonly decoration specific tests."""
 
412
 
 
413
    def test_local_parameters(self):
 
414
        import bzrlib.transport.readonly as readonly
 
415
        # connect to . in readonly mode
 
416
        transport = readonly.ReadonlyTransportDecorator('readonly+.')
 
417
        self.assertEqual(True, transport.listable())
 
418
        self.assertEqual(True, transport.is_readonly())
 
419
 
 
420
    def test_http_parameters(self):
 
421
        from bzrlib.tests.HttpServer import HttpServer
 
422
        import bzrlib.transport.readonly as readonly
 
423
        # connect to . via http which is not listable
 
424
        server = HttpServer()
 
425
        server.setUp()
 
426
        try:
 
427
            transport = get_transport('readonly+' + server.get_url())
 
428
            self.failUnless(isinstance(transport,
 
429
                                       readonly.ReadonlyTransportDecorator))
 
430
            self.assertEqual(False, transport.listable())
 
431
            self.assertEqual(True, transport.is_readonly())
 
432
        finally:
 
433
            server.tearDown()
 
434
 
 
435
 
 
436
class FakeNFSDecoratorTests(TestCaseInTempDir):
 
437
    """NFS decorator specific tests."""
 
438
 
 
439
    def get_nfs_transport(self, url):
 
440
        import bzrlib.transport.fakenfs as fakenfs
 
441
        # connect to url with nfs decoration
 
442
        return fakenfs.FakeNFSTransportDecorator('fakenfs+' + url)
 
443
 
 
444
    def test_local_parameters(self):
 
445
        # the listable and is_readonly parameters
 
446
        # are not changed by the fakenfs decorator
 
447
        transport = self.get_nfs_transport('.')
 
448
        self.assertEqual(True, transport.listable())
 
449
        self.assertEqual(False, transport.is_readonly())
 
450
 
 
451
    def test_http_parameters(self):
 
452
        # the listable and is_readonly parameters
 
453
        # are not changed by the fakenfs decorator
 
454
        from bzrlib.tests.HttpServer import HttpServer
 
455
        # connect to . via http which is not listable
 
456
        server = HttpServer()
 
457
        server.setUp()
 
458
        try:
 
459
            transport = self.get_nfs_transport(server.get_url())
 
460
            self.assertIsInstance(
 
461
                transport, bzrlib.transport.fakenfs.FakeNFSTransportDecorator)
 
462
            self.assertEqual(False, transport.listable())
 
463
            self.assertEqual(True, transport.is_readonly())
 
464
        finally:
 
465
            server.tearDown()
 
466
 
 
467
    def test_fakenfs_server_default(self):
 
468
        # a FakeNFSServer() should bring up a local relpath server for itself
 
469
        import bzrlib.transport.fakenfs as fakenfs
 
470
        server = fakenfs.FakeNFSServer()
 
471
        server.setUp()
 
472
        try:
 
473
            # the url should be decorated appropriately
 
474
            self.assertStartsWith(server.get_url(), 'fakenfs+')
 
475
            # and we should be able to get a transport for it
 
476
            transport = get_transport(server.get_url())
 
477
            # which must be a FakeNFSTransportDecorator instance.
 
478
            self.assertIsInstance(
 
479
                transport, fakenfs.FakeNFSTransportDecorator)
 
480
        finally:
 
481
            server.tearDown()
 
482
 
 
483
    def test_fakenfs_rename_semantics(self):
 
484
        # a FakeNFS transport must mangle the way rename errors occur to
 
485
        # look like NFS problems.
 
486
        transport = self.get_nfs_transport('.')
 
487
        self.build_tree(['from/', 'from/foo', 'to/', 'to/bar'],
 
488
                        transport=transport)
 
489
        self.assertRaises(errors.ResourceBusy,
 
490
                          transport.rename, 'from', 'to')
 
491
 
 
492
 
 
493
class FakeVFATDecoratorTests(TestCaseInTempDir):
 
494
    """Tests for simulation of VFAT restrictions"""
 
495
 
 
496
    def get_vfat_transport(self, url):
 
497
        """Return vfat-backed transport for test directory"""
 
498
        from bzrlib.transport.fakevfat import FakeVFATTransportDecorator
 
499
        return FakeVFATTransportDecorator('vfat+' + url)
 
500
 
 
501
    def test_transport_creation(self):
 
502
        from bzrlib.transport.fakevfat import FakeVFATTransportDecorator
 
503
        transport = self.get_vfat_transport('.')
 
504
        self.assertIsInstance(transport, FakeVFATTransportDecorator)
 
505
 
 
506
    def test_transport_mkdir(self):
 
507
        transport = self.get_vfat_transport('.')
 
508
        transport.mkdir('HELLO')
 
509
        self.assertTrue(transport.has('hello'))
 
510
        self.assertTrue(transport.has('Hello'))
 
511
 
 
512
    def test_forbidden_chars(self):
 
513
        transport = self.get_vfat_transport('.')
 
514
        self.assertRaises(ValueError, transport.has, "<NU>")
 
515
 
 
516
 
 
517
class BadTransportHandler(Transport):
 
518
    def __init__(self, base_url):
 
519
        raise DependencyNotPresent('some_lib', 'testing missing dependency')
 
520
 
 
521
 
 
522
class BackupTransportHandler(Transport):
 
523
    """Test transport that works as a backup for the BadTransportHandler"""
 
524
    pass
 
525
 
 
526
 
 
527
class TestTransportImplementation(TestCaseInTempDir):
 
528
    """Implementation verification for transports.
 
529
    
 
530
    To verify a transport we need a server factory, which is a callable
 
531
    that accepts no parameters and returns an implementation of
 
532
    bzrlib.transport.Server.
 
533
    
 
534
    That Server is then used to construct transport instances and test
 
535
    the transport via loopback activity.
 
536
 
 
537
    Currently this assumes that the Transport object is connected to the 
 
538
    current working directory.  So that whatever is done 
 
539
    through the transport, should show up in the working 
 
540
    directory, and vice-versa. This is a bug, because its possible to have
 
541
    URL schemes which provide access to something that may not be 
 
542
    result in storage on the local disk, i.e. due to file system limits, or 
 
543
    due to it being a database or some other non-filesystem tool.
 
544
 
 
545
    This also tests to make sure that the functions work with both
 
546
    generators and lists (assuming iter(list) is effectively a generator)
 
547
    """
 
548
    
 
549
    def setUp(self):
 
550
        super(TestTransportImplementation, self).setUp()
 
551
        self._server = self.transport_server()
 
552
        self._server.setUp()
 
553
        self.addCleanup(self._server.tearDown)
 
554
 
 
555
    def get_transport(self, relpath=None):
 
556
        """Return a connected transport to the local directory.
 
557
 
 
558
        :param relpath: a path relative to the base url.
 
559
        """
 
560
        base_url = self._server.get_url()
 
561
        url = self._adjust_url(base_url, relpath)
 
562
        # try getting the transport via the regular interface:
 
563
        t = get_transport(url)
 
564
        # vila--20070607 if the following are commented out the test suite
 
565
        # still pass. Is this really still needed or was it a forgotten
 
566
        # temporary fix ?
 
567
        if not isinstance(t, self.transport_class):
 
568
            # we did not get the correct transport class type. Override the
 
569
            # regular connection behaviour by direct construction.
 
570
            t = self.transport_class(url)
 
571
        return t
 
572
 
 
573
 
 
574
class TestLocalTransports(TestCase):
 
575
 
 
576
    def test_get_transport_from_abspath(self):
 
577
        here = osutils.abspath('.')
 
578
        t = get_transport(here)
 
579
        self.assertIsInstance(t, LocalTransport)
 
580
        self.assertEquals(t.base, urlutils.local_path_to_url(here) + '/')
 
581
 
 
582
    def test_get_transport_from_relpath(self):
 
583
        here = osutils.abspath('.')
 
584
        t = get_transport('.')
 
585
        self.assertIsInstance(t, LocalTransport)
 
586
        self.assertEquals(t.base, urlutils.local_path_to_url('.') + '/')
 
587
 
 
588
    def test_get_transport_from_local_url(self):
 
589
        here = osutils.abspath('.')
 
590
        here_url = urlutils.local_path_to_url(here) + '/'
 
591
        t = get_transport(here_url)
 
592
        self.assertIsInstance(t, LocalTransport)
 
593
        self.assertEquals(t.base, here_url)
 
594
 
 
595
    def test_local_abspath(self):
 
596
        here = osutils.abspath('.')
 
597
        t = get_transport(here)
 
598
        self.assertEquals(t.local_abspath(''), here)
 
599
 
 
600
 
 
601
class TestWin32LocalTransport(TestCase):
 
602
 
 
603
    def test_unc_clone_to_root(self):
 
604
        # Win32 UNC path like \\HOST\path
 
605
        # clone to root should stop at least at \\HOST part
 
606
        # not on \\
 
607
        t = EmulatedWin32LocalTransport('file://HOST/path/to/some/dir/')
 
608
        for i in xrange(4):
 
609
            t = t.clone('..')
 
610
        self.assertEquals(t.base, 'file://HOST/')
 
611
        # make sure we reach the root
 
612
        t = t.clone('..')
 
613
        self.assertEquals(t.base, 'file://HOST/')
 
614
 
 
615
 
 
616
class TestConnectedTransport(TestCase):
 
617
    """Tests for connected to remote server transports"""
 
618
 
 
619
    def test_parse_url(self):
 
620
        t = ConnectedTransport('http://simple.example.com/home/source')
 
621
        self.assertEquals(t._host, 'simple.example.com')
 
622
        self.assertEquals(t._port, 80)
 
623
        self.assertEquals(t._path, '/home/source/')
 
624
        self.failUnless(t._user is None)
 
625
        self.failUnless(t._password is None)
 
626
 
 
627
        self.assertEquals(t.base, 'http://simple.example.com/home/source/')
 
628
 
 
629
    def test_parse_quoted_url(self):
 
630
        t = ConnectedTransport('http://ro%62ey:h%40t@ex%41mple.com:2222/path')
 
631
        self.assertEquals(t._host, 'exAmple.com')
 
632
        self.assertEquals(t._port, 2222)
 
633
        self.assertEquals(t._user, 'robey')
 
634
        self.assertEquals(t._password, 'h@t')
 
635
        self.assertEquals(t._path, '/path/')
 
636
 
 
637
        # Base should not keep track of the password
 
638
        self.assertEquals(t.base, 'http://robey@exAmple.com:2222/path/')
 
639
 
 
640
    def test_parse_invalid_url(self):
 
641
        self.assertRaises(errors.InvalidURL,
 
642
                          ConnectedTransport,
 
643
                          'sftp://lily.org:~janneke/public/bzr/gub')
 
644
 
 
645
    def test_relpath(self):
 
646
        t = ConnectedTransport('sftp://user@host.com/abs/path')
 
647
 
 
648
        self.assertEquals(t.relpath('sftp://user@host.com/abs/path/sub'), 'sub')
 
649
        self.assertRaises(errors.PathNotChild, t.relpath,
 
650
                          'http://user@host.com/abs/path/sub')
 
651
        self.assertRaises(errors.PathNotChild, t.relpath,
 
652
                          'sftp://user2@host.com/abs/path/sub')
 
653
        self.assertRaises(errors.PathNotChild, t.relpath,
 
654
                          'sftp://user@otherhost.com/abs/path/sub')
 
655
        self.assertRaises(errors.PathNotChild, t.relpath,
 
656
                          'sftp://user@host.com:33/abs/path/sub')
 
657
        # Make sure it works when we don't supply a username
 
658
        t = ConnectedTransport('sftp://host.com/abs/path')
 
659
        self.assertEquals(t.relpath('sftp://host.com/abs/path/sub'), 'sub')
 
660
 
 
661
        # Make sure it works when parts of the path will be url encoded
 
662
        t = ConnectedTransport('sftp://host.com/dev/%path')
 
663
        self.assertEquals(t.relpath('sftp://host.com/dev/%path/sub'), 'sub')
 
664
 
 
665
    def test_connection_sharing_propagate_credentials(self):
 
666
        t = ConnectedTransport('foo://user@host.com/abs/path')
 
667
        self.assertIs(None, t._get_connection())
 
668
        self.assertIs(None, t._password)
 
669
        c = t.clone('subdir')
 
670
        self.assertEquals(None, c._get_connection())
 
671
        self.assertIs(None, t._password)
 
672
 
 
673
        # Simulate the user entering a password
 
674
        password = 'secret'
 
675
        connection = object()
 
676
        t._set_connection(connection, password)
 
677
        self.assertIs(connection, t._get_connection())
 
678
        self.assertIs(password, t._get_credentials())
 
679
        self.assertIs(connection, c._get_connection())
 
680
        self.assertIs(password, c._get_credentials())
 
681
 
 
682
        # credentials can be updated
 
683
        new_password = 'even more secret'
 
684
        c._update_credentials(new_password)
 
685
        self.assertIs(connection, t._get_connection())
 
686
        self.assertIs(new_password, t._get_credentials())
 
687
        self.assertIs(connection, c._get_connection())
 
688
        self.assertIs(new_password, c._get_credentials())
 
689
 
 
690
 
 
691
class TestReusedTransports(TestCase):
 
692
    """Tests for transport reuse"""
 
693
 
 
694
    def test_reuse_same_transport(self):
 
695
        possible_transports = []
 
696
        t1 = get_transport('http://foo/',
 
697
                           possible_transports=possible_transports)
 
698
        self.assertEqual([t1], possible_transports)
 
699
        t2 = get_transport('http://foo/', possible_transports=[t1])
 
700
        self.assertIs(t1, t2)
 
701
 
 
702
        # Also check that final '/' are handled correctly
 
703
        t3 = get_transport('http://foo/path/')
 
704
        t4 = get_transport('http://foo/path', possible_transports=[t3])
 
705
        self.assertIs(t3, t4)
 
706
 
 
707
        t5 = get_transport('http://foo/path')
 
708
        t6 = get_transport('http://foo/path/', possible_transports=[t5])
 
709
        self.assertIs(t5, t6)
 
710
 
 
711
    def test_don_t_reuse_different_transport(self):
 
712
        t1 = get_transport('http://foo/path')
 
713
        t2 = get_transport('http://bar/path', possible_transports=[t1])
 
714
        self.assertIsNot(t1, t2)
 
715
 
 
716
 
 
717
class TestRemoteTCPTransport(TestCase):
 
718
    """Tests for bzr:// transport (RemoteTCPTransport)."""
 
719
 
 
720
    def test_relpath_with_implicit_port(self):
 
721
        """Connected transports with the same URL are the same, even if the
 
722
        port is implicit.
 
723
 
 
724
        So t.relpath(url) should always be '' if t.base is the same as url, or
 
725
        if the only difference is that one explicitly specifies the default
 
726
        port and the other doesn't specify a port.
 
727
        """
 
728
        t_implicit_port = RemoteTCPTransport('bzr://host.com/')
 
729
        self.assertEquals('', t_implicit_port.relpath('bzr://host.com/'))
 
730
        self.assertEquals('', t_implicit_port.relpath('bzr://host.com:4155/'))
 
731
        t_explicit_port = RemoteTCPTransport('bzr://host.com:4155/')
 
732
        self.assertEquals('', t_explicit_port.relpath('bzr://host.com/'))
 
733
        self.assertEquals('', t_explicit_port.relpath('bzr://host.com:4155/'))
 
734
 
 
735
    def test_construct_uses_default_port(self):
 
736
        """If no port is specified, then RemoteTCPTransport uses
 
737
        BZR_DEFAULT_PORT.
 
738
        """
 
739
        t = get_transport('bzr://host.com/')
 
740
        self.assertEquals(BZR_DEFAULT_PORT, t._port)
 
741
 
 
742
    def test_url_omits_default_port(self):
 
743
        """If a RemoteTCPTransport uses the default port, then its base URL
 
744
        will omit the port.
 
745
 
 
746
        This is like how ":80" is omitted from "http://example.com/".
 
747
        """
 
748
        t = get_transport('bzr://host.com:4155/')
 
749
        self.assertEquals('bzr://host.com/', t.base)
 
750
 
 
751
    def test_url_includes_non_default_port(self):
 
752
        """Non-default ports are included in the transport's URL.
 
753
 
 
754
        Contrast this to `test_url_omits_default_port`.
 
755
        """
 
756
        t = get_transport('bzr://host.com:666/')
 
757
        self.assertEquals('bzr://host.com:666/', t.base)
 
758
 
 
759
 
 
760
class SSHPortTestMixin(object):
 
761
    """Mixin class for testing SSH-based transports' use of ports in URLs.
 
762
    
 
763
    Unlike other connected transports, SSH-based transports (sftp, bzr+ssh)
 
764
    don't have a default port, because the user may have OpenSSH configured to
 
765
    use a non-standard port.
 
766
    """
 
767
 
 
768
    def make_url(self, netloc):
 
769
        """Make a url for the given netloc, using the scheme defined on the
 
770
        TestCase.
 
771
        """
 
772
        return '%s://%s/' % (self.scheme, netloc)
 
773
 
 
774
    def test_relpath_with_implicit_port(self):
 
775
        """SSH-based transports with the same URL are the same.
 
776
        
 
777
        Note than an unspecified port number is different to port 22 (because
 
778
        OpenSSH may be configured to use a non-standard port).
 
779
 
 
780
        So t.relpath(url) should always be '' if t.base is the same as url, but
 
781
        raise PathNotChild if the ports in t and url are not both specified (or
 
782
        both unspecified).
 
783
        """
 
784
        url_implicit_port = self.make_url('host.com')
 
785
        url_explicit_port = self.make_url('host.com:22')
 
786
 
 
787
        t_implicit_port = get_transport(url_implicit_port)
 
788
        self.assertEquals('', t_implicit_port.relpath(url_implicit_port))
 
789
        self.assertRaises(
 
790
            PathNotChild, t_implicit_port.relpath, url_explicit_port)
 
791
        
 
792
        t_explicit_port = get_transport(url_explicit_port)
 
793
        self.assertRaises(
 
794
            PathNotChild, t_explicit_port.relpath, url_implicit_port)
 
795
        self.assertEquals('', t_explicit_port.relpath(url_explicit_port))
 
796
 
 
797
    def test_construct_with_no_port(self):
 
798
        """If no port is specified, then the SSH-based transport's _port will
 
799
        be None.
 
800
        """
 
801
        t = get_transport(self.make_url('host.com'))
 
802
        self.assertEquals(None, t._port)
 
803
 
 
804
    def test_url_with_no_port(self):
 
805
        """If no port was specified, none is shown in the base URL."""
 
806
        t = get_transport(self.make_url('host.com'))
 
807
        self.assertEquals(self.make_url('host.com'), t.base)
 
808
 
 
809
    def test_url_includes_port(self):
 
810
        """An SSH-based transport's base will show the port if one was
 
811
        specified, even if that port is 22, because we do not assume 22 is the
 
812
        default port.
 
813
        """
 
814
        # 22 is the "standard" port for SFTP.
 
815
        t = get_transport(self.make_url('host.com:22'))
 
816
        self.assertEquals(self.make_url('host.com:22'), t.base)
 
817
        # 666 is not a standard port.
 
818
        t = get_transport(self.make_url('host.com:666'))
 
819
        self.assertEquals(self.make_url('host.com:666'), t.base)
 
820
 
 
821
 
 
822
class SFTPTransportPortTest(TestCase, SSHPortTestMixin):
 
823
    """Tests for sftp:// transport (SFTPTransport)."""
 
824
 
 
825
    scheme = 'sftp'
 
826
 
 
827
 
 
828
class BzrSSHTransportPortTest(TestCase, SSHPortTestMixin):
 
829
    """Tests for bzr+ssh:// transport (RemoteSSHTransport)."""
 
830
 
 
831
    scheme = 'bzr+ssh'
 
832
 
 
833
 
 
834
class TestTransportTrace(TestCase):
 
835
 
 
836
    def test_get(self):
 
837
        transport = get_transport('trace+memory://')
 
838
        self.assertIsInstance(
 
839
            transport, bzrlib.transport.trace.TransportTraceDecorator)
 
840
 
 
841
    def test_clone_preserves_activity(self):
 
842
        transport = get_transport('trace+memory://')
 
843
        transport2 = transport.clone('.')
 
844
        self.assertTrue(transport is not transport2)
 
845
        self.assertTrue(transport._activity is transport2._activity)
 
846
 
 
847
    # the following specific tests are for the operations that have made use of
 
848
    # logging in tests; we could test every single operation but doing that
 
849
    # still won't cause a test failure when the top level Transport API
 
850
    # changes; so there is little return doing that.
 
851
    def test_get(self):
 
852
        transport = get_transport('trace+memory:///')
 
853
        transport.put_bytes('foo', 'barish')
 
854
        transport.get('foo')
 
855
        expected_result = []
 
856
        # put_bytes records the bytes, not the content to avoid memory
 
857
        # pressure.
 
858
        expected_result.append(('put_bytes', 'foo', 6, None))
 
859
        # get records the file name only.
 
860
        expected_result.append(('get', 'foo'))
 
861
        self.assertEqual(expected_result, transport._activity)
 
862
 
 
863
    def test_readv(self):
 
864
        transport = get_transport('trace+memory:///')
 
865
        transport.put_bytes('foo', 'barish')
 
866
        list(transport.readv('foo', [(0, 1), (3, 2)], adjust_for_latency=True,
 
867
            upper_limit=6))
 
868
        expected_result = []
 
869
        # put_bytes records the bytes, not the content to avoid memory
 
870
        # pressure.
 
871
        expected_result.append(('put_bytes', 'foo', 6, None))
 
872
        # readv records the supplied offset request
 
873
        expected_result.append(('readv', 'foo', [(0, 1), (3, 2)], True, 6))
 
874
        self.assertEqual(expected_result, transport._activity)