← 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: John Arbash Meinel
  • Date: 2009-07-30 23:54:26 UTC
  • mto: This revision was merged to the branch mainline in revision 4580.
  • Revision ID: john@arbash-meinel.com-20090730235426-o8h73swbh7seqaf7
Update the breakin support to support CTRL-BREAK on Windows.

The signal handling code is very similar, but the testing code got a bit clumsy.

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, 2007, 2008 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
                         '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')
202
211
 
203
212
    def test_31_lock_wait_easy(self):
204
213
        """Succeed when waiting on a lock with no contention.
216
225
            lf1.unlock()
217
226
        self.assertEqual([], self._logged_reports)
218
227
 
 
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
 
219
450
    def test_40_confirm_easy(self):
220
451
        """Confirm a lock that's already held"""
221
452
        t = self.get_transport()
337
568
        finally:
338
569
            bzrlib.ui.ui_factory = orig_factory
339
570
 
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
571
    def test_create_missing_base_directory(self):
399
572
        """If LockDir.path doesn't exist, it can be created
400
573
 
406
579
        lf1 = LockDir(t, 'test_lock')
407
580
 
408
581
        lf1.create()
409
 
        self.assertTrue(t.has('test_lock'))
 
582
        self.failUnless(t.has('test_lock'))
410
583
 
411
584
        t.rmdir('test_lock')
412
 
        self.assertFalse(t.has('test_lock'))
 
585
        self.failIf(t.has('test_lock'))
413
586
 
414
587
        # This will create 'test_lock' if it needs to
415
588
        lf1.lock_write()
416
 
        self.assertTrue(t.has('test_lock'))
417
 
        self.assertTrue(t.has('test_lock/held/info'))
 
589
        self.failUnless(t.has('test_lock'))
 
590
        self.failUnless(t.has('test_lock/held/info'))
418
591
 
419
592
        lf1.unlock()
420
 
        self.assertFalse(t.has('test_lock/held/info'))
 
593
        self.failIf(t.has('test_lock/held/info'))
421
594
 
422
 
    def test_display_form(self):
 
595
    def test__format_lock_info(self):
423
596
        ld1 = self.get_lock()
424
597
        ld1.create()
425
598
        ld1.lock_write()
426
599
        try:
427
 
            info_list = ld1.peek().to_readable_dict()
 
600
            info_list = ld1._format_lock_info(ld1.peek())
428
601
        finally:
429
602
            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$')
 
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$')
433
608
 
434
609
    def test_lock_without_email(self):
435
610
        global_config = config.GlobalConfig()
441
616
        ld1.unlock()
442
617
 
443
618
    def test_lock_permission(self):
444
 
        self.requireFeature(features.not_running_as_root)
445
619
        if not osutils.supports_posix_readonly():
446
620
            raise tests.TestSkipped('Cannot induce a permission failure')
447
621
        ld1 = self.get_lock()
483
657
        # should be nothing before we start
484
658
        ld1.create()
485
659
        t = self.get_transport().clone('test_lock')
486
 
 
487
660
        def check_dir(a):
488
661
            self.assertEquals(a, t.list_dir('.'))
489
 
 
490
662
        check_dir([])
491
663
        # when held, that's all we see
492
664
        ld1.attempt_lock()
497
669
        # no kibble
498
670
        check_dir(['held'])
499
671
 
500
 
    def test_no_lockdir_info(self):
501
 
        """We can cope with empty info files."""
502
 
        # This seems like a fairly common failure case - see
503
 
        # <https://bugs.launchpad.net/bzr/+bug/185103> and all its dupes.
504
 
        # Processes are often interrupted after opening the file
505
 
        # before the actual contents are committed.
506
 
        t = self.get_transport()
507
 
        t.mkdir('test_lock')
508
 
        t.mkdir('test_lock/held')
509
 
        t.put_bytes('test_lock/held/info', '')
510
 
        lf = LockDir(t, 'test_lock')
511
 
        info = lf.peek()
512
 
        formatted_info = info.to_readable_dict()
513
 
        self.assertEquals(
514
 
            dict(user='<unknown>', hostname='<unknown>', pid='<unknown>',
515
 
                time_ago='(unknown)'),
516
 
            formatted_info)
517
 
 
518
 
    def test_corrupt_lockdir_info(self):
519
 
        """We can cope with corrupt (and thus unparseable) info files."""
520
 
        # This seems like a fairly common failure case too - see
521
 
        # <https://bugs.launchpad.net/bzr/+bug/619872> for instance.
522
 
        # In particular some systems tend to fill recently created files with
523
 
        # nul bytes after recovering from a system crash.
524
 
        t = self.get_transport()
525
 
        t.mkdir('test_lock')
526
 
        t.mkdir('test_lock/held')
527
 
        t.put_bytes('test_lock/held/info', '\0')
528
 
        lf = LockDir(t, 'test_lock')
529
 
        self.assertRaises(errors.LockCorrupt, lf.peek)
530
 
        # Currently attempt_lock gives LockContention, but LockCorrupt would be
531
 
        # a reasonable result too.
532
 
        self.assertRaises(
533
 
            (errors.LockCorrupt, errors.LockContention), lf.attempt_lock)
534
 
        self.assertRaises(errors.LockCorrupt, lf.validate_token, 'fake token')
535
 
 
536
 
    def test_missing_lockdir_info(self):
537
 
        """We can cope with absent info files."""
538
 
        t = self.get_transport()
539
 
        t.mkdir('test_lock')
540
 
        t.mkdir('test_lock/held')
541
 
        lf = LockDir(t, 'test_lock')
542
 
        # In this case we expect the 'not held' result from peek, because peek
543
 
        # cannot be expected to notice that there is a 'held' directory with no
544
 
        # 'info' file.
545
 
        self.assertEqual(None, lf.peek())
546
 
        # And lock/unlock may work or give LockContention (but not any other
547
 
        # error).
548
 
        try:
549
 
            lf.attempt_lock()
550
 
        except LockContention:
551
 
            # LockContention is ok, and expected on Windows
552
 
            pass
553
 
        else:
554
 
            # no error is ok, and expected on POSIX (because POSIX allows
555
 
            # os.rename over an empty directory).
556
 
            lf.unlock()
557
 
        # Currently raises TokenMismatch, but LockCorrupt would be reasonable
558
 
        # too.
559
 
        self.assertRaises(
560
 
            (errors.TokenMismatch, errors.LockCorrupt),
561
 
            lf.validate_token, 'fake token')
562
 
 
563
672
 
564
673
class TestLockDirHooks(TestCaseWithTransport):
565
674
 
651
760
        ld2.force_break(holder_info)
652
761
        lock_path = ld.transport.abspath(ld.path)
653
762
        self.assertEqual([], self._calls)
654
 
 
655
 
 
656
 
class TestLockHeldInfo(TestCase):
657
 
    """Can get information about the lock holder, and detect whether they're
