← 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: Jelmer Vernooij
  • Date: 2009-04-17 00:10:45 UTC
  • mto: This revision was merged to the branch mainline in revision 4299.
  • Revision ID: jelmer@samba.org-20090417001045-8elg0p1apb0w8bnm
Don't retrieve the tree if log is called on the root.

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
 
143
142
        lf1 = LockDir(t, 'test_lock')
144
143
        lf1.create()
145
144
        lf1.attempt_lock()
146
 
        self.addCleanup(lf1.unlock)
147
145
        # lock is held, should get some info on it
148
146
        info1 = lf1.peek()
149
 
        self.assertEqual(set(info1.info_dict.keys()),
150
 
            set(['user', 'nonce', 'hostname', 'pid', 'start_time']))
 
147
        self.assertEqual(set(info1.keys()),
 
148
                         set(['user', 'nonce', 'hostname', 'pid', 'start_time']))
151
149
        # should get the same info if we look at it through a different
152
150
        # instance
153
151
        info2 = LockDir(t, 'test_lock').peek()
163
161
        lf2 = LockDir(self.get_readonly_transport(), 'test_lock')
164
162
        self.assertEqual(lf2.peek(), None)
165
163
        lf1.attempt_lock()
166
 
        self.addCleanup(lf1.unlock)
167
164
        info2 = lf2.peek()
168
165
        self.assertTrue(info2)
169
 
        self.assertEqual(info2.get('nonce'), lf1.nonce)
 
166
        self.assertEqual(info2['nonce'], lf1.nonce)
170
167
 
171
168
    def test_30_lock_wait_fail(self):
172
169
        """Wait on a lock, then fail
189
186
            # it should only take about 0.4 seconds, but we allow more time in
190
187
            # case the machine is heavily loaded
191
188
            self.assertTrue(after - before <= 8.0,
192
 
                "took %f seconds to detect lock contention" % (after - before))
 
189
                    "took %f seconds to detect lock contention" % (after - before))
193
190
        finally:
194
191
            lf1.unlock()
 
192
        lock_base = lf2.transport.abspath(lf2.path)
195
193
        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.')
 
194
        lock_url = lf2.transport.abspath(lf2.path)
 
195
        self.assertEqual('%s %s\n'
 
196
                         '%s\n%s\n'
 
197
                         'Will continue to try until %s, unless '
 
198
                         'you press Ctrl-C\n'
 
199
                         'If you\'re sure that it\'s not being '
 
200
                         'modified, use bzr break-lock %s',
 
201
                         self._logged_reports[0][0])
 
202
        args = self._logged_reports[0][1]
 
203
        self.assertEqual('Unable to obtain', args[0])
 
204
        self.assertEqual('lock %s' % (lock_base,), args[1])
 
205
        self.assertStartsWith(args[2], 'held by ')
 
206
        self.assertStartsWith(args[3], 'locked ')
 
207
        self.assertEndsWith(args[3], ' ago')
 
208
        self.assertContainsRe(args[4], r'\d\d:\d\d:\d\d')
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
                         'If you\'re sure that it\'s not being '
 
423
                         'modified, use bzr break-lock %s',
 
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
                         'If you\'re sure that it\'s not being '
 
438
                         'modified, use bzr break-lock %s',
 
439
                         self._logged_reports[1][0])
 
440
        args = self._logged_reports[1][1]
 
441
        self.assertEqual('Lock owner changed for', args[0])
 
442
        self.assertEqual('lock %s' % (lock_base,), args[1])
 
443
        self.assertStartsWith(args[2], 'held by ')
 
444
        self.assertStartsWith(args[3], 'locked ')
 
445
        self.assertEndsWith(args[3], ' ago')
 
446
        self.assertContainsRe(args[4], r'\d\d:\d\d:\d\d')
 
447
 
219
448
    def test_40_confirm_easy(self):
220
449
        """Confirm a lock that's already held"""
221
450
        t = self.get_transport()
222
451
        lf1 = LockDir(t, 'test_lock')
223
452
        lf1.create()
224
453
        lf1.attempt_lock()
225
 
        self.addCleanup(lf1.unlock)
226
454
        lf1.confirm()
227
455
 
228
456
    def test_41_confirm_not_held(self):
240
468
        lf1.attempt_lock()
241
469
        t.move('test_lock', 'lock_gone_now')
242
470
        self.assertRaises(LockBroken, lf1.confirm)
243
 
        # Clean up
244
 
        t.move('lock_gone_now', 'test_lock')
245
 
        lf1.unlock()
246
471
 
247
472
    def test_43_break(self):
248
473
        """Break a lock whose caller has forgotten it"""
259
484
        lf2.force_break(holder_info)
260
485
        # now we should be able to take it
261
486
        lf2.attempt_lock()
262
 
        self.addCleanup(lf2.unlock)
263
487
        lf2.confirm()
264
488
 
265
489
    def test_44_break_already_released(self):
277
501
        lf2.force_break(holder_info)
278
502
        # now we should be able to take it
279
503
        lf2.attempt_lock()
280
 
        self.addCleanup(lf2.unlock)
