← 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-10 15:58:09 UTC
  • mto: This revision was merged to the branch mainline in revision 4284.
  • Revision ID: jelmer@samba.org-20090410155809-kdibzcjvp7pdb83f
Fix missing import.

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
20
 
import sys
 
21
from threading import Thread, Lock
21
22
import time
22
23
 
23
24
import bzrlib
25
26
    config,
26
27
    errors,
27
28
    lock,
28
 
    lockdir,
29
29
    osutils,
30
30
    tests,
31
31
    transport,
34
34
    LockBreakMismatch,
35
35
    LockBroken,
36
36
    LockContention,
 
37
    LockError,
37
38
    LockFailed,
38
39
    LockNotHeld,
39
40
    )
40
 
from bzrlib.lockdir import (
41
 
    LockDir,
42
 
    LockHeldInfo,
43
 
    )
44
 
from bzrlib.tests import (
45
 
    features,
46
 
    TestCase,
47
 
    TestCaseWithTransport,
48
 
    )
 
41
from bzrlib.lockdir import LockDir
 
42
from bzrlib.tests import TestCaseWithTransport
49
43
from bzrlib.trace import note
50
44
 
 
45
# These tests sometimes use threads to test the behaviour of lock files with
 
46
# concurrent actors.  This is not a typical (or necessarily supported) use;
 
47
# they're really meant for guarding between processes.
 
48
 
51
49
# These tests are run on the default transport provided by the test framework
52
50
# (typically a local disk transport).  That can be changed by the --transport
53
51
# option to bzr selftest.  The required properties of the transport
54
52
# implementation are tested separately.  (The main requirement is just that
55
53
# they don't allow overwriting nonempty directories.)
56
54
 
57
 
 
58
55
class TestLockDir(TestCaseWithTransport):
59
56
    """Test LockDir operations"""
60
57
 
145
142
        lf1 = LockDir(t, 'test_lock')
146
143
        lf1.create()
147
144
        lf1.attempt_lock()
148
 
        self.addCleanup(lf1.unlock)
149
145
        # lock is held, should get some info on it
150
146
        info1 = lf1.peek()
151
 
        self.assertEqual(set(info1.info_dict.keys()),
152
 
            set(['user', 'nonce', 'hostname', 'pid', 'start_time']))
 
147
        self.assertEqual(set(info1.keys()),
 
148
                         set(['user', 'nonce', 'hostname', 'pid', 'start_time']))
153
149
        # should get the same info if we look at it through a different
154
150
        # instance
155
151
        info2 = LockDir(t, 'test_lock').peek()
165
161
        lf2 = LockDir(self.get_readonly_transport(), 'test_lock')
166
162
        self.assertEqual(lf2.peek(), None)
167
163
        lf1.attempt_lock()
168
 
        self.addCleanup(lf1.unlock)
169
164
        info2 = lf2.peek()
170
165
        self.assertTrue(info2)
171
 
        self.assertEqual(info2.get('nonce'), lf1.nonce)
 
166
        self.assertEqual(info2['nonce'], lf1.nonce)
172
167
 
173
168
    def test_30_lock_wait_fail(self):
174
169
        """Wait on a lock, then fail
191
186
            # it should only take about 0.4 seconds, but we allow more time in
192
187
            # case the machine is heavily loaded
193
188
            self.assertTrue(after - before <= 8.0,
194
 
                "took %f seconds to detect lock contention" % (after - before))
 
189
                    "took %f seconds to detect lock contention" % (after - before))
195
190
        finally:
196
191
            lf1.unlock()
 
192
        lock_base = lf2.transport.abspath(lf2.path)
197
193
        self.assertEqual(1, len(self._logged_reports))
198
 
        self.assertContainsRe(self._logged_reports[0][0],
199
 
            r'Unable to obtain lock .* held by jrandom@example\.com on .*'
200
 
            r' \(process #\d+\), acquired .* ago\.\n'
201
 
            r'Will continue to try until \d{2}:\d{2}:\d{2}, unless '
202
 
            r'you press Ctrl-C.\n'
203
 
            r'See "bzr help break-lock" for more.')
 
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')
204
209
 
205
210
    def test_31_lock_wait_easy(self):
206
211
        """Succeed when waiting on a lock with no contention.
218
223
            lf1.unlock()
219
224
        self.assertEqual([], self._logged_reports)
220
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
 
