← 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-05-11 11:47:36 UTC
  • mfrom: (5200.3.8 lock_return)
  • Revision ID: pqm@pqm.ubuntu.com-20100511114736-mc1sq9zyo3vufec7
(lifeless) Provide a consistent interface to Tree, Branch,
 Repository where lock methods return an object with an unlock method to
 unlock the lock. This breaks the API for Branch,
 Repository on their lock_write methods. (Robert Collins)

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
 
    TestCaseWithTransport,
47
 
    )
 
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.
48
48
 
49
49
# These tests are run on the default transport provided by the test framework
50
50
# (typically a local disk transport).  That can be changed by the --transport
52
52
# implementation are tested separately.  (The main requirement is just that
53
53
# they don't allow overwriting nonempty directories.)
54
54
 
55
 
 
56
55
class TestLockDir(TestCaseWithTransport):
57
56
    """Test LockDir operations"""
58
57
 
146
145
        self.addCleanup(lf1.unlock)
147
146
        # lock is held, should get some info on it
148
147
        info1 = lf1.peek()
149
 
        self.assertEqual(set(info1.info_dict.keys()),
150
 
            set(['user', 'nonce', 'hostname', 'pid', 'start_time']))
 
148
        self.assertEqual(set(info1.keys()),
 
149
                         set(['user', 'nonce', 'hostname', 'pid', 'start_time']))
151
150
        # should get the same info if we look at it through a different
152
151
        # instance
153
152
        info2 = LockDir(t, 'test_lock').peek()
166
165
        self.addCleanup(lf1.unlock)
167
166
        info2 = lf2.peek()
168
167
        self.assertTrue(info2)
169
 
        self.assertEqual(info2.get('nonce'), lf1.nonce)
 
168
        self.assertEqual(info2['nonce'], lf1.nonce)
170
169
 
171
170
    def test_30_lock_wait_fail(self):
172
171
        """Wait on a lock, then fail
189
188
            # it should only take about 0.4 seconds, but we allow more time in
190
189
            # case the machine is heavily loaded
191
190
            self.assertTrue(after - before <= 8.0,
192
 
                "took %f seconds to detect lock contention" % (after - before))
 
191
                    "took %f seconds to detect lock contention" % (after - before))
193
192
        finally:
194
193
            lf1.unlock()
 
194
        lock_base = lf2.transport.abspath(lf2.path)
195
195
        self.assertEqual(1, len(self._logged_reports))
196
 
        self.assertContainsRe(self._logged_reports[0][0],
197
 
            r'Unable to obtain lock .* held by jrandom@example\.com on .*'
198
 
            r' \(process #\d+\), acquired .* ago\.\n'
199
 
            r'Will continue to try until \d{2}:\d{2}:\d{2}, unless '
200
 
            r'you press Ctrl-C.\n'
201
 
            r'See "bzr help break-lock" for more.')
 
196
        lock_url = lf2.transport.abspath(lf2.path)
 
197
        self.assertEqual('%s %s\n'
 
198
                         '%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.',
 
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')
202
210
 
203
211
    def test_31_lock_wait_easy(self):
204
212
        """Succeed when waiting on a lock with no contention.
216
224
            lf1.unlock()
217
225
        self.assertEqual([], self._logged_reports)
218
226
 
 
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
 
219
447
    def test_40_confirm_easy(self):
220
448
        """Confirm a lock that's already held"""
221
449
        t = self.get_transport()
337
565
        finally:
338
566
            bzrlib.ui.ui_factory = orig_factory
339
567
 
340
 
    def test_break_lock_corrupt_info(self):
341
 
        """break_lock works even if the info file is corrupt (and tells the UI
342
 
        that it is corrupt).
343
 
        """
344
 
        ld = self.get_lock()
345
 
        ld2 = self.get_lock()
346
 
        ld.create()
347
 
        ld.lock_write()
348
 
        ld.transport.put_bytes_non_atomic('test_lock/held/info', '\0')
349
 
 
350
 
        class LoggingUIFactory(bzrlib.ui.SilentUIFactory):
351
 
            def __init__(self):
352
 
                self.prompts = []
353
 
 
354
 
            def get_boolean(self, prompt):
355
 
                self.prompts.append(('boolean', prompt))
356
 
                return True
