← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_lockdir.py

(vila) Fix test failures blocking package builds. (Vincent Ladeuil)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_lockdir.py
1
 
# Copyright (C) 2006, 2007, 2008 Canonical Ltd
 
1
# Copyright (C) 2006-2011 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
20
19
import os
21
 
from threading import Thread, Lock
22
20
import time
23
21
 
24
22
import bzrlib
26
24
    config,
27
25
    errors,
28
26
    lock,
 
27
    lockdir,
29
28
    osutils,
30
29
    tests,
31
30
    transport,
34
33
    LockBreakMismatch,
35
34
    LockBroken,
36
35
    LockContention,
37
 
    LockError,
38
36
    LockFailed,
39
37
    LockNotHeld,
40
38
    )
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.
 
39
from bzrlib.lockdir import (
 
40
    LockDir,
 
41
    LockHeldInfo,
 
42
    )
 
43
from bzrlib.tests import (
 
44
    features,
 
45
    TestCase,
 
46
    TestCaseInTempDir,
 
47
    TestCaseWithTransport,
 
48
    )
48
49
 
49
50
# These tests are run on the default transport provided by the test framework
50
51
# (typically a local disk transport).  That can be changed by the --transport
52
53
# implementation are tested separately.  (The main requirement is just that
53
54
# they don't allow overwriting nonempty directories.)
54
55
 
 
56
 
55
57
class TestLockDir(TestCaseWithTransport):
56
58
    """Test LockDir operations"""
57
59
 
145
147
        self.addCleanup(lf1.unlock)
146
148
        # lock is held, should get some info on it
147
149
        info1 = lf1.peek()
148
 
        self.assertEqual(set(info1.keys()),
149
 
                         set(['user', 'nonce', 'hostname', 'pid', 'start_time']))
 
150
        self.assertEqual(set(info1.info_dict.keys()),
 
151
            set(['user', 'nonce', 'hostname', 'pid', 'start_time']))
150
152
        # should get the same info if we look at it through a different
151
153
        # instance
152
154
        info2 = LockDir(t, 'test_lock').peek()
165
167
        self.addCleanup(lf1.unlock)
166
168
        info2 = lf2.peek()
167
169
        self.assertTrue(info2)
168
 
        self.assertEqual(info2['nonce'], lf1.nonce)
 
170
        self.assertEqual(info2.get('nonce'), lf1.nonce)
169
171
 
170
172
    def test_30_lock_wait_fail(self):
171
173
        """Wait on a lock, then fail
188
190
            # it should only take about 0.4 seconds, but we allow more time in
189
191
            # case the machine is heavily loaded
190
192
            self.assertTrue(after - before <= 8.0,
191
 
                    "took %f seconds to detect lock contention" % (after - before))
 
193
                "took %f seconds to detect lock contention" % (after - before))
192
194
        finally:
193
195
            lf1.unlock()
194
 
        lock_base = lf2.transport.abspath(lf2.path)
195
196
        self.assertEqual(1, len(self._logged_reports))
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
 
                         'If you\'re sure that it\'s not being '
202
 
                         'modified, use bzr break-lock %s',
203
 
                         self._logged_reports[0][0])
204
 
        args = self._logged_reports[0][1]
205
 
        self.assertEqual('Unable to obtain', args[0])
206
 
        self.assertEqual('lock %s' % (lock_base,), args[1])
207
 
        self.assertStartsWith(args[2], 'held by ')
208
 
        self.assertStartsWith(args[3], 'locked ')
209
 
        self.assertEndsWith(args[3], ' ago')
210
 
        self.assertContainsRe(args[4], r'\d\d:\d\d:\d\d')
 
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.')
211
203
 
212
204
    def test_31_lock_wait_easy(self):
213
205
        """Succeed when waiting on a lock with no contention.
225
217
            lf1.unlock()
226
218
        self.assertEqual([], self._logged_reports)
227
219
 