221
448
    def test_40_confirm_easy(self):
222
449
        """Confirm a lock that's already held"""
223
450
        t = self.get_transport()
224
451
        lf1 = LockDir(t, 'test_lock')
225
452
        lf1.create()
226
453
        lf1.attempt_lock()
227
 
        self.addCleanup(lf1.unlock)
228
454
        lf1.confirm()
229
455
 
230
456
    def test_41_confirm_not_held(self):
242
468
        lf1.attempt_lock()
243
469
        t.move('test_lock', 'lock_gone_now')
244
470
        self.assertRaises(LockBroken, lf1.confirm)
245
 
        # Clean up
246
 
        t.move('lock_gone_now', 'test_lock')
247
 
        lf1.unlock()
248
471
 
249
472
    def test_43_break(self):
250
473
        """Break a lock whose caller has forgotten it"""
261
484
        lf2.force_break(holder_info)
262
485
        # now we should be able to take it
263
486
        lf2.attempt_lock()
264
 
        self.addCleanup(lf2.unlock)
265
487
        lf2.confirm()
266
488
 
267
489
    def test_44_break_already_released(self):
279
501
        lf2.force_break(holder_info)
280
502
        # now we should be able to take it
281
503
        lf2.attempt_lock()
282
 
        self.addCleanup(lf2.unlock)
283
504
        lf2.confirm()
284
505
 
285
506
    def test_45_break_mismatch(self):
332
553
        # do this without IO redirection to ensure it doesn't prompt.
333
554
        self.assertRaises(AssertionError, ld1.break_lock)
334
555
        orig_factory = bzrlib.ui.ui_factory
335
 
        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")
336
559
        try:
337
560
            ld2.break_lock()
338
561
            self.assertRaises(LockBroken, ld1.unlock)
339
562
        finally:
340
563
            bzrlib.ui.ui_factory = orig_factory
341
564
 
342
 
    def test_break_lock_corrupt_info(self):
343
 
        """break_lock works even if the info file is corrupt (and tells the UI
344
 
        that it is corrupt).
345
 
        """
346
 
        ld = self.get_lock()
347
 
        ld2 = self.get_lock()
348
 
        ld.create()
349
 
        ld.lock_write()
350
 
        ld.transport.put_bytes_non_atomic('test_lock/held/info', '\0')
351
 
 
352
 
        class LoggingUIFactory(bzrlib.ui.SilentUIFactory):
353
 
            def __init__(self):
354
 
                self.prompts = []
355
 
 
356
 
            def get_boolean(self, prompt):
357
 
                self.prompts.append(('boolean', prompt))
358
 
                return True
359
 
 
360
 
        ui = LoggingUIFactory()
361
 
        self.overrideAttr(bzrlib.ui, 'ui_factory', ui)
362
 
        ld2.break_lock()
363
 
        self.assertLength(1, ui.prompts)
364
 
        self.assertEqual('boolean', ui.prompts[0][0])
365
 
        self.assertStartsWith(ui.prompts[0][1], 'Break (corrupt LockDir')
366
 
        self.assertRaises(LockBroken, ld.unlock)
367
 
 
368
 
    def test_break_lock_missing_info(self):
369
 
        """break_lock works even if the info file is missing (and tells the UI
370
 
        that it is corrupt).
371
 
        """
372
 
        ld = self.get_lock()
373
 
        ld2 = self.get_lock()
374
 
        ld.create()
375
 
        ld.lock_write()
376
 
        ld.transport.delete('test_lock/held/info')
377
 
 
378
 
        class LoggingUIFactory(bzrlib.ui.SilentUIFactory):
379
 
            def __init__(self):
380
 
                self.prompts = []
381
 
 
382
 
            def get_boolean(self, prompt):
383
 
                self.prompts.append(('boolean', prompt))
384
 
                return True
385
 
 
386
 
        ui = LoggingUIFactory()
387
 
        orig_factory = bzrlib.ui.ui_factory
388
 
        bzrlib.ui.ui_factory = ui
389
 
        try:
390
 
            ld2.break_lock()
391
 
            self.assertRaises(LockBroken, ld.unlock)
392
 
            self.assertLength(0, ui.prompts)
393
 
        finally:
394
 
            bzrlib.ui.ui_factory = orig_factory
395
 
        # Suppress warnings due to ld not being unlocked
