← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_lockdir.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-09-01 08:02:42 UTC
  • mfrom: (5390.3.3 faster-revert-593560)
  • Revision ID: pqm@pqm.ubuntu.com-20100901080242-esg62ody4frwmy66
(spiv) Avoid repeatedly calling self.target.all_file_ids() in
 InterTree.iter_changes. (Andrew Bennetts)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_lockdir.py
1
 
# Copyright (C) 2006-2011 Canonical Ltd
 
1
# Copyright (C) 2006-2010 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
16
16
 
17
17
"""Tests for LockDir"""
18
18
 
 
19
from cStringIO import StringIO
19
20
import os
 
21
from threading import Thread, Lock
20
22
import time
21
23
 
22
24
import bzrlib
24
26
    config,
25
27
    errors,
26
28
    lock,
27
 
    lockdir,
28
29
    osutils,
29
30
    tests,
30
31
    transport,
33
34
    LockBreakMismatch,
34
35
    LockBroken,
35
36
    LockContention,
 
37
    LockError,
36
38
    LockFailed,
37
39
    LockNotHeld,
38
40
    )
39
 
from bzrlib.lockdir import (
40
 
    LockDir,
41
 
    LockHeldInfo,
42
 
    )
43
 
from bzrlib.tests import (
44
 
    features,
45
 
    TestCase,
46
 
    TestCaseInTempDir,
47
 
    TestCaseWithTransport,
48
 
    )
 
41
from bzrlib.lockdir import LockDir
 
42
from bzrlib.tests import TestCaseWithTransport
 
43
from bzrlib.trace import note
 
44
 
 
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
48
 
50
49
# These tests are run on the default transport provided by the test framework
51
50
# (typically a local disk transport).  That can be changed by the --transport
53
52
# implementation are tested separately.  (The main requirement is just that
54
53
# they don't allow overwriting nonempty directories.)
55
54
 
56
 
 
57
55
class TestLockDir(TestCaseWithTransport):
58
56
    """Test LockDir operations"""
59
57
 
147
145
        self.addCleanup(lf1.unlock)
148
146
        # lock is held, should get some info on it
149
147
        info1 = lf1.peek()
150
 
        self.assertEqual(set(info1.info_dict.keys()),
151
 
            set(['user', 'nonce', 'hostname', 'pid', 'start_time']))
 
148
        self.assertEqual(set(info1.keys()),
 
149
                         set(['user', 'nonce', 'hostname', 'pid', 'start_time']))
152
150
        # should get the same info if we look at it through a different
153
151
        # instance
154
152
        info2 = LockDir(t, 'test_lock').peek()
167
165
        self.addCleanup(lf1.unlock)
168
166
        info2 = lf2.peek()
169
167
        self.assertTrue(info2)
170
 
        self.assertEqual(info2.get('nonce'), lf1.nonce)
 
168
        self.assertEqual(info2['nonce'], lf1.nonce)
171
169
 
172
170
    def test_30_lock_wait_fail(self):
173
171
        """Wait on a lock, then fail
190
188
            # it should only take about 0.4 seconds, but we allow more time in
191
189
            # case the machine is heavily loaded
192
190
            self.assertTrue(after - before <= 8.0,
193
 
                "took %f seconds to detect lock contention" % (after - before))
 
191
                    "took %f seconds to detect lock contention" % (after - before))
194
192
        finally:
195
193
            lf1.unlock()
196
194
        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.')
 
195
        self.assertEqual(self._logged_reports[0][0],
 
196
            '%s lock %s held by %s\n'
 
197
            'at %s [process #%s], acquired %s.\n'
 
198
            'Will continue to try until %s, unless '
 
199
            'you press Ctrl-C.\n'
 
200
            'See "bzr help break-lock" for more.')
 
201
        start, lock_url, user, hostname, pid, time_ago, deadline_str = \
 
202
            self._logged_reports[0][1]
 
203
        self.assertEqual(start, u'Unable to obtain')
 
204
        self.assertEqual(user, u'jrandom@example.com')
 
205
        # skip hostname
 
206
        self.assertContainsRe(pid, r'\d+')
 
207
        self.assertContainsRe(time_ago, r'.* ago')
 
208
        self.assertContainsRe(deadline_str, r'\d{2}:\d{2}:\d{2}')
203
209
 
204
210
    def test_31_lock_wait_easy(self):
205
211
        """Succeed when waiting on a lock with no contention.
