← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_lockdir.py

Merge bzr.dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_lockdir.py
1
 
# Copyright (C) 2006-2010 Canonical Ltd
 
1
# Copyright (C) 2006 Canonical Ltd
2
2
#
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
12
12
#
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
16
16
 
17
17
"""Tests for LockDir"""
18
18
 
25
25
from bzrlib import (
26
26
    config,
27
27
    errors,
28
 
    lock,
29
28
    osutils,
30
29
    tests,
31
30
    transport,
32
31
    )
33
32
from bzrlib.errors import (
34
 
    LockBreakMismatch,
35
 
    LockBroken,
36
 
    LockContention,
37
 
    LockError,
38
 
    LockFailed,
39
 
    LockNotHeld,
40
 
    )
 
33
        LockBreakMismatch,
 
34
        LockContention, LockError, UnlockableTransport,
 
35
        LockNotHeld, LockBroken
 
36
        )
41
37
from bzrlib.lockdir import LockDir
42
38
from bzrlib.tests import TestCaseWithTransport
43
39
from bzrlib.trace import note
109
105
        """Fail to create lock on readonly transport"""
110
106
        t = self.get_readonly_transport()
111
107
        lf = LockDir(t, 'test_lock')
112
 
        self.assertRaises(LockFailed, lf.create)
 
108
        self.assertRaises(UnlockableTransport, lf.create)
113
109
 
114
110
    def test_12_lock_readonly_transport(self):
115
111
        """Fail to lock on readonly transport"""
116
112
        lf = LockDir(self.get_transport(), 'test_lock')
117
113
        lf.create()
118
114
        lf = LockDir(self.get_readonly_transport(), 'test_lock')
119
 
        self.assertRaises(LockFailed, lf.attempt_lock)
 
115
        self.assertRaises(UnlockableTransport, lf.attempt_lock)
120
116
 
121
117
    def test_20_lock_contested(self):
122
118
        """Contention to get a lock"""
126
122
        lf1.attempt_lock()
127
123
        lf2 = LockDir(t, 'test_lock')
128
124
        try:
129
 
            # locking is between LockDir instances; aliases within
 
125
            # locking is between LockDir instances; aliases within 
130
126
            # a single process are not detected
131
127
            lf2.attempt_lock()
132
128
            self.fail('Failed to detect lock collision')
142
138
        lf1 = LockDir(t, 'test_lock')
143
139
        lf1.create()
144
140
        lf1.attempt_lock()
145
 
        self.addCleanup(lf1.unlock)
146
141
        # lock is held, should get some info on it
147
142
        info1 = lf1.peek()
148
143
        self.assertEqual(set(info1.keys()),
162
157
        lf2 = LockDir(self.get_readonly_transport(), 'test_lock')
163
158
        self.assertEqual(lf2.peek(), None)
164
159
        lf1.attempt_lock()
165
 
        self.addCleanup(lf1.unlock)
166
160
        info2 = lf2.peek()
167
161
        self.assertTrue(info2)
168
162
        self.assertEqual(info2['nonce'], lf1.nonce)
169
163
 
170
164
    def test_30_lock_wait_fail(self):
171
165
        """Wait on a lock, then fail
172
 
 
 
166
        
173
167
        We ask to wait up to 400ms; this should fail within at most one
174
168
        second.  (Longer times are more realistic but we don't want the test
175
169
        suite to take too long, and this should do for now.)
187
181
            after = time.time()
188
182
            # it should only take about 0.4 seconds, but we allow more time in
189
183
            # case the machine is heavily loaded
190
 
            self.assertTrue(after - before <= 8.0,
 
184
            self.assertTrue(after - before <= 8.0, 
191
185
                    "took %f seconds to detect lock contention" % (after - before))
192
186
        finally:
193
187
            lf1.unlock()
194
188
        lock_base = lf2.transport.abspath(lf2.path)
195
189
        self.assertEqual(1, len(self._logged_reports))
196
 
        lock_url = lf2.transport.abspath(lf2.path)
197
190
        self.assertEqual('%s %s\n'
198
191
                         '%s\n%s\n'
199
 
                         'Will continue to try until %s, unless '
200
 
                         'you press Ctrl-C.\n'
201
 
                         'See "bzr help break-lock" for more.',
 
192
                         'Will continue to try until %s\n',
202
193
                         self._logged_reports[0][0])
203
194
        args = self._logged_reports[0][1]
204
195
        self.assertEqual('Unable to obtain', args[0])
227
218
    def test_32_lock_wait_succeed(self):
228
219
        """Succeed when trying to acquire a lock that gets released
229
220
 
230
 
        One thread holds on a lock and then releases it; another
 
221
        One thread holds on a lock and then releases it; another 
231
222
        tries to lock it.
232
223
        """
233
224
        # This test sometimes fails like this:
278
269
        self.assertContainsRe(args[4], r'\d\d:\d\d:\d\d')
279
270
 
280
271
    def test_34_lock_write_waits(self):
281
 
        """LockDir.lock_write() will wait for the lock."""
 
272
        """LockDir.lock_write() will wait for the lock.""" 
282
273
        # the test suite sets the default to 0 to make deadlocks fail fast.
283
274
        # change it for this test, as we want to try a manual deadlock.
284
275
        raise tests.TestSkipped('Timing-sensitive test')
321
312
 
322
313
    def test_35_wait_lock_changing(self):
323
314
        """LockDir.wait_lock() will report if the lock changes underneath.
324
 
 
 
315
        
325
316
        This is the stages we want to happen:
326
317
 
327
318
        0) Synchronization locks are created and locked.