658
 
    still alive."""
659
 
 
660
 
    def test_repr(self):
661
 
        info = LockHeldInfo.for_this_process(None)
662
 
        self.assertContainsRe(repr(info), r"LockHeldInfo\(.*\)")
663
 
 
664
 
    def test_unicode(self):
665
 
        info = LockHeldInfo.for_this_process(None)
666
 
        self.assertContainsRe(unicode(info),
667
 
            r'held by .* on .* \(process #\d+\), acquired .* ago')
668
 
 
669
 
    def test_is_locked_by_this_process(self):
670
 
        info = LockHeldInfo.for_this_process(None)
671
 
        self.assertTrue(info.is_locked_by_this_process())
672
 
 
673
 
    def test_is_not_locked_by_this_process(self):
674
 
        info = LockHeldInfo.for_this_process(None)
675
 
        info.info_dict['pid'] = '123123123123123'
676
 
        self.assertFalse(info.is_locked_by_this_process())
677
 
 
678
 
    def test_lock_holder_live_process(self):
679
 
        """Detect that the holder (this process) is still running."""
680
 
        info = LockHeldInfo.for_this_process(None)
681
 
        self.assertFalse(info.is_lock_holder_known_dead())
682
 
 
683
 
    def test_lock_holder_dead_process(self):
684
 
        """Detect that the holder (this process) is still running."""
685
 
        self.overrideAttr(lockdir, 'get_host_name',
686
 
            lambda: 'aproperhostname')
687
 
        info = LockHeldInfo.for_this_process(None)
688
 
        info.info_dict['pid'] = '123123123'
689
 
        self.assertTrue(info.is_lock_holder_known_dead())
690
 
 
691
 
    def test_lock_holder_other_machine(self):
692
 
        """The lock holder isn't here so we don't know if they're alive."""