217
223
            lf1.unlock()
218
224
        self.assertEqual([], self._logged_reports)
219
225
 
 
226
    def test_32_lock_wait_succeed(self):
 
227
        """Succeed when trying to acquire a lock that gets released
 
228
 
 
229
        One thread holds on a lock and then releases it; another
 
230
        tries to lock it.
 
231
        """
 
232
        # This test sometimes fails like this:
 
233
        # Traceback (most recent call last):
 
234
 
 
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:
 
239
        # a = 1
 
240
        # b = 0
 
241
        raise tests.TestSkipped("Test fails intermittently")
 
242
        t = self.get_transport()
 
243
        lf1 = LockDir(t, 'test_lock')
 
244
        lf1.create()
 
245
        lf1.attempt_lock()
 
246
 
 
247
        def wait_and_unlock():
 
248
            time.sleep(0.1)
 
249
            lf1.unlock()
 
250
        unlocker = Thread(target=wait_and_unlock)
 
251
        unlocker.start()
 
252
        try:
 
253
            lf2 = LockDir(t, 'test_lock')
 
254
            self.setup_log_reporter(lf2)
 
255
            before = time.time()
 
256
            # wait and then lock
 
257
            lf2.wait_lock(timeout=0.4, poll=0.1)
 
258
            after = time.time()
 
259
            self.assertTrue(after - before <= 1.0)
 
260
        finally:
 
261
            unlocker.join()
 
262
 
 
263
        # There should be only 1 report, even though it should have to
 
264
        # wait for a while
 
265
        lock_base = lf2.transport.abspath(lf2.path)
 
266
        self.assertEqual(1, len(self._logged_reports))
 
267
        self.assertEqual('%s %s\n'
 
268
                         '%s\n%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')
 
278
 
 
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')
 
287
        lf1.create()
 
288
        lf1.attempt_lock()
 
289
 
 
290
        def wait_and_unlock():
 
291
            time.sleep(0.1)
 
292
            lf1.unlock()
 
293
        unlocker = Thread(target=wait_and_unlock)
 
294
        unlocker.start()
 
295
        try:
 
296
            lf2 = LockDir(t, 'test_lock')
 
297
            self.setup_log_reporter(lf2)
 
298
            before = time.time()
 
299
            # wait and then lock
 
300
            lf2.lock_write()
 
301
            after = time.time()
 
302
        finally:
 
303
            unlocker.join()
 
304
 
 
305
        # There should be only 1 report, even though it should have to
 
306
        # wait for a while
 
307
        lock_base = lf2.transport.abspath(lf2.path)
 
308
        self.assertEqual(1, len(self._logged_reports))
 
309
        self.assertEqual('%s %s\n'
 
310
                         '%s\n%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')
 
320
 
 
321
    def test_35_wait_lock_changing(self):
 
322
        """LockDir.wait_lock() will report if the lock changes underneath.
 
323
 
 
324
        This is the stages we want to happen:
 
325
 
 
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'
 
333
           lock.
 
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
 
336
           lock holder.
 
337
        5) Thread1 blocks on the 'checked' lock, this time, it completely
 
338
           unlocks the lockdir, allowing Lock2 to acquire the lock.
 
339
        """
 
340
 
 
341
        raise tests.KnownFailure(
 
342
            "timing dependency in lock tests (#213182)")
 
343
 
 
344
        wait_to_check_lock = Lock()
 
345
        wait_until_checked_lock = Lock()
 
346
 
 
347
        wait_to_check_lock.acquire()
 
348
        wait_until_checked_lock.acquire()
 
349
        note('locked check and checked locks')
 
350
 
 
351
        class LockDir1(LockDir):
 
352
            """Use the synchronization points for the first lock."""
 
353
 
 
354
            def attempt_lock(self):
 
355
                # Once we have acquired the lock, it is okay for
 
356
                # the other lock to check it
 
357
                try:
 
358
                    return super(LockDir1, self).attempt_lock()
 
359
                finally:
 
