1
# Copyright (C) 2004, 2005, 2006, 2007 Canonical Ltd
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.
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.
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
21
from cStringIO import StringIO
28
from bzrlib.errors import (ConnectionError,
40
from bzrlib.tests import TestCase, TestCaseInTempDir
41
from bzrlib.transport import (_CoalescedOffset,
42
_get_protocol_handlers,
43
_set_protocol_handlers,
44
_get_transport_modules,
47
register_lazy_transport,
48
register_transport_proto,
49
_clear_protocol_handlers,
52
from bzrlib.transport.chroot import ChrootServer
53
from bzrlib.transport.memory import MemoryTransport
54
from bzrlib.transport.local import (LocalTransport,
55
EmulatedWin32LocalTransport)
58
# TODO: Should possibly split transport-specific tests into their own files.
61
class TestTransport(TestCase):
62
"""Test the non transport-concrete class functionality."""
64
def test__get_set_protocol_handlers(self):
65
handlers = _get_protocol_handlers()
66
self.assertNotEqual([], handlers.keys( ))
68
_clear_protocol_handlers()
69
self.assertEqual([], _get_protocol_handlers().keys())
71
_set_protocol_handlers(handlers)
73
def test_get_transport_modules(self):
74
handlers = _get_protocol_handlers()
75
class SampleHandler(object):
76
"""I exist, isnt that enough?"""
78
_clear_protocol_handlers()
79
register_transport_proto('foo')
80
register_lazy_transport('foo', 'bzrlib.tests.test_transport', 'TestTransport.SampleHandler')
81
register_transport_proto('bar')
82
register_lazy_transport('bar', 'bzrlib.tests.test_transport', 'TestTransport.SampleHandler')
83
self.assertEqual([SampleHandler.__module__, 'bzrlib.transport.chroot'],
84
_get_transport_modules())
86
_set_protocol_handlers(handlers)
88
def test_transport_dependency(self):
89
"""Transport with missing dependency causes no error"""
90
saved_handlers = _get_protocol_handlers()
92
register_transport_proto('foo')
93
register_lazy_transport('foo', 'bzrlib.tests.test_transport',
94
'BadTransportHandler')
96
get_transport('foo://fooserver/foo')
97
except UnsupportedProtocol, e:
99
self.assertEquals('Unsupported protocol'
100
' for url "foo://fooserver/foo":'
101
' Unable to import library "some_lib":'
102
' testing missing dependency', str(e))
104
self.fail('Did not raise UnsupportedProtocol')
106
# restore original values
107
_set_protocol_handlers(saved_handlers)
109
def test_transport_fallback(self):
110
"""Transport with missing dependency causes no error"""
111
saved_handlers = _get_protocol_handlers()
113
_clear_protocol_handlers()
114
register_transport_proto('foo')
115
register_lazy_transport('foo', 'bzrlib.tests.test_transport',
116
'BackupTransportHandler')
117
register_lazy_transport('foo', 'bzrlib.tests.test_transport',
118
'BadTransportHandler')
119
t = get_transport('foo://fooserver/foo')
120
self.assertTrue(isinstance(t, BackupTransportHandler))
122
_set_protocol_handlers(saved_handlers)
124
def test_LateReadError(self):
125
"""The LateReadError helper should raise on read()."""
126
a_file = LateReadError('a path')
129
except ReadError, error:
130
self.assertEqual('a path', error.path)
131
self.assertRaises(ReadError, a_file.read, 40)
134
def test__combine_paths(self):
136
self.assertEqual('/home/sarah/project/foo',
137
t._combine_paths('/home/sarah', 'project/foo'))
138
self.assertEqual('/etc',
139
t._combine_paths('/home/sarah', '../../etc'))
140
self.assertEqual('/etc',
141
t._combine_paths('/home/sarah', '../../../etc'))
142
self.assertEqual('/etc',
143
t._combine_paths('/home/sarah', '/etc'))
145
def test_local_abspath_non_local_transport(self):
146
# the base implementation should throw
147
t = MemoryTransport()
148
e = self.assertRaises(errors.NotLocalUrl, t.local_abspath, 't')
149
self.assertEqual('memory:///t is not a local path.', str(e))
152
class TestCoalesceOffsets(TestCase):
154
def check(self, expected, offsets, limit=0, fudge=0):
155
coalesce = Transport._coalesce_offsets
156
exp = [_CoalescedOffset(*x) for x in expected]
157
out = list(coalesce(offsets, limit=limit, fudge_factor=fudge))
158
self.assertEqual(exp, out)
160
def test_coalesce_empty(self):
163
def test_coalesce_simple(self):
164
self.check([(0, 10, [(0, 10)])], [(0, 10)])
166
def test_coalesce_unrelated(self):
167
self.check([(0, 10, [(0, 10)]),
169
], [(0, 10), (20, 10)])
171
def test_coalesce_unsorted(self):
172
self.check([(20, 10, [(0, 10)]),
174
], [(20, 10), (0, 10)])
176
def test_coalesce_nearby(self):
177
self.check([(0, 20, [(0, 10), (10, 10)])],
180
def test_coalesce_overlapped(self):
181
self.check([(0, 15, [(0, 10), (5, 10)])],
184
def test_coalesce_limit(self):
185
self.check([(10, 50, [(0, 10), (10, 10), (20, 10),
186
(30, 10), (40, 10)]),
187
(60, 50, [(0, 10), (10, 10), (20, 10),
188
(30, 10), (40, 10)]),
189
], [(10, 10), (20, 10), (30, 10), (40, 10),
190
(50, 10), (60, 10), (70, 10), (80, 10),
191
(90, 10), (100, 10)],
194
def test_coalesce_no_limit(self):
195
self.check([(10, 100, [(0, 10), (10, 10), (20, 10),
196
(30, 10), (40, 10), (50, 10),
197
(60, 10), (70, 10), (80, 10),
199
], [(10, 10), (20, 10), (30, 10), (40, 10),
200
(50, 10), (60, 10), (70, 10), (80, 10),
201
(90, 10), (100, 10)])
203
def test_coalesce_fudge(self):
204
self.check([(10, 30, [(0, 10), (20, 10)]),
205
(100, 10, [(0, 10),]),
206
], [(10, 10), (30, 10), (100, 10)],
211
class TestMemoryTransport(TestCase):
213
def test_get_transport(self):
216
def test_clone(self):
217
transport = MemoryTransport()
218
self.assertTrue(isinstance(transport, MemoryTransport))
219
self.assertEqual("memory:///", transport.clone("/").base)
221
def test_abspath(self):
222
transport = MemoryTransport()
223
self.assertEqual("memory:///relpath", transport.abspath('relpath'))
225
def test_abspath_of_root(self):
226
transport = MemoryTransport()
227
self.assertEqual("memory:///", transport.base)
228
self.assertEqual("memory:///", transport.abspath('/'))
230
def test_abspath_of_relpath_starting_at_root(self):
231
transport = MemoryTransport()
232
self.assertEqual("memory:///foo", transport.abspath('/foo'))
234
def test_append_and_get(self):
235
transport = MemoryTransport()
236
transport.append_bytes('path', 'content')
237
self.assertEqual(transport.get('path').read(), 'content')
238
transport.append_file('path', StringIO('content'))
239
self.assertEqual(transport.get('path').read(), 'contentcontent')
241
def test_put_and_get(self):
242
transport = MemoryTransport()
243
transport.put_file('path', StringIO('content'))
244
self.assertEqual(transport.get('path').read(), 'content')
245
transport.put_bytes('path', 'content')
246
self.assertEqual(transport.get('path').read(), 'content')
248
def test_append_without_dir_fails(self):
249
transport = MemoryTransport()
250
self.assertRaises(NoSuchFile,
251
transport.append_bytes, 'dir/path', 'content')
253
def test_put_without_dir_fails(self):
254
transport = MemoryTransport()
255
self.assertRaises(NoSuchFile,
256
transport.put_file, 'dir/path', StringIO('content'))
258
def test_get_missing(self):
259
transport = MemoryTransport()
260
self.assertRaises(NoSuchFile, transport.get, 'foo')
262
def test_has_missing(self):
263
transport = MemoryTransport()
264
self.assertEquals(False, transport.has('foo'))
266
def test_has_present(self):
267
transport = MemoryTransport()
268
transport.append_bytes('foo', 'content')
269
self.assertEquals(True, transport.has('foo'))
271
def test_list_dir(self):
272
transport = MemoryTransport()
273
transport.put_bytes('foo', 'content')
274
transport.mkdir('dir')
275
transport.put_bytes('dir/subfoo', 'content')
276
transport.put_bytes('dirlike', 'content')
278
self.assertEquals(['dir', 'dirlike', 'foo'], sorted(transport.list_dir('.')))
279
self.assertEquals(['subfoo'], sorted(transport.list_dir('dir')))
281
def test_mkdir(self):
282
transport = MemoryTransport()
283
transport.mkdir('dir')
284
transport.append_bytes('dir/path', 'content')
285
self.assertEqual(transport.get('dir/path').read(), 'content')
287
def test_mkdir_missing_parent(self):
288
transport = MemoryTransport()
289
self.assertRaises(NoSuchFile,
290
transport.mkdir, 'dir/dir')
292
def test_mkdir_twice(self):
293
transport = MemoryTransport()
294
transport.mkdir('dir')
295
self.assertRaises(FileExists, transport.mkdir, 'dir')
297
def test_parameters(self):
298
transport = MemoryTransport()
299
self.assertEqual(True, transport.listable())
300
self.assertEqual(False, transport.should_cache())
301
self.assertEqual(False, transport.is_readonly())
303
def test_iter_files_recursive(self):
304
transport = MemoryTransport()
305
transport.mkdir('dir')
306
transport.put_bytes('dir/foo', 'content')
307
transport.put_bytes('dir/bar', 'content')
308
transport.put_bytes('bar', 'content')
309
paths = set(transport.iter_files_recursive())
310
self.assertEqual(set(['dir/foo', 'dir/bar', 'bar']), paths)
313
transport = MemoryTransport()
314
transport.put_bytes('foo', 'content')
315
transport.put_bytes('bar', 'phowar')
316
self.assertEqual(7, transport.stat('foo').st_size)
317
self.assertEqual(6, transport.stat('bar').st_size)
320
class ChrootDecoratorTransportTest(TestCase):
321
"""Chroot decoration specific tests."""
323
def test_abspath(self):
324
# The abspath is always relative to the chroot_url.
325
server = ChrootServer(get_transport('memory:///foo/bar/'))
327
transport = get_transport(server.get_url())
328
self.assertEqual(server.get_url(), transport.abspath('/'))
330
subdir_transport = transport.clone('subdir')
331
self.assertEqual(server.get_url(), subdir_transport.abspath('/'))
334
def test_clone(self):
335
server = ChrootServer(get_transport('memory:///foo/bar/'))
337
transport = get_transport(server.get_url())
338
# relpath from root and root path are the same
339
relpath_cloned = transport.clone('foo')
340
abspath_cloned = transport.clone('/foo')
341
self.assertEqual(server, relpath_cloned.server)
342
self.assertEqual(server, abspath_cloned.server)
345
def test_chroot_url_preserves_chroot(self):
346
"""Calling get_transport on a chroot transport's base should produce a
347
transport with exactly the same behaviour as the original chroot
350
This is so that it is not possible to escape a chroot by doing::
351
url = chroot_transport.base
352
parent_url = urlutils.join(url, '..')
353
new_transport = get_transport(parent_url)
355
server = ChrootServer(get_transport('memory:///path/subpath'))
357
transport = get_transport(server.get_url())
358
new_transport = get_transport(transport.base)
359
self.assertEqual(transport.server, new_transport.server)
360
self.assertEqual(transport.base, new_transport.base)
363
def test_urljoin_preserves_chroot(self):
364
"""Using urlutils.join(url, '..') on a chroot URL should not produce a
365
URL that escapes the intended chroot.
367
This is so that it is not possible to escape a chroot by doing::
368
url = chroot_transport.base
369
parent_url = urlutils.join(url, '..')
370
new_transport = get_transport(parent_url)
372
server = ChrootServer(get_transport('memory:///path/'))
374
transport = get_transport(server.get_url())
376
InvalidURLJoin, urlutils.join, transport.base, '..')
380
class ChrootServerTest(TestCase):
382
def test_construct(self):
383
backing_transport = MemoryTransport()
384
server = ChrootServer(backing_transport)
385
self.assertEqual(backing_transport, server.backing_transport)
387
def test_setUp(self):
388
backing_transport = MemoryTransport()
389
server = ChrootServer(backing_transport)
391
self.assertTrue(server.scheme in _get_protocol_handlers().keys())
393
def test_tearDown(self):
394
backing_transport = MemoryTransport()
395
server = ChrootServer(backing_transport)
398
self.assertFalse(server.scheme in _get_protocol_handlers().keys())
400
def test_get_url(self):
401
backing_transport = MemoryTransport()
402
server = ChrootServer(backing_transport)
404
self.assertEqual('chroot-%d:///' % id(server), server.get_url())
408
class ReadonlyDecoratorTransportTest(TestCase):
409
"""Readonly decoration specific tests."""
411
def test_local_parameters(self):
412
import bzrlib.transport.readonly as readonly
413
# connect to . in readonly mode
414
transport = readonly.ReadonlyTransportDecorator('readonly+.')
415
self.assertEqual(True, transport.listable())
416
self.assertEqual(False, transport.should_cache())
417
self.assertEqual(True, transport.is_readonly())
419
def test_http_parameters(self):
420
from bzrlib.tests.HttpServer import HttpServer
421
import bzrlib.transport.readonly as readonly
422
# connect to . via http which is not listable
423
server = HttpServer()
426
transport = get_transport('readonly+' + server.get_url())
427
self.failUnless(isinstance(transport,
428
readonly.ReadonlyTransportDecorator))
429
self.assertEqual(False, transport.listable())
430
self.assertEqual(True, transport.should_cache())
431
self.assertEqual(True, transport.is_readonly())
436
class FakeNFSDecoratorTests(TestCaseInTempDir):
437
"""NFS decorator specific tests."""
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)
444
def test_local_parameters(self):
445
# the listable, should_cache 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.should_cache())
450
self.assertEqual(False, transport.is_readonly())
452
def test_http_parameters(self):
453
# the listable, should_cache and is_readonly parameters
454
# are not changed by the fakenfs decorator
455
from bzrlib.tests.HttpServer import HttpServer
456
# connect to . via http which is not listable
457
server = HttpServer()
460
transport = self.get_nfs_transport(server.get_url())
461
self.assertIsInstance(
462
transport, bzrlib.transport.fakenfs.FakeNFSTransportDecorator)
463
self.assertEqual(False, transport.listable())
464
self.assertEqual(True, transport.should_cache())
465
self.assertEqual(True, transport.is_readonly())
469
def test_fakenfs_server_default(self):
470
# a FakeNFSServer() should bring up a local relpath server for itself
471
import bzrlib.transport.fakenfs as fakenfs
472
server = fakenfs.FakeNFSServer()
475
# the url should be decorated appropriately
476
self.assertStartsWith(server.get_url(), 'fakenfs+')
477
# and we should be able to get a transport for it
478
transport = get_transport(server.get_url())
479
# which must be a FakeNFSTransportDecorator instance.
480
self.assertIsInstance(
481
transport, fakenfs.FakeNFSTransportDecorator)
485
def test_fakenfs_rename_semantics(self):
486
# a FakeNFS transport must mangle the way rename errors occur to
487
# look like NFS problems.
488
transport = self.get_nfs_transport('.')
489
self.build_tree(['from/', 'from/foo', 'to/', 'to/bar'],
491
self.assertRaises(errors.ResourceBusy,
492
transport.rename, 'from', 'to')
495
class FakeVFATDecoratorTests(TestCaseInTempDir):
496
"""Tests for simulation of VFAT restrictions"""
498
def get_vfat_transport(self, url):
499
"""Return vfat-backed transport for test directory"""
500
from bzrlib.transport.fakevfat import FakeVFATTransportDecorator
501
return FakeVFATTransportDecorator('vfat+' + url)
503
def test_transport_creation(self):
504
from bzrlib.transport.fakevfat import FakeVFATTransportDecorator
505
transport = self.get_vfat_transport('.')
506
self.assertIsInstance(transport, FakeVFATTransportDecorator)
508
def test_transport_mkdir(self):
509
transport = self.get_vfat_transport('.')
510
transport.mkdir('HELLO')
511
self.assertTrue(transport.has('hello'))
512
self.assertTrue(transport.has('Hello'))
514
def test_forbidden_chars(self):
515
transport = self.get_vfat_transport('.')
516
self.assertRaises(ValueError, transport.has, "<NU>")
519
class BadTransportHandler(Transport):
520
def __init__(self, base_url):
521
raise DependencyNotPresent('some_lib', 'testing missing dependency')
524
class BackupTransportHandler(Transport):
525
"""Test transport that works as a backup for the BadTransportHandler"""
529
class TestTransportImplementation(TestCaseInTempDir):
530
"""Implementation verification for transports.
532
To verify a transport we need a server factory, which is a callable
533
that accepts no parameters and returns an implementation of
534
bzrlib.transport.Server.
536
That Server is then used to construct transport instances and test
537
the transport via loopback activity.
539
Currently this assumes that the Transport object is connected to the
540
current working directory. So that whatever is done
541
through the transport, should show up in the working
542
directory, and vice-versa. This is a bug, because its possible to have
543
URL schemes which provide access to something that may not be
544
result in storage on the local disk, i.e. due to file system limits, or
545
due to it being a database or some other non-filesystem tool.
547
This also tests to make sure that the functions work with both
548
generators and lists (assuming iter(list) is effectively a generator)
552
super(TestTransportImplementation, self).setUp()
553
self._server = self.transport_server()
555
self.addCleanup(self._server.tearDown)
557
def get_transport(self, relpath=None):
558
"""Return a connected transport to the local directory.
560
:param relpath: a path relative to the base url.
562
base_url = self._server.get_url()
563
url = self._adjust_url(base_url, relpath)
564
# try getting the transport via the regular interface:
565
t = get_transport(url)
566
if not isinstance(t, self.transport_class):
567
# we did not get the correct transport class type. Override the
568
# regular connection behaviour by direct construction.
569
t = self.transport_class(url)
573
class TestLocalTransports(TestCase):
575
def test_get_transport_from_abspath(self):
576
here = os.path.abspath('.')
577
t = get_transport(here)
578
self.assertIsInstance(t, LocalTransport)
579
self.assertEquals(t.base, urlutils.local_path_to_url(here) + '/')
581
def test_get_transport_from_relpath(self):
582
here = os.path.abspath('.')
583
t = get_transport('.')
584
self.assertIsInstance(t, LocalTransport)
585
self.assertEquals(t.base, urlutils.local_path_to_url('.') + '/')
587
def test_get_transport_from_local_url(self):
588
here = os.path.abspath('.')
589
here_url = urlutils.local_path_to_url(here) + '/'
590
t = get_transport(here_url)
591
self.assertIsInstance(t, LocalTransport)
592
self.assertEquals(t.base, here_url)
594
def test_local_abspath(self):
595
here = os.path.abspath('.')
596
t = get_transport(here)
597
self.assertEquals(t.local_abspath(''), here)
600
class TestWin32LocalTransport(TestCase):
602
def test_unc_clone_to_root(self):
603
# Win32 UNC path like \\HOST\path
604
# clone to root should stop at least at \\HOST part
606
t = EmulatedWin32LocalTransport('file://HOST/path/to/some/dir/')
609
self.assertEquals(t.base, 'file://HOST/')
610
# make sure we reach the root
612
self.assertEquals(t.base, 'file://HOST/')
615
def get_test_permutations():
616
"""Return transport permutations to be used in testing.
618
This module registers some transports, but they're only for testing
619
registration. We don't really want to run all the transport tests against
added
removed
bzrlib/tests/test_transport.py
