1
# Copyright (C) 2006, 2007 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
"""Tests for LockDir"""
19
from cStringIO import StringIO
21
from threading import Thread, Lock
32
from bzrlib.errors import (
40
from bzrlib.lockdir import LockDir
41
from bzrlib.tests import TestCaseWithTransport
42
from bzrlib.trace import note
44
# These tests sometimes use threads to test the behaviour of lock files with
45
# concurrent actors. This is not a typical (or necessarily supported) use;
46
# they're really meant for guarding between processes.
48
# These tests are run on the default transport provided by the test framework
49
# (typically a local disk transport). That can be changed by the --transport
50
# option to bzr selftest. The required properties of the transport
51
# implementation are tested separately. (The main requirement is just that
52
# they don't allow overwriting nonempty directories.)
54
class TestLockDir(TestCaseWithTransport):
55
"""Test LockDir operations"""
57
def logging_report_function(self, fmt, *args):
58
self._logged_reports.append((fmt, args))
60
def setup_log_reporter(self, lock_dir):
61
self._logged_reports = []
62
lock_dir._report_function = self.logging_report_function
64
def test_00_lock_creation(self):
65
"""Creation of lock file on a transport"""
66
t = self.get_transport()
67
lf = LockDir(t, 'test_lock')
68
self.assertFalse(lf.is_held)
70
def test_01_lock_repr(self):
71
"""Lock string representation"""
72
lf = LockDir(self.get_transport(), 'test_lock')
74
self.assertContainsRe(r, r'^LockDir\(.*/test_lock\)$')
76
def test_02_unlocked_peek(self):
77
lf = LockDir(self.get_transport(), 'test_lock')
78
self.assertEqual(lf.peek(), None)
81
return LockDir(self.get_transport(), 'test_lock')
83
def test_unlock_after_break_raises(self):
88
ld2.force_break(ld2.peek())
89
self.assertRaises(LockBroken, ld.unlock)
91
def test_03_readonly_peek(self):
92
lf = LockDir(self.get_readonly_transport(), 'test_lock')
93
self.assertEqual(lf.peek(), None)
95
def test_10_lock_uncontested(self):
96
"""Acquire and release a lock"""
97
t = self.get_transport()
98
lf = LockDir(t, 'test_lock')
102
self.assertTrue(lf.is_held)
105
self.assertFalse(lf.is_held)
107
def test_11_create_readonly_transport(self):
108
"""Fail to create lock on readonly transport"""
109
t = self.get_readonly_transport()
110
lf = LockDir(t, 'test_lock')
111
self.assertRaises(LockFailed, lf.create)
113
def test_12_lock_readonly_transport(self):
114
"""Fail to lock on readonly transport"""
115
lf = LockDir(self.get_transport(), 'test_lock')
117
lf = LockDir(self.get_readonly_transport(), 'test_lock')
118
self.assertRaises(LockFailed, lf.attempt_lock)
120
def test_20_lock_contested(self):
121
"""Contention to get a lock"""
122
t = self.get_transport()
123
lf1 = LockDir(t, 'test_lock')
126
lf2 = LockDir(t, 'test_lock')
128
# locking is between LockDir instances; aliases within
129
# a single process are not detected
131
self.fail('Failed to detect lock collision')
132
except LockContention, e:
133
self.assertEqual(e.lock, lf2)
134
self.assertContainsRe(str(e),
135
r'^Could not acquire.*test_lock.*$')
138
def test_20_lock_peek(self):
139
"""Peek at the state of a lock"""
140
t = self.get_transport()
141
lf1 = LockDir(t, 'test_lock')
144
# lock is held, should get some info on it
146
self.assertEqual(set(info1.keys()),
147
set(['user', 'nonce', 'hostname', 'pid', 'start_time']))
148
# should get the same info if we look at it through a different
150
info2 = LockDir(t, 'test_lock').peek()
151
self.assertEqual(info1, info2)
152
# locks which are never used should be not-held
153
self.assertEqual(LockDir(t, 'other_lock').peek(), None)
155
def test_21_peek_readonly(self):
156
"""Peek over a readonly transport"""
157
t = self.get_transport()
158
lf1 = LockDir(t, 'test_lock')
160
lf2 = LockDir(self.get_readonly_transport(), 'test_lock')
161
self.assertEqual(lf2.peek(), None)
164
self.assertTrue(info2)
165
self.assertEqual(info2['nonce'], lf1.nonce)
167
def test_30_lock_wait_fail(self):
168
"""Wait on a lock, then fail
170
We ask to wait up to 400ms; this should fail within at most one
171
second. (Longer times are more realistic but we don't want the test
172
suite to take too long, and this should do for now.)
174
t = self.get_transport()
175
lf1 = LockDir(t, 'test_lock')
177
lf2 = LockDir(t, 'test_lock')
178
self.setup_log_reporter(lf2)
182
self.assertRaises(LockContention, lf2.wait_lock,
183
timeout=0.4, poll=0.1)
185
# it should only take about 0.4 seconds, but we allow more time in
186
# case the machine is heavily loaded
187
self.assertTrue(after - before <= 8.0,
188
"took %f seconds to detect lock contention" % (after - before))
191
lock_base = lf2.transport.abspath(lf2.path)
192
self.assertEqual(1, len(self._logged_reports))
193
self.assertEqual('%s %s\n'
195
'Will continue to try until %s\n',
196
self._logged_reports[0][0])
197
args = self._logged_reports[0][1]
198
self.assertEqual('Unable to obtain', args[0])
199
self.assertEqual('lock %s' % (lock_base,), args[1])
200
self.assertStartsWith(args[2], 'held by ')
201
self.assertStartsWith(args[3], 'locked ')
202
self.assertEndsWith(args[3], ' ago')
203
self.assertContainsRe(args[4], r'\d\d:\d\d:\d\d')
205
def test_31_lock_wait_easy(self):
206
"""Succeed when waiting on a lock with no contention.
208
t = self.get_transport()
209
lf1 = LockDir(t, 'test_lock')
211
self.setup_log_reporter(lf1)
214
lf1.wait_lock(timeout=0.4, poll=0.1)
216
self.assertTrue(after - before <= 1.0)
219
self.assertEqual([], self._logged_reports)
221
def test_32_lock_wait_succeed(self):
222
"""Succeed when trying to acquire a lock that gets released
224
One thread holds on a lock and then releases it; another
227
# This test sometimes fails like this:
228
# Traceback (most recent call last):
230
# File "/home/pqm/bzr-pqm-workdir/home/+trunk/bzrlib/tests/
231
# test_lockdir.py", line 247, in test_32_lock_wait_succeed
232
# self.assertEqual(1, len(self._logged_reports))
233
# AssertionError: not equal:
236
raise tests.TestSkipped("Test fails intermittently")
237
t = self.get_transport()
238
lf1 = LockDir(t, 'test_lock')
242
def wait_and_unlock():
245
unlocker = Thread(target=wait_and_unlock)
248
lf2 = LockDir(t, 'test_lock')
249
self.setup_log_reporter(lf2)
252
lf2.wait_lock(timeout=0.4, poll=0.1)
254
self.assertTrue(after - before <= 1.0)
258
# There should be only 1 report, even though it should have to
260
lock_base = lf2.transport.abspath(lf2.path)
261
self.assertEqual(1, len(self._logged_reports))
262
self.assertEqual('%s %s\n'
264
'Will continue to try until %s\n',
265
self._logged_reports[0][0])
266
args = self._logged_reports[0][1]
267
self.assertEqual('Unable to obtain', args[0])
268
self.assertEqual('lock %s' % (lock_base,), args[1])
269
self.assertStartsWith(args[2], 'held by ')
270
self.assertStartsWith(args[3], 'locked ')
271
self.assertEndsWith(args[3], ' ago')
272
self.assertContainsRe(args[4], r'\d\d:\d\d:\d\d')
274
def test_34_lock_write_waits(self):
275
"""LockDir.lock_write() will wait for the lock."""
276
# the test suite sets the default to 0 to make deadlocks fail fast.
277
# change it for this test, as we want to try a manual deadlock.
278
raise tests.TestSkipped('Timing-sensitive test')
279
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 300
280
t = self.get_transport()
281
lf1 = LockDir(t, 'test_lock')
285
def wait_and_unlock():
288
unlocker = Thread(target=wait_and_unlock)
291
lf2 = LockDir(t, 'test_lock')
292
self.setup_log_reporter(lf2)
300
# There should be only 1 report, even though it should have to
302
lock_base = lf2.transport.abspath(lf2.path)
303
self.assertEqual(1, len(self._logged_reports))
304
self.assertEqual('%s %s\n'
306
'Will continue to try until %s\n',
307
self._logged_reports[0][0])
308
args = self._logged_reports[0][1]
309
self.assertEqual('Unable to obtain', args[0])
310
self.assertEqual('lock %s' % (lock_base,), args[1])
311
self.assertStartsWith(args[2], 'held by ')
312
self.assertStartsWith(args[3], 'locked ')
313
self.assertEndsWith(args[3], ' ago')
314
self.assertContainsRe(args[4], r'\d\d:\d\d:\d\d')
316
def test_35_wait_lock_changing(self):
317
"""LockDir.wait_lock() will report if the lock changes underneath.
319
This is the stages we want to happen:
321
0) Synchronization locks are created and locked.
322
1) Lock1 obtains the lockdir, and releases the 'check' lock.
323
2) Lock2 grabs the 'check' lock, and checks the lockdir.
324
It sees the lockdir is already acquired, reports the fact,
325
and unsets the 'checked' lock.
326
3) Thread1 blocks on acquiring the 'checked' lock, and then tells
327
Lock1 to release and acquire the lockdir. This resets the 'check'
329
4) Lock2 acquires the 'check' lock, and checks again. It notices
330
that the holder of the lock has changed, and so reports a new
332
5) Thread1 blocks on the 'checked' lock, this time, it completely
333
unlocks the lockdir, allowing Lock2 to acquire the lock.
336
wait_to_check_lock = Lock()
337
wait_until_checked_lock = Lock()
339
wait_to_check_lock.acquire()
340
wait_until_checked_lock.acquire()
341
note('locked check and checked locks')
343
class LockDir1(LockDir):
344
"""Use the synchronization points for the first lock."""
346
def attempt_lock(self):
347
# Once we have acquired the lock, it is okay for
348
# the other lock to check it
350
return super(LockDir1, self).attempt_lock()
352
note('lock1: releasing check lock')
353
wait_to_check_lock.release()
355
class LockDir2(LockDir):
356
"""Use the synchronization points for the second lock."""
358
def attempt_lock(self):
359
note('lock2: waiting for check lock')
360
wait_to_check_lock.acquire()
361
note('lock2: acquired check lock')
363
return super(LockDir2, self).attempt_lock()
365
note('lock2: releasing checked lock')
366
wait_until_checked_lock.release()
368
t = self.get_transport()
369
lf1 = LockDir1(t, 'test_lock')
372
lf2 = LockDir2(t, 'test_lock')
373
self.setup_log_reporter(lf2)
375
def wait_and_switch():
377
# Block until lock2 has had a chance to check
378
note('lock1: waiting 1 for checked lock')
379
wait_until_checked_lock.acquire()
380
note('lock1: acquired for checked lock')
381
note('lock1: released lockdir')
383
note('lock1: acquiring lockdir')
384
# Create a new nonce, so the lock looks different.
385
lf1.nonce = osutils.rand_chars(20)
387
note('lock1: acquired lockdir')
389
# Block until lock2 has peeked again
390
note('lock1: waiting 2 for checked lock')
391
wait_until_checked_lock.acquire()
392
note('lock1: acquired for checked lock')
393
# Now unlock, and let lock 2 grab the lock
395
wait_to_check_lock.release()
397
unlocker = Thread(target=wait_and_switch)
400
# Wait and play against the other thread
401
lf2.wait_lock(timeout=20.0, poll=0.01)
406
# There should be 2 reports, because the lock changed
407
lock_base = lf2.transport.abspath(lf2.path)
408
self.assertEqual(2, len(self._logged_reports))
410
self.assertEqual('%s %s\n'
412
'Will continue to try until %s\n',
413
self._logged_reports[0][0])
414
args = self._logged_reports[0][1]
415
self.assertEqual('Unable to obtain', args[0])
416
self.assertEqual('lock %s' % (lock_base,), args[1])
417
self.assertStartsWith(args[2], 'held by ')
418
self.assertStartsWith(args[3], 'locked ')
419
self.assertEndsWith(args[3], ' ago')
420
self.assertContainsRe(args[4], r'\d\d:\d\d:\d\d')
422
self.assertEqual('%s %s\n'
424
'Will continue to try until %s\n',
425
self._logged_reports[1][0])
426
args = self._logged_reports[1][1]
427
self.assertEqual('Lock owner changed for', args[0])
428
self.assertEqual('lock %s' % (lock_base,), args[1])
429
self.assertStartsWith(args[2], 'held by ')
430
self.assertStartsWith(args[3], 'locked ')
431
self.assertEndsWith(args[3], ' ago')
432
self.assertContainsRe(args[4], r'\d\d:\d\d:\d\d')
434
def test_40_confirm_easy(self):
435
"""Confirm a lock that's already held"""
436
t = self.get_transport()
437
lf1 = LockDir(t, 'test_lock')
442
def test_41_confirm_not_held(self):
443
"""Confirm a lock that's already held"""
444
t = self.get_transport()
445
lf1 = LockDir(t, 'test_lock')
447
self.assertRaises(LockNotHeld, lf1.confirm)
449
def test_42_confirm_broken_manually(self):
450
"""Confirm a lock broken by hand"""
451
t = self.get_transport()
452
lf1 = LockDir(t, 'test_lock')
455
t.move('test_lock', 'lock_gone_now')
456
self.assertRaises(LockBroken, lf1.confirm)
458
def test_43_break(self):
459
"""Break a lock whose caller has forgotten it"""
460
t = self.get_transport()
461
lf1 = LockDir(t, 'test_lock')
464
# we incorrectly discard the lock object without unlocking it
466
# someone else sees it's still locked
467
lf2 = LockDir(t, 'test_lock')
468
holder_info = lf2.peek()
469
self.assertTrue(holder_info)
470
lf2.force_break(holder_info)
471
# now we should be able to take it
475
def test_44_break_already_released(self):
476
"""Lock break races with regular release"""
477
t = self.get_transport()
478
lf1 = LockDir(t, 'test_lock')
481
# someone else sees it's still locked
482
lf2 = LockDir(t, 'test_lock')
483
holder_info = lf2.peek()
484
# in the interim the lock is released
486
# break should succeed
487
lf2.force_break(holder_info)
488
# now we should be able to take it
492
def test_45_break_mismatch(self):
493
"""Lock break races with someone else acquiring it"""
494
t = self.get_transport()
495
lf1 = LockDir(t, 'test_lock')
498
# someone else sees it's still locked
499
lf2 = LockDir(t, 'test_lock')
500
holder_info = lf2.peek()
501
# in the interim the lock is released
503
lf3 = LockDir(t, 'test_lock')
505
# break should now *fail*
506
self.assertRaises(LockBreakMismatch, lf2.force_break,
510
def test_46_fake_read_lock(self):
511
t = self.get_transport()
512
lf1 = LockDir(t, 'test_lock')
517
def test_50_lockdir_representation(self):
518
"""Check the on-disk representation of LockDirs is as expected.
520
There should always be a top-level directory named by the lock.
521
When the lock is held, there should be a lockname/held directory
522
containing an info file.
524
t = self.get_transport()
525
lf1 = LockDir(t, 'test_lock')
527
self.assertTrue(t.has('test_lock'))
529
self.assertTrue(t.has('test_lock/held/info'))
531
self.assertFalse(t.has('test_lock/held/info'))
533
def test_break_lock(self):
534
# the ui based break_lock routine should Just Work (tm)
535
ld1 = self.get_lock()
536
ld2 = self.get_lock()
539
# do this without IO redirection to ensure it doesn't prompt.
540
self.assertRaises(AssertionError, ld1.break_lock)
541
orig_factory = bzrlib.ui.ui_factory
542
# silent ui - no need for stdout
543
bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
544
bzrlib.ui.ui_factory.stdin = StringIO("y\n")
547
self.assertRaises(LockBroken, ld1.unlock)
549
bzrlib.ui.ui_factory = orig_factory
551
def test_create_missing_base_directory(self):
552
"""If LockDir.path doesn't exist, it can be created
554
Some people manually remove the entire lock/ directory trying
555
to unlock a stuck repository/branch/etc. Rather than failing
556
after that, just create the lock directory when needed.
558
t = self.get_transport()
559
lf1 = LockDir(t, 'test_lock')
562
self.failUnless(t.has('test_lock'))
565
self.failIf(t.has('test_lock'))
567
# This will create 'test_lock' if it needs to
569
self.failUnless(t.has('test_lock'))
570
self.failUnless(t.has('test_lock/held/info'))
573
self.failIf(t.has('test_lock/held/info'))
575
def test__format_lock_info(self):
576
ld1 = self.get_lock()
580
info_list = ld1._format_lock_info(ld1.peek())
583
self.assertEqual('lock %s' % (ld1.transport.abspath(ld1.path),),
585
self.assertContainsRe(info_list[1],
586
r'^held by .* on host .* \[process #\d*\]$')
587
self.assertContainsRe(info_list[2], r'locked \d+ seconds? ago$')
589
def test_lock_without_email(self):
590
global_config = config.GlobalConfig()
591
# Intentionally has no email address
592
global_config.set_user_option('email', 'User Identity')
593
ld1 = self.get_lock()
598
def test_lock_permission(self):
599
if not osutils.supports_posix_readonly():
600
raise tests.TestSkipped('Cannot induce a permission failure')
601
ld1 = self.get_lock()
602
lock_path = ld1.transport.local_abspath('test_lock')
604
osutils.make_readonly(lock_path)
605
self.assertRaises(errors.LockFailed, ld1.attempt_lock)
607
def test_lock_by_token(self):
608
ld1 = self.get_lock()
609
token = ld1.lock_write()
610
self.assertNotEqual(None, token)
611
ld2 = self.get_lock()
612
t2 = ld2.lock_write(token)
613
self.assertEqual(token, t2)
615
def test_lock_with_buggy_rename(self):
616
# test that lock acquisition handles servers which pretend they
617
# renamed correctly but that actually fail
618
t = transport.get_transport('brokenrename+' + self.get_url())
619
ld1 = LockDir(t, 'test_lock')
622
ld2 = LockDir(t, 'test_lock')
623
# we should fail to lock
624
e = self.assertRaises(errors.LockContention, ld2.attempt_lock)
625
# now the original caller should succeed in unlocking
627
# and there should be nothing left over
628
self.assertEquals([], t.list_dir('test_lock'))
630
def test_failed_lock_leaves_no_trash(self):
631
# if we fail to acquire the lock, we don't leave pending directories
632
# behind -- https://bugs.launchpad.net/bzr/+bug/109169
633
ld1 = self.get_lock()
634
ld2 = self.get_lock()
635
# should be nothing before we start
637
t = self.get_transport().clone('test_lock')
639
self.assertEquals(a, t.list_dir('.'))
641
# when held, that's all we see
644
# second guy should fail
645
self.assertRaises(errors.LockContention, ld2.attempt_lock)
added
removed
bzrlib/tests/test_lockdir.py
