← 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: Canonical.com Patch Queue Manager
  • Date: 2008-09-11 06:10:59 UTC
  • mfrom: (3702.1.1 trivial)
  • Revision ID: pqm@pqm.ubuntu.com-20080911061059-svzqfejar17ui4zw
(mbp) KnitVersionedFiles repr

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 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
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
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
23
25
from bzrlib import (
24
26
    config,
25
27
    errors,
26
 
    lock,
27
 
    lockdir,
28
28
    osutils,
29
29
    tests,
30
30
    transport,
33
33
    LockBreakMismatch,
34
34
    LockBroken,
35
35
    LockContention,
 
36
    LockError,
36
37
    LockFailed,
37
38
    LockNotHeld,
38
39
    )
39
 
from bzrlib.lockdir import (
40
 
    LockDir,
41
 
    LockHeldInfo,
42
 
    )
43
 
from bzrlib.tests import (
44
 
    features,
45
 
    TestCase,
46
 
    TestCaseWithTransport,
47
 
    )
 
40
from bzrlib.lockdir import LockDir
 
41
from bzrlib.tests import TestCaseWithTransport
 
42
from bzrlib.trace import note
 
43
 
 
44
# These tests sometimes use threads to test the behaviour of lock files with
 
45
# concurrent actors.  This is not a typical (or necessarily supported) use;
 
46
# they're really meant for guarding between processes.
48
47
 
49
48
# These tests are run on the default transport provided by the test framework
50
49
# (typically a local disk transport).  That can be changed by the --transport
52
51
# implementation are tested separately.  (The main requirement is just that
53
52
# they don't allow overwriting nonempty directories.)
54
53
 
55
 
 
56
54
class TestLockDir(TestCaseWithTransport):
57
55
    """Test LockDir operations"""
58
56
 
127
125
        lf1.attempt_lock()
128
126
        lf2 = LockDir(t, 'test_lock')
129
127
        try:
130
 
            # locking is between LockDir instances; aliases within
 
128
            # locking is between LockDir instances; aliases within 
131
129
            # a single process are not detected
132
130
            lf2.attempt_lock()
133
131
            self.fail('Failed to detect lock collision')
143
141
        lf1 = LockDir(t, 'test_lock')
144
142
        lf1.create()
145
143
        lf1.attempt_lock()
146
 
        self.addCleanup(lf1.unlock)
147
144
        # lock is held, should get some info on it
148
145
        info1 = lf1.peek()
149
 
        self.assertEqual(set(info1.info_dict.keys()),
150
 
            set(['user', 'nonce', 'hostname', 'pid', 'start_time']))
 
146
        self.assertEqual(set(info1.keys()),
 
147
                         set(['user', 'nonce', 'hostname', 'pid', 'start_time']))
151
148
        # should get the same info if we look at it through a different
152
149
        # instance
153
150
        info2 = LockDir(t, 'test_lock').peek()
163
160
        lf2 = LockDir(self.get_readonly_transport(), 'test_lock')
164
161
        self.assertEqual(lf2.peek(), None)
165
162
        lf1.attempt_lock()
166
 
        self.addCleanup(lf1.unlock)
167
163
        info2 = lf2.peek()
168
164
        self.assertTrue(info2)
169
 
        self.assertEqual(info2.get('nonce'), lf1.nonce)
 
165
        self.assertEqual(info2['nonce'], lf1.nonce)
170
166
 
171
167
    def test_30_lock_wait_fail(self):
172
168
        """Wait on a lock, then fail
173
 
 
 
169
        
174
170
        We ask to wait up to 400ms; this should fail within at most one
175
171
        second.  (Longer times are more realistic but we don't want the test
176
172
        suite to take too long, and this should do for now.)
188
184
            after = time.time()
189
185
            # it should only take about 0.4 seconds, but we allow more time in
190
186
            # case the machine is heavily loaded
191
 
            self.assertTrue(after - before <= 8.0,
192
 
                "took %f seconds to detect lock contention" % (after - before))
 
187
            self.assertTrue(after - before <= 8.0, 
 
188
                    "took %f seconds to detect lock contention" % (after - before))
193
189
        finally:
194
190
            lf1.unlock()
 
191
        lock_base = lf2.transport.abspath(lf2.path)
195
192
        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.')
 
193
        lock_url = lf2.transport.abspath(lf2.path)
 
194
        self.assertEqual('%s %s\n'
 
195
                         '%s\n%s\n'
 
196
                         'Will continue to try until %s, unless '
 
197
                         'you press Ctrl-C\n'
 
198
                         'If you\'re sure that it\'s not being '
 
199
                         'modified, use bzr break-lock %s',
 
200
                         self._logged_reports[0][0])
 
201
        args = self._logged_reports[0][1]
 
202
        self.assertEqual('Unable to obtain', args[0])
 
203
        self.assertEqual('lock %s' % (lock_base,), args[1])
 
204
        self.assertStartsWith(args[2], 'held by ')
 
205
        self.assertStartsWith(args[3], 'locked ')
 
206
        self.assertEndsWith(args[3], ' ago')
 
207
        self.assertContainsRe(args[4], r'\d\d:\d\d:\d\d')
202
208
 
203
209
    def test_31_lock_wait_easy(self):
204
210
        """Succeed when waiting on a lock with no contention.