228
 
    def test_32_lock_wait_succeed(self):
229
 
        """Succeed when trying to acquire a lock that gets released
230
 
 
231
 
        One thread holds on a lock and then releases it; another
232
 
        tries to lock it.
233
 
        """
234
 
        # This test sometimes fails like this:
235
 
        # Traceback (most recent call last):
236
 
 
237
 
        #   File "/home/pqm/bzr-pqm-workdir/home/+trunk/bzrlib/tests/
238
 
        # test_lockdir.py", line 247, in test_32_lock_wait_succeed
239
 
        #     self.assertEqual(1, len(self._logged_reports))
240
 
        # AssertionError: not equal:
241
 
        # a = 1
242
 
        # b = 0
243
 
        raise tests.TestSkipped("Test fails intermittently")
244
 
        t = self.get_transport()
245
 
        lf1 = LockDir(t, 'test_lock')
246
 
        lf1.create()
247
 
        lf1.attempt_lock()
248
 
 
249
 
        def wait_and_unlock():
250
 
            time.sleep(0.1)
251
 
            lf1.unlock()
252
 
        unlocker = Thread(target=wait_and_unlock)
253
 
        unlocker.start()
254
 
        try:
255
 
            lf2 = LockDir(t, 'test_lock')
256
 
            self.setup_log_reporter(lf2)
257
 
            before = time.time()
258
 
            # wait and then lock
259
 
            lf2.wait_lock(timeout=0.4, poll=0.1)
260
 
            after = time.time()
261
 
            self.assertTrue(after - before <= 1.0)
262
 
        finally:
263
 
            unlocker.join()
264
 
 
265
 
        # There should be only 1 report, even though it should have to
266
 
        # wait for a while
267
 
        lock_base = lf2.transport.abspath(lf2.path)
268
 
        self.assertEqual(1, len(self._logged_reports))
269
 
        self.assertEqual('%s %s\n'
270
 
                         '%s\n%s\n'
271
 
                         'Will continue to try until %s\n',
272
 
                         self._logged_reports[0][0])
273
 
        args = self._logged_reports[0][1]
274
 
        self.assertEqual('Unable to obtain', args[0])
275
 
        self.assertEqual('lock %s' % (lock_base,), args[1])
276
 
        self.assertStartsWith(args[2], 'held by ')
277
 
        self.assertStartsWith(args[3], 'locked ')
278
 
        self.assertEndsWith(args[3], ' ago')
279
 
        self.assertContainsRe(args[4], r'\d\d:\d\d:\d\d')
280
 
 
281
 
    def test_34_lock_write_waits(self):
282
 
        """LockDir.lock_write() will wait for the lock."""
283
 
        # the test suite sets the default to 0 to make deadlocks fail fast.
284
 
        # change it for this test, as we want to try a manual deadlock.
285
 
        raise tests.TestSkipped('Timing-sensitive test')
286
 
        bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 300
287
 
        t = self.get_transport()
288
 
        lf1 = LockDir(t, 'test_lock')
289
 
        lf1.create()
290
 
        lf1.attempt_lock()
291
 
 
292
 
        def wait_and_unlock():
293
 
            time.sleep(0.1)
294
 
            lf1.unlock()
295
 
        unlocker = Thread(target=wait_and_unlock)
296
 
        unlocker.start()
297
 
        try:
298
 
            lf2 = LockDir(t, 'test_lock')
299
 
            self.setup_log_reporter(lf2)
300
 
            before = time.time()
301
 
            # wait and then lock
302
 
            lf2.lock_write()
303
 
            after = time.time()
304
 
        finally:
305
 
            unlocker.join()
306
 
 
307
 
        # There should be only 1 report, even though it should have to
308
 
        # wait for a while
309
 
        lock_base = lf2.transport.abspath(lf2.path)
310
 
        self.assertEqual(1, len(self._logged_reports))
