1
# Copyright (C) 2005, 2006 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
17
from StringIO import StringIO
25
from bzrlib.errors import BzrBadParameterNotString, NoSuchFile, ReadOnlyError
26
from bzrlib.lockable_files import LockableFiles, TransportLock
27
from bzrlib.tests import TestCaseInTempDir
28
from bzrlib.tests.test_smart import TestCaseWithSmartMedium
29
from bzrlib.tests.test_transactions import DummyWeave
30
from bzrlib.transactions import (PassThroughTransaction,
34
from bzrlib.transport import get_transport
37
# these tests are applied in each parameterized suite for LockableFiles
38
class _TestLockableFiles_mixin(object):
40
def test_read_write(self):
41
self.assertRaises(NoSuchFile, self.lockable.get, 'foo')
42
self.assertRaises(NoSuchFile, self.lockable.get_utf8, 'foo')
43
self.lockable.lock_write()
45
unicode_string = u'bar\u1234'
46
self.assertEqual(4, len(unicode_string))
47
byte_string = unicode_string.encode('utf-8')
48
self.assertEqual(6, len(byte_string))
49
self.assertRaises(UnicodeEncodeError, self.lockable.put, 'foo',
50
StringIO(unicode_string))
51
self.lockable.put('foo', StringIO(byte_string))
52
self.assertEqual(byte_string,
53
self.lockable.get('foo').read())
54
self.assertEqual(unicode_string,
55
self.lockable.get_utf8('foo').read())
56
self.assertRaises(BzrBadParameterNotString,
57
self.lockable.put_utf8,
59
StringIO(unicode_string)
61
self.lockable.put_utf8('bar', unicode_string)
62
self.assertEqual(unicode_string,
63
self.lockable.get_utf8('bar').read())
64
self.assertEqual(byte_string,
65
self.lockable.get('bar').read())
66
self.lockable.put_bytes('raw', 'raw\xffbytes')
67
self.assertEqual('raw\xffbytes',
68
self.lockable.get('raw').read())
70
self.lockable.unlock()
73
self.lockable.lock_read()
75
self.assertRaises(ReadOnlyError, self.lockable.put, 'foo',
76
StringIO('bar\u1234'))
78
self.lockable.unlock()
80
def test_transactions(self):
81
self.assertIs(self.lockable.get_transaction().__class__,
82
PassThroughTransaction)
83
self.lockable.lock_read()
85
self.assertIs(self.lockable.get_transaction().__class__,
88
self.lockable.unlock()
89
self.assertIs(self.lockable.get_transaction().__class__,
90
PassThroughTransaction)
91
self.lockable.lock_write()
92
self.assertIs(self.lockable.get_transaction().__class__,
94
# check that finish is called:
96
self.lockable.get_transaction().register_dirty(vf)
97
self.lockable.unlock()
98
self.assertTrue(vf.finished)
100
def test__escape(self):
101
self.assertEqual('%25', self.lockable._escape('%'))
103
def test__escape_empty(self):
104
self.assertEqual('', self.lockable._escape(''))
106
def test_break_lock(self):
107
# some locks are not breakable
108
self.lockable.lock_write()
110
self.assertRaises(AssertionError, self.lockable.break_lock)
111
except NotImplementedError:
112
# this lock cannot be broken
113
self.lockable.unlock()
115
l2 = self.get_lockable()
116
orig_factory = bzrlib.ui.ui_factory
117
# silent ui - no need for stdout
118
bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
119
bzrlib.ui.ui_factory.stdin = StringIO("y\n")
123
bzrlib.ui.ui_factory = orig_factory
128
self.assertRaises(errors.LockBroken, self.lockable.unlock)
129
self.assertFalse(self.lockable.is_locked())
131
def test_lock_write_returns_None_refuses_token(self):
132
token = self.lockable.lock_write()
134
if token is not None:
135
# This test does not apply, because this lockable supports
138
self.assertRaises(errors.TokenLockingNotSupported,
139
self.lockable.lock_write, token='token')
141
self.lockable.unlock()
143
def test_lock_write_returns_token_when_given_token(self):
144
token = self.lockable.lock_write()
147
# This test does not apply, because this lockable refuses
150
new_lockable = self.get_lockable()
151
token_from_new_lockable = new_lockable.lock_write(token=token)
153
self.assertEqual(token, token_from_new_lockable)
155
new_lockable.unlock()
157
self.lockable.unlock()
159
def test_lock_write_raises_on_token_mismatch(self):
160
token = self.lockable.lock_write()
163
# This test does not apply, because this lockable refuses
166
different_token = token + 'xxx'
167
# Re-using the same lockable instance with a different token will
168
# raise TokenMismatch.
169
self.assertRaises(errors.TokenMismatch,
170
self.lockable.lock_write, token=different_token)
171
# A seperate instance for the same lockable will also raise
173
# This detects the case where a caller claims to have a lock (via
174
# the token) for an external resource, but doesn't (the token is
175
# different). Clients need a seperate lock object to make sure the
176
# external resource is probed, whereas the existing lock object
178
new_lockable = self.get_lockable()
179
self.assertRaises(errors.TokenMismatch,
180
new_lockable.lock_write, token=different_token)
182
self.lockable.unlock()
184
def test_lock_write_with_matching_token(self):
185
# If the token matches, so no exception is raised by lock_write.
186
token = self.lockable.lock_write()
189
# This test does not apply, because this lockable refuses
192
# The same instance will accept a second lock_write if the specified
194
self.lockable.lock_write(token=token)
195
self.lockable.unlock()
196
# Calling lock_write on a new instance for the same lockable will
198
new_lockable = self.get_lockable()
199
new_lockable.lock_write(token=token)
200
new_lockable.unlock()
202
self.lockable.unlock()
204
def test_unlock_after_lock_write_with_token(self):
205
# If lock_write did not physically acquire the lock (because it was
206
# passed a token), then unlock should not physically release it.
207
token = self.lockable.lock_write()
210
# This test does not apply, because this lockable refuses
213
new_lockable = self.get_lockable()
214
new_lockable.lock_write(token=token)
215
new_lockable.unlock()
216
self.assertTrue(self.lockable.get_physical_lock_status())
218
self.lockable.unlock()
220
def test_lock_write_with_token_fails_when_unlocked(self):
221
# Lock and unlock to get a superficially valid token. This mimics a
222
# likely programming error, where a caller accidentally tries to lock
223
# with a token that is no longer valid (because the original lock was
225
token = self.lockable.lock_write()
226
self.lockable.unlock()
228
# This test does not apply, because this lockable refuses
232
self.assertRaises(errors.TokenMismatch,
233
self.lockable.lock_write, token=token)
235
def test_lock_write_reenter_with_token(self):
236
token = self.lockable.lock_write()
239
# This test does not apply, because this lockable refuses
242
# Relock with a token.
243
token_from_reentry = self.lockable.lock_write(token=token)
245
self.assertEqual(token, token_from_reentry)
247
self.lockable.unlock()
249
self.lockable.unlock()
250
# The lock should be unlocked on disk. Verify that with a new lock
252
new_lockable = self.get_lockable()
253
# Calling lock_write now should work, rather than raise LockContention.
254
new_lockable.lock_write()
255
new_lockable.unlock()
257
def test_second_lock_write_returns_same_token(self):
258
first_token = self.lockable.lock_write()
260
if first_token is None:
261
# This test does not apply, because this lockable refuses
264
# Relock the already locked lockable. It should return the same
266
second_token = self.lockable.lock_write()
268
self.assertEqual(first_token, second_token)
270
self.lockable.unlock()
272
self.lockable.unlock()
274
def test_leave_in_place(self):
275
token = self.lockable.lock_write()
278
# This test does not apply, because this lockable refuses
281
self.lockable.leave_in_place()
283
self.lockable.unlock()
284
# At this point, the lock is still in place on disk
285
self.assertRaises(errors.LockContention, self.lockable.lock_write)
286
# But should be relockable with a token.
287
self.lockable.lock_write(token=token)
288
self.lockable.unlock()
290
def test_dont_leave_in_place(self):
291
token = self.lockable.lock_write()
294
# This test does not apply, because this lockable refuses
297
self.lockable.leave_in_place()
299
self.lockable.unlock()
300
# At this point, the lock is still in place on disk.
301
# Acquire the existing lock with the token, and ask that it is removed
302
# when this object unlocks, and unlock to trigger that removal.
303
new_lockable = self.get_lockable()
304
new_lockable.lock_write(token=token)
305
new_lockable.dont_leave_in_place()
306
new_lockable.unlock()
307
# At this point, the lock is no longer on disk, so we can lock it.
308
third_lockable = self.get_lockable()
309
third_lockable.lock_write()
310
third_lockable.unlock()
313
# This method of adapting tests to parameters is different to
314
# the TestProviderAdapters used elsewhere, but seems simpler for this
316
class TestLockableFiles_TransportLock(TestCaseInTempDir,
317
_TestLockableFiles_mixin):
320
TestCaseInTempDir.setUp(self)
321
transport = get_transport('.')
322
transport.mkdir('.bzr')
323
self.sub_transport = transport.clone('.bzr')
324
self.lockable = self.get_lockable()
325
self.lockable.create_lock()
328
super(TestLockableFiles_TransportLock, self).tearDown()
329
# free the subtransport so that we do not get a 5 second
330
# timeout due to the SFTP connection cache.
331
del self.sub_transport
333
def get_lockable(self):
334
return LockableFiles(self.sub_transport, 'my-lock', TransportLock)
337
class TestLockableFiles_LockDir(TestCaseInTempDir,
338
_TestLockableFiles_mixin):
339
"""LockableFile tests run with LockDir underneath"""
342
TestCaseInTempDir.setUp(self)
343
self.transport = get_transport('.')
344
self.lockable = self.get_lockable()
345
# the lock creation here sets mode - test_permissions on branch
346
# tests that implicitly, but it might be a good idea to factor
347
# out the mode checking logic and have it applied to loackable files
348
# directly. RBC 20060418
349
self.lockable.create_lock()
351
def get_lockable(self):
352
return LockableFiles(self.transport, 'my-lock', lockdir.LockDir)
354
def test_lock_created(self):
355
self.assertTrue(self.transport.has('my-lock'))
356
self.lockable.lock_write()
357
self.assertTrue(self.transport.has('my-lock/held/info'))
358
self.lockable.unlock()
359
self.assertFalse(self.transport.has('my-lock/held/info'))
360
self.assertTrue(self.transport.has('my-lock'))
362
def test__file_modes(self):
363
self.transport.mkdir('readonly')
364
osutils.make_readonly('readonly')
365
lockable = LockableFiles(self.transport.clone('readonly'), 'test-lock',
367
# The directory mode should be read-write-execute for the current user
368
self.assertEqual(00700, lockable._dir_mode & 00700)
369
# Files should be read-write for the current user
370
self.assertEqual(00600, lockable._file_mode & 00700)
373
class TestLockableFiles_RemoteLockDir(TestCaseWithSmartMedium,
374
_TestLockableFiles_mixin):
375
"""LockableFile tests run with RemoteLockDir on a branch."""
378
TestCaseWithSmartMedium.setUp(self)
379
# can only get a RemoteLockDir with some RemoteObject...
380
# use a branch as thats what we want. These mixin tests test the end
381
# to end behaviour, so stubbing out the backend and simulating would
382
# defeat the purpose. We test the protocol implementation separately
383
# in test_remote and test_smart as usual.
384
b = self.make_branch('foo')
385
self.addCleanup(b.bzrdir.transport.disconnect)
386
self.transport = get_transport('.')
387
self.lockable = self.get_lockable()
389
def get_lockable(self):
390
# getting a new lockable involves opening a new instance of the branch
391
branch = bzrlib.branch.Branch.open(self.get_url('foo'))
392
self.addCleanup(branch.bzrdir.transport.disconnect)
393
return branch.control_files
added
removed
bzrlib/tests/test_lockable_files.py