216
222
            lf1.unlock()
217
223
        self.assertEqual([], self._logged_reports)
218
224
 
 
225
    def test_32_lock_wait_succeed(self):
 
226
        """Succeed when trying to acquire a lock that gets released
 
227
 
 
228
        One thread holds on a lock and then releases it; another 
 
229
        tries to lock it.
 
230
        """
 
231
        # This test sometimes fails like this:
 
232
        # Traceback (most recent call last):
 
233
 
 
234
        #   File "/home/pqm/bzr-pqm-workdir/home/+trunk/bzrlib/tests/
 
235
        # test_lockdir.py", line 247, in test_32_lock_wait_succeed
 
236
        #     self.assertEqual(1, len(self._logged_reports))
 
237
        # AssertionError: not equal:
 
238
        # a = 1
 
239
        # b = 0
 
240
        raise tests.TestSkipped("Test fails intermittently")
 
241
        t = self.get_transport()
 
242
        lf1 = LockDir(t, 'test_lock')
 
243
        lf1.create()
 
244
        lf1.attempt_lock()
 
245
 
 
246
        def wait_and_unlock():
 
247
            time.sleep(0.1)
 
248
            lf1.unlock()
 
249
        unlocker = Thread(target=wait_and_unlock)
 
250
        unlocker.start()
 
251
        try:
 
252
            lf2 = LockDir(t, 'test_lock')
 
253
            self.setup_log_reporter(lf2)
 
254
            before = time.time()
 
255
            # wait and then lock
 
256
            lf2.wait_lock(timeout=0.4, poll=0.1)
 
257
            after = time.time()
 
258
            self.assertTrue(after - before <= 1.0)
 
259
        finally:
 
260
            unlocker.join()
 
261
 
 
262
        # There should be only 1 report, even though it should have to
 
263
        # wait for a while
 
264
        lock_base = lf2.transport.abspath(lf2.path)
 
265
        self.assertEqual(1, len(self._logged_reports))
 
266
        self.assertEqual('%s %s\n'
 
267
                         '%s\n%s\n'
 
268
                         'Will continue to try until %s\n',
 
269
                         self._logged_reports[0][0])
 
270
        args = self._logged_reports[0][1]
 
271
        self.assertEqual('Unable to obtain', args[0])
 
272
        self.assertEqual('lock %s' % (lock_base,), args[1])
 
273
        self.assertStartsWith(args[2], 'held by ')
 
274
        self.assertStartsWith(args[3], 'locked ')
 
275
        self.assertEndsWith(args[3], ' ago')
 
276
        self.assertContainsRe(args[4], r'\d\d:\d\d:\d\d')
 
277
 
 
278
    def test_34_lock_write_waits(self):
 
279
        """LockDir.lock_write() will wait for the lock.""" 
 
280
        # the test suite sets the default to 0 to make deadlocks fail fast.
 
281
        # change it for this test, as we want to try a manual deadlock.
 
282
        raise tests.TestSkipped('Timing-sensitive test')
 
283
        bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 300
 
284
        t = self.get_transport()
 
285
        lf1 = LockDir(t, 'test_lock')
 
286
        lf1.create()
 
287
        lf1.attempt_lock()
 
288
 
 
289
        def wait_and_unlock():
 
290
            time.sleep(0.1)
 
291
            lf1.unlock()
 
292
        unlocker = Thread(target=wait_and_unlock)
 
293
        unlocker.start()
 
294
        try:
 
295
            lf2 = LockDir(t, 'test_lock')
 
