← 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: 2011-08-17 18:13:57 UTC
  • mfrom: (5268.7.29 transport-segments)
  • Revision ID: pqm@pqm.ubuntu.com-20110817181357-y5q5eth1hk8bl3om
(jelmer) Allow specifying the colocated branch to use in the branch URL,
 and retrieving the branch name using ControlDir._get_selected_branch.
 (Jelmer Vernooij)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_lockdir.py
1
 
# Copyright (C) 2006, 2007, 2008 Canonical Ltd
 
1
# Copyright (C) 2006-2011 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
"""Tests for LockDir"""
18
18
 
19
 
from cStringIO import StringIO
20
19
import os
21
 
from threading import Thread, Lock
22
20
import time
23
21
 
24
22
import bzrlib
26
24
    config,
27
25
    errors,
28
26
    lock,
 
27
    lockdir,
29
28
    osutils,
30
29
    tests,
31
30
    transport,
34
33
    LockBreakMismatch,
35
34
    LockBroken,
36
35
    LockContention,
37
 
    LockError,
38
36
    LockFailed,
39
37
    LockNotHeld,
40
38
    )
41
 
from bzrlib.lockdir import LockDir
42
 
from bzrlib.tests import TestCaseWithTransport
43
 
from bzrlib.trace import note
44
 
 
45
 
# These tests sometimes use threads to test the behaviour of lock files with
46
 
# concurrent actors.  This is not a typical (or necessarily supported) use;
47
 
# they're really meant for guarding between processes.
 
39
from bzrlib.lockdir import (
 
40
    LockDir,
 
41
    LockHeldInfo,
 
42
    )
 
43
from bzrlib.tests import (
 
44
    features,
 
45
    TestCase,
 
46
    TestCaseWithTransport,
 
47
    )
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
 
55
56
class TestLockDir(TestCaseWithTransport):
56
57
    """Test LockDir operations"""
57
58
 
126
127
        lf1.attempt_lock()
127
128
        lf2 = LockDir(t, 'test_lock')
128
129
        try:
129
 
            # locking is between LockDir instances; aliases within 
 
130
            # locking is between LockDir instances; aliases within
130
131
            # a single process are not detected
131
132
            lf2.attempt_lock()
132
133
            self.fail('Failed to detect lock collision')
142
143
        lf1 = LockDir(t, 'test_lock')
143
144
        lf1.create()
144
145
        lf1.attempt_lock()
 
146
        self.addCleanup(lf1.unlock)
145
147
        # lock is held, should get some info on it
146
148
        info1 = lf1.peek()
147
 
        self.assertEqual(set(info1.keys()),
148
 
                         set(['user', 'nonce', 'hostname', 'pid', 'start_time']))
 
149
        self.assertEqual(set(info1.info_dict.keys()),
 
150
            set(['user', 'nonce', 'hostname', 'pid', 'start_time']))
149
151
        # should get the same info if we look at it through a different
150
152
        # instance
151
153
        info2 = LockDir(t, 'test_lock').peek()
161
163
        lf2 = LockDir(self.get_readonly_transport(), 'test_lock')
162
164
        self.assertEqual(lf2.peek(), None)
163
165
        lf1.attempt_lock()
 
166
        self.addCleanup(lf1.unlock)
164
167
        info2 = lf2.peek()
165
168
        self.assertTrue(info2)
166
 
        self.assertEqual(info2['nonce'], lf1.nonce)
 
169
        self.assertEqual(info2.get('nonce'), lf1.nonce)
167
170
 
168
171
    def test_30_lock_wait_fail(self):
169
172
        """Wait on a lock, then fail
170
 
        
 
173
 
171
174
        We ask to wait up to 400ms; this should fail within at most one
172
175
        second.  (Longer times are more realistic but we don't want the test
173
176
        suite to take too long, and this should do for now.)
185
188
            after = time.time()
186
189
            # it should only take about 0.4 seconds, but we allow more time in
187
190
            # case the machine is heavily loaded
188
 
            self.assertTrue(after - before <= 8.0, 
189
 
                    "took %f seconds to detect lock contention" % (after - before))
 
191
            self.assertTrue(after - before <= 8.0,
 
192
                "took %f seconds to detect lock contention" % (after - before))
190
193
        finally:
191
194
            lf1.unlock()
192
 
        lock_base = lf2.transport.abspath(lf2.path)
193
195
        self.assertEqual(1, len(self._logged_reports))
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')
 
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.')
209
202
 
210
203
    def test_31_lock_wait_easy(self):
211
204
        """Succeed when waiting on a lock with no contention.
