1
# Copyright (C) 2005, 2006 by Canonical Ltd
1
# Copyright (C) 2005-2011 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
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
19
from bzrlib.branch import Branch
20
from bzrlib.errors import BzrBadParameterNotString, NoSuchFile, ReadOnlyError
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21
24
from bzrlib.lockable_files import LockableFiles, TransportLock
22
from bzrlib.lockdir import LockDir
23
from bzrlib.tests import TestCaseInTempDir
25
from bzrlib.tests import (
29
from bzrlib.tests.test_smart import TestCaseWithSmartMedium
24
30
from bzrlib.tests.test_transactions import DummyWeave
25
31
from bzrlib.transactions import (PassThroughTransaction,
26
32
ReadOnlyTransaction,
29
from bzrlib.transport import get_transport
32
37
# these tests are applied in each parameterized suite for LockableFiles
39
# they use an old style of parameterization, but we want to remove this class
40
# so won't modernize them now. - mbp 20080430
33
41
class _TestLockableFiles_mixin(object):
35
def test_read_write(self):
36
self.assertRaises(NoSuchFile, self.lockable.get, 'foo')
37
self.assertRaises(NoSuchFile, self.lockable.get_utf8, 'foo')
38
self.lockable.lock_write()
40
unicode_string = u'bar\u1234'
41
self.assertEqual(4, len(unicode_string))
42
byte_string = unicode_string.encode('utf-8')
43
self.assertEqual(6, len(byte_string))
44
self.assertRaises(UnicodeEncodeError, self.lockable.put, 'foo',
45
StringIO(unicode_string))
46
self.lockable.put('foo', StringIO(byte_string))
47
self.assertEqual(byte_string,
48
self.lockable.get('foo').read())
49
self.assertEqual(unicode_string,
50
self.lockable.get_utf8('foo').read())
51
self.assertRaises(BzrBadParameterNotString,
52
self.lockable.put_utf8,
54
StringIO(unicode_string)
56
self.lockable.put_utf8('bar', unicode_string)
57
self.assertEqual(unicode_string,
58
self.lockable.get_utf8('bar').read())
59
self.assertEqual(byte_string,
60
self.lockable.get('bar').read())
62
self.lockable.unlock()
65
self.lockable.lock_read()
67
self.assertRaises(ReadOnlyError, self.lockable.put, 'foo',
68
StringIO('bar\u1234'))
70
self.lockable.unlock()
72
43
def test_transactions(self):
73
44
self.assertIs(self.lockable.get_transaction().__class__,
74
45
PassThroughTransaction)
92
63
def test__escape(self):
93
64
self.assertEqual('%25', self.lockable._escape('%'))
95
66
def test__escape_empty(self):
96
67
self.assertEqual('', self.lockable._escape(''))
99
# This method of adapting tests to parameters is different to
100
# the TestProviderAdapters used elsewhere, but seems simpler for this
69
def test_break_lock(self):
70
# some locks are not breakable
71
self.lockable.lock_write()
73
self.assertRaises(AssertionError, self.lockable.break_lock)
74
except NotImplementedError:
75
# this lock cannot be broken
76
self.lockable.unlock()
77
raise TestNotApplicable("%r is not breakable" % (self.lockable,))
78
l2 = self.get_lockable()
79
orig_factory = bzrlib.ui.ui_factory
80
# silent ui - no need for stdout
81
bzrlib.ui.ui_factory = bzrlib.ui.CannedInputUIFactory([True])
85
bzrlib.ui.ui_factory = orig_factory
90
self.assertRaises(errors.LockBroken, self.lockable.unlock)
91
self.assertFalse(self.lockable.is_locked())
93
def test_lock_write_returns_None_refuses_token(self):
94
token = self.lockable.lock_write()
95
self.addCleanup(self.lockable.unlock)
97
# This test does not apply, because this lockable supports
99
raise TestNotApplicable("%r uses tokens" % (self.lockable,))
100
self.assertRaises(errors.TokenLockingNotSupported,
101
self.lockable.lock_write, token='token')
103
def test_lock_write_returns_token_when_given_token(self):
104
token = self.lockable.lock_write()
105
self.addCleanup(self.lockable.unlock)
107
# This test does not apply, because this lockable refuses
110
new_lockable = self.get_lockable()
111
token_from_new_lockable = new_lockable.lock_write(token=token)
112
self.addCleanup(new_lockable.unlock)
113
self.assertEqual(token, token_from_new_lockable)
115
def test_lock_write_raises_on_token_mismatch(self):
116
token = self.lockable.lock_write()
117
self.addCleanup(self.lockable.unlock)
119
# This test does not apply, because this lockable refuses
122
different_token = token + 'xxx'
123
# Re-using the same lockable instance with a different token will
124
# raise TokenMismatch.
125
self.assertRaises(errors.TokenMismatch,
126
self.lockable.lock_write, token=different_token)
127
# A separate instance for the same lockable will also raise
129
# This detects the case where a caller claims to have a lock (via
130
# the token) for an external resource, but doesn't (the token is
131
# different). Clients need a separate lock object to make sure the
132
# external resource is probed, whereas the existing lock object
134
new_lockable = self.get_lockable()
135
self.assertRaises(errors.TokenMismatch,
136
new_lockable.lock_write, token=different_token)
138
def test_lock_write_with_matching_token(self):
139
# If the token matches, so no exception is raised by lock_write.
140
token = self.lockable.lock_write()
141
self.addCleanup(self.lockable.unlock)
143
# This test does not apply, because this lockable refuses
146
# The same instance will accept a second lock_write if the specified
148
self.lockable.lock_write(token=token)
149
self.lockable.unlock()
150
# Calling lock_write on a new instance for the same lockable will
152
new_lockable = self.get_lockable()
153
new_lockable.lock_write(token=token)
154
new_lockable.unlock()
156
def test_unlock_after_lock_write_with_token(self):
157
# If lock_write did not physically acquire the lock (because it was
158
# passed a token), then unlock should not physically release it.
159
token = self.lockable.lock_write()
160
self.addCleanup(self.lockable.unlock)
162
# This test does not apply, because this lockable refuses
165
new_lockable = self.get_lockable()
166
new_lockable.lock_write(token=token)
167
new_lockable.unlock()
168
self.assertTrue(self.lockable.get_physical_lock_status())
170
def test_lock_write_with_token_fails_when_unlocked(self):
171
# Lock and unlock to get a superficially valid token. This mimics a
172
# likely programming error, where a caller accidentally tries to lock
173
# with a token that is no longer valid (because the original lock was
175
token = self.lockable.lock_write()
176
self.lockable.unlock()
178
# This test does not apply, because this lockable refuses
182
self.assertRaises(errors.TokenMismatch,
183
self.lockable.lock_write, token=token)
185
def test_lock_write_reenter_with_token(self):
186
token = self.lockable.lock_write()
189
# This test does not apply, because this lockable refuses
192
# Relock with a token.
193
token_from_reentry = self.lockable.lock_write(token=token)
195
self.assertEqual(token, token_from_reentry)
197
self.lockable.unlock()
199
self.lockable.unlock()
200
# The lock should be unlocked on disk. Verify that with a new lock
202
new_lockable = self.get_lockable()
203
# Calling lock_write now should work, rather than raise LockContention.
204
new_lockable.lock_write()
205
new_lockable.unlock()
207
def test_second_lock_write_returns_same_token(self):
208
first_token = self.lockable.lock_write()
210
if first_token is None:
211
# This test does not apply, because this lockable refuses
214
# Relock the already locked lockable. It should return the same
216
second_token = self.lockable.lock_write()
218
self.assertEqual(first_token, second_token)
220
self.lockable.unlock()
222
self.lockable.unlock()
224
def test_leave_in_place(self):
225
token = self.lockable.lock_write()
228
# This test does not apply, because this lockable refuses
231
self.lockable.leave_in_place()
233
self.lockable.unlock()
234
# At this point, the lock is still in place on disk
235
self.assertRaises(errors.LockContention, self.lockable.lock_write)
236
# But should be relockable with a token.
237
self.lockable.lock_write(token=token)
238
self.lockable.unlock()
239
# Cleanup: we should still be able to get the lock, but we restore the
240
# behavior to clearing the lock when unlocking.
241
self.lockable.lock_write(token=token)
242
self.lockable.dont_leave_in_place()
243
self.lockable.unlock()
245
def test_dont_leave_in_place(self):
246
token = self.lockable.lock_write()
249
# This test does not apply, because this lockable refuses
252
self.lockable.leave_in_place()
254
self.lockable.unlock()
255
# At this point, the lock is still in place on disk.
256
# Acquire the existing lock with the token, and ask that it is removed
257
# when this object unlocks, and unlock to trigger that removal.
258
new_lockable = self.get_lockable()
259
new_lockable.lock_write(token=token)
260
new_lockable.dont_leave_in_place()
261
new_lockable.unlock()
262
# At this point, the lock is no longer on disk, so we can lock it.
263
third_lockable = self.get_lockable()
264
third_lockable.lock_write()
265
third_lockable.unlock()
268
# This method of adapting tests to parameters is different to
269
# the TestProviderAdapters used elsewhere, but seems simpler for this
102
271
class TestLockableFiles_TransportLock(TestCaseInTempDir,
103
272
_TestLockableFiles_mixin):
106
275
super(TestLockableFiles_TransportLock, self).setUp()
107
transport = get_transport('.')
108
transport.mkdir('.bzr')
109
sub_transport = transport.clone('.bzr')
110
self.lockable = LockableFiles(sub_transport, 'my-lock', TransportLock)
276
t = transport.get_transport_from_path('.')
278
self.sub_transport = t.clone('.bzr')
279
self.lockable = self.get_lockable()
111
280
self.lockable.create_lock()
282
def stop_server(self):
283
super(TestLockableFiles_TransportLock, self).stop_server()
284
# free the subtransport so that we do not get a 5 second
285
# timeout due to the SFTP connection cache.
287
del self.sub_transport
288
except AttributeError:
291
def get_lockable(self):
292
return LockableFiles(self.sub_transport, 'my-lock', TransportLock)
114
295
class TestLockableFiles_LockDir(TestCaseInTempDir,
115
_TestLockableFiles_mixin):
296
_TestLockableFiles_mixin):
116
297
"""LockableFile tests run with LockDir underneath"""
119
300
super(TestLockableFiles_LockDir, self).setUp()
120
self.transport = get_transport('.')
121
self.lockable = LockableFiles(self.transport, 'my-lock', LockDir)
301
self.transport = transport.get_transport_from_path('.')
302
self.lockable = self.get_lockable()
303
# the lock creation here sets mode - test_permissions on branch
304
# tests that implicitly, but it might be a good idea to factor
305
# out the mode checking logic and have it applied to loackable files
306
# directly. RBC 20060418
122
307
self.lockable.create_lock()
124
def test_lock_is_lockdir(self):
125
"""Created instance should use a LockDir.
127
This primarily tests the mixin adapter works properly.
129
## self.assertIsInstance(self.lockable, LockableFiles)
130
## self.assertIsInstance(self.lockable._lock_strategy,
309
def get_lockable(self):
310
return LockableFiles(self.transport, 'my-lock', lockdir.LockDir)
133
312
def test_lock_created(self):
134
313
self.assertTrue(self.transport.has('my-lock'))
138
317
self.assertFalse(self.transport.has('my-lock/held/info'))
139
318
self.assertTrue(self.transport.has('my-lock'))
142
# TODO: Test the lockdir inherits the right file and directory permissions
143
# from the LockableFiles.
320
def test__file_modes(self):
321
self.transport.mkdir('readonly')
322
osutils.make_readonly('readonly')
323
lockable = LockableFiles(self.transport.clone('readonly'), 'test-lock',
325
# The directory mode should be read-write-execute for the current user
326
self.assertEqual(00700, lockable._dir_mode & 00700)
327
# Files should be read-write for the current user
328
self.assertEqual(00600, lockable._file_mode & 00700)
331
class TestLockableFiles_RemoteLockDir(TestCaseWithSmartMedium,
332
_TestLockableFiles_mixin):
333
"""LockableFile tests run with RemoteLockDir on a branch."""
336
super(TestLockableFiles_RemoteLockDir, self).setUp()
337
# can only get a RemoteLockDir with some RemoteObject...
338
# use a branch as thats what we want. These mixin tests test the end
339
# to end behaviour, so stubbing out the backend and simulating would
340
# defeat the purpose. We test the protocol implementation separately
341
# in test_remote and test_smart as usual.
342
b = self.make_branch('foo')
343
self.addCleanup(b.bzrdir.transport.disconnect)
344
self.transport = transport.get_transport_from_path('.')
345
self.lockable = self.get_lockable()
347
def get_lockable(self):
348
# getting a new lockable involves opening a new instance of the branch
349
branch = bzrlib.branch.Branch.open(self.get_url('foo'))
350
self.addCleanup(branch.bzrdir.transport.disconnect)
351
return branch.control_files
added
removed
bzrlib/tests/test_lockable_files.py