296
            self.setup_log_reporter(lf2)
 
297
            before = time.time()
 
298
            # wait and then lock
 
299
            lf2.lock_write()
 
300
            after = time.time()
 
301
        finally:
 
302
            unlocker.join()
 
303
 
 
304
        # There should be only 1 report, even though it should have to
 
305
        # wait for a while
 
306
        lock_base = lf2.transport.abspath(lf2.path)
 
307
        self.assertEqual(1, len(self._logged_reports))
 
308
        self.assertEqual('%s %s\n'
 
309
                         '%s\n%s\n'
 
310
                         'Will continue to try until %s\n',
 
311
                         self._logged_reports[0][0])
 
312
        args = self._logged_reports[0][1]
 
313
        self.assertEqual('Unable to obtain', args[0])
 
314
        self.assertEqual('lock %s' % (lock_base,), args[1])
 
315
        self.assertStartsWith(args[2], 'held by ')
 
316
        self.assertStartsWith(args[3], 'locked ')
 
317
        self.assertEndsWith(args[3], ' ago')
 
318
        self.assertContainsRe(args[4], r'\d\d:\d\d:\d\d')
 
319
 
 
320
    def test_35_wait_lock_changing(self):
 
321
        """LockDir.wait_lock() will report if the lock changes underneath.
 
322
        
 
323
        This is the stages we want to happen:
 
324
 
 
325
        0) Synchronization locks are created and locked.
 
326
        1) Lock1 obtains the lockdir, and releases the 'check' lock.
 
327
        2) Lock2 grabs the 'check' lock, and checks the lockdir.
 
328
           It sees the lockdir is already acquired, reports the fact, 
 
329
           and unsets the 'checked' lock.
 
330
        3) Thread1 blocks on acquiring the 'checked' lock, and then tells
 
331
           Lock1 to release and acquire the lockdir. This resets the 'check'
 
332
           lock.
 
333
        4) Lock2 acquires the 'check' lock, and checks again. It notices
 
334
           that the holder of the lock has changed, and so reports a new 
 
335
           lock holder.
 
336
        5) Thread1 blocks on the 'checked' lock, this time, it completely
 
337
           unlocks the lockdir, allowing Lock2 to acquire the lock.
 
338
        """
 
339
 
 
340
        raise tests.KnownFailure(
 
341
            "timing dependency in lock tests (#213182)")
 
342
 
 
343
        wait_to_check_lock = Lock()
 
344
        wait_until_checked_lock = Lock()
 
345
 
 
346
        wait_to_check_lock.acquire()
 
347
        wait_until_checked_lock.acquire()
 
348
        note('locked check and checked locks')
 
349
 
 
350
        class LockDir1(LockDir):
 
351
            """Use the synchronization points for the first lock."""
 
352
 
 
353
            def attempt_lock(self):
 
354
                # Once we have acquired the lock, it is okay for
 
355
                # the other lock to check it
 
356
                try:
 
357
                    return super(LockDir1, self).attempt_lock()
 
358
                finally:
 
359
                    note('lock1: releasing check lock')
 
360
                    wait_to_check_lock.release()
 
361
 
 
362
        class LockDir2(LockDir):
 
363
            """Use the synchronization points for the second lock."""
 
364
 
 
365
            def attempt_lock(self):
 
366
                note('lock2: waiting for check lock')
 
367
                wait_to_check_lock.acquire()
 
368
                note('lock2: acquired check lock')
 
369
                try:
 
370
                    return super(LockDir2, self).attempt_lock()
 
371
                finally:
 
372
                    note('lock2: releasing checked lock')
 
373
                    wait_until_checked_lock.release()
 
374
 
 
375
        t = self.get_transport()
 
376
        lf1 = LockDir1(t, 'test_lock')
 
377
        lf1.create()
 
378
 
 
379
        lf2 = LockDir2(t, 'test_lock')
 
380
        self.setup_log_reporter(lf2)
 
381
 
 
382
        def wait_and_switch():
 
383
            lf1.attempt_lock()
 
384
            # Block until lock2 has had a chance to check
 
385
            note('lock1: waiting 1 for checked lock')
 
386
            wait_until_checked_lock.acquire()
 
387
            note('lock1: acquired for checked lock')
 
388
            note('lock1: released lockdir')
 
389
            lf1.unlock()
 
390
            note('lock1: acquiring lockdir')
 
391
            # Create a new nonce, so the lock looks different.
 