328
319
        1) Lock1 obtains the lockdir, and releases the 'check' lock.
329
320
        2) Lock2 grabs the 'check' lock, and checks the lockdir.
330
 
           It sees the lockdir is already acquired, reports the fact,
 
321
           It sees the lockdir is already acquired, reports the fact, 
331
322
           and unsets the 'checked' lock.
332
323
        3) Thread1 blocks on acquiring the 'checked' lock, and then tells
333
324
           Lock1 to release and acquire the lockdir. This resets the 'check'
334
325
           lock.
335
326
        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
 
327
           that the holder of the lock has changed, and so reports a new 
337
328
           lock holder.
338
329
        5) Thread1 blocks on the 'checked' lock, this time, it completely
339
330
           unlocks the lockdir, allowing Lock2 to acquire the lock.
340
331
        """
341
332
 
342
 
        raise tests.KnownFailure(
343
 
            "timing dependency in lock tests (#213182)")
344
 
 
345
333
        wait_to_check_lock = Lock()
346
334
        wait_until_checked_lock = Lock()
347
335
 
415
403
        # There should be 2 reports, because the lock changed
416
404
        lock_base = lf2.transport.abspath(lf2.path)
417
405
        self.assertEqual(2, len(self._logged_reports))
418
 
        lock_url = lf2.transport.abspath(lf2.path)
 
406
 
419
407
        self.assertEqual('%s %s\n'
420
408
                         '%s\n%s\n'
421
 
                         'Will continue to try until %s, unless '
422
 
                         'you press Ctrl-C.\n'
423
 
                         'See "bzr help break-lock" for more.',
 
409
                         'Will continue to try until %s\n',
424
410
                         self._logged_reports[0][0])
425
411
        args = self._logged_reports[0][1]
426
412
        self.assertEqual('Unable to obtain', args[0])
432
418
 
433
419
        self.assertEqual('%s %s\n'
434
420
                         '%s\n%s\n'
435
 
                         'Will continue to try until %s, unless '
436
 
                         'you press Ctrl-C.\n'
437
 
                         'See "bzr help break-lock" for more.',
 
421
                         'Will continue to try until %s\n',
438
422
                         self._logged_reports[1][0])
439
423
        args = self._logged_reports[1][1]
440
424
        self.assertEqual('Lock owner changed for', args[0])
450
434
        lf1 = LockDir(t, 'test_lock')
451
435
        lf1.create()
452
436
        lf1.attempt_lock()
453
 
        self.addCleanup(lf1.unlock)
454
437
        lf1.confirm()
455
438
 
456
439
    def test_41_confirm_not_held(self):
468
451
        lf1.attempt_lock()
469
452
        t.move('test_lock', 'lock_gone_now')
470
453
        self.assertRaises(LockBroken, lf1.confirm)
471
 
        # Clean up
472
 
        t.move('lock_gone_now', 'test_lock')
473
 
        lf1.unlock()
474
454
 
475
455
    def test_43_break(self):
476
456
        """Break a lock whose caller has forgotten it"""
487
467
        lf2.force_break(holder_info)
488
468
        # now we should be able to take it
489
469
        lf2.attempt_lock()
490
 
        self.addCleanup(lf2.unlock)
491
470
        lf2.confirm()
492
471
 
493
472
    def test_44_break_already_released(self):
505
484
        lf2.force_break(holder_info)
506
485
        # now we should be able to take it
507
486
        lf2.attempt_lock()
508
 
        self.addCleanup(lf2.unlock)
509
487
        lf2.confirm()
510
488
 
511
489
    def test_45_break_mismatch(self):
537
515
        """Check the on-disk representation of LockDirs is as expected.