360
                    note('lock1: releasing check lock')
 
361
                    wait_to_check_lock.release()
 
362
 
 
363
        class LockDir2(LockDir):
 
364
            """Use the synchronization points for the second lock."""
 
365
 
 
366
            def attempt_lock(self):
 
367
                note('lock2: waiting for check lock')
 
368
                wait_to_check_lock.acquire()
 
369
                note('lock2: acquired check lock')
 
370
                try:
 
371
                    return super(LockDir2, self).attempt_lock()
 
372
                finally:
 
373
                    note('lock2: releasing checked lock')
 
374
                    wait_until_checked_lock.release()
 
375
 
 
376
        t = self.get_transport()
 
377
        lf1 = LockDir1(t, 'test_lock')
 
378
        lf1.create()
 
379
 
 
380
        lf2 = LockDir2(t, 'test_lock')
 
381
        self.setup_log_reporter(lf2)
 
382
 
 
383
        def wait_and_switch():
 
384
            lf1.attempt_lock()
 
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')
 
390
            lf1.unlock()
 
391
            note('lock1: acquiring lockdir')
 
392
            # Create a new nonce, so the lock looks different.
 
393
            lf1.nonce = osutils.rand_chars(20)
 
394
            lf1.lock_write()
 
395
            note('lock1: acquired lockdir')
 
396
 
 
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
 
402
            lf1.unlock()
 
403
            wait_to_check_lock.release()
 
404
 
 
405
        unlocker = Thread(target=wait_and_switch)
 
406
        unlocker.start()
 
407
        try:
 
408
            # Wait and play against the other thread
 
409
            lf2.wait_lock(timeout=20.0, poll=0.01)
 
410
        finally:
 
411
            unlocker.join()
 
412
        lf2.unlock()
 
413
 
 
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'
 
419
                         '%s\n%s\n'
 
420
                         'Will continue to try until %s, unless '
 
421
                         'you press Ctrl-C.\n'
 
422
                         'See "bzr help break-lock" for more.',
 
423
                         self._logged_reports[0][0])
 
424
        args = self._logged_reports[0][1]
 
425
        self.assertEqual('Unable to obtain', args[0])
 
426
        self.assertEqual('lock %s' % (lock_base,), args[1])
 
427
        self.assertStartsWith(args[2], 'held by ')
 
428
        self.assertStartsWith(args[3], 'locked ')
 
429
        self.assertEndsWith(args[3], ' ago')
 
430
        self.assertContainsRe(args[4], r'\d\d:\d\d:\d\d')
 
431
 
 
432
        self.assertEqual('%s %s\n'
 
433
                         '%s\n%s\n'
 
434
                         'Will continue to try until %s, unless '
 
435
                         'you press Ctrl-C.\n'
 
436
                         'See "bzr help break-lock" for more.',
 
437
                         self._logged_reports[1][0])
 
438
        args = self._logged_reports[1][1]
 
439
        self.assertEqual('Lock owner changed for', args[0])
 
440
        self.assertEqual('lock %s' % (lock_base,), args[1])
 
441
        self.assertStartsWith(args[2], 'held by ')
 
442
        self.assertStartsWith(args[3], 'locked ')
 
443
        self.assertEndsWith(args[3], ' ago')
 
444
        self.assertContainsRe(args[4], r'\d\d:\d\d:\d\d')
 
445
 
220
446
    def test_40_confirm_easy(self):
221
447
        """Confirm a lock that's already held"""
222
448
        t = self.get_transport()
338
564
        finally:
339
565
            bzrlib.ui.ui_factory = orig_factory
340
566
 
341
 
    def test_break_lock_corrupt_info(self):
342
 
        """break_lock works even if the info file is corrupt (and tells the UI
343
 
        that it is corrupt).
344
 
        """
345
 
        ld = self.get_lock()
346
 
        ld2 = self.get_lock()
347
 
        ld.create()
348
 
        ld.lock_write()
349
 
        ld.transport.put_bytes_non_atomic('test_lock/held/info', '\0')
350
 
 
351
 
        class LoggingUIFactory(bzrlib.ui.SilentUIFactory):
352
 
            def __init__(self):
353
 
                self.prompts = []