392
            lf1.nonce = osutils.rand_chars(20)
 
393
            lf1.lock_write()
 
394
            note('lock1: acquired lockdir')
 
395
 
 
396
            # Block until lock2 has peeked again
 
397
            note('lock1: waiting 2 for checked lock')
 
398
            wait_until_checked_lock.acquire()
 
399
            note('lock1: acquired for checked lock')
 
400
            # Now unlock, and let lock 2 grab the lock
 
401
            lf1.unlock()
 
402
            wait_to_check_lock.release()
 
403
 
 
404
        unlocker = Thread(target=wait_and_switch)
 
405
        unlocker.start()
 
406
        try:
 
407
            # Wait and play against the other thread
 
408
            lf2.wait_lock(timeout=20.0, poll=0.01)
 
409
        finally:
 
410
            unlocker.join()
 
411
        lf2.unlock()
 
412
 
 
413
        # There should be 2 reports, because the lock changed
 
414
        lock_base = lf2.transport.abspath(lf2.path)
 
415
        self.assertEqual(2, len(self._logged_reports))
 
416
        lock_url = lf2.transport.abspath(lf2.path)
 
417
        self.assertEqual('%s %s\n'
 
418
                         '%s\n%s\n'
 
419
                         'Will continue to try until %s, unless '
 
420
                         'you press Ctrl-C\n'
 
421
                         'If you\'re sure that it\'s not being '
 
422
                         'modified, use bzr break-lock %s',
 
423
                         self._logged_reports[0][0])
 
424
        args = self._logged_reports[0][1]
 
425
        self.assertEqual('Unable to obtain', args[0])
 
426
        self.assertEqual('lock %s' % (lock_base,), args[1])
 
427
        self.assertStartsWith(args[2], 'held by ')
 
428
        self.assertStartsWith(args[3], 'locked ')
 
429
        self.assertEndsWith(args[3], ' ago')
 
430
        self.assertContainsRe(args[4], r'\d\d:\d\d:\d\d')
 
431
 
 
432
        self.assertEqual('%s %s\n'
 
433
                         '%s\n%s\n'
 
434
                         'Will continue to try until %s, unless '
 
435
                         'you press Ctrl-C\n'
 
436
                         'If you\'re sure that it\'s not being '
 
437
                         'modified, use bzr break-lock %s',
 
438
                         self._logged_reports[1][0])
 
439
        args = self._logged_reports[1][1]
 
440
        self.assertEqual('Lock owner changed for', args[0])
 
441
        self.assertEqual('lock %s' % (lock_base,), args[1])
 
442
        self.assertStartsWith(args[2], 'held by ')
 
443
        self.assertStartsWith(args[3], 'locked ')
 
444
        self.assertEndsWith(args[3], ' ago')
 
445
        self.assertContainsRe(args[4], r'\d\d:\d\d:\d\d')
 
446
 
219
447
    def test_40_confirm_easy(self):
220
448
        """Confirm a lock that's already held"""
221
449
        t = self.get_transport()
222
450
        lf1 = LockDir(t, 'test_lock')
223
451
        lf1.create()
224
452
        lf1.attempt_lock()
225
 
        self.addCleanup(lf1.unlock)
226
453
        lf1.confirm()
227
454
 
228
455
    def test_41_confirm_not_held(self):
240
467
        lf1.attempt_lock()
241
468
        t.move('test_lock', 'lock_gone_now')
242
469
        self.assertRaises(LockBroken, lf1.confirm)
243
 
        # Clean up
244
 
        t.move('lock_gone_now', 'test_lock')
245
 
        lf1.unlock()
246
470
 
247
471
    def test_43_break(self):
248
472
        """Break a lock whose caller has forgotten it"""
259
483
        lf2.force_break(holder_info)
260
484
        # now we should be able to take it
261
485
        lf2.attempt_lock()
262
 
        self.addCleanup(lf2.unlock)
263
486
        lf2.confirm()
264
487
 
265
488
    def test_44_break_already_released(self):
277
500
        lf2.force_break(holder_info)
278
501
        # now we should be able to take it
279
502
        lf2.attempt_lock()
280
 
        self.addCleanup(lf2.unlock)
281
503
        lf2.confirm()
282
504
 
283
505
    def test_45_break_mismatch(self):