357
 
 
358
 
        ui = LoggingUIFactory()
359
 
        self.overrideAttr(bzrlib.ui, 'ui_factory', ui)
360
 
        ld2.break_lock()
361
 
        self.assertLength(1, ui.prompts)
362
 
        self.assertEqual('boolean', ui.prompts[0][0])
363
 
        self.assertStartsWith(ui.prompts[0][1], 'Break (corrupt LockDir')
364
 
        self.assertRaises(LockBroken, ld.unlock)
365
 
 
366
 
    def test_break_lock_missing_info(self):
367
 
        """break_lock works even if the info file is missing (and tells the UI
368
 
        that it is corrupt).
369
 
        """
370
 
        ld = self.get_lock()
371
 
        ld2 = self.get_lock()
372
 
        ld.create()
373
 
        ld.lock_write()
374
 
        ld.transport.delete('test_lock/held/info')
375
 
 
376
 
        class LoggingUIFactory(bzrlib.ui.SilentUIFactory):
377
 
            def __init__(self):
378
 
                self.prompts = []
379
 
 
380
 
            def get_boolean(self, prompt):
381
 
                self.prompts.append(('boolean', prompt))
382
 
                return True
383
 
 
384
 
        ui = LoggingUIFactory()
385
 
        orig_factory = bzrlib.ui.ui_factory
386
 
        bzrlib.ui.ui_factory = ui
387
 
        try:
388
 
            ld2.break_lock()
389
 
            self.assertRaises(LockBroken, ld.unlock)
390
 
            self.assertLength(0, ui.prompts)
391
 
        finally:
392
 
            bzrlib.ui.ui_factory = orig_factory
393
 
        # Suppress warnings due to ld not being unlocked
394
 
        # XXX: if lock_broken hook was invoked in this case, this hack would
395
 
        # not be necessary.  - Andrew Bennetts, 2010-09-06.
396
 
        del self._lock_actions[:]
397
 
 
398
568
    def test_create_missing_base_directory(self):