693
 
        info = LockHeldInfo.for_this_process(None)
694
 
        info.info_dict['hostname'] = 'egg.example.com'
695
 
        info.info_dict['pid'] = '123123123'
696
 
        self.assertFalse(info.is_lock_holder_known_dead())
697
 
 
698
 
    def test_lock_holder_other_user(self):
699
 
        """Only auto-break locks held by this user."""
700
 
        info = LockHeldInfo.for_this_process(None)
701
 
        info.info_dict['user'] = 'notme@example.com'
702
 
        info.info_dict['pid'] = '123123123'
703
 
        self.assertFalse(info.is_lock_holder_known_dead())
704
 
 
705
 
    def test_no_good_hostname(self):
706
 
        """Correctly handle ambiguous hostnames.
707
 
 
708
 
        If the lock's recorded with just 'localhost' we can't really trust
709
 
        it's the same 'localhost'.  (There are quite a few of them. :-)
710
 
        So even if the process is known not to be alive, we can't say that's
711
 
        known for sure.
712
 
        """
713
 
        self.overrideAttr(lockdir, 'get_host_name',
714
 
            lambda: 'localhost')
715
 
        info = LockHeldInfo.for_this_process(None)
716
 
        info.info_dict['pid'] = '123123123'
717
 
        self.assertFalse(info.is_lock_holder_known_dead())
718
 
 
719
 
 
720
 
class TestStaleLockDir(TestCaseWithTransport):
721
 
    """Can automatically break stale locks.
722
 
 
723
 
    :see: https://bugs.launchpad.net/bzr/+bug/220464
724
 
    """
725
 
 
726
 
    def test_auto_break_stale_lock(self):
727
 
        """Locks safely known to be stale are just cleaned up.
728
 
 
729
 
        This generates a warning but no other user interaction.
730
 
        """
731
 
        self.overrideAttr(lockdir, 'get_host_name',
732
 
            lambda: 'aproperhostname')
733
 
        # This is off by default at present; see the discussion in the bug.
734
 
        # If you change the default, don't forget to update the docs.
735
 
        config.GlobalConfig().set_user_option('locks.steal_dead', True)
736
 
        # Create a lock pretending to come from a different nonexistent
737
 
        # process on the same machine.
738
 
        l1 = LockDir(self.get_transport(), 'a',
739
 
            extra_holder_info={'pid': '12312313'})
740
 
        token_1 = l1.attempt_lock()
741
 
        l2 = LockDir(self.get_transport(), 'a')
742
 
        token_2 = l2.attempt_lock()
743
 
        # l1 will notice its lock was stolen.
744
 
        self.assertRaises(errors.LockBroken,
745
 
            l1.unlock)
746
 
        l2.unlock()
747
 
 
748
 
    def test_auto_break_stale_lock_configured_off(self):
749
 
        """Automatic breaking can be turned off"""
750
 
        l1 = LockDir(self.get_transport(), 'a',
751
 
            extra_holder_info={'pid': '12312313'})
752
 
        token_1 = l1.attempt_lock()
753
 
        self.addCleanup(l1.unlock)
754
 
        l2 = LockDir(self.get_transport(), 'a')
755
 
        # This fails now, because dead lock breaking is off by default.
756
 
        self.assertRaises(LockContention,
757
 
            l2.attempt_lock)
758
 
        # and it's in fact not broken
759
 
        l1.confirm()