← 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: Andrew Bennetts
  • Date: 2010-03-11 04:33:41 UTC
  • mfrom: (4797.33.4 2.1)
  • mto: This revision was merged to the branch mainline in revision 5082.
  • Revision ID: andrew.bennetts@canonical.com-20100311043341-rzdik83fnactjsxs
Merge lp:bzr/2.1, including fixes for #496813, #526211, #526353.

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
20
 
import sys
 
21
from threading import Thread, Lock
21
22
import time
22
23
 
23
24
import bzrlib
25
26
    config,
26
27
    errors,
27
28
    lock,
28
 
    lockdir,
29
29
    osutils,
30
30
    tests,
31
31
    transport,
34
34
    LockBreakMismatch,
35
35
    LockBroken,
36
36
    LockContention,
 
37
    LockError,
37
38
    LockFailed,
38
39
    LockNotHeld,
39
40
    )
40
 
from bzrlib.lockdir import (
41
 
    LockDir,
42
 
    LockHeldInfo,
43
 
    )
44
 
from bzrlib.tests import (
45
 
    features,
46
 
    TestCase,
47
 
    TestCaseWithTransport,
48
 
    )
 
41
from bzrlib.lockdir import LockDir
 
42
from bzrlib.tests import TestCaseWithTransport
49
43
from bzrlib.trace import note
50
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
 
51
49
# These tests are run on the default transport provided by the test framework
52
50
# (typically a local disk transport).  That can be changed by the --transport
53
51
# option to bzr selftest.  The required properties of the transport
54
52
# implementation are tested separately.  (The main requirement is just that
55
53
# they don't allow overwriting nonempty directories.)
56
54
 
57
 
 
58
55
class TestLockDir(TestCaseWithTransport):
59
56
    """Test LockDir operations"""
60
57
 
148
145
        self.addCleanup(lf1.unlock)
149
146
        # lock is held, should get some info on it
150
147
        info1 = lf1.peek()
151
 
        self.assertEqual(set(info1.info_dict.keys()),
152
 
            set(['user', 'nonce', 'hostname', 'pid', 'start_time']))
 
148
        self.assertEqual(set(info1.keys()),
 
149
                         set(['user', 'nonce', 'hostname', 'pid', 'start_time']))
153
150
        # should get the same info if we look at it through a different
154
151
        # instance
155
152
        info2 = LockDir(t, 'test_lock').peek()
168
165
        self.addCleanup(lf1.unlock)
169
166
        info2 = lf2.peek()
170
167
        self.assertTrue(info2)
171
 
        self.assertEqual(info2.get('nonce'), lf1.nonce)
 
168
        self.assertEqual(info2['nonce'], lf1.nonce)
172
169
 
173
170
    def test_30_lock_wait_fail(self):
174
171
        """Wait on a lock, then fail
191
188
            # it should only take about 0.4 seconds, but we allow more time in
192
189
            # case the machine is heavily loaded
193
190
            self.assertTrue(after - before <= 8.0,
194
 
                "took %f seconds to detect lock contention" % (after - before))
 
191
                    "took %f seconds to detect lock contention" % (after - before))
195
192
        finally:
196
193
            lf1.unlock()
 
194
        lock_base = lf2.transport.abspath(lf2.path)
197
195
        self.assertEqual(1, len(self._logged_reports))
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.')
 
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')
204
210
 
205
211
    def test_31_lock_wait_easy(self):
206
212
        """Succeed when waiting on a lock with no contention.
218
224
            lf1.unlock()
219
225
        self.assertEqual([], self._logged_reports)
220
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
 
221
447
    def test_40_confirm_easy(self):
222
448
        """Confirm a lock that's already held"""
223
449
        t = self.get_transport()
339
565
        finally:
340
566
            bzrlib.ui.ui_factory = orig_factory
341
567
 
342
 
    def test_break_lock_corrupt_info(self):
343
 
        """break_lock works even if the info file is corrupt (and tells the UI
344
 
        that it is corrupt).
345
 
        """
346
 
        ld = self.get_lock()
347
 
        ld2 = self.get_lock()
348
 
        ld.create()
349
 
        ld.lock_write()
350
 
        ld.transport.put_bytes_non_atomic('test_lock/held/info', '\0')
351
 
 
352
 
        class LoggingUIFactory(bzrlib.ui.SilentUIFactory):
353
 
            def __init__(self):
354
 
                self.prompts = []
355
 
 
356
 
            def get_boolean(self, prompt):
357
 
                self.prompts.append(('boolean', prompt))
358
 
                return True
359
 
 
360
 
        ui = LoggingUIFactory()
361
 
        self.overrideAttr(bzrlib.ui, 'ui_factory', ui)
362
 
        ld2.break_lock()
363
 
        self.assertLength(1, ui.prompts)
364
 
        self.assertEqual('boolean', ui.prompts[0][0])
365
 
        self.assertStartsWith(ui.prompts[0][1], 'Break (corrupt LockDir')
366
 
        self.assertRaises(LockBroken, ld.unlock)
367
 
 
368
 
    def test_break_lock_missing_info(self):