396
 
        # XXX: if lock_broken hook was invoked in this case, this hack would
397
 
        # not be necessary.  - Andrew Bennetts, 2010-09-06.
398
 
        del self._lock_actions[:]
399
 
 
400
565
    def test_create_missing_base_directory(self):
401
566
        """If LockDir.path doesn't exist, it can be created
402
567
 
408
573
        lf1 = LockDir(t, 'test_lock')
409
574
 
410
575
        lf1.create()
411
 
        self.assertTrue(t.has('test_lock'))
 
576
        self.failUnless(t.has('test_lock'))
412
577
 
413
578
        t.rmdir('test_lock')
414
 
        self.assertFalse(t.has('test_lock'))
 
579
        self.failIf(t.has('test_lock'))
415
580
 
416
581
        # This will create 'test_lock' if it needs to
417
582
        lf1.lock_write()
418
 
        self.assertTrue(t.has('test_lock'))
419
 
        self.assertTrue(t.has('test_lock/held/info'))
 
583
        self.failUnless(t.has('test_lock'))
 
584
        self.failUnless(t.has('test_lock/held/info'))
420
585
 
421
586
        lf1.unlock()
422
 
        self.assertFalse(t.has('test_lock/held/info'))
 
587
        self.failIf(t.has('test_lock/held/info'))
423
588
 
424
 
    def test_display_form(self):
 
589
    def test__format_lock_info(self):
425
590
        ld1 = self.get_lock()
426
591
        ld1.create()
427
592
        ld1.lock_write()
428
593
        try:
429
 
            info_list = ld1.peek().to_readable_dict()
 
594
            info_list = ld1._format_lock_info(ld1.peek())
430
595
        finally:
431
596
            ld1.unlock()
432
 
        self.assertEqual(info_list['user'], u'jrandom@example.com')
433
 
        self.assertContainsRe(info_list['pid'], '^\d+$')
434
 
        self.assertContainsRe(info_list['time_ago'], r'^\d+ seconds? ago$')
 
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$')
435
602
 
436
603
    def test_lock_without_email(self):
437
604
        global_config = config.GlobalConfig()
443
610
        ld1.unlock()
444
611
 
445
612
    def test_lock_permission(self):
446
 
        self.requireFeature(features.not_running_as_root)
447
613
        if not osutils.supports_posix_readonly():
448
614
            raise tests.TestSkipped('Cannot induce a permission failure')
449
615
        ld1 = self.get_lock()
455
621
    def test_lock_by_token(self):
456
622
        ld1 = self.get_lock()
457
623
        token = ld1.lock_write()
458
 
        self.addCleanup(ld1.unlock)
459
624
        self.assertNotEqual(None, token)
460
625
        ld2 = self.get_lock()
461
626
        t2 = ld2.lock_write(token)
462
 
        self.addCleanup(ld2.unlock)
463
627
        self.assertEqual(token, t2)
464
628
 
465
629
    def test_lock_with_buggy_rename(self):
485
649
        # should be nothing before we start
486
650
        ld1.create()
487
651
        t = self.get_transport().clone('test_lock')
488
 
 
489
652
        def check_dir(a):
490
653
            self.assertEquals(a, t.list_dir('.'))
491
 
 
492
654
        check_dir([])
493
655
        # when held, that's all we see
494
656
        ld1.attempt_lock()
495
 
        self.addCleanup(ld1.unlock)
496
657
        check_dir(['held'])
497
658
        # second guy should fail
498
659
        self.assertRaises(errors.LockContention, ld2.attempt_lock)
499
660
        # no kibble
500
661
        check_dir(['held'])
501
662
 
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
 
 
565
 
 
566
 
class TestLockDirHooks(TestCaseWithTransport):
567
 
 
568
 
    def setUp(self):
569
 
        super(TestLockDirHooks, self).setUp()
570
 
        self._calls = []
571
 
 
572
 
    def get_lock(self):
573
 
        return LockDir(self.get_transport(), 'test_lock')
574
 
 
575
663
    def record_hook(self, result):
576
664
        self._calls.append(result)
577
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
 
578
674
    def test_LockDir_acquired_success(self):
579
675
        # the LockDir.lock_acquired hook fires when a lock is acquired.
 
676
        self._calls = []
 
677
        self.reset_hooks()
580
678
        LockDir.hooks.install_named_hook('lock_acquired',
581
 
                                         self.record_hook, 'record_hook')
 
679
            self.record_hook, 'record_hook')
582
680
        ld = self.get_lock()
583
681
        ld.create()
584
682
        self.assertEqual([], self._calls)
590
688
 
591
689
    def test_LockDir_acquired_fail(self):
592
690
        # the LockDir.lock_acquired hook does not fire on failure.
 
691
        self._calls = []
 
692
        self.reset_hooks()
593
693
        ld = self.get_lock()
594
694
        ld.create()
595
695
        ld2 = self.get_lock()
596
696
        ld2.attempt_lock()
597
697
        # install a lock hook now, when the disk lock is locked
598
698
        LockDir.hooks.install_named_hook('lock_acquired',
599
 
                                         self.record_hook, 'record_hook')
 
699
            self.record_hook, 'record_hook')
600
700
        self.assertRaises(errors.LockContention, ld.attempt_lock)
601
701
        self.assertEqual([], self._calls)
602
702
        ld2.unlock()
604
704
 
605
705
    def test_LockDir_released_success(self):
606
706
        # the LockDir.lock_released hook fires when a lock is acquired.
 
707
        self._calls = []
 
708
        self.reset_hooks()
607
709
        LockDir.hooks.install_named_hook('lock_released',
608
 
                                         self.record_hook, 'record_hook')
 
710
            self.record_hook, 'record_hook')
609
711
        ld = self.get_lock()
610
712
        ld.create()
611
713
        self.assertEqual([], self._calls)
617
719
 
618
720
    def test_LockDir_released_fail(self):
619
721
        # the LockDir.lock_released hook does not fire on failure.
 
722
        self._calls = []
 
723
        self.reset_hooks()
620
724
        ld = self.get_lock()
621
725
        ld.create()
622
726
        ld2 = self.get_lock()
623
727
        ld.attempt_lock()
624
728
        ld2.force_break(ld2.peek())
625
729
        LockDir.hooks.install_named_hook('lock_released',
626
 
                                         self.record_hook, 'record_hook')
 
730
            self.record_hook, 'record_hook')
627
731
        self.assertRaises(LockBroken, ld.unlock)
628
732
        self.assertEqual([], self._calls)
629
 
 
630
 
    def test_LockDir_broken_success(self):
631
 
        # the LockDir.lock_broken hook fires when a lock is broken.
632
 
        ld = self.get_lock()
633
 
        ld.create()
634
 
        ld2 = self.get_lock()
635
 
        result = ld.attempt_lock()
636
 
        LockDir.hooks.install_named_hook('lock_broken',
637
 
                                         self.record_hook, 'record_hook')
638
 
        ld2.force_break(ld2.peek())
639
 
        lock_path = ld.transport.abspath(ld.path)
640
 
        self.assertEqual([lock.LockResult(lock_path, result)], self._calls)
641
 
 
642
 
    def test_LockDir_broken_failure(self):
643
 
        # the LockDir.lock_broken hook does not fires when a lock is already
644
 
        # released.
645
 
        ld = self.get_lock()
646
 
        ld.create()
647
 
        ld2 = self.get_lock()
648
 
        result = ld.attempt_lock()
649
 
        holder_info = ld2.peek()
650
 
        ld.unlock()
651
 
        LockDir.hooks.install_named_hook('lock_broken',
652
 
                                         self.record_hook, 'record_hook')
653
 
        ld2.force_break(holder_info)
654
 
        lock_path = ld.transport.abspath(ld.path)
655
 
        self.assertEqual([], self._calls)
656
 
 
657
 
 
658
 
class TestLockHeldInfo(TestCase):
659
 
    """Can get information about the lock holder, and detect whether they're