223
216
            lf1.unlock()
224
217
        self.assertEqual([], self._logged_reports)
225
218
 
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
 
 
448
219
    def test_40_confirm_easy(self):
449
220
        """Confirm a lock that's already held"""
450
221
        t = self.get_transport()
451
222
        lf1 = LockDir(t, 'test_lock')
452
223
        lf1.create()
453
224
        lf1.attempt_lock()
 
225
        self.addCleanup(lf1.unlock)
454
226
        lf1.confirm()
455
227
 
456
228
    def test_41_confirm_not_held(self):
468
240
        lf1.attempt_lock()
469
241
        t.move('test_lock', 'lock_gone_now')
470
242
        self.assertRaises(LockBroken, lf1.confirm)
 
243
        # Clean up
 
244
        t.move('lock_gone_now', 'test_lock')
 
245
        lf1.unlock()
471
246
 
472
247
    def test_43_break(self):
473
248
        """Break a lock whose caller has forgotten it"""
484
259
        lf2.force_break(holder_info)
485
260
        # now we should be able to take it
486
261
        lf2.attempt_lock()
 
262
        self.addCleanup(lf2.unlock)
487
263
        lf2.confirm()
488
264
 
489
265
    def test_44_break_already_released(self):
501
277
        lf2.force_break(holder_info)
502
278
        # now we should be able to take it
503
279
        lf2.attempt_lock()
 
280
        self.addCleanup(lf2.unlock)
504
281
        lf2.confirm()
505
282
 
506
283
    def test_45_break_mismatch(self):
532
309
        """Check the on-disk representation of LockDirs is as expected.
533
310
 
534
311
        There should always be a top-level directory named by the lock.
535
 
        When the lock is held, there should be a lockname/held directory 
 
312
        When the lock is held, there should be a lockname/held directory
536
313
        containing an info file.
537
314
        """
538
315
        t = self.get_transport()
553
330
        # do this without IO redirection to ensure it doesn't prompt.
554
331
        self.assertRaises(AssertionError, ld1.break_lock)
555
332
        orig_factory = bzrlib.ui.ui_factory
556
 
        # silent ui - no need for stdout
557
 
        bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
558
 
        bzrlib.ui.ui_factory.stdin = StringIO("y\n")
 
333
        bzrlib.ui.ui_factory = bzrlib.ui.CannedInputUIFactory([True])
559
334
        try:
560
335
            ld2.break_lock()
561
336
            self.assertRaises(LockBroken, ld1.unlock)
562
337
        finally:
563
338
            bzrlib.ui.ui_factory = orig_factory
564
339
 
 
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
 
565
398
    def test_create_missing_base_directory(self):
