/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_lockdir.py

  • Committer: Vincent Ladeuil
  • Date: 2011-07-06 09:22:00 UTC
  • mfrom: (6008 +trunk)
  • mto: (6012.1.1 trunk)
  • mto: This revision was merged to the branch mainline in revision 6013.
  • Revision ID: v.ladeuil+lp@free.fr-20110706092200-7iai2mwzc0sqdsvf
MergingĀ inĀ trunk

Show diffs side-by-side

added added

removed removed

Lines of Context:
17
17
"""Tests for LockDir"""
18
18
 
19
19
import os
20
 
from threading import Thread, Lock
 
20
import sys
21
21
import time
22
22
 
23
23
import bzrlib
25
25
    config,
26
26
    errors,
27
27
    lock,
 
28
    lockdir,
28
29
    osutils,
29
30
    tests,
30
31
    transport,
36
37
    LockFailed,
37
38
    LockNotHeld,
38
39
    )
39
 
from bzrlib.lockdir import LockDir
 
40
from bzrlib.lockdir import (
 
41
    LockDir,
 
42
    LockHeldInfo,
 
43
    )
40
44
from bzrlib.tests import (
41
45
    features,
 
46
    TestCase,
42
47
    TestCaseWithTransport,
43
48
    )
44
49
from bzrlib.trace import note
45
50
 
46
 
# These tests sometimes use threads to test the behaviour of lock files with
47
 
# concurrent actors.  This is not a typical (or necessarily supported) use;
48
 
# they're really meant for guarding between processes.
49
 
 
50
51
# These tests are run on the default transport provided by the test framework
51
52
# (typically a local disk transport).  That can be changed by the --transport
52
53
# option to bzr selftest.  The required properties of the transport
53
54
# implementation are tested separately.  (The main requirement is just that
54
55
# they don't allow overwriting nonempty directories.)
55
56
 
 
57
 
56
58
class TestLockDir(TestCaseWithTransport):
57
59
    """Test LockDir operations"""
58
60
 
146
148
        self.addCleanup(lf1.unlock)
147
149
        # lock is held, should get some info on it
148
150
        info1 = lf1.peek()
149
 
        self.assertEqual(set(info1.keys()),
150
 
                         set(['user', 'nonce', 'hostname', 'pid', 'start_time']))
 
151
        self.assertEqual(set(info1.info_dict.keys()),
 
152
            set(['user', 'nonce', 'hostname', 'pid', 'start_time']))
151
153
        # should get the same info if we look at it through a different
152
154
        # instance
153
155
        info2 = LockDir(t, 'test_lock').peek()
166
168
        self.addCleanup(lf1.unlock)
167
169
        info2 = lf2.peek()
168
170
        self.assertTrue(info2)
169
 
        self.assertEqual(info2['nonce'], lf1.nonce)
 
171
        self.assertEqual(info2.get('nonce'), lf1.nonce)
170
172
 
171
173
    def test_30_lock_wait_fail(self):
172
174
        """Wait on a lock, then fail
189
191
            # it should only take about 0.4 seconds, but we allow more time in
190
192
            # case the machine is heavily loaded
191
193
            self.assertTrue(after - before <= 8.0,
192
 
                    "took %f seconds to detect lock contention" % (after - before))
 
194
                "took %f seconds to detect lock contention" % (after - before))
193
195
        finally:
194
196
            lf1.unlock()
195
197
        self.assertEqual(1, len(self._logged_reports))
196
 
        self.assertEqual(self._logged_reports[0][0],
197
 
            '%s lock %s held by %s\n'
198
 
            'at %s [process #%s], acquired %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
 
        start, lock_url, user, hostname, pid, time_ago, deadline_str = \
203
 
            self._logged_reports[0][1]
204
 
        self.assertEqual(start, u'Unable to obtain')
205
 
        self.assertEqual(user, u'jrandom@example.com')
206
 
        # skip hostname
207
 
        self.assertContainsRe(pid, r'\d+')
208
 
        self.assertContainsRe(time_ago, r'.* ago')
209
 
        self.assertContainsRe(deadline_str, r'\d{2}:\d{2}:\d{2}')
 
198
        self.assertContainsRe(self._logged_reports[0][0],
 
199
            r'Unable to obtain lock .* held by jrandom@example\.com on .*'
 
200
            r' \(process #\d+\), acquired .* ago\.\n'
 
201
            r'Will continue to try until \d{2}:\d{2}:\d{2}, unless '
 
202
            r'you press Ctrl-C.\n'
 
203
            r'See "bzr help break-lock" for more.')
210
204
 
211
205
    def test_31_lock_wait_easy(self):
212
206
        """Succeed when waiting on a lock with no contention.
224
218
            lf1.unlock()
225
219
        self.assertEqual([], self._logged_reports)