354
 
 
355
 
            def get_boolean(self, prompt):
356
 
                self.prompts.append(('boolean', prompt))
357
 
                return True
358
 
 
359
 
        ui = LoggingUIFactory()
360
 
        self.overrideAttr(bzrlib.ui, 'ui_factory', ui)
361
 
        ld2.break_lock()
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)
366
 
 
367
 
    def test_break_lock_missing_info(self):
368
 
        """break_lock works even if the info file is missing (and tells the UI
369
 
        that it is corrupt).
370
 
        """
371
 
        ld = self.get_lock()
372
 
        ld2 = self.get_lock()
373
 
        ld.create()
374
 
        ld.lock_write()
375
 
        ld.transport.delete('test_lock/held/info')
376
 
 
377
 
        class LoggingUIFactory(bzrlib.ui.SilentUIFactory):
378
 
            def __init__(self):
379
 
                self.prompts = []
380
 
 
381
 
            def get_boolean(self, prompt):
382
 
                self.prompts.append(('boolean', prompt))
383
 
                return True
384
 
 
385
 
        ui = LoggingUIFactory()
386
 
        orig_factory = bzrlib.ui.ui_factory
387
 
        bzrlib.ui.ui_factory = ui
388
 
        try:
389
 
            ld2.break_lock()
390
 
            self.assertRaises(LockBroken, ld.unlock)
391
 
            self.assertLength(0, ui.prompts)
392
 
        finally:
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[:]
398
 
 
399
567
    def test_create_missing_base_directory(self):
