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
20
import bzrlib.errors as errors
21
from bzrlib.errors import BzrBadParameterNotString, NoSuchFile, ReadOnlyError
22
from bzrlib.lockable_files import LockableFiles, TransportLock
23
from bzrlib import lockdir
24
from bzrlib.lockdir import LockDir
25
from bzrlib.tests import TestCaseInTempDir
26
from bzrlib.tests.test_smart import TestCaseWithSmartMedium
27
from bzrlib.tests.test_transactions import DummyWeave
28
from bzrlib.transactions import (PassThroughTransaction,
32
from bzrlib.transport import get_transport
35
# these tests are applied in each parameterized suite for LockableFiles
36
class _TestLockableFiles_mixin(object):
38
def test_read_write(self):
39
self.assertRaises(NoSuchFile, self.lockable.get, 'foo')
40
self.assertRaises(NoSuchFile, self.lockable.get_utf8, 'foo')
41
self.lockable.lock_write()
43
unicode_string = u'bar\u1234'
44
self.assertEqual(4, len(unicode_string))
45
byte_string = unicode_string.encode('utf-8')
46
self.assertEqual(6, len(byte_string))
47
self.assertRaises(UnicodeEncodeError, self.lockable.put, 'foo',
48
StringIO(unicode_string))
49
self.lockable.put('foo', StringIO(byte_string))
50
self.assertEqual(byte_string,
51
self.lockable.get('foo').read())
52
self.assertEqual(unicode_string,
53
self.lockable.get_utf8('foo').read())
54
self.assertRaises(BzrBadParameterNotString,
55
self.lockable.put_utf8,
57
StringIO(unicode_string)
59
self.lockable.put_utf8('bar', unicode_string)
60
self.assertEqual(unicode_string,
61
self.lockable.get_utf8('bar').read())
62
self.assertEqual(byte_string,
63
self.lockable.get('bar').read())
64
self.lockable.put_bytes('raw', 'raw\xffbytes')
65
self.assertEqual('raw\xffbytes',
66
self.lockable.get('raw').read())
68
self.lockable.unlock()
71
self.lockable.lock_read()
73
self.assertRaises(ReadOnlyError, self.lockable.put, 'foo',
74
StringIO('bar\u1234'))
76
self.lockable.unlock()
78
def test_transactions(self):
79
self.assertIs(self.lockable.get_transaction().__class__,
80
PassThroughTransaction)
81
self.lockable.lock_read()
83
self.assertIs(self.lockable.get_transaction().__class__,
86
self.lockable.unlock()
87
self.assertIs(self.lockable.get_transaction().__class__,
88
PassThroughTransaction)
89
self.lockable.lock_write()
90
self.assertIs(self.lockable.get_transaction().__class__,
92
# check that finish is called:
94
self.lockable.get_transaction().register_dirty(vf)
95
self.lockable.unlock()
96
self.assertTrue(vf.finished)
98
def test__escape(self):
99
self.assertEqual('%25', self.lockable._escape('%'))
101
def test__escape_empty(self):
102
self.assertEqual('', self.lockable._escape(''))
104
def test_break_lock(self):
105
# some locks are not breakable
106
self.lockable.lock_write()
108
self.assertRaises(AssertionError, self.lockable.break_lock)
109
except NotImplementedError:
110
# this lock cannot be broken
111
self.lockable.unlock()
113
l2 = self.get_lockable()
114
orig_factory = bzrlib.ui.ui_factory
115
# silent ui - no need for stdout
116
bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
117
bzrlib.ui.ui_factory.stdin = StringIO("y\n")
121
bzrlib.ui.ui_factory = orig_factory
126
self.assertRaises(errors.LockBroken, self.lockable.unlock)
127
self.assertFalse(self.lockable.is_locked())
129
def test_lock_write_returns_None_refuses_token(self):
130
token = self.lockable.lock_write()
132
if token is not None:
133
# This test does not apply, because this lockable supports
136
self.assertRaises(errors.TokenLockingNotSupported,
137
self.lockable.lock_write, token='token')
139
self.lockable.unlock()
141
def test_lock_write_returns_token_when_given_token(self):
142
token = self.lockable.lock_write()
145
# This test does not apply, because this lockable refuses
148
new_lockable = self.get_lockable()
149
token_from_new_lockable = new_lockable.lock_write(token=token)
151
self.assertEqual(token, token_from_new_lockable)
153
new_lockable.unlock()
155
self.lockable.unlock()
157
def test_lock_write_raises_on_token_mismatch(self):
158
token = self.lockable.lock_write()
161
# This test does not apply, because this lockable refuses
164
different_token = token + 'xxx'
165
# Re-using the same lockable instance with a different token will
166
# raise TokenMismatch.
167
self.assertRaises(errors.TokenMismatch,
168
self.lockable.lock_write, token=different_token)
169
# A seperate instance for the same lockable will also raise
171
# This detects the case where a caller claims to have a lock (via
172
# the token) for an external resource, but doesn't (the token is
173
# different). Clients need a seperate lock object to make sure the
174
# external resource is probed, whereas the existing lock object
176
new_lockable = self.get_lockable()
177
self.assertRaises(errors.TokenMismatch,
178
new_lockable.lock_write, token=different_token)
180
self.lockable.unlock()
182
def test_lock_write_with_matching_token(self):
183
# If the token matches, so no exception is raised by lock_write.
184
token = self.lockable.lock_write()
187
# This test does not apply, because this lockable refuses
190
# The same instance will accept a second lock_write if the specified
192
self.lockable.lock_write(token=token)
193
self.lockable.unlock()
194
# Calling lock_write on a new instance for the same lockable will
196
new_lockable = self.get_lockable()
197
new_lockable.lock_write(token=token)
198
new_lockable.unlock()
200
self.lockable.unlock()
202
def test_unlock_after_lock_write_with_token(self):
203
# If lock_write did not physically acquire the lock (because it was
204
# passed a token), then unlock should not physically release it.
205
token = self.lockable.lock_write()
208
# This test does not apply, because this lockable refuses
211
new_lockable = self.get_lockable()
212
new_lockable.lock_write(token=token)
213
new_lockable.unlock()
214
self.assertTrue(self.lockable.get_physical_lock_status())
216
self.lockable.unlock()
218
def test_lock_write_with_token_fails_when_unlocked(self):
219
# Lock and unlock to get a superficially valid token. This mimics a
220
# likely programming error, where a caller accidentally tries to lock
221
# with a token that is no longer valid (because the original lock was
223
token = self.lockable.lock_write()
224
self.lockable.unlock()
226
# This test does not apply, because this lockable refuses
230
self.assertRaises(errors.TokenMismatch,
231
self.lockable.lock_write, token=token)
233
def test_lock_write_reenter_with_token(self):
234
token = self.lockable.lock_write()
237
# This test does not apply, because this lockable refuses
240
# Relock with a token.
241
token_from_reentry = self.lockable.lock_write(token=token)
243
self.assertEqual(token, token_from_reentry)
245
self.lockable.unlock()
247
self.lockable.unlock()
248
# The lock should be unlocked on disk. Verify that with a new lock
250
new_lockable = self.get_lockable()
251
# Calling lock_write now should work, rather than raise LockContention.
252
new_lockable.lock_write()
253
new_lockable.unlock()
255
def test_second_lock_write_returns_same_token(self):
256
first_token = self.lockable.lock_write()
258
if first_token is None:
259
# This test does not apply, because this lockable refuses
262
# Relock the already locked lockable. It should return the same
264
second_token = self.lockable.lock_write()
266
self.assertEqual(first_token, second_token)
268
self.lockable.unlock()
270
self.lockable.unlock()
272
def test_leave_in_place(self):
273
token = self.lockable.lock_write()
276
# This test does not apply, because this lockable refuses
279
self.lockable.leave_in_place()
281
self.lockable.unlock()
282
# At this point, the lock is still in place on disk
283
self.assertRaises(errors.LockContention, self.lockable.lock_write)
284
# But should be relockable with a token.
285
self.lockable.lock_write(token=token)
286
self.lockable.unlock()
288
def test_dont_leave_in_place(self):
289
token = self.lockable.lock_write()
292
# This test does not apply, because this lockable refuses
295
self.lockable.leave_in_place()
297
self.lockable.unlock()
298
# At this point, the lock is still in place on disk.
299
# Acquire the existing lock with the token, and ask that it is removed
300
# when this object unlocks, and unlock to trigger that removal.
301
new_lockable = self.get_lockable()
302
new_lockable.lock_write(token=token)
303
new_lockable.dont_leave_in_place()
304
new_lockable.unlock()
305
# At this point, the lock is no longer on disk, so we can lock it.
306
third_lockable = self.get_lockable()
307
third_lockable.lock_write()
308
third_lockable.unlock()
311
# This method of adapting tests to parameters is different to
312
# the TestProviderAdapters used elsewhere, but seems simpler for this
314
class TestLockableFiles_TransportLock(TestCaseInTempDir,
315
_TestLockableFiles_mixin):
318
TestCaseInTempDir.setUp(self)
319
transport = get_transport('.')
320
transport.mkdir('.bzr')
321
self.sub_transport = transport.clone('.bzr')
322
self.lockable = self.get_lockable()
323
self.lockable.create_lock()
326
super(TestLockableFiles_TransportLock, self).tearDown()
327
# free the subtransport so that we do not get a 5 second
328
# timeout due to the SFTP connection cache.
329
del self.sub_transport
331
def get_lockable(self):
332
return LockableFiles(self.sub_transport, 'my-lock', TransportLock)
335
class TestLockableFiles_LockDir(TestCaseInTempDir,
336
_TestLockableFiles_mixin):
337
"""LockableFile tests run with LockDir underneath"""
340
TestCaseInTempDir.setUp(self)
341
self.transport = get_transport('.')
342
self.lockable = self.get_lockable()
343
# the lock creation here sets mode - test_permissions on branch
344
# tests that implicitly, but it might be a good idea to factor
345
# out the mode checking logic and have it applied to loackable files
346
# directly. RBC 20060418
347
self.lockable.create_lock()
349
def get_lockable(self):
350
return LockableFiles(self.transport, 'my-lock', LockDir)
352
def test_lock_created(self):
353
self.assertTrue(self.transport.has('my-lock'))
354
self.lockable.lock_write()
355
self.assertTrue(self.transport.has('my-lock/held/info'))
356
self.lockable.unlock()
357
self.assertFalse(self.transport.has('my-lock/held/info'))
358
self.assertTrue(self.transport.has('my-lock'))
361
# TODO: Test the lockdir inherits the right file and directory permissions
362
# from the LockableFiles.
365
class TestLockableFiles_RemoteLockDir(TestCaseWithSmartMedium,
366
_TestLockableFiles_mixin):
367
"""LockableFile tests run with RemoteLockDir on a branch."""
370
TestCaseWithSmartMedium.setUp(self)
371
# can only get a RemoteLockDir with some RemoteObject...
372
# use a branch as thats what we want. These mixin tests test the end
373
# to end behaviour, so stubbing out the backend and simulating would
374
# defeat the purpose. We test the protocol implementation separately
375
# in test_remote and test_smart as usual.
376
b = self.make_branch('foo')
377
self.addCleanup(b.bzrdir.transport.disconnect)
378
self.transport = get_transport('.')
379
self.lockable = self.get_lockable()
381
def get_lockable(self):
382
# getting a new lockable involves opening a new instance of the branch
383
branch = bzrlib.branch.Branch.open(self.get_url('foo'))
384
self.addCleanup(branch.bzrdir.transport.disconnect)
385
return branch.control_files
added
removed
bzrlib/tests/test_lockable_files.py
