1
# Copyright (C) 2005, 2006, 2008 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
from StringIO import StringIO
25
from bzrlib.errors import BzrBadParameterNotString, NoSuchFile, ReadOnlyError
26
from bzrlib.lockable_files import LockableFiles, TransportLock
27
from bzrlib.symbol_versioning import (
30
from bzrlib.tests import (
34
from bzrlib.tests.test_smart import TestCaseWithSmartMedium
35
from bzrlib.tests.test_transactions import DummyWeave
36
from bzrlib.transactions import (PassThroughTransaction,
40
from bzrlib.transport import get_transport
43
# these tests are applied in each parameterized suite for LockableFiles
45
# they use an old style of parameterization, but we want to remove this class
46
# so won't modernize them now. - mbp 20080430
47
class _TestLockableFiles_mixin(object):
49
def test_read_write(self):
50
self.assertRaises(NoSuchFile,
52
deprecated_in((1, 5, 0)),
53
self.lockable.get, 'foo')
54
self.assertRaises(NoSuchFile,
56
deprecated_in((1, 5, 0)),
57
self.lockable.get_utf8, 'foo')
58
self.lockable.lock_write()
60
unicode_string = u'bar\u1234'
61
self.assertEqual(4, len(unicode_string))
62
byte_string = unicode_string.encode('utf-8')
63
self.assertEqual(6, len(byte_string))
64
self.assertRaises(UnicodeEncodeError,
66
deprecated_in((1, 6, 0)),
67
self.lockable.put, 'foo',
68
StringIO(unicode_string))
70
deprecated_in((1, 6, 0)),
72
'foo', StringIO(byte_string))
73
byte_stream = self.applyDeprecated(
74
deprecated_in((1, 5, 0)),
77
self.assertEqual(byte_string, byte_stream.read())
78
unicode_stream = self.applyDeprecated(
79
deprecated_in((1, 5, 0)),
80
self.lockable.get_utf8,
82
self.assertEqual(unicode_string,
83
unicode_stream.read())
84
self.assertRaises(BzrBadParameterNotString,
86
deprecated_in((1, 6, 0)),
87
self.lockable.put_utf8,
89
StringIO(unicode_string))
91
deprecated_in((1, 6, 0)),
92
self.lockable.put_utf8,
95
unicode_stream = self.applyDeprecated(
96
deprecated_in((1, 5, 0)),
97
self.lockable.get_utf8,
99
self.assertEqual(unicode_string,
100
unicode_stream.read())
101
byte_stream = self.applyDeprecated(
102
deprecated_in((1, 5, 0)),
105
self.assertEqual(byte_string, byte_stream.read())
106
self.applyDeprecated(
107
deprecated_in((1, 6, 0)),
108
self.lockable.put_bytes,
109
'raw', 'raw\xffbytes')
110
byte_stream = self.applyDeprecated(
111
deprecated_in((1, 5, 0)),
114
self.assertEqual('raw\xffbytes', byte_stream.read())
116
self.lockable.unlock()
118
def test_locks(self):
119
self.lockable.lock_read()
121
self.assertRaises(ReadOnlyError, self.lockable.put, 'foo',
122
StringIO('bar\u1234'))
124
self.lockable.unlock()
126
def test_transactions(self):
127
self.assertIs(self.lockable.get_transaction().__class__,
128
PassThroughTransaction)
129
self.lockable.lock_read()
131
self.assertIs(self.lockable.get_transaction().__class__,
134
self.lockable.unlock()
135
self.assertIs(self.lockable.get_transaction().__class__,
136
PassThroughTransaction)
137
self.lockable.lock_write()
138
self.assertIs(self.lockable.get_transaction().__class__,
140
# check that finish is called:
142
self.lockable.get_transaction().register_dirty(vf)
143
self.lockable.unlock()
144
self.assertTrue(vf.finished)
146
def test__escape(self):
147
self.assertEqual('%25', self.lockable._escape('%'))
149
def test__escape_empty(self):
150
self.assertEqual('', self.lockable._escape(''))
152
def test_break_lock(self):
153
# some locks are not breakable
154
self.lockable.lock_write()
156
self.assertRaises(AssertionError, self.lockable.break_lock)
157
except NotImplementedError:
158
# this lock cannot be broken
159
self.lockable.unlock()
160
raise TestNotApplicable("%r is not breakable" % (self.lockable,))
161
l2 = self.get_lockable()
162
orig_factory = bzrlib.ui.ui_factory
163
# silent ui - no need for stdout
164
bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
165
bzrlib.ui.ui_factory.stdin = StringIO("y\n")
169
bzrlib.ui.ui_factory = orig_factory
174
self.assertRaises(errors.LockBroken, self.lockable.unlock)
175
self.assertFalse(self.lockable.is_locked())
177
def test_lock_write_returns_None_refuses_token(self):
178
token = self.lockable.lock_write()
180
if token is not None:
181
# This test does not apply, because this lockable supports
183
raise TestNotApplicable("%r uses tokens" % (self.lockable,))
184
self.assertRaises(errors.TokenLockingNotSupported,
185
self.lockable.lock_write, token='token')
187
self.lockable.unlock()
189
def test_lock_write_returns_token_when_given_token(self):
190
token = self.lockable.lock_write()
193
# This test does not apply, because this lockable refuses
196
new_lockable = self.get_lockable()
197
token_from_new_lockable = new_lockable.lock_write(token=token)
199
self.assertEqual(token, token_from_new_lockable)
201
new_lockable.unlock()
203
self.lockable.unlock()
205
def test_lock_write_raises_on_token_mismatch(self):
206
token = self.lockable.lock_write()
209
# This test does not apply, because this lockable refuses
212
different_token = token + 'xxx'
213
# Re-using the same lockable instance with a different token will
214
# raise TokenMismatch.
215
self.assertRaises(errors.TokenMismatch,
216
self.lockable.lock_write, token=different_token)
217
# A separate instance for the same lockable will also raise
219
# This detects the case where a caller claims to have a lock (via
220
# the token) for an external resource, but doesn't (the token is
221
# different). Clients need a separate lock object to make sure the
222
# external resource is probed, whereas the existing lock object
224
new_lockable = self.get_lockable()
225
self.assertRaises(errors.TokenMismatch,
226
new_lockable.lock_write, token=different_token)
228
self.lockable.unlock()
230
def test_lock_write_with_matching_token(self):
231
# If the token matches, so no exception is raised by lock_write.
232
token = self.lockable.lock_write()
235
# This test does not apply, because this lockable refuses
238
# The same instance will accept a second lock_write if the specified
240
self.lockable.lock_write(token=token)
241
self.lockable.unlock()
242
# Calling lock_write on a new instance for the same lockable will
244
new_lockable = self.get_lockable()
245
new_lockable.lock_write(token=token)
246
new_lockable.unlock()
248
self.lockable.unlock()
250
def test_unlock_after_lock_write_with_token(self):
251
# If lock_write did not physically acquire the lock (because it was
252
# passed a token), then unlock should not physically release it.
253
token = self.lockable.lock_write()
256
# This test does not apply, because this lockable refuses
259
new_lockable = self.get_lockable()
260
new_lockable.lock_write(token=token)
261
new_lockable.unlock()
262
self.assertTrue(self.lockable.get_physical_lock_status())
264
self.lockable.unlock()
266
def test_lock_write_with_token_fails_when_unlocked(self):
267
# Lock and unlock to get a superficially valid token. This mimics a
268
# likely programming error, where a caller accidentally tries to lock
269
# with a token that is no longer valid (because the original lock was
271
token = self.lockable.lock_write()
272
self.lockable.unlock()
274
# This test does not apply, because this lockable refuses
278
self.assertRaises(errors.TokenMismatch,
279
self.lockable.lock_write, token=token)
281
def test_lock_write_reenter_with_token(self):
282
token = self.lockable.lock_write()
285
# This test does not apply, because this lockable refuses
288
# Relock with a token.
289
token_from_reentry = self.lockable.lock_write(token=token)
291
self.assertEqual(token, token_from_reentry)
293
self.lockable.unlock()
295
self.lockable.unlock()
296
# The lock should be unlocked on disk. Verify that with a new lock
298
new_lockable = self.get_lockable()
299
# Calling lock_write now should work, rather than raise LockContention.
300
new_lockable.lock_write()
301
new_lockable.unlock()
303
def test_second_lock_write_returns_same_token(self):
304
first_token = self.lockable.lock_write()
306
if first_token is None:
307
# This test does not apply, because this lockable refuses
310
# Relock the already locked lockable. It should return the same
312
second_token = self.lockable.lock_write()
314
self.assertEqual(first_token, second_token)
316
self.lockable.unlock()
318
self.lockable.unlock()
320
def test_leave_in_place(self):
321
token = self.lockable.lock_write()
324
# This test does not apply, because this lockable refuses
327
self.lockable.leave_in_place()
329
self.lockable.unlock()
330
# At this point, the lock is still in place on disk
331
self.assertRaises(errors.LockContention, self.lockable.lock_write)
332
# But should be relockable with a token.
333
self.lockable.lock_write(token=token)
334
self.lockable.unlock()
336
def test_dont_leave_in_place(self):
337
token = self.lockable.lock_write()
340
# This test does not apply, because this lockable refuses
343
self.lockable.leave_in_place()
345
self.lockable.unlock()
346
# At this point, the lock is still in place on disk.
347
# Acquire the existing lock with the token, and ask that it is removed
348
# when this object unlocks, and unlock to trigger that removal.
349
new_lockable = self.get_lockable()
350
new_lockable.lock_write(token=token)
351
new_lockable.dont_leave_in_place()
352
new_lockable.unlock()
353
# At this point, the lock is no longer on disk, so we can lock it.
354
third_lockable = self.get_lockable()
355
third_lockable.lock_write()
356
third_lockable.unlock()
359
# This method of adapting tests to parameters is different to
360
# the TestProviderAdapters used elsewhere, but seems simpler for this
362
class TestLockableFiles_TransportLock(TestCaseInTempDir,
363
_TestLockableFiles_mixin):
366
TestCaseInTempDir.setUp(self)
367
transport = get_transport('.')
368
transport.mkdir('.bzr')
369
self.sub_transport = transport.clone('.bzr')
370
self.lockable = self.get_lockable()
371
self.lockable.create_lock()
374
super(TestLockableFiles_TransportLock, self).tearDown()
375
# free the subtransport so that we do not get a 5 second
376
# timeout due to the SFTP connection cache.
378
del self.sub_transport
379
except AttributeError:
382
def get_lockable(self):
383
return LockableFiles(self.sub_transport, 'my-lock', TransportLock)
386
class TestLockableFiles_LockDir(TestCaseInTempDir,
387
_TestLockableFiles_mixin):
388
"""LockableFile tests run with LockDir underneath"""
391
TestCaseInTempDir.setUp(self)
392
self.transport = get_transport('.')
393
self.lockable = self.get_lockable()
394
# the lock creation here sets mode - test_permissions on branch
395
# tests that implicitly, but it might be a good idea to factor
396
# out the mode checking logic and have it applied to loackable files
397
# directly. RBC 20060418
398
self.lockable.create_lock()
400
def get_lockable(self):
401
return LockableFiles(self.transport, 'my-lock', lockdir.LockDir)
403
def test_lock_created(self):
404
self.assertTrue(self.transport.has('my-lock'))
405
self.lockable.lock_write()
406
self.assertTrue(self.transport.has('my-lock/held/info'))
407
self.lockable.unlock()
408
self.assertFalse(self.transport.has('my-lock/held/info'))
409
self.assertTrue(self.transport.has('my-lock'))
411
def test__file_modes(self):
412
self.transport.mkdir('readonly')
413
osutils.make_readonly('readonly')
414
lockable = LockableFiles(self.transport.clone('readonly'), 'test-lock',
416
# The directory mode should be read-write-execute for the current user
417
self.assertEqual(00700, lockable._dir_mode & 00700)
418
# Files should be read-write for the current user
419
self.assertEqual(00600, lockable._file_mode & 00700)
422
class TestLockableFiles_RemoteLockDir(TestCaseWithSmartMedium,
423
_TestLockableFiles_mixin):
424
"""LockableFile tests run with RemoteLockDir on a branch."""
427
TestCaseWithSmartMedium.setUp(self)
428
# can only get a RemoteLockDir with some RemoteObject...
429
# use a branch as thats what we want. These mixin tests test the end
430
# to end behaviour, so stubbing out the backend and simulating would
431
# defeat the purpose. We test the protocol implementation separately
432
# in test_remote and test_smart as usual.
433
b = self.make_branch('foo')
434
self.addCleanup(b.bzrdir.transport.disconnect)
435
self.transport = get_transport('.')
436
self.lockable = self.get_lockable()
438
def get_lockable(self):
439
# getting a new lockable involves opening a new instance of the branch
440
branch = bzrlib.branch.Branch.open(self.get_url('foo'))
441
self.addCleanup(branch.bzrdir.transport.disconnect)
442
return branch.control_files
added
removed
bzrlib/tests/test_lockable_files.py
