1
# Copyright (C) 2006-2012, 2016 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"""
32
from bzrlib.errors import (
39
from bzrlib.lockdir import (
43
from bzrlib.tests import (
47
TestCaseWithTransport,
50
# These tests are run on the default transport provided by the test framework
51
# (typically a local disk transport). That can be changed by the --transport
52
# option to bzr selftest. The required properties of the transport
53
# implementation are tested separately. (The main requirement is just that
54
# they don't allow overwriting nonempty directories.)
57
class TestLockDir(TestCaseWithTransport):
58
"""Test LockDir operations"""
60
def logging_report_function(self, fmt, *args):
61
self._logged_reports.append((fmt, args))
63
def setup_log_reporter(self, lock_dir):
64
self._logged_reports = []
65
lock_dir._report_function = self.logging_report_function
67
def test_00_lock_creation(self):
68
"""Creation of lock file on a transport"""
69
t = self.get_transport()
70
lf = LockDir(t, 'test_lock')
71
self.assertFalse(lf.is_held)
73
def test_01_lock_repr(self):
74
"""Lock string representation"""
75
lf = LockDir(self.get_transport(), 'test_lock')
77
self.assertContainsRe(r, r'^LockDir\(.*/test_lock\)$')
79
def test_02_unlocked_peek(self):
80
lf = LockDir(self.get_transport(), 'test_lock')
81
self.assertEqual(lf.peek(), None)
84
return LockDir(self.get_transport(), 'test_lock')
86
def test_unlock_after_break_raises(self):
91
ld2.force_break(ld2.peek())
92
self.assertRaises(LockBroken, ld.unlock)
94
def test_03_readonly_peek(self):
95
lf = LockDir(self.get_readonly_transport(), 'test_lock')
96
self.assertEqual(lf.peek(), None)
98
def test_10_lock_uncontested(self):
99
"""Acquire and release a lock"""
100
t = self.get_transport()
101
lf = LockDir(t, 'test_lock')
105
self.assertTrue(lf.is_held)
108
self.assertFalse(lf.is_held)
110
def test_11_create_readonly_transport(self):
111
"""Fail to create lock on readonly transport"""
112
t = self.get_readonly_transport()
113
lf = LockDir(t, 'test_lock')
114
self.assertRaises(LockFailed, lf.create)
116
def test_12_lock_readonly_transport(self):
117
"""Fail to lock on readonly transport"""
118
lf = LockDir(self.get_transport(), 'test_lock')
120
lf = LockDir(self.get_readonly_transport(), 'test_lock')
121
self.assertRaises(LockFailed, lf.attempt_lock)
123
def test_20_lock_contested(self):
124
"""Contention to get a lock"""
125
t = self.get_transport()
126
lf1 = LockDir(t, 'test_lock')
129
lf2 = LockDir(t, 'test_lock')
131
# locking is between LockDir instances; aliases within
132
# a single process are not detected
134
self.fail('Failed to detect lock collision')
135
except LockContention, e:
136
self.assertEqual(e.lock, lf2)
137
self.assertContainsRe(str(e),
138
r'^Could not acquire.*test_lock.*$')
141
def test_20_lock_peek(self):
142
"""Peek at the state of a lock"""
143
t = self.get_transport()
144
lf1 = LockDir(t, 'test_lock')
147
self.addCleanup(lf1.unlock)
148
# lock is held, should get some info on it
150
self.assertEqual(set(info1.info_dict.keys()),
151
set(['user', 'nonce', 'hostname', 'pid', 'start_time']))
152
# should get the same info if we look at it through a different
154
info2 = LockDir(t, 'test_lock').peek()
155
self.assertEqual(info1, info2)
156
# locks which are never used should be not-held
157
self.assertEqual(LockDir(t, 'other_lock').peek(), None)
159
def test_21_peek_readonly(self):
160
"""Peek over a readonly transport"""
161
t = self.get_transport()
162
lf1 = LockDir(t, 'test_lock')
164
lf2 = LockDir(self.get_readonly_transport(), 'test_lock')
165
self.assertEqual(lf2.peek(), None)
167
self.addCleanup(lf1.unlock)
169
self.assertTrue(info2)
170
self.assertEqual(info2.get('nonce'), lf1.nonce)
172
def test_30_lock_wait_fail(self):
173
"""Wait on a lock, then fail
175
We ask to wait up to 400ms; this should fail within at most one
176
second. (Longer times are more realistic but we don't want the test
177
suite to take too long, and this should do for now.)
179
t = self.get_transport()
180
lf1 = LockDir(t, 'test_lock')
182
lf2 = LockDir(t, 'test_lock')
183
self.setup_log_reporter(lf2)
187
self.assertRaises(LockContention, lf2.wait_lock,
188
timeout=0.4, poll=0.1)
190
# it should only take about 0.4 seconds, but we allow more time in
191
# case the machine is heavily loaded
192
self.assertTrue(after - before <= 8.0,
193
"took %f seconds to detect lock contention" % (after - before))
196
self.assertEqual(1, len(self._logged_reports))
197
self.assertContainsRe(self._logged_reports[0][0],
198
r'Unable to obtain lock .* held by jrandom@example\.com on .*'
199
r' \(process #\d+\), acquired .* ago\.\n'
200
r'Will continue to try until \d{2}:\d{2}:\d{2}, unless '
201
r'you press Ctrl-C.\n'
202
r'See "bzr help break-lock" for more.')
204
def test_31_lock_wait_easy(self):
205
"""Succeed when waiting on a lock with no contention.
207
t = self.get_transport()
208
lf1 = LockDir(t, 'test_lock')
210
self.setup_log_reporter(lf1)
213
lf1.wait_lock(timeout=0.4, poll=0.1)
215
self.assertTrue(after - before <= 1.0)
218
self.assertEqual([], self._logged_reports)
220
def test_40_confirm_easy(self):
221
"""Confirm a lock that's already held"""
222
t = self.get_transport()
223
lf1 = LockDir(t, 'test_lock')
226
self.addCleanup(lf1.unlock)
229
def test_41_confirm_not_held(self):
230
"""Confirm a lock that's already held"""
231
t = self.get_transport()
232
lf1 = LockDir(t, 'test_lock')
234
self.assertRaises(LockNotHeld, lf1.confirm)
236
def test_42_confirm_broken_manually(self):
237
"""Confirm a lock broken by hand"""
238
t = self.get_transport()
239
lf1 = LockDir(t, 'test_lock')
242
t.move('test_lock', 'lock_gone_now')
243
self.assertRaises(LockBroken, lf1.confirm)
245
t.move('lock_gone_now', 'test_lock')
248
def test_43_break(self):
249
"""Break a lock whose caller has forgotten it"""
250
t = self.get_transport()
251
lf1 = LockDir(t, 'test_lock')
254
# we incorrectly discard the lock object without unlocking it
256
# someone else sees it's still locked
257
lf2 = LockDir(t, 'test_lock')
258
holder_info = lf2.peek()
259
self.assertTrue(holder_info)
260
lf2.force_break(holder_info)
261
# now we should be able to take it
263
self.addCleanup(lf2.unlock)
266
def test_44_break_already_released(self):
267
"""Lock break races with regular release"""
268
t = self.get_transport()
269
lf1 = LockDir(t, 'test_lock')
272
# someone else sees it's still locked
273
lf2 = LockDir(t, 'test_lock')
274
holder_info = lf2.peek()
275
# in the interim the lock is released
277
# break should succeed
278
lf2.force_break(holder_info)
279
# now we should be able to take it
281
self.addCleanup(lf2.unlock)
284
def test_45_break_mismatch(self):
285
"""Lock break races with someone else acquiring it"""
286
t = self.get_transport()
287
lf1 = LockDir(t, 'test_lock')
290
# someone else sees it's still locked
291
lf2 = LockDir(t, 'test_lock')
292
holder_info = lf2.peek()
293
# in the interim the lock is released
295
lf3 = LockDir(t, 'test_lock')
297
# break should now *fail*
298
self.assertRaises(LockBreakMismatch, lf2.force_break,
302
def test_46_fake_read_lock(self):
303
t = self.get_transport()
304
lf1 = LockDir(t, 'test_lock')
309
def test_50_lockdir_representation(self):
310
"""Check the on-disk representation of LockDirs is as expected.
312
There should always be a top-level directory named by the lock.
313
When the lock is held, there should be a lockname/held directory
314
containing an info file.
316
t = self.get_transport()
317
lf1 = LockDir(t, 'test_lock')
319
self.assertTrue(t.has('test_lock'))
321
self.assertTrue(t.has('test_lock/held/info'))
323
self.assertFalse(t.has('test_lock/held/info'))
325
def test_break_lock(self):
326
# the ui based break_lock routine should Just Work (tm)
327
ld1 = self.get_lock()
328
ld2 = self.get_lock()
331
# do this without IO redirection to ensure it doesn't prompt.
332
self.assertRaises(AssertionError, ld1.break_lock)
333
orig_factory = bzrlib.ui.ui_factory
334
bzrlib.ui.ui_factory = bzrlib.ui.CannedInputUIFactory([True])
337
self.assertRaises(LockBroken, ld1.unlock)
339
bzrlib.ui.ui_factory = orig_factory
341
def test_break_lock_corrupt_info(self):
342
"""break_lock works even if the info file is corrupt (and tells the UI
346
ld2 = self.get_lock()
349
ld.transport.put_bytes_non_atomic('test_lock/held/info', '\0')
351
class LoggingUIFactory(bzrlib.ui.SilentUIFactory):
355
def get_boolean(self, prompt):
356
self.prompts.append(('boolean', prompt))
359
ui = LoggingUIFactory()
360
self.overrideAttr(bzrlib.ui, 'ui_factory', ui)
362
self.assertLength(1, ui.prompts)
363
self.assertEqual('boolean', ui.prompts[0][0])
364
self.assertStartsWith(ui.prompts[0][1], 'Break (corrupt LockDir')
365
self.assertRaises(LockBroken, ld.unlock)
367
def test_break_lock_missing_info(self):
368
"""break_lock works even if the info file is missing (and tells the UI
372
ld2 = self.get_lock()
375
ld.transport.delete('test_lock/held/info')
377
class LoggingUIFactory(bzrlib.ui.SilentUIFactory):
381
def get_boolean(self, prompt):
382
self.prompts.append(('boolean', prompt))
385
ui = LoggingUIFactory()
386
orig_factory = bzrlib.ui.ui_factory
387
bzrlib.ui.ui_factory = ui
390
self.assertRaises(LockBroken, ld.unlock)
391
self.assertLength(0, ui.prompts)
393
bzrlib.ui.ui_factory = orig_factory
394
# Suppress warnings due to ld not being unlocked
395
# XXX: if lock_broken hook was invoked in this case, this hack would
396
# not be necessary. - Andrew Bennetts, 2010-09-06.
397
del self._lock_actions[:]
399
def test_create_missing_base_directory(self):
400
"""If LockDir.path doesn't exist, it can be created
402
Some people manually remove the entire lock/ directory trying
403
to unlock a stuck repository/branch/etc. Rather than failing
404
after that, just create the lock directory when needed.
406
t = self.get_transport()
407
lf1 = LockDir(t, 'test_lock')
410
self.assertTrue(t.has('test_lock'))
413
self.assertFalse(t.has('test_lock'))
415
# This will create 'test_lock' if it needs to
417
self.assertTrue(t.has('test_lock'))
418
self.assertTrue(t.has('test_lock/held/info'))
421
self.assertFalse(t.has('test_lock/held/info'))
423
def test_display_form(self):
424
ld1 = self.get_lock()
428
info_list = ld1.peek().to_readable_dict()
431
self.assertEqual(info_list['user'], u'jrandom@example.com')
432
self.assertContainsRe(info_list['pid'], '^\d+$')
433
self.assertContainsRe(info_list['time_ago'], r'^\d+ seconds? ago$')
435
def test_lock_without_email(self):
436
global_config = config.GlobalStack()
437
# Intentionally has no email address
438
global_config.set('email', 'User Identity')
439
ld1 = self.get_lock()
444
def test_lock_permission(self):
445
self.requireFeature(features.not_running_as_root)
446
if not osutils.supports_posix_readonly():
447
raise tests.TestSkipped('Cannot induce a permission failure')
448
ld1 = self.get_lock()
449
lock_path = ld1.transport.local_abspath('test_lock')
451
osutils.make_readonly(lock_path)
452
self.assertRaises(errors.LockFailed, ld1.attempt_lock)
454
def test_lock_by_token(self):
455
ld1 = self.get_lock()
456
token = ld1.lock_write()
457
self.addCleanup(ld1.unlock)
458
self.assertNotEqual(None, token)
459
ld2 = self.get_lock()
460
t2 = ld2.lock_write(token)
461
self.addCleanup(ld2.unlock)
462
self.assertEqual(token, t2)
464
def test_lock_with_buggy_rename(self):
465
# test that lock acquisition handles servers which pretend they
466
# renamed correctly but that actually fail
467
t = transport.get_transport_from_url(
468
'brokenrename+' + self.get_url())
469
ld1 = LockDir(t, 'test_lock')
472
ld2 = LockDir(t, 'test_lock')
473
# we should fail to lock
474
e = self.assertRaises(errors.LockContention, ld2.attempt_lock)
475
# now the original caller should succeed in unlocking
477
# and there should be nothing left over
478
self.assertEqual([], t.list_dir('test_lock'))
480
def test_failed_lock_leaves_no_trash(self):
481
# if we fail to acquire the lock, we don't leave pending directories
482
# behind -- https://bugs.launchpad.net/bzr/+bug/109169
483
ld1 = self.get_lock()
484
ld2 = self.get_lock()
485
# should be nothing before we start
487
t = self.get_transport().clone('test_lock')
490
self.assertEqual(a, t.list_dir('.'))
493
# when held, that's all we see
495
self.addCleanup(ld1.unlock)
497
# second guy should fail
498
self.assertRaises(errors.LockContention, ld2.attempt_lock)
502
def test_no_lockdir_info(self):
503
"""We can cope with empty info files."""
504
# This seems like a fairly common failure case - see
505
# <https://bugs.launchpad.net/bzr/+bug/185103> and all its dupes.
506
# Processes are often interrupted after opening the file
507
# before the actual contents are committed.
508
t = self.get_transport()
510
t.mkdir('test_lock/held')
511
t.put_bytes('test_lock/held/info', '')
512
lf = LockDir(t, 'test_lock')
514
formatted_info = info.to_readable_dict()
516
dict(user='<unknown>', hostname='<unknown>', pid='<unknown>',
517
time_ago='(unknown)'),
520
def test_corrupt_lockdir_info(self):
521
"""We can cope with corrupt (and thus unparseable) info files."""
522
# This seems like a fairly common failure case too - see
523
# <https://bugs.launchpad.net/bzr/+bug/619872> for instance.
524
# In particular some systems tend to fill recently created files with
525
# nul bytes after recovering from a system crash.
526
t = self.get_transport()
528
t.mkdir('test_lock/held')
529
t.put_bytes('test_lock/held/info', '\0')
530
lf = LockDir(t, 'test_lock')
531
self.assertRaises(errors.LockCorrupt, lf.peek)
532
# Currently attempt_lock gives LockContention, but LockCorrupt would be
533
# a reasonable result too.
535
(errors.LockCorrupt, errors.LockContention), lf.attempt_lock)
536
self.assertRaises(errors.LockCorrupt, lf.validate_token, 'fake token')
538
def test_missing_lockdir_info(self):
539
"""We can cope with absent info files."""
540
t = self.get_transport()
542
t.mkdir('test_lock/held')
543
lf = LockDir(t, 'test_lock')
544
# In this case we expect the 'not held' result from peek, because peek
545
# cannot be expected to notice that there is a 'held' directory with no
547
self.assertEqual(None, lf.peek())
548
# And lock/unlock may work or give LockContention (but not any other
552
except LockContention:
553
# LockContention is ok, and expected on Windows
556
# no error is ok, and expected on POSIX (because POSIX allows
557
# os.rename over an empty directory).
559
# Currently raises TokenMismatch, but LockCorrupt would be reasonable
562
(errors.TokenMismatch, errors.LockCorrupt),
563
lf.validate_token, 'fake token')
566
class TestLockDirHooks(TestCaseWithTransport):
569
super(TestLockDirHooks, self).setUp()
573
return LockDir(self.get_transport(), 'test_lock')
575
def record_hook(self, result):
576
self._calls.append(result)
578
def test_LockDir_acquired_success(self):
579
# the LockDir.lock_acquired hook fires when a lock is acquired.
580
LockDir.hooks.install_named_hook('lock_acquired',
581
self.record_hook, 'record_hook')
584
self.assertEqual([], self._calls)
585
result = ld.attempt_lock()
586
lock_path = ld.transport.abspath(ld.path)
587
self.assertEqual([lock.LockResult(lock_path, result)], self._calls)
589
self.assertEqual([lock.LockResult(lock_path, result)], self._calls)
591
def test_LockDir_acquired_fail(self):
592
# the LockDir.lock_acquired hook does not fire on failure.
595
ld2 = self.get_lock()
597
# install a lock hook now, when the disk lock is locked
598
LockDir.hooks.install_named_hook('lock_acquired',
599
self.record_hook, 'record_hook')
600
self.assertRaises(errors.LockContention, ld.attempt_lock)
601
self.assertEqual([], self._calls)
603
self.assertEqual([], self._calls)
605
def test_LockDir_released_success(self):
606
# the LockDir.lock_released hook fires when a lock is acquired.
607
LockDir.hooks.install_named_hook('lock_released',
608
self.record_hook, 'record_hook')
611
self.assertEqual([], self._calls)
612
result = ld.attempt_lock()
613
self.assertEqual([], self._calls)
615
lock_path = ld.transport.abspath(ld.path)
616
self.assertEqual([lock.LockResult(lock_path, result)], self._calls)
618
def test_LockDir_released_fail(self):
619
# the LockDir.lock_released hook does not fire on failure.
622
ld2 = self.get_lock()
624
ld2.force_break(ld2.peek())
625
LockDir.hooks.install_named_hook('lock_released',
626
self.record_hook, 'record_hook')
627
self.assertRaises(LockBroken, ld.unlock)
628
self.assertEqual([], self._calls)
630
def test_LockDir_broken_success(self):
631
# the LockDir.lock_broken hook fires when a lock is broken.
634
ld2 = self.get_lock()
635
result = ld.attempt_lock()
636
LockDir.hooks.install_named_hook('lock_broken',
637
self.record_hook, 'record_hook')
638
ld2.force_break(ld2.peek())
639
lock_path = ld.transport.abspath(ld.path)
640
self.assertEqual([lock.LockResult(lock_path, result)], self._calls)
642
def test_LockDir_broken_failure(self):
643
# the LockDir.lock_broken hook does not fires when a lock is already
647
ld2 = self.get_lock()
648
result = ld.attempt_lock()
649
holder_info = ld2.peek()
651
LockDir.hooks.install_named_hook('lock_broken',
652
self.record_hook, 'record_hook')
653
ld2.force_break(holder_info)
654
lock_path = ld.transport.abspath(ld.path)
655
self.assertEqual([], self._calls)
658
class TestLockHeldInfo(TestCaseInTempDir):
659
"""Can get information about the lock holder, and detect whether they're
663
info = LockHeldInfo.for_this_process(None)
664
self.assertContainsRe(repr(info), r"LockHeldInfo\(.*\)")
666
def test_unicode(self):
667
info = LockHeldInfo.for_this_process(None)
668
self.assertContainsRe(unicode(info),
669
r'held by .* on .* \(process #\d+\), acquired .* ago')
671
def test_is_locked_by_this_process(self):
672
info = LockHeldInfo.for_this_process(None)
673
self.assertTrue(info.is_locked_by_this_process())
675
def test_is_not_locked_by_this_process(self):
676
info = LockHeldInfo.for_this_process(None)
677
info.info_dict['pid'] = '123123123123123'
678
self.assertFalse(info.is_locked_by_this_process())
680
def test_lock_holder_live_process(self):
681
"""Detect that the holder (this process) is still running."""
682
info = LockHeldInfo.for_this_process(None)
683
self.assertFalse(info.is_lock_holder_known_dead())
685
def test_lock_holder_dead_process(self):
686
"""Detect that the holder (this process) is still running."""
687
self.overrideAttr(lockdir, 'get_host_name',
688
lambda: 'aproperhostname')
689
info = LockHeldInfo.for_this_process(None)
690
info.info_dict['pid'] = '123123123'
691
self.assertTrue(info.is_lock_holder_known_dead())
693
def test_lock_holder_other_machine(self):
694
"""The lock holder isn't here so we don't know if they're alive."""
695
info = LockHeldInfo.for_this_process(None)
696
info.info_dict['hostname'] = 'egg.example.com'
697
info.info_dict['pid'] = '123123123'
698
self.assertFalse(info.is_lock_holder_known_dead())
700
def test_lock_holder_other_user(self):
701
"""Only auto-break locks held by this user."""
702
info = LockHeldInfo.for_this_process(None)
703
info.info_dict['user'] = 'notme@example.com'
704
info.info_dict['pid'] = '123123123'
705
self.assertFalse(info.is_lock_holder_known_dead())
707
def test_no_good_hostname(self):
708
"""Correctly handle ambiguous hostnames.
710
If the lock's recorded with just 'localhost' we can't really trust
711
it's the same 'localhost'. (There are quite a few of them. :-)
712
So even if the process is known not to be alive, we can't say that's
715
self.overrideAttr(lockdir, 'get_host_name',
717
info = LockHeldInfo.for_this_process(None)
718
info.info_dict['pid'] = '123123123'
719
self.assertFalse(info.is_lock_holder_known_dead())
722
class TestStaleLockDir(TestCaseWithTransport):
723
"""Can automatically break stale locks.
725
:see: https://bugs.launchpad.net/bzr/+bug/220464
728
def test_auto_break_stale_lock(self):
729
"""Locks safely known to be stale are just cleaned up.
731
This generates a warning but no other user interaction.
733
self.overrideAttr(lockdir, 'get_host_name',
734
lambda: 'aproperhostname')
735
# This is off by default at present; see the discussion in the bug.
736
# If you change the default, don't forget to update the docs.
737
config.GlobalStack().set('locks.steal_dead', True)
738
# Create a lock pretending to come from a different nonexistent
739
# process on the same machine.
740
l1 = LockDir(self.get_transport(), 'a',
741
extra_holder_info={'pid': '12312313'})
742
token_1 = l1.attempt_lock()
743
l2 = LockDir(self.get_transport(), 'a')
744
token_2 = l2.attempt_lock()
745
# l1 will notice its lock was stolen.
746
self.assertRaises(errors.LockBroken,
750
def test_auto_break_stale_lock_configured_off(self):
751
"""Automatic breaking can be turned off"""
752
l1 = LockDir(self.get_transport(), 'a',
753
extra_holder_info={'pid': '12312313'})
754
token_1 = l1.attempt_lock()
755
self.addCleanup(l1.unlock)
756
l2 = LockDir(self.get_transport(), 'a')
757
# This fails now, because dead lock breaking is off by default.
758
self.assertRaises(LockContention,
760
# and it's in fact not broken
added
removed
bzrlib/tests/test_lockdir.py
