1
# Copyright (C) 2006, 2007, 2008 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""Tests for LockDir"""
19
from cStringIO import StringIO
21
from threading import Thread, Lock
33
from bzrlib.errors import (
41
from bzrlib.lockdir import LockDir
42
from bzrlib.tests import TestCaseWithTransport
43
from bzrlib.trace import note
45
# These tests sometimes use threads to test the behaviour of lock files with
46
# concurrent actors. This is not a typical (or necessarily supported) use;
47
# they're really meant for guarding between processes.
49
# These tests are run on the default transport provided by the test framework
50
# (typically a local disk transport). That can be changed by the --transport
51
# option to bzr selftest. The required properties of the transport
52
# implementation are tested separately. (The main requirement is just that
53
# they don't allow overwriting nonempty directories.)
55
class TestLockDir(TestCaseWithTransport):
56
"""Test LockDir operations"""
58
def logging_report_function(self, fmt, *args):
59
self._logged_reports.append((fmt, args))
61
def setup_log_reporter(self, lock_dir):
62
self._logged_reports = []
63
lock_dir._report_function = self.logging_report_function
65
def test_00_lock_creation(self):
66
"""Creation of lock file on a transport"""
67
t = self.get_transport()
68
lf = LockDir(t, 'test_lock')
69
self.assertFalse(lf.is_held)
71
def test_01_lock_repr(self):
72
"""Lock string representation"""
73
lf = LockDir(self.get_transport(), 'test_lock')
75
self.assertContainsRe(r, r'^LockDir\(.*/test_lock\)$')
77
def test_02_unlocked_peek(self):
78
lf = LockDir(self.get_transport(), 'test_lock')
79
self.assertEqual(lf.peek(), None)
82
return LockDir(self.get_transport(), 'test_lock')
84
def test_unlock_after_break_raises(self):
89
ld2.force_break(ld2.peek())
90
self.assertRaises(LockBroken, ld.unlock)
92
def test_03_readonly_peek(self):
93
lf = LockDir(self.get_readonly_transport(), 'test_lock')
94
self.assertEqual(lf.peek(), None)
96
def test_10_lock_uncontested(self):
97
"""Acquire and release a lock"""
98
t = self.get_transport()
99
lf = LockDir(t, 'test_lock')
103
self.assertTrue(lf.is_held)
106
self.assertFalse(lf.is_held)
108
def test_11_create_readonly_transport(self):
109
"""Fail to create lock on readonly transport"""
110
t = self.get_readonly_transport()
111
lf = LockDir(t, 'test_lock')
112
self.assertRaises(LockFailed, lf.create)
114
def test_12_lock_readonly_transport(self):
115
"""Fail to lock on readonly transport"""
116
lf = LockDir(self.get_transport(), 'test_lock')
118
lf = LockDir(self.get_readonly_transport(), 'test_lock')
119
self.assertRaises(LockFailed, lf.attempt_lock)
121
def test_20_lock_contested(self):
122
"""Contention to get a lock"""
123
t = self.get_transport()
124
lf1 = LockDir(t, 'test_lock')
127
lf2 = LockDir(t, 'test_lock')
129
# locking is between LockDir instances; aliases within
130
# a single process are not detected
132
self.fail('Failed to detect lock collision')
133
except LockContention, e:
134
self.assertEqual(e.lock, lf2)
135
self.assertContainsRe(str(e),
136
r'^Could not acquire.*test_lock.*$')
139
def test_20_lock_peek(self):
140
"""Peek at the state of a lock"""
141
t = self.get_transport()
142
lf1 = LockDir(t, 'test_lock')
145
# lock is held, should get some info on it
147
self.assertEqual(set(info1.keys()),
148
set(['user', 'nonce', 'hostname', 'pid', 'start_time']))
149
# should get the same info if we look at it through a different
151
info2 = LockDir(t, 'test_lock').peek()
152
self.assertEqual(info1, info2)
153
# locks which are never used should be not-held
154
self.assertEqual(LockDir(t, 'other_lock').peek(), None)
156
def test_21_peek_readonly(self):
157
"""Peek over a readonly transport"""
158
t = self.get_transport()
159
lf1 = LockDir(t, 'test_lock')
161
lf2 = LockDir(self.get_readonly_transport(), 'test_lock')
162
self.assertEqual(lf2.peek(), None)
165
self.assertTrue(info2)
166
self.assertEqual(info2['nonce'], lf1.nonce)
168
def test_30_lock_wait_fail(self):
169
"""Wait on a lock, then fail
171
We ask to wait up to 400ms; this should fail within at most one
172
second. (Longer times are more realistic but we don't want the test
173
suite to take too long, and this should do for now.)
175
t = self.get_transport()
176
lf1 = LockDir(t, 'test_lock')
178
lf2 = LockDir(t, 'test_lock')
179
self.setup_log_reporter(lf2)
183
self.assertRaises(LockContention, lf2.wait_lock,
184
timeout=0.4, poll=0.1)
186
# it should only take about 0.4 seconds, but we allow more time in
187
# case the machine is heavily loaded
188
self.assertTrue(after - before <= 8.0,
189
"took %f seconds to detect lock contention" % (after - before))
192
lock_base = lf2.transport.abspath(lf2.path)
193
self.assertEqual(1, len(self._logged_reports))
194
lock_url = lf2.transport.abspath(lf2.path)
195
self.assertEqual('%s %s\n'
197
'Will continue to try until %s, unless '
199
'If you\'re sure that it\'s not being '
200
'modified, use bzr break-lock %s',
201
self._logged_reports[0][0])
202
args = self._logged_reports[0][1]
203
self.assertEqual('Unable to obtain', args[0])
204
self.assertEqual('lock %s' % (lock_base,), args[1])
205
self.assertStartsWith(args[2], 'held by ')
206
self.assertStartsWith(args[3], 'locked ')
207
self.assertEndsWith(args[3], ' ago')
208
self.assertContainsRe(args[4], r'\d\d:\d\d:\d\d')
210
def test_31_lock_wait_easy(self):
211
"""Succeed when waiting on a lock with no contention.
213
t = self.get_transport()
214
lf1 = LockDir(t, 'test_lock')
216
self.setup_log_reporter(lf1)
219
lf1.wait_lock(timeout=0.4, poll=0.1)
221
self.assertTrue(after - before <= 1.0)
224
self.assertEqual([], self._logged_reports)
226
def test_32_lock_wait_succeed(self):
227
"""Succeed when trying to acquire a lock that gets released
229
One thread holds on a lock and then releases it; another
232
# This test sometimes fails like this:
233
# Traceback (most recent call last):
235
# File "/home/pqm/bzr-pqm-workdir/home/+trunk/bzrlib/tests/
236
# test_lockdir.py", line 247, in test_32_lock_wait_succeed
237
# self.assertEqual(1, len(self._logged_reports))
238
# AssertionError: not equal:
241
raise tests.TestSkipped("Test fails intermittently")
242
t = self.get_transport()
243
lf1 = LockDir(t, 'test_lock')
247
def wait_and_unlock():
250
unlocker = Thread(target=wait_and_unlock)
253
lf2 = LockDir(t, 'test_lock')
254
self.setup_log_reporter(lf2)
257
lf2.wait_lock(timeout=0.4, poll=0.1)
259
self.assertTrue(after - before <= 1.0)
263
# There should be only 1 report, even though it should have to
265
lock_base = lf2.transport.abspath(lf2.path)
266
self.assertEqual(1, len(self._logged_reports))
267
self.assertEqual('%s %s\n'
269
'Will continue to try until %s\n',
270
self._logged_reports[0][0])
271
args = self._logged_reports[0][1]
272
self.assertEqual('Unable to obtain', args[0])
273
self.assertEqual('lock %s' % (lock_base,), args[1])
274
self.assertStartsWith(args[2], 'held by ')
275
self.assertStartsWith(args[3], 'locked ')
276
self.assertEndsWith(args[3], ' ago')
277
self.assertContainsRe(args[4], r'\d\d:\d\d:\d\d')
279
def test_34_lock_write_waits(self):
280
"""LockDir.lock_write() will wait for the lock."""
281
# the test suite sets the default to 0 to make deadlocks fail fast.
282
# change it for this test, as we want to try a manual deadlock.
283
raise tests.TestSkipped('Timing-sensitive test')
284
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 300
285
t = self.get_transport()
286
lf1 = LockDir(t, 'test_lock')
290
def wait_and_unlock():
293
unlocker = Thread(target=wait_and_unlock)
296
lf2 = LockDir(t, 'test_lock')
297
self.setup_log_reporter(lf2)
305
# There should be only 1 report, even though it should have to
307
lock_base = lf2.transport.abspath(lf2.path)
308
self.assertEqual(1, len(self._logged_reports))
309
self.assertEqual('%s %s\n'
311
'Will continue to try until %s\n',
312
self._logged_reports[0][0])
313
args = self._logged_reports[0][1]
314
self.assertEqual('Unable to obtain', args[0])
315
self.assertEqual('lock %s' % (lock_base,), args[1])
316
self.assertStartsWith(args[2], 'held by ')
317
self.assertStartsWith(args[3], 'locked ')
318
self.assertEndsWith(args[3], ' ago')
319
self.assertContainsRe(args[4], r'\d\d:\d\d:\d\d')
321
def test_35_wait_lock_changing(self):
322
"""LockDir.wait_lock() will report if the lock changes underneath.
324
This is the stages we want to happen:
326
0) Synchronization locks are created and locked.
327
1) Lock1 obtains the lockdir, and releases the 'check' lock.
328
2) Lock2 grabs the 'check' lock, and checks the lockdir.
329
It sees the lockdir is already acquired, reports the fact,
330
and unsets the 'checked' lock.
331
3) Thread1 blocks on acquiring the 'checked' lock, and then tells
332
Lock1 to release and acquire the lockdir. This resets the 'check'
334
4) Lock2 acquires the 'check' lock, and checks again. It notices
335
that the holder of the lock has changed, and so reports a new
337
5) Thread1 blocks on the 'checked' lock, this time, it completely
338
unlocks the lockdir, allowing Lock2 to acquire the lock.
341
raise tests.KnownFailure(
342
"timing dependency in lock tests (#213182)")
344
wait_to_check_lock = Lock()
345
wait_until_checked_lock = Lock()
347
wait_to_check_lock.acquire()
348
wait_until_checked_lock.acquire()
349
note('locked check and checked locks')
351
class LockDir1(LockDir):
352
"""Use the synchronization points for the first lock."""
354
def attempt_lock(self):
355
# Once we have acquired the lock, it is okay for
356
# the other lock to check it
358
return super(LockDir1, self).attempt_lock()
360
note('lock1: releasing check lock')
361
wait_to_check_lock.release()
363
class LockDir2(LockDir):
364
"""Use the synchronization points for the second lock."""
366
def attempt_lock(self):
367
note('lock2: waiting for check lock')
368
wait_to_check_lock.acquire()
369
note('lock2: acquired check lock')
371
return super(LockDir2, self).attempt_lock()
373
note('lock2: releasing checked lock')
374
wait_until_checked_lock.release()
376
t = self.get_transport()
377
lf1 = LockDir1(t, 'test_lock')
380
lf2 = LockDir2(t, 'test_lock')
381
self.setup_log_reporter(lf2)
383
def wait_and_switch():
385
# Block until lock2 has had a chance to check
386
note('lock1: waiting 1 for checked lock')
387
wait_until_checked_lock.acquire()
388
note('lock1: acquired for checked lock')
389
note('lock1: released lockdir')
391
note('lock1: acquiring lockdir')
392
# Create a new nonce, so the lock looks different.
393
lf1.nonce = osutils.rand_chars(20)
395
note('lock1: acquired lockdir')
397
# Block until lock2 has peeked again
398
note('lock1: waiting 2 for checked lock')
399
wait_until_checked_lock.acquire()
400
note('lock1: acquired for checked lock')
401
# Now unlock, and let lock 2 grab the lock
403
wait_to_check_lock.release()
405
unlocker = Thread(target=wait_and_switch)
408
# Wait and play against the other thread
409
lf2.wait_lock(timeout=20.0, poll=0.01)
414
# There should be 2 reports, because the lock changed
415
lock_base = lf2.transport.abspath(lf2.path)
416
self.assertEqual(2, len(self._logged_reports))
417
lock_url = lf2.transport.abspath(lf2.path)
418
self.assertEqual('%s %s\n'
420
'Will continue to try until %s, unless '
422
'If you\'re sure that it\'s not being '
423
'modified, use bzr break-lock %s',
424
self._logged_reports[0][0])
425
args = self._logged_reports[0][1]
426
self.assertEqual('Unable to obtain', args[0])
427
self.assertEqual('lock %s' % (lock_base,), args[1])
428
self.assertStartsWith(args[2], 'held by ')
429
self.assertStartsWith(args[3], 'locked ')
430
self.assertEndsWith(args[3], ' ago')
431
self.assertContainsRe(args[4], r'\d\d:\d\d:\d\d')
433
self.assertEqual('%s %s\n'
435
'Will continue to try until %s, unless '
437
'If you\'re sure that it\'s not being '
438
'modified, use bzr break-lock %s',
439
self._logged_reports[1][0])
440
args = self._logged_reports[1][1]
441
self.assertEqual('Lock owner changed for', args[0])
442
self.assertEqual('lock %s' % (lock_base,), args[1])
443
self.assertStartsWith(args[2], 'held by ')
444
self.assertStartsWith(args[3], 'locked ')
445
self.assertEndsWith(args[3], ' ago')
446
self.assertContainsRe(args[4], r'\d\d:\d\d:\d\d')
448
def test_40_confirm_easy(self):
449
"""Confirm a lock that's already held"""
450
t = self.get_transport()
451
lf1 = LockDir(t, 'test_lock')
456
def test_41_confirm_not_held(self):
457
"""Confirm a lock that's already held"""
458
t = self.get_transport()
459
lf1 = LockDir(t, 'test_lock')
461
self.assertRaises(LockNotHeld, lf1.confirm)
463
def test_42_confirm_broken_manually(self):
464
"""Confirm a lock broken by hand"""
465
t = self.get_transport()
466
lf1 = LockDir(t, 'test_lock')
469
t.move('test_lock', 'lock_gone_now')
470
self.assertRaises(LockBroken, lf1.confirm)
472
def test_43_break(self):
473
"""Break a lock whose caller has forgotten it"""
474
t = self.get_transport()
475
lf1 = LockDir(t, 'test_lock')
478
# we incorrectly discard the lock object without unlocking it
480
# someone else sees it's still locked
481
lf2 = LockDir(t, 'test_lock')
482
holder_info = lf2.peek()
483
self.assertTrue(holder_info)
484
lf2.force_break(holder_info)
485
# now we should be able to take it
489
def test_44_break_already_released(self):
490
"""Lock break races with regular release"""
491
t = self.get_transport()
492
lf1 = LockDir(t, 'test_lock')
495
# someone else sees it's still locked
496
lf2 = LockDir(t, 'test_lock')
497
holder_info = lf2.peek()
498
# in the interim the lock is released
500
# break should succeed
501
lf2.force_break(holder_info)
502
# now we should be able to take it
506
def test_45_break_mismatch(self):
507
"""Lock break races with someone else acquiring it"""
508
t = self.get_transport()
509
lf1 = LockDir(t, 'test_lock')
512
# someone else sees it's still locked
513
lf2 = LockDir(t, 'test_lock')
514
holder_info = lf2.peek()
515
# in the interim the lock is released
517
lf3 = LockDir(t, 'test_lock')
519
# break should now *fail*
520
self.assertRaises(LockBreakMismatch, lf2.force_break,
524
def test_46_fake_read_lock(self):
525
t = self.get_transport()
526
lf1 = LockDir(t, 'test_lock')
531
def test_50_lockdir_representation(self):
532
"""Check the on-disk representation of LockDirs is as expected.
534
There should always be a top-level directory named by the lock.
535
When the lock is held, there should be a lockname/held directory
536
containing an info file.
538
t = self.get_transport()
539
lf1 = LockDir(t, 'test_lock')
541
self.assertTrue(t.has('test_lock'))
543
self.assertTrue(t.has('test_lock/held/info'))
545
self.assertFalse(t.has('test_lock/held/info'))
547
def test_break_lock(self):
548
# the ui based break_lock routine should Just Work (tm)
549
ld1 = self.get_lock()
550
ld2 = self.get_lock()
553
# do this without IO redirection to ensure it doesn't prompt.
554
self.assertRaises(AssertionError, ld1.break_lock)
555
orig_factory = bzrlib.ui.ui_factory
556
# silent ui - no need for stdout
557
bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
558
bzrlib.ui.ui_factory.stdin = StringIO("y\n")
561
self.assertRaises(LockBroken, ld1.unlock)
563
bzrlib.ui.ui_factory = orig_factory
565
def test_create_missing_base_directory(self):
566
"""If LockDir.path doesn't exist, it can be created
568
Some people manually remove the entire lock/ directory trying
569
to unlock a stuck repository/branch/etc. Rather than failing
570
after that, just create the lock directory when needed.
572
t = self.get_transport()
573
lf1 = LockDir(t, 'test_lock')
576
self.failUnless(t.has('test_lock'))
579
self.failIf(t.has('test_lock'))
581
# This will create 'test_lock' if it needs to
583
self.failUnless(t.has('test_lock'))
584
self.failUnless(t.has('test_lock/held/info'))
587
self.failIf(t.has('test_lock/held/info'))
589
def test__format_lock_info(self):
590
ld1 = self.get_lock()
594
info_list = ld1._format_lock_info(ld1.peek())
597
self.assertEqual('lock %s' % (ld1.transport.abspath(ld1.path),),
599
self.assertContainsRe(info_list[1],
600
r'^held by .* on host .* \[process #\d*\]$')
601
self.assertContainsRe(info_list[2], r'locked \d+ seconds? ago$')
603
def test_lock_without_email(self):
604
global_config = config.GlobalConfig()
605
# Intentionally has no email address
606
global_config.set_user_option('email', 'User Identity')
607
ld1 = self.get_lock()
612
def test_lock_permission(self):
613
if not osutils.supports_posix_readonly():
614
raise tests.TestSkipped('Cannot induce a permission failure')
615
ld1 = self.get_lock()
616
lock_path = ld1.transport.local_abspath('test_lock')
618
osutils.make_readonly(lock_path)
619
self.assertRaises(errors.LockFailed, ld1.attempt_lock)
621
def test_lock_by_token(self):
622
ld1 = self.get_lock()
623
token = ld1.lock_write()
624
self.assertNotEqual(None, token)
625
ld2 = self.get_lock()
626
t2 = ld2.lock_write(token)
627
self.assertEqual(token, t2)
629
def test_lock_with_buggy_rename(self):
630
# test that lock acquisition handles servers which pretend they
631
# renamed correctly but that actually fail
632
t = transport.get_transport('brokenrename+' + self.get_url())
633
ld1 = LockDir(t, 'test_lock')
636
ld2 = LockDir(t, 'test_lock')
637
# we should fail to lock
638
e = self.assertRaises(errors.LockContention, ld2.attempt_lock)
639
# now the original caller should succeed in unlocking
641
# and there should be nothing left over
642
self.assertEquals([], t.list_dir('test_lock'))
644
def test_failed_lock_leaves_no_trash(self):
645
# if we fail to acquire the lock, we don't leave pending directories
646
# behind -- https://bugs.launchpad.net/bzr/+bug/109169
647
ld1 = self.get_lock()
648
ld2 = self.get_lock()
649
# should be nothing before we start
651
t = self.get_transport().clone('test_lock')
653
self.assertEquals(a, t.list_dir('.'))
655
# when held, that's all we see
658
# second guy should fail
659
self.assertRaises(errors.LockContention, ld2.attempt_lock)
663
def record_hook(self, result):
664
self._calls.append(result)
666
def reset_hooks(self):
667
self._old_hooks = lock.Lock.hooks
668
self.addCleanup(self.restore_hooks)
669
lock.Lock.hooks = lock.LockHooks()
671
def restore_hooks(self):
672
lock.Lock.hooks = self._old_hooks
674
def test_LockDir_acquired_success(self):
675
# the LockDir.lock_acquired hook fires when a lock is acquired.
678
LockDir.hooks.install_named_hook('lock_acquired',
679
self.record_hook, 'record_hook')
682
self.assertEqual([], self._calls)
683
result = ld.attempt_lock()
684
lock_path = ld.transport.abspath(ld.path)
685
self.assertEqual([lock.LockResult(lock_path, result)], self._calls)
687
self.assertEqual([lock.LockResult(lock_path, result)], self._calls)
689
def test_LockDir_acquired_fail(self):
690
# the LockDir.lock_acquired hook does not fire on failure.
695
ld2 = self.get_lock()
697
# install a lock hook now, when the disk lock is locked
698
LockDir.hooks.install_named_hook('lock_acquired',
699
self.record_hook, 'record_hook')
700
self.assertRaises(errors.LockContention, ld.attempt_lock)
701
self.assertEqual([], self._calls)
703
self.assertEqual([], self._calls)
705
def test_LockDir_released_success(self):
706
# the LockDir.lock_released hook fires when a lock is acquired.
709
LockDir.hooks.install_named_hook('lock_released',
710
self.record_hook, 'record_hook')
713
self.assertEqual([], self._calls)
714
result = ld.attempt_lock()
715
self.assertEqual([], self._calls)
717
lock_path = ld.transport.abspath(ld.path)
718
self.assertEqual([lock.LockResult(lock_path, result)], self._calls)
720
def test_LockDir_released_fail(self):
721
# the LockDir.lock_released hook does not fire on failure.
726
ld2 = self.get_lock()
728
ld2.force_break(ld2.peek())
729
LockDir.hooks.install_named_hook('lock_released',
730
self.record_hook, 'record_hook')
731
self.assertRaises(LockBroken, ld.unlock)
732
self.assertEqual([], self._calls)
added
removed
bzrlib/tests/test_lockdir.py