311
 
        self.assertEqual('%s %s\n'
312
 
                         '%s\n%s\n'
313
 
                         'Will continue to try until %s\n',
314
 
                         self._logged_reports[0][0])
315
 
        args = self._logged_reports[0][1]
316
 
        self.assertEqual('Unable to obtain', args[0])
317
 
        self.assertEqual('lock %s' % (lock_base,), args[1])
318
 
        self.assertStartsWith(args[2], 'held by ')
319
 
        self.assertStartsWith(args[3], 'locked ')
320
 
        self.assertEndsWith(args[3], ' ago')
321
 
        self.assertContainsRe(args[4], r'\d\d:\d\d:\d\d')
322
 
 
323
 
    def test_35_wait_lock_changing(self):
324
 
        """LockDir.wait_lock() will report if the lock changes underneath.
325
 
 
326
 
        This is the stages we want to happen:
327
 
 
328
 
        0) Synchronization locks are created and locked.
329
 
        1) Lock1 obtains the lockdir, and releases the 'check' lock.
330
 
        2) Lock2 grabs the 'check' lock, and checks the lockdir.
331
 
           It sees the lockdir is already acquired, reports the fact,
332
 
           and unsets the 'checked' lock.
333
 
        3) Thread1 blocks on acquiring the 'checked' lock, and then tells
334
 
           Lock1 to release and acquire the lockdir. This resets the 'check'
335
 
           lock.
336
 
        4) Lock2 acquires the 'check' lock, and checks again. It notices
337
 
           that the holder of the lock has changed, and so reports a new
338
 
           lock holder.
339
 
        5) Thread1 blocks on the 'checked' lock, this time, it completely
340
 
           unlocks the lockdir, allowing Lock2 to acquire the lock.
341
 
        """
342
 
 
343
 
        raise tests.KnownFailure(
344
 
            "timing dependency in lock tests (#213182)")
345
 
 
346
 
        wait_to_check_lock = Lock()
347
 
        wait_until_checked_lock = Lock()
348
 
 
349
 
        wait_to_check_lock.acquire()
350
 
        wait_until_checked_lock.acquire()
351
 
        note('locked check and checked locks')
352
 
 
353
 
        class LockDir1(LockDir):
354
 
            """Use the synchronization points for the first lock."""
355
 
 
356
 
            def attempt_lock(self):
357
 
                # Once we have acquired the lock, it is okay for
358
 
                # the other lock to check it
359
 
                try:
360
 
                    return super(LockDir1, self).attempt_lock()
361
 
                finally:
362
 
                    note('lock1: releasing check lock')
363
 
                    wait_to_check_lock.release()
364
 
 
365
 
        class LockDir2(LockDir):
366
 
            """Use the synchronization points for the second lock."""
367
 
 
368
 
            def attempt_lock(self):
369
 
                note('lock2: waiting for check lock')
370
 
                wait_to_check_lock.acquire()
371
 
                note('lock2: acquired check lock')
372
 
                try:
373
 
                    return super(LockDir2, self).attempt_lock()
374
 
                finally:
375
 
                    note('lock2: releasing checked lock')
376
 
                    wait_until_checked_lock.release()
377
 
 
378
 
        t = self.get_transport()
379
 
        lf1 = LockDir1(t, 'test_lock')
380
 
        lf1.create()
381
 
 
382
 
        lf2 = LockDir2(t, 'test_lock')
383
 
        self.setup_log_reporter(lf2)
384
 
 
385
 
        def wait_and_switch():
386
 
            lf1.attempt_lock()
387
 
            # Block until lock2 has had a chance to check
388
 
            note('lock1: waiting 1 for checked lock')
389
 
            wait_until_checked_lock.acquire()
390
 
            note('lock1: acquired for checked lock')
391
 
            note('lock1: released lockdir')
392
 
            lf1.unlock()
393
 
            note('lock1: acquiring lockdir')
394
 
            # Create a new nonce, so the lock looks different.