309
531
        """Check the on-disk representation of LockDirs is as expected.
310
532
 
311
533
        There should always be a top-level directory named by the lock.
312
 
        When the lock is held, there should be a lockname/held directory
 
534
        When the lock is held, there should be a lockname/held directory 
313
535
        containing an info file.
314
536
        """
315
537
        t = self.get_transport()
330
552
        # do this without IO redirection to ensure it doesn't prompt.
331
553
        self.assertRaises(AssertionError, ld1.break_lock)
332
554
        orig_factory = bzrlib.ui.ui_factory
333
 
        bzrlib.ui.ui_factory = bzrlib.ui.CannedInputUIFactory([True])
 
555
        # silent ui - no need for stdout
 
556
        bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
 
557
        bzrlib.ui.ui_factory.stdin = StringIO("y\n")
334
558
        try:
335
559
            ld2.break_lock()
336
560
            self.assertRaises(LockBroken, ld1.unlock)
337
561
        finally:
338
562
            bzrlib.ui.ui_factory = orig_factory
339
563
 
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
564
    def test_create_missing_base_directory(self):
399
565
        """If LockDir.path doesn't exist, it can be created
400
566
 
406
572
        lf1 = LockDir(t, 'test_lock')
407
573
 
408
574
        lf1.create()
409
 
        self.assertTrue(t.has('test_lock'))
 
575
        self.failUnless(t.has('test_lock'))
410
576
 
411
577
        t.rmdir('test_lock')
412
 
        self.assertFalse(t.has('test_lock'))
 
578
        self.failIf(t.has('test_lock'))
413
579
 
414
580
        # This will create 'test_lock' if it needs to
415
581
        lf1.lock_write()
416
 
        self.assertTrue(t.has('test_lock'))
417
 
        self.assertTrue(t.has('test_lock/held/info'))
 
582
        self.failUnless(t.has('test_lock'))
 
583
        self.failUnless(t.has('test_lock/held/info'))
418
584
 
419
585
        lf1.unlock()
420
 
        self.assertFalse(t.has('test_lock/held/info'))
 
586
        self.failIf(t.has('test_lock/held/info'))
421
587
 
422
 
    def test_display_form(self):
 
588
    def test__format_lock_info(self):
423
589
        ld1 = self.get_lock()
424
590
        ld1.create()
425
591
        ld1.lock_write()
426
592
        try:
427
 
            info_list = ld1.peek().to_readable_dict()
 
593
            info_list = ld1._format_lock_info(ld1.peek())
428
594
        finally:
429
595
            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$')
 
596
        self.assertEqual('lock %s' % (ld1.transport.abspath(ld1.path),),
 
597
                         info_list[0])
 
598
        self.assertContainsRe(info_list[1],
 
599
                              r'^held by .* on host .* \[process #\d*\]$')
 
600
        self.assertContainsRe(info_list[2], r'locked \d+ seconds? ago$')
433
601
 
434
602
    def test_lock_without_email(self):
435
603
        global_config = config.GlobalConfig()
441
609
        ld1.unlock()
442
610
 
443
611
    def test_lock_permission(self):
444
 
        self.requireFeature(features.not_running_as_root)
445
612
        if not osutils.supports_posix_readonly():
446
613
            raise tests.TestSkipped('Cannot induce a permission failure')
447
614
        ld1 = self.get_lock()
453
620
    def test_lock_by_token(self):
454
621
        ld1 = self.get_lock()
455
622
        token = ld1.lock_write()
456
 
        self.addCleanup(ld1.unlock)
457
623
        self.assertNotEqual(None, token)
458
624
        ld2 = self.get_lock()
459
625
        t2 = ld2.lock_write(token)
460
 
        self.addCleanup(ld2.unlock)
461
626
        self.assertEqual(token, t2)
462
627
 
463
628
    def test_lock_with_buggy_rename(self):
483
648
        # should be nothing before we start
484
649
        ld1.create()
485
650
        t = self.get_transport().clone('test_lock')
486
 
 
487
651
        def check_dir(a):
488
652
            self.assertEquals(a, t.list_dir('.'))
489
 
 
490
653
        check_dir([])
491
654
        # when held, that's all we see
492
655
        ld1.attempt_lock()
493
 
        self.addCleanup(ld1.unlock)
494
656
        check_dir(['held'])
495
657
        # second guy should fail
496
658
        self.assertRaises(errors.LockContention, ld2.attempt_lock)
497
659
        # no kibble
498
660
        check_dir(['held'])
499
 
 
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
 
 
564
 
class TestLockDirHooks(TestCaseWithTransport):
565
 
 
566
 
    def setUp(self):
567
 
        super(TestLockDirHooks, self).setUp()
568
 
        self._calls = []
569
 
 
570
 
    def get_lock(self):
571
 
        return LockDir(self.get_transport(), 'test_lock')
572
 
 
573
 
    def record_hook(self, result):
574
 
        self._calls.append(result)
575
 
 
576
 
    def test_LockDir_acquired_success(self):
577
 
        # the LockDir.lock_acquired hook fires when a lock is acquired.
578
 
        LockDir.hooks.install_named_hook('lock_acquired',
579
 
                                         self.record_hook, 'record_hook')
580
 
        ld = self.get_lock()
581
 
        ld.create()
582
 
        self.assertEqual([], self._calls)
583
 
        result = ld.attempt_lock()
584
 
        lock_path = ld.transport.abspath(ld.path)
585
 
        self.assertEqual([lock.LockResult(lock_path, result)], self._calls)
586
 
        ld.unlock()
587
 
        self.assertEqual([lock.LockResult(lock_path, result)], self._calls)
588
 
 
589
 
    def test_LockDir_acquired_fail(self):
590
 
        # the LockDir.lock_acquired hook does not fire on failure.
591
 
        ld = self.get_lock()
592
 
        ld.create()
593
 
        ld2 = self.get_lock()
594
 
        ld2.attempt_lock()
595
 
        # install a lock hook now, when the disk lock is locked
596
 
        LockDir.hooks.install_named_hook('lock_acquired',
597
 
                                         self.record_hook, 'record_hook')
598
 
        self.assertRaises(errors.LockContention, ld.attempt_lock)
599
 
        self.assertEqual([], self._calls)
600
 
        ld2.unlock()
601
 
        self.assertEqual([], self._calls)
602
 
 
603
 
    def test_LockDir_released_success(self):
604
 
        # the LockDir.lock_released hook fires when a lock is acquired.
605
 
        LockDir.hooks.install_named_hook('lock_released',
606
 
                                         self.record_hook, 'record_hook')
607
 
        ld = self.get_lock()
608
 
        ld.create()
609
 
        self.assertEqual([], self._calls)
610
 
        result = ld.attempt_lock()
611
 
        self.assertEqual([], self._calls)
612
 
        ld.unlock()
613
 
        lock_path = ld.transport.abspath(ld.path)
614
 
        self.assertEqual([lock.LockResult(lock_path, result)], self._calls)
615
 
 
616
 
    def test_LockDir_released_fail(self):
617
 
        # the LockDir.lock_released hook does not fire on failure.
618
 
        ld = self.get_lock()
619
 
        ld.create()
620
 
        ld2 = self.get_lock()
621
 
        ld.attempt_lock()
622
 
        ld2.force_break(ld2.peek())
623
 
        LockDir.hooks.install_named_hook('lock_released',
624
 
                                         self.record_hook, 'record_hook')
625
 
        self.assertRaises(LockBroken, ld.unlock)
626
 
        self.assertEqual([], self._calls)
627
 
 
628
 
    def test_LockDir_broken_success(self):
629
 
        # the LockDir.lock_broken hook fires when a lock is broken.
630
 
        ld = self.get_lock()
631
 
        ld.create()
632
 
        ld2 = self.get_lock()
633
 
        result = ld.attempt_lock()
634
 
        LockDir.hooks.install_named_hook('lock_broken',
635
 
                                         self.record_hook, 'record_hook')
636
 
        ld2.force_break(ld2.peek())
637
 
        lock_path = ld.transport.abspath(ld.path)
638
 
        self.assertEqual([lock.LockResult(lock_path, result)], self._calls)
639
 
 
640
 
    def test_LockDir_broken_failure(self):
641
 
        # the LockDir.lock_broken hook does not fires when a lock is already
642
 
        # released.
643
 
        ld = self.get_lock()
644
 
        ld.create()
645
 
        ld2 = self.get_lock()
646
 
        result = ld.attempt_lock()
647
 
        holder_info = ld2.peek()
648
 
        ld.unlock()
649
 
        LockDir.hooks.install_named_hook('lock_broken',
650
 
                                         self.record_hook, 'record_hook')
651
 
        ld2.force_break(holder_info)
652
 
        lock_path = ld.transport.abspath(ld.path)
653
 
        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()