1
# Copyright (C) 2006, 2007, 2008, 2010 Canonical Ltd
1
# Copyright (C) 2006 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
17
"""Tests for LockDir"""
19
19
from cStringIO import StringIO
21
from threading import Thread, Lock
20
from threading import Thread
33
24
from bzrlib.errors import (
26
LockContention, LockError, UnlockableTransport,
27
LockNotHeld, LockBroken
41
29
from bzrlib.lockdir import LockDir
42
30
from bzrlib.tests import TestCaseWithTransport
43
from bzrlib.trace import note
45
32
# These tests sometimes use threads to test the behaviour of lock files with
46
33
# concurrent actors. This is not a typical (or necessarily supported) use;
187
164
after = time.time()
188
165
# it should only take about 0.4 seconds, but we allow more time in
189
166
# case the machine is heavily loaded
190
self.assertTrue(after - before <= 8.0,
167
self.assertTrue(after - before <= 8.0,
191
168
"took %f seconds to detect lock contention" % (after - before))
194
lock_base = lf2.transport.abspath(lf2.path)
195
self.assertEqual(1, len(self._logged_reports))
196
lock_url = lf2.transport.abspath(lf2.path)
197
self.assertEqual('%s %s\n'
199
'Will continue to try until %s, unless '
200
'you press Ctrl-C.\n'
201
'See "bzr help break-lock" for more.',
202
self._logged_reports[0][0])
203
args = self._logged_reports[0][1]
204
self.assertEqual('Unable to obtain', args[0])
205
self.assertEqual('lock %s' % (lock_base,), args[1])
206
self.assertStartsWith(args[2], 'held by ')
207
self.assertStartsWith(args[3], 'locked ')
208
self.assertEndsWith(args[3], ' ago')
209
self.assertContainsRe(args[4], r'\d\d:\d\d:\d\d')
211
172
def test_31_lock_wait_easy(self):
212
173
"""Succeed when waiting on a lock with no contention.
264
# There should be only 1 report, even though it should have to
266
lock_base = lf2.transport.abspath(lf2.path)
267
self.assertEqual(1, len(self._logged_reports))
268
self.assertEqual('%s %s\n'
270
'Will continue to try until %s\n',
271
self._logged_reports[0][0])
272
args = self._logged_reports[0][1]
273
self.assertEqual('Unable to obtain', args[0])
274
self.assertEqual('lock %s' % (lock_base,), args[1])
275
self.assertStartsWith(args[2], 'held by ')
276
self.assertStartsWith(args[3], 'locked ')
277
self.assertEndsWith(args[3], ' ago')
278
self.assertContainsRe(args[4], r'\d\d:\d\d:\d\d')
212
def test_33_wait(self):
213
"""Succeed when waiting on a lock that gets released
280
def test_34_lock_write_waits(self):
281
"""LockDir.lock_write() will wait for the lock."""
282
# the test suite sets the default to 0 to make deadlocks fail fast.
283
# change it for this test, as we want to try a manual deadlock.
284
raise tests.TestSkipped('Timing-sensitive test')
285
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 300
215
The difference from test_32_lock_wait_succeed is that the second
216
caller does not actually acquire the lock, but just waits for it
217
to be released. This is done over a readonly transport.
286
219
t = self.get_transport()
287
220
lf1 = LockDir(t, 'test_lock')
294
227
unlocker = Thread(target=wait_and_unlock)
297
lf2 = LockDir(t, 'test_lock')
298
self.setup_log_reporter(lf2)
230
lf2 = LockDir(self.get_readonly_transport(), 'test_lock')
299
231
before = time.time()
232
# wait but don't lock
233
lf2.wait(timeout=0.4, poll=0.1)
302
234
after = time.time()
306
# There should be only 1 report, even though it should have to
308
lock_base = lf2.transport.abspath(lf2.path)
309
self.assertEqual(1, len(self._logged_reports))
310
self.assertEqual('%s %s\n'
312
'Will continue to try until %s\n',
313
self._logged_reports[0][0])
314
args = self._logged_reports[0][1]
315
self.assertEqual('Unable to obtain', args[0])
316
self.assertEqual('lock %s' % (lock_base,), args[1])
317
self.assertStartsWith(args[2], 'held by ')
318
self.assertStartsWith(args[3], 'locked ')
319
self.assertEndsWith(args[3], ' ago')
320
self.assertContainsRe(args[4], r'\d\d:\d\d:\d\d')
322
def test_35_wait_lock_changing(self):
323
"""LockDir.wait_lock() will report if the lock changes underneath.
325
This is the stages we want to happen:
327
0) Synchronization locks are created and locked.
328
1) Lock1 obtains the lockdir, and releases the 'check' lock.
329
2) Lock2 grabs the 'check' lock, and checks the lockdir.
330
It sees the lockdir is already acquired, reports the fact,
331
and unsets the 'checked' lock.
332
3) Thread1 blocks on acquiring the 'checked' lock, and then tells
333
Lock1 to release and acquire the lockdir. This resets the 'check'
335
4) Lock2 acquires the 'check' lock, and checks again. It notices
336
that the holder of the lock has changed, and so reports a new
338
5) Thread1 blocks on the 'checked' lock, this time, it completely
339
unlocks the lockdir, allowing Lock2 to acquire the lock.
342
raise tests.KnownFailure(
343
"timing dependency in lock tests (#213182)")
345
wait_to_check_lock = Lock()
346
wait_until_checked_lock = Lock()
348
wait_to_check_lock.acquire()
349
wait_until_checked_lock.acquire()
350
note('locked check and checked locks')
352
class LockDir1(LockDir):
353
"""Use the synchronization points for the first lock."""
355
def attempt_lock(self):
356
# Once we have acquired the lock, it is okay for
357
# the other lock to check it
359
return super(LockDir1, self).attempt_lock()
361
note('lock1: releasing check lock')
362
wait_to_check_lock.release()
364
class LockDir2(LockDir):
365
"""Use the synchronization points for the second lock."""
367
def attempt_lock(self):
368
note('lock2: waiting for check lock')
369
wait_to_check_lock.acquire()
370
note('lock2: acquired check lock')
372
return super(LockDir2, self).attempt_lock()
374
note('lock2: releasing checked lock')
375
wait_until_checked_lock.release()
377
t = self.get_transport()
378
lf1 = LockDir1(t, 'test_lock')
381
lf2 = LockDir2(t, 'test_lock')
382
self.setup_log_reporter(lf2)
384
def wait_and_switch():
386
# Block until lock2 has had a chance to check
387
note('lock1: waiting 1 for checked lock')
388
wait_until_checked_lock.acquire()
389
note('lock1: acquired for checked lock')
390
note('lock1: released lockdir')
392
note('lock1: acquiring lockdir')
393
# Create a new nonce, so the lock looks different.
394
lf1.nonce = osutils.rand_chars(20)
396
note('lock1: acquired lockdir')
398
# Block until lock2 has peeked again
399
note('lock1: waiting 2 for checked lock')
400
wait_until_checked_lock.acquire()
401
note('lock1: acquired for checked lock')
402
# Now unlock, and let lock 2 grab the lock
404
wait_to_check_lock.release()
406
unlocker = Thread(target=wait_and_switch)
409
# Wait and play against the other thread
410
lf2.wait_lock(timeout=20.0, poll=0.01)
415
# There should be 2 reports, because the lock changed
416
lock_base = lf2.transport.abspath(lf2.path)
417
self.assertEqual(2, len(self._logged_reports))
418
lock_url = lf2.transport.abspath(lf2.path)
419
self.assertEqual('%s %s\n'
421
'Will continue to try until %s, unless '
422
'you press Ctrl-C.\n'
423
'See "bzr help break-lock" for more.',
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 '
436
'you press Ctrl-C.\n'
437
'See "bzr help break-lock" for more.',
438
self._logged_reports[1][0])
439
args = self._logged_reports[1][1]
440
self.assertEqual('Lock owner changed for', args[0])
441
self.assertEqual('lock %s' % (lock_base,), args[1])
442
self.assertStartsWith(args[2], 'held by ')
443
self.assertStartsWith(args[3], 'locked ')
444
self.assertEndsWith(args[3], ' ago')
445
self.assertContainsRe(args[4], r'\d\d:\d\d:\d\d')
235
self.assertTrue(after - before <= 1.0)
447
239
def test_40_confirm_easy(self):
448
240
"""Confirm a lock that's already held"""
558
344
# do this without IO redirection to ensure it doesn't prompt.
559
345
self.assertRaises(AssertionError, ld1.break_lock)
560
346
orig_factory = bzrlib.ui.ui_factory
561
bzrlib.ui.ui_factory = bzrlib.ui.CannedInputUIFactory([True])
347
# silent ui - no need for stdout
348
bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
349
bzrlib.ui.ui_factory.stdin = StringIO("y\n")
564
352
self.assertRaises(LockBroken, ld1.unlock)
566
354
bzrlib.ui.ui_factory = orig_factory
568
def test_create_missing_base_directory(self):
569
"""If LockDir.path doesn't exist, it can be created
571
Some people manually remove the entire lock/ directory trying
572
to unlock a stuck repository/branch/etc. Rather than failing
573
after that, just create the lock directory when needed.
575
t = self.get_transport()
576
lf1 = LockDir(t, 'test_lock')
579
self.failUnless(t.has('test_lock'))
582
self.failIf(t.has('test_lock'))
584
# This will create 'test_lock' if it needs to
586
self.failUnless(t.has('test_lock'))
587
self.failUnless(t.has('test_lock/held/info'))
590
self.failIf(t.has('test_lock/held/info'))
592
def test__format_lock_info(self):
593
ld1 = self.get_lock()
597
info_list = ld1._format_lock_info(ld1.peek())
600
self.assertEqual('lock %s' % (ld1.transport.abspath(ld1.path),),
602
self.assertContainsRe(info_list[1],
603
r'^held by .* on host .* \[process #\d*\]$')
604
self.assertContainsRe(info_list[2], r'locked \d+ seconds? ago$')
606
def test_lock_without_email(self):
607
global_config = config.GlobalConfig()
608
# Intentionally has no email address
609
global_config.set_user_option('email', 'User Identity')
610
ld1 = self.get_lock()
615
def test_lock_permission(self):
616
if not osutils.supports_posix_readonly():
617
raise tests.TestSkipped('Cannot induce a permission failure')
618
ld1 = self.get_lock()
619
lock_path = ld1.transport.local_abspath('test_lock')
621
osutils.make_readonly(lock_path)
622
self.assertRaises(errors.LockFailed, ld1.attempt_lock)
624
def test_lock_by_token(self):
625
ld1 = self.get_lock()
626
token = ld1.lock_write()
627
self.addCleanup(ld1.unlock)
628
self.assertNotEqual(None, token)
629
ld2 = self.get_lock()
630
t2 = ld2.lock_write(token)
631
self.addCleanup(ld2.unlock)
632
self.assertEqual(token, t2)
634
def test_lock_with_buggy_rename(self):
635
# test that lock acquisition handles servers which pretend they
636
# renamed correctly but that actually fail
637
t = transport.get_transport('brokenrename+' + self.get_url())
638
ld1 = LockDir(t, 'test_lock')
641
ld2 = LockDir(t, 'test_lock')
642
# we should fail to lock
643
e = self.assertRaises(errors.LockContention, ld2.attempt_lock)
644
# now the original caller should succeed in unlocking
646
# and there should be nothing left over
647
self.assertEquals([], t.list_dir('test_lock'))
649
def test_failed_lock_leaves_no_trash(self):
650
# if we fail to acquire the lock, we don't leave pending directories
651
# behind -- https://bugs.launchpad.net/bzr/+bug/109169
652
ld1 = self.get_lock()
653
ld2 = self.get_lock()
654
# should be nothing before we start
656
t = self.get_transport().clone('test_lock')
658
self.assertEquals(a, t.list_dir('.'))
660
# when held, that's all we see
662
self.addCleanup(ld1.unlock)
664
# second guy should fail
665
self.assertRaises(errors.LockContention, ld2.attempt_lock)
670
class TestLockDirHooks(TestCaseWithTransport):
673
super(TestLockDirHooks, self).setUp()
677
return LockDir(self.get_transport(), 'test_lock')
679
def record_hook(self, result):
680
self._calls.append(result)
682
def test_LockDir_acquired_success(self):
683
# the LockDir.lock_acquired hook fires when a lock is acquired.
684
LockDir.hooks.install_named_hook('lock_acquired',
685
self.record_hook, 'record_hook')
688
self.assertEqual([], self._calls)
689
result = ld.attempt_lock()
690
lock_path = ld.transport.abspath(ld.path)
691
self.assertEqual([lock.LockResult(lock_path, result)], self._calls)
693
self.assertEqual([lock.LockResult(lock_path, result)], self._calls)
695
def test_LockDir_acquired_fail(self):
696
# the LockDir.lock_acquired hook does not fire on failure.
699
ld2 = self.get_lock()
701
# install a lock hook now, when the disk lock is locked
702
LockDir.hooks.install_named_hook('lock_acquired',
703
self.record_hook, 'record_hook')
704
self.assertRaises(errors.LockContention, ld.attempt_lock)
705
self.assertEqual([], self._calls)
707
self.assertEqual([], self._calls)
709
def test_LockDir_released_success(self):
710
# the LockDir.lock_released hook fires when a lock is acquired.
711
LockDir.hooks.install_named_hook('lock_released',
712
self.record_hook, 'record_hook')
715
self.assertEqual([], self._calls)
716
result = ld.attempt_lock()
717
self.assertEqual([], self._calls)
719
lock_path = ld.transport.abspath(ld.path)
720
self.assertEqual([lock.LockResult(lock_path, result)], self._calls)
722
def test_LockDir_released_fail(self):
723
# 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)
734
def test_LockDir_broken_success(self):
735
# the LockDir.lock_broken hook fires when a lock is broken.
738
ld2 = self.get_lock()
739
result = ld.attempt_lock()
740
LockDir.hooks.install_named_hook('lock_broken',
741
self.record_hook, 'record_hook')
742
ld2.force_break(ld2.peek())
743
lock_path = ld.transport.abspath(ld.path)
744
self.assertEqual([lock.LockResult(lock_path, result)], self._calls)
746
def test_LockDir_broken_failure(self):
747
# the LockDir.lock_broken hook does not fires when a lock is already
751
ld2 = self.get_lock()
752
result = ld.attempt_lock()
753
holder_info = ld2.peek()
755
LockDir.hooks.install_named_hook('lock_broken',
756
self.record_hook, 'record_hook')
757
ld2.force_break(holder_info)
758
lock_path = ld.transport.abspath(ld.path)
759
self.assertEqual([], self._calls)
added
removed
bzrlib/tests/test_lockdir.py