369
 
        """break_lock works even if the info file is missing (and tells the UI
370
 
        that it is corrupt).
371
 
        """
372
 
        ld = self.get_lock()
373
 
        ld2 = self.get_lock()
374
 
        ld.create()
375
 
        ld.lock_write()
376
 
        ld.transport.delete('test_lock/held/info')
377
 
 
378
 
        class LoggingUIFactory(bzrlib.ui.SilentUIFactory):
379
 
            def __init__(self):
380
 
                self.prompts = []
381
 
 
382
 
            def get_boolean(self, prompt):
383
 
                self.prompts.append(('boolean', prompt))
384
 
                return True
385
 
 
386
 
        ui = LoggingUIFactory()
387
 
        orig_factory = bzrlib.ui.ui_factory
388
 
        bzrlib.ui.ui_factory = ui
389
 
        try:
390
 
            ld2.break_lock()
391
 
            self.assertRaises(LockBroken, ld.unlock)
392
 
            self.assertLength(0, ui.prompts)
393
 
        finally:
394
 
            bzrlib.ui.ui_factory = orig_factory
395
 
        # Suppress warnings due to ld not being unlocked
396
 
        # XXX: if lock_broken hook was invoked in this case, this hack would
397
 
        # not be necessary.  - Andrew Bennetts, 2010-09-06.
398
 
        del self._lock_actions[:]
399
 
 
400
568
    def test_create_missing_base_directory(self):
401
569
        """If LockDir.path doesn't exist, it can be created
402
570
 
408
576
        lf1 = LockDir(t, 'test_lock')
409
577
 
410
578
        lf1.create()
411
 
        self.assertTrue(t.has('test_lock'))
 
579
        self.failUnless(t.has('test_lock'))
412
580
 
413
581
        t.rmdir('test_lock')
414
 
        self.assertFalse(t.has('test_lock'))
 
582
        self.failIf(t.has('test_lock'))
415
583
 
416
584
        # This will create 'test_lock' if it needs to
417
585
        lf1.lock_write()
418
 
        self.assertTrue(t.has('test_lock'))
419
 
        self.assertTrue(t.has('test_lock/held/info'))
 
586
        self.failUnless(t.has('test_lock'))
 
587
        self.failUnless(t.has('test_lock/held/info'))
420
588
 
421
589
        lf1.unlock()
422
 
        self.assertFalse(t.has('test_lock/held/info'))
 
590
        self.failIf(t.has('test_lock/held/info'))
423
591
 
424
 
    def test_display_form(self):
 
592
    def test__format_lock_info(self):
425
593
        ld1 = self.get_lock()
426
594
        ld1.create()
427
595
        ld1.lock_write()
428
596
        try:
429
 
            info_list = ld1.peek().to_readable_dict()
 
597
            info_list = ld1._format_lock_info(ld1.peek())
430
598
        finally:
431
599
            ld1.unlock()
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$')
 
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$')
435
605
 
436
606
    def test_lock_without_email(self):
437
607
        global_config = config.GlobalConfig()
443
613
        ld1.unlock()
444
614
 
445
615
    def test_lock_permission(self):
446
 
        self.requireFeature(features.not_running_as_root)
447
616
        if not osutils.supports_posix_readonly():
448
617
            raise tests.TestSkipped('Cannot induce a permission failure')
449
618
        ld1 = self.get_lock()
485
654
        # should be nothing before we start
486
655
        ld1.create()
487
656
        t = self.get_transport().clone('test_lock')
488
 
 
489
657
        def check_dir(a):
490
658
            self.assertEquals(a, t.list_dir('.'))
491
 
 
492
659
        check_dir([])
493
660
        # when held, that's all we see
494
661
        ld1.attempt_lock()
502
669
    def test_no_lockdir_info(self):
503
670
        """We can cope with empty info files."""
504
671
        # This seems like a fairly common failure case - see
505
 
        # <https://bugs.launchpad.net/bzr/+bug/185103> and all its dupes.
 
672
        # <https://bugs.edge.launchpad.net/bzr/+bug/185103> and all its dupes.
506
673
        # Processes are often interrupted after opening the file
507
674
        # before the actual contents are committed.
508
675
        t = self.get_transport()
511
678
        t.put_bytes('test_lock/held/info', '')
512
679
        lf = LockDir(t, 'test_lock')
513
680
        info = lf.peek()
514
 
        formatted_info = info.to_readable_dict()
 
681
        formatted_info = lf._format_lock_info(info)
515
682
        self.assertEquals(
516
 
            dict(user='<unknown>', hostname='<unknown>', pid='<unknown>',
517
 
                time_ago='(unknown)'),
 
683
            ['lock %s' % t.abspath('test_lock'),
 
684
             'held by <unknown> on host <unknown> [process #<unknown>]',
 
685
             'locked (unknown)'],
518
686
            formatted_info)
519
687
 
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
688
 
566
689
class TestLockDirHooks(TestCaseWithTransport):
567
690
 
653
776
        ld2.force_break(holder_info)
654
777
        lock_path = ld.transport.abspath(ld.path)
655
778
        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()