399
569
        """If LockDir.path doesn't exist, it can be created
400
570
 
406
576
        lf1 = LockDir(t, 'test_lock')
407
577
 
408
578
        lf1.create()
409
 
        self.assertTrue(t.has('test_lock'))
 
579
        self.failUnless(t.has('test_lock'))
410
580
 
411
581
        t.rmdir('test_lock')
412
 
        self.assertFalse(t.has('test_lock'))
 
582
        self.failIf(t.has('test_lock'))
413
583
 
414
584
        # This will create 'test_lock' if it needs to
415
585
        lf1.lock_write()
416
 
        self.assertTrue(t.has('test_lock'))
417
 
        self.assertTrue(t.has('test_lock/held/info'))
 
586
        self.failUnless(t.has('test_lock'))
 
587
        self.failUnless(t.has('test_lock/held/info'))
418
588
 
419
589
        lf1.unlock()
420
 
        self.assertFalse(t.has('test_lock/held/info'))
 
590
        self.failIf(t.has('test_lock/held/info'))
421
591
 
422
 
    def test_display_form(self):
 
592
    def test__format_lock_info(self):
423
593
        ld1 = self.get_lock()
424
594
        ld1.create()
425
595
        ld1.lock_write()
426
596
        try:
427
 
            info_list = ld1.peek().to_readable_dict()
 
597
            info_list = ld1._format_lock_info(ld1.peek())
428
598
        finally:
429
599
            ld1.unlock()
430
 
        self.assertEqual(info_list['user'], u'jrandom@example.com')
431
 
        self.assertContainsRe(info_list['pid'], '^\d+$')
432
 
        self.assertContainsRe(info_list['time_ago'], r'^\d+ seconds? ago$')
 
600
        self.assertEqual('lock %s' % (ld1.transport.abspath(ld1.path),),
 
601
                         info_list[0])
 
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$')
433
605
 
434
606
    def test_lock_without_email(self):
435
607
        global_config = config.GlobalConfig()
441
613
        ld1.unlock()
442
614
 
443
615
    def test_lock_permission(self):
444
 
        self.requireFeature(features.not_running_as_root)
445
616
        if not osutils.supports_posix_readonly():
446
617
            raise tests.TestSkipped('Cannot induce a permission failure')
447
618
        ld1 = self.get_lock()
463
634
    def test_lock_with_buggy_rename(self):
464
635
        # test that lock acquisition handles servers which pretend they
465
636
        # renamed correctly but that actually fail
466
 
        t = transport.get_transport_from_url(
467
 
            'brokenrename+' + self.get_url())
 
637
        t = transport.get_transport('brokenrename+' + self.get_url())
468
638
        ld1 = LockDir(t, 'test_lock')
469
639
        ld1.create()
470
640
        ld1.attempt_lock()
484
654
        # should be nothing before we start
485
655
        ld1.create()
486
656
        t = self.get_transport().clone('test_lock')
487
 
 
488
657
        def check_dir(a):
489
658
            self.assertEquals(a, t.list_dir('.'))
490
 
 
491
659
        check_dir([])
492
660
        # when held, that's all we see
493
661
        ld1.attempt_lock()
501
669
    def test_no_lockdir_info(self):
502
670
        """We can cope with empty info files."""
503
671
        # This seems like a fairly common failure case - see
504
 
        # <https://bugs.launchpad.net/bzr/+bug/185103> and all its dupes.
 
672
        # <https://bugs.edge.launchpad.net/bzr/+bug/185103> and all its dupes.
505
673
        # Processes are often interrupted after opening the file
506
674
        # before the actual contents are committed.
507
675
        t = self.get_transport()
510
678
        t.put_bytes('test_lock/held/info', '')
511
679
        lf = LockDir(t, 'test_lock')
512
680
        info = lf.peek()
513
 
        formatted_info = info.to_readable_dict()
 
681
        formatted_info = lf._format_lock_info(info)
514
682
        self.assertEquals(
515
 
            dict(user='<unknown>', hostname='<unknown>', pid='<unknown>',
516
 
                time_ago='(unknown)'),
 
683
            ['lock %s' % t.abspath('test_lock'),
 
684
             'held by <unknown> on host <unknown> [process #<unknown>]',
 
685
             'locked (unknown)'],
517
686
            formatted_info)
518
687
 
519
 
    def test_corrupt_lockdir_info(self):
520
 
        """We can cope with corrupt (and thus unparseable) info files."""
521
 
        # This seems like a fairly common failure case too - see
522
 
        # <https://bugs.launchpad.net/bzr/+bug/619872> for instance.
523
 
        # In particular some systems tend to fill recently created files with
524
 
        # nul bytes after recovering from a system crash.
525
 
        t = self.get_transport()
526
 
        t.mkdir('test_lock')
527
 
        t.mkdir('test_lock/held')
528
 
        t.put_bytes('test_lock/held/info', '\0')
529
 
        lf = LockDir(t, 'test_lock')
530
 
        self.assertRaises(errors.LockCorrupt, lf.peek)
531
 
        # Currently attempt_lock gives LockContention, but LockCorrupt would be
532
 
        # a reasonable result too.
533
 
        self.assertRaises(
534
 
            (errors.LockCorrupt, errors.LockContention), lf.attempt_lock)
535
 
        self.assertRaises(errors.LockCorrupt, lf.validate_token, 'fake token')
536
 
 
537
 
    def test_missing_lockdir_info(self):
538
 
        """We can cope with absent info files."""
539
 
        t = self.get_transport()
540
 
        t.mkdir('test_lock')
541
 
        t.mkdir('test_lock/held')
542
 
        lf = LockDir(t, 'test_lock')
543
 
        # In this case we expect the 'not held' result from peek, because peek
544
 
        # cannot be expected to notice that there is a 'held' directory with no
545
 
        # 'info' file.
546
 
        self.assertEqual(None, lf.peek())
547
 
        # And lock/unlock may work or give LockContention (but not any other
548
 
        # error).
549
 
        try:
550
 
            lf.attempt_lock()
551
 
        except LockContention:
552
 
            # LockContention is ok, and expected on Windows
553
 
            pass
554
 
        else:
555
 
            # no error is ok, and expected on POSIX (because POSIX allows
556
 
            # os.rename over an empty directory).
557
 
            lf.unlock()
558
 
        # Currently raises TokenMismatch, but LockCorrupt would be reasonable
559
 
        # too.
560
 
        self.assertRaises(
561
 
            (errors.TokenMismatch, errors.LockCorrupt),
562
 
            lf.validate_token, 'fake token')
563
 
 
564
688
 
565
689
class TestLockDirHooks(TestCaseWithTransport):
566
690
 
652
776
        ld2.force_break(holder_info)
653
777
        lock_path = ld.transport.abspath(ld.path)
654
778
        self.assertEqual([], self._calls)
655
 
 
656
 
 
657
 
class TestLockHeldInfo(TestCase):
658
 
    """Can get information about the lock holder, and detect whether they're