660
 
    still alive."""
661
 
 
662
 
    def test_repr(self):
663
 
        info = LockHeldInfo.for_this_process(None)
664
 
        self.assertContainsRe(repr(info), r"LockHeldInfo\(.*\)")
665
 
 
666
 
    def test_unicode(self):
667
 
        info = LockHeldInfo.for_this_process(None)
668
 
        self.assertContainsRe(unicode(info),
669
 
            r'held by .* on .* \(process #\d+\), acquired .* ago')
670
 
 
671
 
    def test_is_locked_by_this_process(self):
672
 
        info = LockHeldInfo.for_this_process(None)
673
 
        self.assertTrue(info.is_locked_by_this_process())
674
 
 
675
 
    def test_is_not_locked_by_this_process(self):
676
 
        info = LockHeldInfo.for_this_process(None)
677
 
        info.info_dict['pid'] = '123123123123123'
678
 
        self.assertFalse(info.is_locked_by_this_process())
679
 
 
680
 
    def test_lock_holder_live_process(self):
681
 
        """Detect that the holder (this process) is still running."""
682
 
        info = LockHeldInfo.for_this_process(None)
683
 
        self.assertFalse(info.is_lock_holder_known_dead())
684
 
 
685
 
    def test_lock_holder_dead_process(self):
686
 
        """Detect that the holder (this process) is still running."""
687
 
        info = LockHeldInfo.for_this_process(None)
688
 
        info.info_dict['pid'] = '123123123'
689
 
        if sys.platform == 'win32':
690
 
            self.knownFailure(
691
 
                'live lock holder detection not implemented yet on win32')
692
 
        self.assertTrue(info.is_lock_holder_known_dead())
693
 
 
694
 
    def test_lock_holder_other_machine(self):
695
 
        """The lock holder isn't here so we don't know if they're alive."""
