43
34
# 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
35
class _TestLockableFiles_mixin(object):
49
37
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')
38
self.assertRaises(NoSuchFile, self.lockable.get, 'foo')
39
self.assertRaises(NoSuchFile, self.lockable.get_utf8, 'foo')
58
40
self.lockable.lock_write()
60
42
unicode_string = u'bar\u1234'
61
43
self.assertEqual(4, len(unicode_string))
62
44
byte_string = unicode_string.encode('utf-8')
63
45
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,
46
self.assertRaises(UnicodeEncodeError, self.lockable.put, 'foo',
47
StringIO(unicode_string))
48
self.lockable.put('foo', StringIO(byte_string))
49
self.assertEqual(byte_string,
50
self.lockable.get('foo').read())
82
51
self.assertEqual(unicode_string,
83
unicode_stream.read())
52
self.lockable.get_utf8('foo').read())
84
53
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())
54
self.lockable.put_utf8,
56
StringIO(unicode_string)
58
self.lockable.put_utf8('bar', unicode_string)
59
self.assertEqual(unicode_string,
60
self.lockable.get_utf8('bar').read())
61
self.assertEqual(byte_string,
62
self.lockable.get('bar').read())
116
64
self.lockable.unlock()
118
66
def test_locks(self):
119
67
self.lockable.lock_read()
121
self.assertRaises(ReadOnlyError, self.lockable.put, 'foo',
69
self.assertRaises(ReadOnlyError, self.lockable.put, 'foo',
122
70
StringIO('bar\u1234'))
124
72
self.lockable.unlock()
174
122
self.assertRaises(errors.LockBroken, self.lockable.unlock)
175
123
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 seperate 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 seperate 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
126
# This method of adapting tests to parameters is different to
360
127
# the TestProviderAdapters used elsewhere, but seems simpler for this
408
172
self.assertFalse(self.transport.has('my-lock/held/info'))
409
173
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
176
# TODO: Test the lockdir inherits the right file and directory permissions
177
# from the LockableFiles.
added
removed
bzrlib/tests/test_lockable_files.py