659
 
    still alive."""
660
 
 
661
 
    def test_repr(self):
662
 
        info = LockHeldInfo.for_this_process(None)
663
 
        self.assertContainsRe(repr(info), r"LockHeldInfo\(.*\)")
664
 
 
665
 
    def test_unicode(self):
666
 
        info = LockHeldInfo.for_this_process(None)
667
 
        self.assertContainsRe(unicode(info),
668
 
            r'held by .* on .* \(process #\d+\), acquired .* ago')
669
 
 
670
 
    def test_is_locked_by_this_process(self):
671
 
        info = LockHeldInfo.for_this_process(None)
672
 
        self.assertTrue(info.is_locked_by_this_process())
673
 
 
674
 
    def test_is_not_locked_by_this_process(self):
675
 
        info = LockHeldInfo.for_this_process(None)
676
 
        info.info_dict['pid'] = '123123123123123'
677
 
        self.assertFalse(info.is_locked_by_this_process())
678
 
 
679
 
    def test_lock_holder_live_process(self):
680
 
        """Detect that the holder (this process) is still running."""
681
 
        info = LockHeldInfo.for_this_process(None)
682
 
        self.assertFalse(info.is_lock_holder_known_dead())
683
 
 
684
 
    def test_lock_holder_dead_process(self):
685
 
        """Detect that the holder (this process) is still running."""
686
 
        self.overrideAttr(lockdir, 'get_host_name',
687
 
            lambda: 'aproperhostname')
688
 
        info = LockHeldInfo.for_this_process(None)
689
 
        info.info_dict['pid'] = '123123123'
690
 
        self.assertTrue(info.is_lock_holder_known_dead())
691
 
 
692
 
    def test_lock_holder_other_machine(self):
693
 
        """The lock holder isn't here so we don't know if they're alive."""
694
 
        info = LockHeldInfo.for_this_process(None)
695
 
        info.info_dict['hostname'] = 'egg.example.com'
696
 
        info.info_dict['pid'] = '123123123'
697
 
        self.assertFalse(info.is_lock_holder_known_dead())
698
 
 
699
 
    def test_lock_holder_other_user(self):
700
 
        """Only auto-break locks held by this user."""
701
 
        info = LockHeldInfo.for_this_process(None)
702
 
        info.info_dict['user'] = 'notme@example.com'
703
 
        info.info_dict['pid'] = '123123123'
704
 
        self.assertFalse(info.is_lock_holder_known_dead())
705
 
 
706
 
    def test_no_good_hostname(self):
707
 
        """Correctly handle ambiguous hostnames.
708
 
 
709
 
        If the lock's recorded with just 'localhost' we can't really trust
710
 
        it's the same 'localhost'.  (There are quite a few of them. :-)
711
 
        So even if the process is known not to be alive, we can't say that's
712
 
        known for sure.
713
 
        """
714
 
        self.overrideAttr(lockdir, 'get_host_name',
715
 
            lambda: 'localhost')
716
 
        info = LockHeldInfo.for_this_process(None)
717
 
        info.info_dict['pid'] = '123123123'
718
 
        self.assertFalse(info.is_lock_holder_known_dead())
719
 
 
720
 
 
721
 
class TestStaleLockDir(TestCaseWithTransport):
722
 
    """Can automatically break stale locks.
723
 
 
724
 
    :see: https://bugs.launchpad.net/bzr/+bug/220464
725
 
    """
726
 
 
727
 
    def test_auto_break_stale_lock(self):
728
 
        """Locks safely known to be stale are just cleaned up.
729
 
 
730
 
        This generates a warning but no other user interaction.
731
 
        """
732
 
        self.overrideAttr(lockdir, 'get_host_name',
733
 
            lambda: 'aproperhostname')
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()