← 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-07-29 11:17:57 UTC
  • mfrom: (5050.3.17 2.2)
  • mto: This revision was merged to the branch mainline in revision 5365.
  • Revision ID: andrew.bennetts@canonical.com-20100729111757-018h3pcefo7z0dnq
Merge lp:bzr/2.2 into lp:bzr.

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()
195
194
        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.')
 
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}')
202
209
 
203
210
    def test_31_lock_wait_easy(self):
204
211
        """Succeed when waiting on a lock with no contention.
216
223
            lf1.unlock()
217
224
        self.assertEqual([], self._logged_reports)
218
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
 
219
446
    def test_40_confirm_easy(self):
220
447
        """Confirm a lock that's already held"""
221
448
        t = self.get_transport()
337
564
        finally:
338
565
            bzrlib.ui.ui_factory = orig_factory
339
566
 
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
567
    def test_create_missing_base_directory(self):
399
568
        """If LockDir.path doesn't exist, it can be created
400
569
 
406
575
        lf1 = LockDir(t, 'test_lock')
407
576
 
408
577
        lf1.create()
409
 
        self.assertTrue(t.has('test_lock'))
 
578
        self.failUnless(t.has('test_lock'))
410
579
 
411
580
        t.rmdir('test_lock')
412
 
        self.assertFalse(t.has('test_lock'))
 
581
        self.failIf(t.has('test_lock'))
413
582
 
414
583
        # This will create 'test_lock' if it needs to
415
584
        lf1.lock_write()
416
 
        self.assertTrue(t.has('test_lock'))
417
 
        self.assertTrue(t.has('test_lock/held/info'))
 
585
        self.failUnless(t.has('test_lock'))
 
586
        self.failUnless(t.has('test_lock/held/info'))
418
587
 
419
588
        lf1.unlock()
420
 
        self.assertFalse(t.has('test_lock/held/info'))
 
589
        self.failIf(t.has('test_lock/held/info'))
421
590
 
422
 
    def test_display_form(self):
 
591
    def test__format_lock_info(self):
423
592
        ld1 = self.get_lock()
424
593
        ld1.create()
425
594
        ld1.lock_write()
426
595
        try:
427
 
            info_list = ld1.peek().to_readable_dict()
 
596
            info_list = ld1._format_lock_info(ld1.peek())
428
597
        finally:
429
598
            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$')
 
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
433
603
 
434
604
    def test_lock_without_email(self):
435
605
        global_config = config.GlobalConfig()
441
611
        ld1.unlock()
442
612
 
443
613
    def test_lock_permission(self):
444
 
        self.requireFeature(features.not_running_as_root)
445
614
        if not osutils.supports_posix_readonly():
446
615
            raise tests.TestSkipped('Cannot induce a permission failure')
447
616
        ld1 = self.get_lock()
463
632
    def test_lock_with_buggy_rename(self):
464
633
        # test that lock acquisition handles servers which pretend they
465
634
        # renamed correctly but that actually fail
466
 
        t = transport.get_transport_from_url(
467
 
            'brokenrename+' + self.get_url())
 
635
        t = transport.get_transport('brokenrename+' + self.get_url())
468
636
        ld1 = LockDir(t, 'test_lock')
469
637
        ld1.create()
470
638
        ld1.attempt_lock()
484
652
        # should be nothing before we start
485
653
        ld1.create()
486
654
        t = self.get_transport().clone('test_lock')
487
 
 
488
655
        def check_dir(a):
489
656
            self.assertEquals(a, t.list_dir('.'))
490
 
 
491
657
        check_dir([])
492
658
        # when held, that's all we see
493
659
        ld1.attempt_lock()
510
676
        t.put_bytes('test_lock/held/info', '')
511
677
        lf = LockDir(t, 'test_lock')
512
678
        info = lf.peek()
513
 
        formatted_info = info.to_readable_dict()
 
679
        formatted_info = lf._format_lock_info(info)
514
680
        self.assertEquals(
515
 
            dict(user='<unknown>', hostname='<unknown>', pid='<unknown>',
516
 
                time_ago='(unknown)'),
 
681
            ['<unknown>', '<unknown>', '<unknown>', '(unknown)'],
517
682
            formatted_info)
518
683
 
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
684
 
565
685
class TestLockDirHooks(TestCaseWithTransport):
566
686
 
652
772
        ld2.force_break(holder_info)
653
773
        lock_path = ld.transport.abspath(ld.path)
654
774
        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()