281
504
        lf2.confirm()
282
505
 
283
506
    def test_45_break_mismatch(self):
330
553
        # do this without IO redirection to ensure it doesn't prompt.
331
554
        self.assertRaises(AssertionError, ld1.break_lock)
332
555
        orig_factory = bzrlib.ui.ui_factory
333
 
        bzrlib.ui.ui_factory = bzrlib.ui.CannedInputUIFactory([True])
 
556
        # silent ui - no need for stdout
 
557
        bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
 
558
        bzrlib.ui.ui_factory.stdin = StringIO("y\n")
334
559
        try:
335
560
            ld2.break_lock()
336
561
            self.assertRaises(LockBroken, ld1.unlock)
337
562
        finally:
338
563
            bzrlib.ui.ui_factory = orig_factory
339
564
 
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
565
    def test_create_missing_base_directory(self):
399
566
        """If LockDir.path doesn't exist, it can be created
400
567
 
406
573
        lf1 = LockDir(t, 'test_lock')
407
574
 
408
575
        lf1.create()
409
 
        self.assertTrue(t.has('test_lock'))
 
576
        self.failUnless(t.has('test_lock'))
410
577
 
411
578
        t.rmdir('test_lock')
412
 
        self.assertFalse(t.has('test_lock'))
 
579
        self.failIf(t.has('test_lock'))
413
580
 
414
581
        # This will create 'test_lock' if it needs to
415
582
        lf1.lock_write()
416
 
        self.assertTrue(t.has('test_lock'))
417
 
        self.assertTrue(t.has('test_lock/held/info'))
 
583
        self.failUnless(t.has('test_lock'))
 
584
        self.failUnless(t.has('test_lock/held/info'))
418
585
 
419
586
        lf1.unlock()
420
 
        self.assertFalse(t.has('test_lock/held/info'))
 
587
        self.failIf(t.has('test_lock/held/info'))
421
588
 
422
 
    def test_display_form(self):
 
589
    def test__format_lock_info(self):
423
590
        ld1 = self.get_lock()
424
591
        ld1.create()
425
592
        ld1.lock_write()
426
593
        try:
427
 
            info_list = ld1.peek().to_readable_dict()
 
594
            info_list = ld1._format_lock_info(ld1.peek())
428
595
        finally:
429
596
            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$')
 
597
        self.assertEqual('lock %s' % (ld1.transport.abspath(ld1.path),),
 
598
                         info_list[0])
 
599
        self.assertContainsRe(info_list[1],
 
600
                              r'^held by .* on host .* \[process #\d*\]$')
 
601
        self.assertContainsRe(info_list[2], r'locked \d+ seconds? ago$')
433
602
 
434
603
    def test_lock_without_email(self):
435
604
        global_config = config.GlobalConfig()
441
610
        ld1.unlock()
442
611
 
443
612
    def test_lock_permission(self):
444
 
        self.requireFeature(features.not_running_as_root)
445
613
        if not osutils.supports_posix_readonly():
446
614
            raise tests.TestSkipped('Cannot induce a permission failure')
447
615
        ld1 = self.get_lock()
453
621
    def test_lock_by_token(self):
454
622
        ld1 = self.get_lock()
455
623
        token = ld1.lock_write()
456
 
        self.addCleanup(ld1.unlock)
457
624
        self.assertNotEqual(None, token)
458
625
        ld2 = self.get_lock()
459
626
        t2 = ld2.lock_write(token)
460
 
        self.addCleanup(ld2.unlock)
461
627
        self.assertEqual(token, t2)
462
628
 
463
629
    def test_lock_with_buggy_rename(self):
464
630
        # test that lock acquisition handles servers which pretend they
465
631
        # renamed correctly but that actually fail
466
 
        t = transport.get_transport_from_url(
467
 
            'brokenrename+' + self.get_url())
 
632
        t = transport.get_transport('brokenrename+' + self.get_url())
468
633
        ld1 = LockDir(t, 'test_lock')
469
634
        ld1.create()
470
635
        ld1.attempt_lock()
484
649
        # should be nothing before we start
485
650
        ld1.create()
486
651
        t = self.get_transport().clone('test_lock')
487
 
 
488
652
        def check_dir(a):
489
653
            self.assertEquals(a, t.list_dir('.'))
490
 
 
491
654
        check_dir([])
492
655
        # when held, that's all we see
493
656
        ld1.attempt_lock()
494
 
        self.addCleanup(ld1.unlock)
495
657
        check_dir(['held'])
496
658
        # second guy should fail
497
659
        self.assertRaises(errors.LockContention, ld2.attempt_lock)
498
660
        # no kibble
499
661
        check_dir(['held'])
500
662
 
501
 
    def test_no_lockdir_info(self):
502
 
        """We can cope with empty info files."""
503
 
        # This seems like a fairly common failure case - see
504
 
        # <https://bugs.launchpad.net/bzr/+bug/185103> and all its dupes.
505
 
        # Processes are often interrupted after opening the file
506
 
        # before the actual contents are committed.
507
 
        t = self.get_transport()
508
 
        t.mkdir('test_lock')
509
 
        t.mkdir('test_lock/held')
510
 
        t.put_bytes('test_lock/held/info', '')
511
 
        lf = LockDir(t, 'test_lock')
512
 
        info = lf.peek()
513
 
        formatted_info = info.to_readable_dict()
514
 
        self.assertEquals(
515
 
            dict(user='<unknown>', hostname='<unknown>', pid='<unknown>',
516
 
                time_ago='(unknown)'),
517
 
            formatted_info)
518
 
 
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
 
 
565
 
class TestLockDirHooks(TestCaseWithTransport):
566
 
 
567
 
    def setUp(self):
568
 
        super(TestLockDirHooks, self).setUp()
569
 
        self._calls = []
570
 
 
571
 
    def get_lock(self):
572
 
        return LockDir(self.get_transport(), 'test_lock')
573
 
 
574
663
    def record_hook(self, result):
575
664
        self._calls.append(result)
576
665
 
 
666
    def reset_hooks(self):
 
667
        self._old_hooks = lock.Lock.hooks
 
668
        self.addCleanup(self.restore_hooks)
 
669
        lock.Lock.hooks = lock.LockHooks()
 
670
 
 
671
    def restore_hooks(self):
 
672
        lock.Lock.hooks = self._old_hooks
 
673
 
577
674
    def test_LockDir_acquired_success(self):
578
675
        # the LockDir.lock_acquired hook fires when a lock is acquired.
 
676
        self._calls = []
 
677
        self.reset_hooks()
579
678
        LockDir.hooks.install_named_hook('lock_acquired',
580
 
                                         self.record_hook, 'record_hook')
 
679
            self.record_hook, 'record_hook')
581
680
        ld = self.get_lock()
582
681
        ld.create()
583
682
        self.assertEqual([], self._calls)
589
688
 
590
689
    def test_LockDir_acquired_fail(self):
591
690
        # the LockDir.lock_acquired hook does not fire on failure.
 
691
        self._calls = []
 
692
        self.reset_hooks()
592
693
        ld = self.get_lock()
593
694
        ld.create()
594
695
        ld2 = self.get_lock()
595
696
        ld2.attempt_lock()
596
697
        # install a lock hook now, when the disk lock is locked
597
698
        LockDir.hooks.install_named_hook('lock_acquired',
598
 
                                         self.record_hook, 'record_hook')
 
699
            self.record_hook, 'record_hook')
599
700
        self.assertRaises(errors.LockContention, ld.attempt_lock)
600
701
        self.assertEqual([], self._calls)
601
702
        ld2.unlock()
603
704
 
604
705
    def test_LockDir_released_success(self):
605
706
        # the LockDir.lock_released hook fires when a lock is acquired.
 
707
        self._calls = []
 
708
        self.reset_hooks()
606
709
        LockDir.hooks.install_named_hook('lock_released',
607
 
                                         self.record_hook, 'record_hook')
 
710
            self.record_hook, 'record_hook')
608
711
        ld = self.get_lock()
609
712
        ld.create()
610
713
        self.assertEqual([], self._calls)
616
719
 
617
720
    def test_LockDir_released_fail(self):
618
721
        # the LockDir.lock_released hook does not fire on failure.
 
722
        self._calls = []
 
723
        self.reset_hooks()
619
724
        ld = self.get_lock()
620
725
        ld.create()
621
726
        ld2 = self.get_lock()
622
727
        ld.attempt_lock()
623
728
        ld2.force_break(ld2.peek())
624
729
        LockDir.hooks.install_named_hook('lock_released',
625
 
                                         self.record_hook, 'record_hook')
 
730
            self.record_hook, 'record_hook')
626
731
        self.assertRaises(LockBroken, ld.unlock)
627
732
        self.assertEqual([], self._calls)
628
 
 
629
 
    def test_LockDir_broken_success(self):
630
 
        # the LockDir.lock_broken hook fires when a lock is broken.
631
 
        ld = self.get_lock()
632
 
        ld.create()
633
 
        ld2 = self.get_lock()
634
 
        result = ld.attempt_lock()
635
 
        LockDir.hooks.install_named_hook('lock_broken',
636
 
                                         self.record_hook, 'record_hook')
637
 
        ld2.force_break(ld2.peek())
638
 
        lock_path = ld.transport.abspath(ld.path)
639
 
        self.assertEqual([lock.LockResult(lock_path, result)], self._calls)
640
 
 
641
 
    def test_LockDir_broken_failure(self):
642
 
        # the LockDir.lock_broken hook does not fires when a lock is already
643
 
        # released.
644
 
        ld = self.get_lock()
645
 
        ld.create()
646
 
        ld2 = self.get_lock()
647
 
        result = ld.attempt_lock()
648
 
        holder_info = ld2.peek()
649
 
        ld.unlock()
650
 
        LockDir.hooks.install_named_hook('lock_broken',
651
 
                                         self.record_hook, 'record_hook')
652
 
        ld2.force_break(holder_info)
653
 
        lock_path = ld.transport.abspath(ld.path)
654
 
        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()