566
399
        """If LockDir.path doesn't exist, it can be created
567
400
 
573
406
        lf1 = LockDir(t, 'test_lock')
574
407
 
575
408
        lf1.create()
576
 
        self.failUnless(t.has('test_lock'))
 
409
        self.assertTrue(t.has('test_lock'))
577
410
 
578
411
        t.rmdir('test_lock')
579
 
        self.failIf(t.has('test_lock'))
 
412
        self.assertFalse(t.has('test_lock'))
580
413
 
581
414
        # This will create 'test_lock' if it needs to
582
415
        lf1.lock_write()
583
 
        self.failUnless(t.has('test_lock'))
584
 
        self.failUnless(t.has('test_lock/held/info'))
 
416
        self.assertTrue(t.has('test_lock'))
 
417
        self.assertTrue(t.has('test_lock/held/info'))
585
418
 
586
419
        lf1.unlock()
587
 
        self.failIf(t.has('test_lock/held/info'))
 
420
        self.assertFalse(t.has('test_lock/held/info'))
588
421
 
589
 
    def test__format_lock_info(self):
 
422
    def test_display_form(self):
590
423
        ld1 = self.get_lock()
591
424
        ld1.create()
592
425
        ld1.lock_write()
593
426
        try:
594
 
            info_list = ld1._format_lock_info(ld1.peek())
 
427
            info_list = ld1.peek().to_readable_dict()
595
428
        finally:
596
429
            ld1.unlock()
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$')
 
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$')
602
433
 
603
434
    def test_lock_without_email(self):
604
435
        global_config = config.GlobalConfig()
610
441
        ld1.unlock()
611
442
 
612
443
    def test_lock_permission(self):
 
444
        self.requireFeature(features.not_running_as_root)
613
445
        if not osutils.supports_posix_readonly():
614
446
            raise tests.TestSkipped('Cannot induce a permission failure')
615
447
        ld1 = self.get_lock()
621
453
    def test_lock_by_token(self):
622
454
        ld1 = self.get_lock()
623
455
        token = ld1.lock_write()
 
456
        self.addCleanup(ld1.unlock)
624
457
        self.assertNotEqual(None, token)
625
458
        ld2 = self.get_lock()
626
459
        t2 = ld2.lock_write(token)
 
460
        self.addCleanup(ld2.unlock)
627
461
        self.assertEqual(token, t2)
628
462
 
629
463
    def test_lock_with_buggy_rename(self):
649
483
        # should be nothing before we start
650
484
        ld1.create()
651
485
        t = self.get_transport().clone('test_lock')
 
486
 
652
487
        def check_dir(a):
653
488
            self.assertEquals(a, t.list_dir('.'))
 
489
 
654
490
        check_dir([])
655
491
        # when held, that's all we see
656
492
        ld1.attempt_lock()
 
493
        self.addCleanup(ld1.unlock)
657
494
        check_dir(['held'])
658
495
        # second guy should fail
659
496
        self.assertRaises(errors.LockContention, ld2.attempt_lock)
660
497
        # no kibble
661
498
        check_dir(['held'])
662
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
 
663
573
    def record_hook(self, result):
664
574
        self._calls.append(result)
665
575
 
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
 
 
674
576
    def test_LockDir_acquired_success(self):
675
577
        # the LockDir.lock_acquired hook fires when a lock is acquired.
676
 
        self._calls = []
677
 
        self.reset_hooks()
678
578
        LockDir.hooks.install_named_hook('lock_acquired',
679
 
            self.record_hook, 'record_hook')
 
579
                                         self.record_hook, 'record_hook')
680
580
        ld = self.get_lock()
681
581
        ld.create()
682
582
        self.assertEqual([], self._calls)
688
588
 
689
589
    def test_LockDir_acquired_fail(self):
690
590
        # the LockDir.lock_acquired hook does not fire on failure.
691
 
        self._calls = []
692
 
        self.reset_hooks()
693
591
        ld = self.get_lock()
694
592
        ld.create()
695
593
        ld2 = self.get_lock()
696
594
        ld2.attempt_lock()
697
595
        # install a lock hook now, when the disk lock is locked
698
596
        LockDir.hooks.install_named_hook('lock_acquired',
699
 
            self.record_hook, 'record_hook')
 
597
                                         self.record_hook, 'record_hook')
700
598
        self.assertRaises(errors.LockContention, ld.attempt_lock)
701
599
        self.assertEqual([], self._calls)
702
600
        ld2.unlock()
704
602
 
705
603
    def test_LockDir_released_success(self):
706
604
        # the LockDir.lock_released hook fires when a lock is acquired.
707
 
        self._calls = []
708
 
        self.reset_hooks()
709
605
        LockDir.hooks.install_named_hook('lock_released',
710
 
            self.record_hook, 'record_hook')
 
606
                                         self.record_hook, 'record_hook')
711
607
        ld = self.get_lock()
712
608
        ld.create()
713
609
        self.assertEqual([], self._calls)
719
615
 
720
616
    def test_LockDir_released_fail(self):
721
617
        # the LockDir.lock_released hook does not fire on failure.
722
 
        self._calls = []
723
 
        self.reset_hooks()
724
618
        ld = self.get_lock()
725
619
        ld.create()
726
620
        ld2 = self.get_lock()
727
621
        ld.attempt_lock()
728
622
        ld2.force_break(ld2.peek())
729
623
        LockDir.hooks.install_named_hook('lock_released',
730
 
            self.record_hook, 'record_hook')
 
624
                                         self.record_hook, 'record_hook')
731
625
        self.assertRaises(LockBroken, ld.unlock)
732
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()