395
 
            lf1.nonce = osutils.rand_chars(20)
396
 
            lf1.lock_write()
397
 
            note('lock1: acquired lockdir')
398
 
 
399
 
            # Block until lock2 has peeked again
400
 
            note('lock1: waiting 2 for checked lock')
401
 
            wait_until_checked_lock.acquire()
402
 
            note('lock1: acquired for checked lock')
403
 
            # Now unlock, and let lock 2 grab the lock
404
 
            lf1.unlock()
405
 
            wait_to_check_lock.release()
406
 
 
407
 
        unlocker = Thread(target=wait_and_switch)
408
 
        unlocker.start()
409
 
        try:
410
 
            # Wait and play against the other thread
411
 
            lf2.wait_lock(timeout=20.0, poll=0.01)
412
 
        finally:
413
 
            unlocker.join()
414
 
        lf2.unlock()
415
 
 
416
 
        # There should be 2 reports, because the lock changed
417
 
        lock_base = lf2.transport.abspath(lf2.path)
418
 
        self.assertEqual(2, len(self._logged_reports))
419
 
        lock_url = lf2.transport.abspath(lf2.path)
420
 
        self.assertEqual('%s %s\n'
421
 
                         '%s\n%s\n'
422
 
                         'Will continue to try until %s, unless '
423
 
                         'you press Ctrl-C\n'
424
 
                         'If you\'re sure that it\'s not being '
425
 
                         'modified, use bzr break-lock %s',
426
 
                         self._logged_reports[0][0])
427
 
        args = self._logged_reports[0][1]
428
 
        self.assertEqual('Unable to obtain', args[0])
429
 
        self.assertEqual('lock %s' % (lock_base,), args[1])
430
 
        self.assertStartsWith(args[2], 'held by ')
431
 
        self.assertStartsWith(args[3], 'locked ')
432
 
        self.assertEndsWith(args[3], ' ago')
433
 
        self.assertContainsRe(args[4], r'\d\d:\d\d:\d\d')
434
 
 
435
 
        self.assertEqual('%s %s\n'
436
 
                         '%s\n%s\n'
437
 
                         'Will continue to try until %s, unless '
438
 
                         'you press Ctrl-C\n'
439
 
                         'If you\'re sure that it\'s not being '
440
 
                         'modified, use bzr break-lock %s',
441
 
                         self._logged_reports[1][0])
442
 
        args = self._logged_reports[1][1]
443
 
        self.assertEqual('Lock owner changed for', args[0])
444
 
        self.assertEqual('lock %s' % (lock_base,), args[1])
445
 
        self.assertStartsWith(args[2], 'held by ')
446
 
        self.assertStartsWith(args[3], 'locked ')
447
 
        self.assertEndsWith(args[3], ' ago')
448
 
        self.assertContainsRe(args[4], r'\d\d:\d\d:\d\d')
449
 
 
450
220
    def test_40_confirm_easy(self):
451
221
        """Confirm a lock that's already held"""
452
222
        t = self.get_transport()
568
338
        finally:
569
339
            bzrlib.ui.ui_factory = orig_factory
570
340
 
 
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
 
571
399
    def test_create_missing_base_directory(self):