226
220
 
227
 
    def test_32_lock_wait_succeed(self):
228
 
        """Succeed when trying to acquire a lock that gets released
229
 
 
230
 
        One thread holds on a lock and then releases it; another
231
 
        tries to lock it.
232
 
        """
233
 
        # This test sometimes fails like this:
234
 
        # Traceback (most recent call last):
235
 
 
236
 
        #   File "/home/pqm/bzr-pqm-workdir/home/+trunk/bzrlib/tests/
237
 
        # test_lockdir.py", line 247, in test_32_lock_wait_succeed
238
 
        #     self.assertEqual(1, len(self._logged_reports))
239
 
        # AssertionError: not equal:
240
 
        # a = 1
241
 
        # b = 0
242
 
        raise tests.TestSkipped("Test fails intermittently")
243
 
        t = self.get_transport()
244
 
        lf1 = LockDir(t, 'test_lock')
245
 
        lf1.create()
246
 
        lf1.attempt_lock()
247
 
 
248
 
        def wait_and_unlock():
249
 
            time.sleep(0.1)
250
 
            lf1.unlock()
251
 
        unlocker = Thread(target=wait_and_unlock)
252
 
        unlocker.start()
253
 
        try:
254
 
            lf2 = LockDir(t, 'test_lock')
255
 
            self.setup_log_reporter(lf2)
256
 
            before = time.time()
257
 
            # wait and then lock
258
 
            lf2.wait_lock(timeout=0.4, poll=0.1)
259
 
            after = time.time()
260
 
            self.assertTrue(after - before <= 1.0)
261
 
        finally:
262
 
            unlocker.join()
263
 
 
264
 
        # There should be only 1 report, even though it should have to
265
 
        # wait for a while
266
 
        lock_base = lf2.transport.abspath(lf2.path)
267
 
        self.assertEqual(1, len(self._logged_reports))
268
 
        self.assertEqual('%s %s\n'
269
 
                         '%s\n%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')
279
 
 
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
286
 
        t = self.get_transport()
287
 
        lf1 = LockDir(t, 'test_lock')
288
 
        lf1.create()
289
 
        lf1.attempt_lock()
290
 
 
291
 
        def wait_and_unlock():
292
 
            time.sleep(0.1)
293
 
            lf1.unlock()
294
 
        unlocker = Thread(target=wait_and_unlock)
295
 
        unlocker.start()
296
 
        try:
297
 
            lf2 = LockDir(t, 'test_lock')
298
 
            self.setup_log_reporter(lf2)
299
 
            before = time.time()
300
 
            # wait and then lock
301
 
            lf2.lock_write()
302
 
            after = time.time()
303
 
        finally:
304
 
            unlocker.join()
305
 
 
306
 
        # There should be only 1 report, even though it should have to
307
 
        # wait for a while
308
 
        lock_base = lf2.transport.abspath(lf2.path)
309
 
        self.assertEqual(1, len(self._logged_reports))
310
 
        self.assertEqual('%s %s\n'
311
 
                         '%s\n%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')
321
 
 
322
 
    def test_35_wait_lock_changing(self):
323
 
        """LockDir.wait_lock() will report if the lock changes underneath.
324
 
 
325
 
        This is the stages we want to happen:
326
 
 
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'
334
 
           lock.
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
337
 
           lock holder.
338
 
        5) Thread1 blocks on the 'checked' lock, this time, it completely
339
 
           unlocks the lockdir, allowing Lock2 to acquire the lock.
340
 
        """
341
 
 
342
 
        raise tests.KnownFailure(
343
 
            "timing dependency in lock tests (#213182)")
344
 
 
345
 
        wait_to_check_lock = Lock()
346
 
        wait_until_checked_lock = Lock()
347
 
 
348
 
        wait_to_check_lock.acquire()
349
 
        wait_until_checked_lock.acquire()
350
 
        note('locked check and checked locks')
351
 
 
352
 
        class LockDir1(LockDir):
353
 
            """Use the synchronization points for the first lock."""
354
 
 
355
 
            def attempt_lock(self):
356
 
                # Once we have acquired the lock, it is okay for
357
 
                # the other lock to check it
358
 
                try:
359
 
                    return super(LockDir1, self).attempt_lock()
360
 
                finally:
361
 
                    note('lock1: releasing check lock')
362
 
                    wait_to_check_lock.release()
363
 
 
364
 
        class LockDir2(LockDir):
365
 
            """Use the synchronization points for the second lock."""
366
 
 
367
 
            def attempt_lock(self):
368
 
                note('lock2: waiting for check lock')
369
 
                wait_to_check_lock.acquire()
370
 
                note('lock2: acquired check lock')
371
 
                try:
372
 
                    return super(LockDir2, self).attempt_lock()
373
 
                finally:
374
 
                    note('lock2: releasing checked lock')
375
 
                    wait_until_checked_lock.release()
376
 
 
377
 
        t = self.get_transport()
378
 
        lf1 = LockDir1(t, 'test_lock')
379
 
        lf1.create()
380
 
 
381
 
        lf2 = LockDir2(t, 'test_lock')
382
 
        self.setup_log_reporter(lf2)
383
 
 
384
 
        def wait_and_switch():
385
 
            lf1.attempt_lock()
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')
391
 
            lf1.unlock()
392
 
            note('lock1: acquiring lockdir')
393
 
            # Create a new nonce, so the lock looks different.
394
 
            lf1.nonce = osutils.rand_chars(20)
395
 
            lf1.lock_write()
396
 
            note('lock1: acquired lockdir')
397
 
 
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
403
 
            lf1.unlock()
404
 
            wait_to_check_lock.release()
405
 
 
406
 
        unlocker = Thread(target=wait_and_switch)
407
 
        unlocker.start()
408
 
        try:
409
 
            # Wait and play against the other thread
410
 
            lf2.wait_lock(timeout=20.0, poll=0.01)
411
 
        finally:
412
 
            unlocker.join()
413
 
        lf2.unlock()
414
 
 
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'
420
 
                         '%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.',
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')
432
 
 
433
 
        self.assertEqual('%s %s\n'
434
 
                         '%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.',
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')
446
 
 
447
221
    def test_40_confirm_easy(self):
448
222
        """Confirm a lock that's already held"""
449
223
        t = self.get_transport()
574
348
        ld.create()
575
349
        ld.lock_write()
576
350
        ld.transport.put_bytes_non_atomic('test_lock/held/info', '\0')
 
351
 
577
352
        class LoggingUIFactory(bzrlib.ui.SilentUIFactory):
578
353
            def __init__(self):
579
354
                self.prompts = []
 
355
 
580
356
            def get_boolean(self, prompt):
581
357
                self.prompts.append(('boolean', prompt))
582
358
                return True
 
359
 
583
360
        ui = LoggingUIFactory()
584
361
        self.overrideAttr(bzrlib.ui, 'ui_factory', ui)
585
362
        ld2.break_lock()
597
374
        ld.create()
598
375
        ld.lock_write()
599
376
        ld.transport.delete('test_lock/held/info')
 
377
 
600
378
        class LoggingUIFactory(bzrlib.ui.SilentUIFactory):
601
379
            def __init__(self):
602
380
                self.prompts = []
 
381
 
603
382
            def get_boolean(self, prompt):
604
383
                self.prompts.append(('boolean', prompt))
605
384
                return True
 
385
 
606
386
        ui = LoggingUIFactory()
607
387
        orig_factory = bzrlib.ui.ui_factory
608
388
        bzrlib.ui.ui_factory = ui
641
421
        lf1.unlock()
642
422
        self.assertFalse(t.has('test_lock/held/info'))
643
423
 
644
 
    def test__format_lock_info(self):
 
424
    def test_display_form(self):
645
425
        ld1 = self.get_lock()
646
426
        ld1.create()
647
427
        ld1.lock_write()
648
428
        try:
649
 
            info_list = ld1._format_lock_info(ld1.peek())
 
429
            info_list = ld1.peek().to_readable_dict()
650
430
        finally:
651
431
            ld1.unlock()
652
 
        self.assertEqual(info_list[0], u'jrandom@example.com')
653
 
        # info_list[1] is hostname. we skip this.
654
 
        self.assertContainsRe(info_list[2], '^\d+$') # pid
655
 
        self.assertContainsRe(info_list[3], r'^\d+ seconds? ago$') # time_ago
 
432
        self.assertEqual(info_list['user'], u'jrandom@example.com')
 
433
        self.assertContainsRe(info_list['pid'], '^\d+$')
 
434
        self.assertContainsRe(info_list['time_ago'], r'^\d+ seconds? ago$')
656
435
 
657
436
    def test_lock_without_email(self):
658
437
        global_config = config.GlobalConfig()
706
485
        # should be nothing before we start
707
486
        ld1.create()
708
487
        t = self.get_transport().clone('test_lock')
 
488
 
709
489
        def check_dir(a):
710
490
            self.assertEquals(a, t.list_dir('.'))
 
491
 
711
492
        check_dir([])
712
493
        # when held, that's all we see
713
494
        ld1.attempt_lock()
730
511
        t.put_bytes('test_lock/held/info', '')
731
512
        lf = LockDir(t, 'test_lock')
732
513
        info = lf.peek()
733
 
        formatted_info = lf._format_lock_info(info)
 
514
        formatted_info = info.to_readable_dict()
734
515
        self.assertEquals(
735
 
            ['<unknown>', '<unknown>', '<unknown>', '(unknown)'],
 
516
            dict(user='<unknown>', hostname='<unknown>', pid='<unknown>',
 
517
                time_ago='(unknown)'),
736
518
            formatted_info)
737
519
 
738
520
    def test_corrupt_lockdir_info(self):
871
653
        ld2.force_break(holder_info)
872
654
        lock_path = ld.transport.abspath(ld.path)
873
655
        self.assertEqual([], self._calls)
 
656
 
 
657
 
 
658
class TestLockHeldInfo(TestCase):
 
659
    """Can get information about the lock holder, and detect whether they're
 
660
    still alive."""
 
661
 
 
662
    def test_repr(self):
 
663
        info = LockHeldInfo.for_this_process(None)
 
664
        self.assertContainsRe(repr(info), r"LockHeldInfo\(.*\)")
 
665
 
 
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')
 
670
 
 
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())
 