400
568
        """If LockDir.path doesn't exist, it can be created
401
569
 
407
575
        lf1 = LockDir(t, 'test_lock')
408
576
 
409
577
        lf1.create()
410
 
        self.assertTrue(t.has('test_lock'))
 
578
        self.failUnless(t.has('test_lock'))
411
579
 
412
580
        t.rmdir('test_lock')
413
 
        self.assertFalse(t.has('test_lock'))
 
581
        self.failIf(t.has('test_lock'))
414
582
 
415
583
        # This will create 'test_lock' if it needs to
416
584
        lf1.lock_write()
417
 
        self.assertTrue(t.has('test_lock'))
418
 
        self.assertTrue(t.has('test_lock/held/info'))
 
585
        self.failUnless(t.has('test_lock'))
 
586
        self.failUnless(t.has('test_lock/held/info'))
419
587
 
420
588
        lf1.unlock()
421
 
        self.assertFalse(t.has('test_lock/held/info'))
 
589
        self.failIf(t.has('test_lock/held/info'))
422
590
 
423
 
    def test_display_form(self):
 
591
    def test__format_lock_info(self):
424
592
        ld1 = self.get_lock()
425
593
        ld1.create()
426
594
        ld1.lock_write()
427
595
        try:
428
 
            info_list = ld1.peek().to_readable_dict()
 
596
            info_list = ld1._format_lock_info(ld1.peek())
429
597
        finally:
430
598
            ld1.unlock()
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$')
 
599
        self.assertEqual(info_list[0], u'jrandom@example.com')
 
600
        # info_list[1] is hostname. we skip this.
 
601
        self.assertContainsRe(info_list[2], '^\d+$') # pid
 
602
        self.assertContainsRe(info_list[3], r'^\d+ seconds? ago$') # time_ago
434
603
 
435
604
    def test_lock_without_email(self):
436
 
        global_config = config.GlobalStack()
 
605
        global_config = config.GlobalConfig()
437
606
        # Intentionally has no email address
438
 
        global_config.set('email', 'User Identity')
 
607
        global_config.set_user_option('email', 'User Identity')
439
608
        ld1 = self.get_lock()
440
609
        ld1.create()
441
610
        ld1.lock_write()
442
611
        ld1.unlock()
443
612
 
444
613
    def test_lock_permission(self):
445
 
        self.requireFeature(features.not_running_as_root)
446
614
        if not osutils.supports_posix_readonly():
447
615
            raise tests.TestSkipped('Cannot induce a permission failure')
448
616
        ld1 = self.get_lock()
464
632
    def test_lock_with_buggy_rename(self):
465
633
        # test that lock acquisition handles servers which pretend they
466
634
        # renamed correctly but that actually fail
467
 
        t = transport.get_transport_from_url(
468
 
            'brokenrename+' + self.get_url())
 
635
        t = transport.get_transport('brokenrename+' + self.get_url())
469
636
        ld1 = LockDir(t, 'test_lock')
470
637
        ld1.create()
471
638
        ld1.attempt_lock()
485
652
        # should be nothing before we start
486
653
        ld1.create()
487
654
        t = self.get_transport().clone('test_lock')
488
 
 
489
655
        def check_dir(a):
490
656
            self.assertEquals(a, t.list_dir('.'))
491
 
 
492
657
        check_dir([])
493
658
        # when held, that's all we see
494
659
        ld1.attempt_lock()
511
676
        t.put_bytes('test_lock/held/info', '')
512
677
        lf = LockDir(t, 'test_lock')
513
678
        info = lf.peek()
514
 
        formatted_info = info.to_readable_dict()
 
679
        formatted_info = lf._format_lock_info(info)
515
680
        self.assertEquals(
516
 
            dict(user='<unknown>', hostname='<unknown>', pid='<unknown>',
517
 
                time_ago='(unknown)'),
 
681
            ['<unknown>', '<unknown>', '<unknown>', '(unknown)'],
518
682
            formatted_info)
519
683
 
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()
527
 
        t.mkdir('test_lock')
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.
534
 
        self.assertRaises(
535
 
            (errors.LockCorrupt, errors.LockContention), lf.attempt_lock)
536
 
        self.assertRaises(errors.LockCorrupt, lf.validate_token, 'fake token')
537
 
 
538
 
    def test_missing_lockdir_info(self):
539
 
        """We can cope with absent info files."""
540
 
        t = self.get_transport()
541
 
        t.mkdir('test_lock')
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
546
 
        # 'info' file.
547
 
        self.assertEqual(None, lf.peek())
548
 
        # And lock/unlock may work or give LockContention (but not any other
549
 
        # error).
550
 
        try:
551
 
            lf.attempt_lock()
552
 
        except LockContention:
553
 
            # LockContention is ok, and expected on Windows
554
 
            pass
555
 
        else:
556
 
            # no error is ok, and expected on POSIX (because POSIX allows
557
 
            # os.rename over an empty directory).
558
 
            lf.unlock()
559
 
        # Currently raises TokenMismatch, but LockCorrupt would be reasonable
560
 
        # too.
561
 
        self.assertRaises(
562
 
            (errors.TokenMismatch, errors.LockCorrupt),
563
 
            lf.validate_token, 'fake token')
564
 
 
565
684
 
566
685
class TestLockDirHooks(TestCaseWithTransport):
567
686
 
653
772
        ld2.force_break(holder_info)
654
773
        lock_path = ld.transport.abspath(ld.path)
655
774
        self.assertEqual([], self._calls)
656
 
 
657
 
 
658
 
class TestLockHeldInfo(TestCaseInTempDir):
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
 
        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())
692
 
 
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())
699
 
 
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())
706
 
 
707
 
    def test_no_good_hostname(self):
708
 
        """Correctly handle ambiguous hostnames.
709
 
 
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
713
 
        known for sure.
714
 
        """
715
 
        self.overrideAttr(lockdir, 'get_host_name',
716
 
            lambda: 'localhost')
717
 
        info = LockHeldInfo.for_this_process(None)
718
 
        info.info_dict['pid'] = '123123123'
719
 
        self.assertFalse(info.is_lock_holder_known_dead())
720
 
 
721
 
 
722
 
class TestStaleLockDir(TestCaseWithTransport):
723
 
    """Can automatically break stale locks.
724
 
 
725
 
    :see: https://bugs.launchpad.net/bzr/+bug/220464
726
 
    """
727
 
 
728
 
    def test_auto_break_stale_lock(self):
729
 
        """Locks safely known to be stale are just cleaned up.
730
 
 
731
 
        This generates a warning but no other user interaction.
732
 
        """
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,
747
 
            l1.unlock)
748
 
        l2.unlock()
749
 
 
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,
759
 
            l2.attempt_lock)
760
 
        # and it's in fact not broken
761
 
        l1.confirm()