572
400
        """If LockDir.path doesn't exist, it can be created
573
401
 
579
407
        lf1 = LockDir(t, 'test_lock')
580
408
 
581
409
        lf1.create()
582
 
        self.failUnless(t.has('test_lock'))
 
410
        self.assertTrue(t.has('test_lock'))
583
411
 
584
412
        t.rmdir('test_lock')
585
 
        self.failIf(t.has('test_lock'))
 
413
        self.assertFalse(t.has('test_lock'))
586
414
 
587
415
        # This will create 'test_lock' if it needs to
588
416
        lf1.lock_write()
589
 
        self.failUnless(t.has('test_lock'))
590
 
        self.failUnless(t.has('test_lock/held/info'))
 
417
        self.assertTrue(t.has('test_lock'))
 
418
        self.assertTrue(t.has('test_lock/held/info'))
591
419
 
592
420
        lf1.unlock()
593
 
        self.failIf(t.has('test_lock/held/info'))
 
421
        self.assertFalse(t.has('test_lock/held/info'))
594
422
 
595
 
    def test__format_lock_info(self):
 
423
    def test_display_form(self):
596
424
        ld1 = self.get_lock()
597
425
        ld1.create()
598
426
        ld1.lock_write()
599
427
        try:
600
 
            info_list = ld1._format_lock_info(ld1.peek())
 
428
            info_list = ld1.peek().to_readable_dict()
601
429
        finally:
602
430
            ld1.unlock()
603
 
        self.assertEqual('lock %s' % (ld1.transport.abspath(ld1.path),),
604
 
                         info_list[0])
605
 
        self.assertContainsRe(info_list[1],
606
 
                              r'^held by .* on host .* \[process #\d*\]$')
607
 
        self.assertContainsRe(info_list[2], r'locked \d+ seconds? ago$')
 
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$')
608
434
 
609
435
    def test_lock_without_email(self):
610
 
        global_config = config.GlobalConfig()
 
436
        global_config = config.GlobalStack()
611
437
        # Intentionally has no email address
612
 
        global_config.set_user_option('email', 'User Identity')
 
438
        global_config.set('email', 'User Identity')
613
439
        ld1 = self.get_lock()
614
440
        ld1.create()
615
441
        ld1.lock_write()
616
442
        ld1.unlock()
617
443
 
618
444
    def test_lock_permission(self):
 
445
        self.requireFeature(features.not_running_as_root)
619
446
        if not osutils.supports_posix_readonly():
620
447
            raise tests.TestSkipped('Cannot induce a permission failure')
621
448
        ld1 = self.get_lock()
637
464
    def test_lock_with_buggy_rename(self):
638
465
        # test that lock acquisition handles servers which pretend they
639
466
        # renamed correctly but that actually fail
640
 
        t = transport.get_transport('brokenrename+' + self.get_url())
 
467
        t = transport.get_transport_from_url(
 
468
            'brokenrename+' + self.get_url())
641
469
        ld1 = LockDir(t, 'test_lock')
642
470
        ld1.create()
643
471
        ld1.attempt_lock()
657
485
        # should be nothing before we start
658
486
        ld1.create()
659
487
        t = self.get_transport().clone('test_lock')
 
488
 
660
489
        def check_dir(a):
661
490
            self.assertEquals(a, t.list_dir('.'))
 
491
 
662
492
        check_dir([])
663
493
        # when held, that's all we see
664
494
        ld1.attempt_lock()
669
499
        # no kibble
670
500
        check_dir(['held'])
671
501
 
 
502
    def test_no_lockdir_info(self):
 
503
        """We can cope with empty info files."""
 
504
        # This seems like a fairly common failure case - see
 
505
        # <https://bugs.launchpad.net/bzr/+bug/185103> and all its dupes.
 
506
        # Processes are often interrupted after opening the file
 
507
        # before the actual contents are committed.
 
508
        t = self.get_transport()
 
509
        t.mkdir('test_lock')
 
510
        t.mkdir('test_lock/held')
 
511
        t.put_bytes('test_lock/held/info', '')
 
512
        lf = LockDir(t, 'test_lock')
 
513
        info = lf.peek()
 
514
        formatted_info = info.to_readable_dict()
 
515
        self.assertEquals(
 
516
            dict(user='<unknown>', hostname='<unknown>', pid='<unknown>',
 
517
                time_ago='(unknown)'),
 
518
            formatted_info)
 
519
 
 
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
 
672
565
 
673
566
class TestLockDirHooks(TestCaseWithTransport):
674
567
 
760
653
        ld2.force_break(holder_info)
761
654
        lock_path = ld.transport.abspath(ld.path)
762
655
        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()