696
 
        info = LockHeldInfo.for_this_process(None)
697
 
        info.info_dict['hostname'] = 'egg.example.com'
698
 
        info.info_dict['pid'] = '123123123'
699
 
        self.assertFalse(info.is_lock_holder_known_dead())
700
 
 
701
 
    def test_lock_holder_other_user(self):
702
 
        """Only auto-break locks held by this user."""
703
 
        info = LockHeldInfo.for_this_process(None)
704
 
        info.info_dict['user'] = 'notme@example.com'
705
 
        info.info_dict['pid'] = '123123123'
706
 
        self.assertFalse(info.is_lock_holder_known_dead())
707
 
 
708
 
    def test_no_good_hostname(self):
709
 
        """Correctly handle ambiguous hostnames.
710
 
 
711
 
        If the lock's recorded with just 'localhost' we can't really trust
712
 
        it's the same 'localhost'.  (There are quite a few of them. :-)
713
 
        So even if the process is known not to be alive, we can't say that's
714
 
        known for sure.
715
 
        """
716
 
        self.overrideAttr(lockdir, 'get_host_name',
717
 
            lambda: 'localhost')
718
 
        info = LockHeldInfo.for_this_process(None)
719
 
        info.info_dict['pid'] = '123123123'
720
 
        self.assertFalse(info.is_lock_holder_known_dead())
721
 
 
722
 
 
723
 
class TestStaleLockDir(TestCaseWithTransport):
724
 
    """Can automatically break stale locks.
725
 
 
726
 
    :see: https://bugs.launchpad.net/bzr/+bug/220464
727
 
    """
728
 
 
729
 
    def test_auto_break_stale_lock(self):
730
 
        """Locks safely known to be stale are just cleaned up.
731
 
 
732
 
        This generates a warning but no other user interaction.
733
 
        """
734
 
        # This is off by default at present; see the discussion in the bug.
735
 
        # If you change the default, don't forget to update the docs.
736
 
        config.GlobalConfig().set_user_option('locks.steal_dead', True)
737
 
        # Create a lock pretending to come from a different nonexistent
738
 
        # process on the same machine.
739
 
        l1 = LockDir(self.get_transport(), 'a',
740
 
            extra_holder_info={'pid': '12312313'})
741
 
        token_1 = l1.attempt_lock()
742
 
        l2 = LockDir(self.get_transport(), 'a')
743
 
        token_2 = l2.attempt_lock()
744
 
        # l1 will notice its lock was stolen.
745
 
        self.assertRaises(errors.LockBroken,
746
 
            l1.unlock)
747
 
        l2.unlock()
748
 
 
749
 
    def test_auto_break_stale_lock_configured_off(self):
750
 
        """Automatic breaking can be turned off"""
751
 
        l1 = LockDir(self.get_transport(), 'a',
752
 
            extra_holder_info={'pid': '12312313'})
753
 
        token_1 = l1.attempt_lock()
754
 
        self.addCleanup(l1.unlock)
755
 
        l2 = LockDir(self.get_transport(), 'a')
756
 
        # This fails now, because dead lock breaking is off by default.
757
 
        self.assertRaises(LockContention,
758
 
            l2.attempt_lock)
759
 
        # and it's in fact not broken
760
 
        l1.confirm()