674
 
 
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())
 
679
 
 
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())
 
684
 
 
685
    def test_lock_holder_dead_process(self):
 
686
        """Detect that the holder (this process) is still running."""
 
687
        info = LockHeldInfo.for_this_process(None)
 
688
        info.info_dict['pid'] = '123123123'
 
689
        if sys.platform == 'win32':
 
690
            self.knownFailure(
 
691
                'live lock holder detection not implemented yet on win32')
 
692
        self.assertTrue(info.is_lock_holder_known_dead())
 
693
 
 
694
    def test_lock_holder_other_machine(self):
 
695
        """The lock holder isn't here so we don't know if they're alive."""
 
696
        info = LockHeldInfo.for_this_process(None)
 
697
        info.info_dict['hostname'] = 'egg.example.com'
 
698
        info.info_dict['pid'] = '123123123'
 
699
        self.assertFalse(info.is_lock_holder_known_dead())
 
700
 
 
701
    def test_lock_holder_other_user(self):
 
702
        """Only auto-break locks held by this user."""
 
703
        info = LockHeldInfo.for_this_process(None)
 
704
        info.info_dict['user'] = 'notme@example.com'
 
705
        info.info_dict['pid'] = '123123123'
 
706
        self.assertFalse(info.is_lock_holder_known_dead())
 
707
 
 
708
    def test_no_good_hostname(self):
 
709
        """Correctly handle ambiguous hostnames.
 
710
 
 
711
        If the lock's recorded with just 'localhost' we can't really trust
 
712
        it's the same 'localhost'.  (There are quite a few of them. :-)
 
713
        So even if the process is known not to be alive, we can't say that's
 
714
        known for sure.
 
715
        """
 
716
        self.overrideAttr(lockdir, 'get_host_name',
 
717
            lambda: 'localhost')
 
718
        info = LockHeldInfo.for_this_process(None)
 
719
        info.info_dict['pid'] = '123123123'
 
720
        self.assertFalse(info.is_lock_holder_known_dead())
 
721
 
 
722
 
 
723
class TestStaleLockDir(TestCaseWithTransport):
 
724
    """Can automatically break stale locks.
 
725
 
 
726
    :see: https://bugs.launchpad.net/bzr/+bug/220464
 
727
    """
 
728
 
 
729
    def test_auto_break_stale_lock(self):
 
730
        """Locks safely known to be stale are just cleaned up.
 
731
 
 
732
        This generates a warning but no other user interaction.
 
733
        """
 
734
        # This is off by default at present; see the discussion in the bug.
 
735
        # If you change the default, don't forget to update the docs.
 
736
        config.GlobalConfig().set_user_option('locks.steal_dead', True)
 
737
        # Create a lock pretending to come from a different nonexistent
 
738
        # process on the same machine.
 
739
        l1 = LockDir(self.get_transport(), 'a',
 
740
            extra_holder_info={'pid': '12312313'})
 
741
        token_1 = l1.attempt_lock()
 
742
        l2 = LockDir(self.get_transport(), 'a')
 
743
        token_2 = l2.attempt_lock()
 
744
        # l1 will notice its lock was stolen.
 
745
        self.assertRaises(errors.LockBroken,
 
746
            l1.unlock)
 
747
        l2.unlock()
 
748
 
 
749
    def test_auto_break_stale_lock_configured_off(self):
 
750
        """Automatic breaking can be turned off"""
 
751
        l1 = LockDir(self.get_transport(), 'a',
 
752
            extra_holder_info={'pid': '12312313'})
 
753
        token_1 = l1.attempt_lock()
 
754
        self.addCleanup(l1.unlock)
 
755
        l2 = LockDir(self.get_transport(), 'a')
 
756
        # This fails now, because dead lock breaking is off by default.
 
757
        self.assertRaises(LockContention,
 
758
            l2.attempt_lock)
 
759
        # and it's in fact not broken
 
760
        l1.confirm()