538
516
 
539
517
        There should always be a top-level directory named by the lock.
540
 
        When the lock is held, there should be a lockname/held directory
 
518
        When the lock is held, there should be a lockname/held directory 
541
519
        containing an info file.
542
520
        """
543
521
        t = self.get_transport()
558
536
        # do this without IO redirection to ensure it doesn't prompt.
559
537
        self.assertRaises(AssertionError, ld1.break_lock)
560
538
        orig_factory = bzrlib.ui.ui_factory
561
 
        bzrlib.ui.ui_factory = bzrlib.ui.CannedInputUIFactory([True])
 
539
        # silent ui - no need for stdout
 
540
        bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
 
541
        bzrlib.ui.ui_factory.stdin = StringIO("y\n")
562
542
        try:
563
543
            ld2.break_lock()
564
544
            self.assertRaises(LockBroken, ld1.unlock)
619
599
        lock_path = ld1.transport.local_abspath('test_lock')
620
600
        os.mkdir(lock_path)
621
601
        osutils.make_readonly(lock_path)
622
 
        self.assertRaises(errors.LockFailed, ld1.attempt_lock)
 
602
        self.assertRaises(errors.PermissionDenied, ld1.attempt_lock)
623
603
 
624
604
    def test_lock_by_token(self):
625
605
        ld1 = self.get_lock()
626
606
        token = ld1.lock_write()
627
 
        self.addCleanup(ld1.unlock)
628
607
        self.assertNotEqual(None, token)
629
608
        ld2 = self.get_lock()
630
609
        t2 = ld2.lock_write(token)
631
 
        self.addCleanup(ld2.unlock)
632
610
        self.assertEqual(token, t2)
633
611
 
634
612
    def test_lock_with_buggy_rename(self):
659
637
        check_dir([])
660
638
        # when held, that's all we see
661
639
        ld1.attempt_lock()
662
 
        self.addCleanup(ld1.unlock)
663
640
        check_dir(['held'])
664
641
        # second guy should fail
665
642
        self.assertRaises(errors.LockContention, ld2.attempt_lock)
666
643
        # no kibble
667
644
        check_dir(['held'])
668
 
 
669
 
    def test_no_lockdir_info(self):
670
 
        """We can cope with empty info files."""
671
 
        # This seems like a fairly common failure case - see
672
 
        # <https://bugs.edge.launchpad.net/bzr/+bug/185103> and all its dupes.
673
 
        # Processes are often interrupted after opening the file
674
 
        # before the actual contents are committed.
675
 
        t = self.get_transport()
676
 
        t.mkdir('test_lock')
677
 
        t.mkdir('test_lock/held')
678
 
        t.put_bytes('test_lock/held/info', '')
679
 
        lf = LockDir(t, 'test_lock')
680
 
        info = lf.peek()
681
 
        formatted_info = lf._format_lock_info(info)
682
 
        self.assertEquals(
683
 
            ['lock %s' % t.abspath('test_lock'),
684
 
             'held by <unknown> on host <unknown> [process #<unknown>]',
685
 
             'locked (unknown)'],
686
 
            formatted_info)
687
 
 
688
 
 
689
 
class TestLockDirHooks(TestCaseWithTransport):
690
 
 
691
 
    def setUp(self):
692
 
        super(TestLockDirHooks, self).setUp()
693
 
        self._calls = []
694
 
 
695
 
    def get_lock(self):
696
 
        return LockDir(self.get_transport(), 'test_lock')
697
 
 
698
 
    def record_hook(self, result):
699
 
        self._calls.append(result)
700
 
 
701
 
    def test_LockDir_acquired_success(self):
702
 
        # the LockDir.lock_acquired hook fires when a lock is acquired.
703
 
        LockDir.hooks.install_named_hook('lock_acquired',
704
 
                                         self.record_hook, 'record_hook')
705
 
        ld = self.get_lock()
706
 
        ld.create()
707
 
        self.assertEqual([], self._calls)
708
 
        result = ld.attempt_lock()
709
 
        lock_path = ld.transport.abspath(ld.path)
710
 
        self.assertEqual([lock.LockResult(lock_path, result)], self._calls)
711
 
        ld.unlock()
712
 
        self.assertEqual([lock.LockResult(lock_path, result)], self._calls)
713
 
 
714
 
    def test_LockDir_acquired_fail(self):
715
 
        # the LockDir.lock_acquired hook does not fire on failure.
716
 
        ld = self.get_lock()
717
 
        ld.create()
718
 
        ld2 = self.get_lock()
719
 
        ld2.attempt_lock()
720
 
        # install a lock hook now, when the disk lock is locked
721
 
        LockDir.hooks.install_named_hook('lock_acquired',
722
 
                                         self.record_hook, 'record_hook')
723
 
        self.assertRaises(errors.LockContention, ld.attempt_lock)
724
 
        self.assertEqual([], self._calls)
725
 
        ld2.unlock()
726
 
        self.assertEqual([], self._calls)
727
 
 
728
 
    def test_LockDir_released_success(self):
729
 
        # the LockDir.lock_released hook fires when a lock is acquired.
730
 
        LockDir.hooks.install_named_hook('lock_released',
731
 
                                         self.record_hook, 'record_hook')
732
 
        ld = self.get_lock()
733
 
        ld.create()
734
 
        self.assertEqual([], self._calls)
735
 
        result = ld.attempt_lock()
736
 
        self.assertEqual([], self._calls)
737
 
        ld.unlock()
738
 
        lock_path = ld.transport.abspath(ld.path)
739
 
        self.assertEqual([lock.LockResult(lock_path, result)], self._calls)
740
 
 
741
 
    def test_LockDir_released_fail(self):
742
 
        # the LockDir.lock_released hook does not fire on failure.
743
 
        ld = self.get_lock()
744
 
        ld.create()
745
 
        ld2 = self.get_lock()
746
 
        ld.attempt_lock()
747
 
        ld2.force_break(ld2.peek())
748
 
        LockDir.hooks.install_named_hook('lock_released',
749
 
                                         self.record_hook, 'record_hook')
750
 
        self.assertRaises(LockBroken, ld.unlock)
751
 
        self.assertEqual([], self._calls)
752
 
 
753
 
    def test_LockDir_broken_success(self):
754
 
        # the LockDir.lock_broken hook fires when a lock is broken.
755
 
        ld = self.get_lock()
756
 
        ld.create()
757
 
        ld2 = self.get_lock()
758
 
        result = ld.attempt_lock()
759
 
        LockDir.hooks.install_named_hook('lock_broken',
760
 
                                         self.record_hook, 'record_hook')
761
 
        ld2.force_break(ld2.peek())
762
 
        lock_path = ld.transport.abspath(ld.path)
763
 
        self.assertEqual([lock.LockResult(lock_path, result)], self._calls)
764
 
 
765
 
    def test_LockDir_broken_failure(self):
766
 
        # the LockDir.lock_broken hook does not fires when a lock is already
767
 
        # released.
768
 
        ld = self.get_lock()
769
 
        ld.create()
770
 
        ld2 = self.get_lock()
771
 
        result = ld.attempt_lock()
772
 
        holder_info = ld2.peek()
773
 
        ld.unlock()
774
 
        LockDir.hooks.install_named_hook('lock_broken',
775
 
                                         self.record_hook, 'record_hook')
776
 
        ld2.force_break(holder_info)
777
 
        lock_path = ld.transport.abspath(ld.path)
778
 
        self.assertEqual([], self._calls)