~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_lockdir.py

  • Committer: INADA Naoki
  • Date: 2011-05-18 06:27:34 UTC
  • mfrom: (5887 +trunk)
  • mto: This revision was merged to the branch mainline in revision 5894.
  • Revision ID: songofacandy@gmail.com-20110518062734-1ilhll0rrqyyp8um
merge from lp:bzr and resolve conflicts.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
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
34
32
    LockBreakMismatch,
35
33
    LockBroken,
36
34
    LockContention,
37
 
    LockError,
38
35
    LockFailed,
39
36
    LockNotHeld,
40
37
    )
41
38
from bzrlib.lockdir import LockDir
42
 
from bzrlib.tests import TestCaseWithTransport
 
39
from bzrlib.tests import (
 
40
    features,
 
41
    TestCaseWithTransport,
 
42
    )
43
43
from bzrlib.trace import note
44
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
 
 
49
45
# These tests are run on the default transport provided by the test framework
50
46
# (typically a local disk transport).  That can be changed by the --transport
51
47
# option to bzr selftest.  The required properties of the transport
191
187
                    "took %f seconds to detect lock contention" % (after - before))
192
188
        finally:
193
189
            lf1.unlock()
194
 
        lock_base = lf2.transport.abspath(lf2.path)
195
190
        self.assertEqual(1, len(self._logged_reports))
196
 
        lock_url = lf2.transport.abspath(lf2.path)
197
 
        self.assertEqual('%s %s\n'
198
 
                         '%s\n%s\n'
199
 
                         'Will continue to try until %s, unless '
200
 
                         'you press Ctrl-C\n'
201
 
                         'If you\'re sure that it\'s not being '
202
 
                         'modified, use bzr break-lock %s',
203
 
                         self._logged_reports[0][0])
204
 
        args = self._logged_reports[0][1]
205
 
        self.assertEqual('Unable to obtain', args[0])
206
 
        self.assertEqual('lock %s' % (lock_base,), args[1])
207
 
        self.assertStartsWith(args[2], 'held by ')
208
 
        self.assertStartsWith(args[3], 'locked ')
209
 
        self.assertEndsWith(args[3], ' ago')
210
 
        self.assertContainsRe(args[4], r'\d\d:\d\d:\d\d')
 
191
        self.assertEqual(self._logged_reports[0][0],
 
192
            '%s lock %s held by %s\n'
 
193
            'at %s [process #%s], acquired %s.\n'
 
194
            'Will continue to try until %s, unless '
 
195
            'you press Ctrl-C.\n'
 
196
            'See "bzr help break-lock" for more.')
 
197
        start, lock_url, user, hostname, pid, time_ago, deadline_str = \
 
198
            self._logged_reports[0][1]
 
199
        self.assertEqual(start, u'Unable to obtain')
 
200
        self.assertEqual(user, u'jrandom@example.com')
 
201
        # skip hostname
 
202
        self.assertContainsRe(pid, r'\d+')
 
203
        self.assertContainsRe(time_ago, r'.* ago')
 
204
        self.assertContainsRe(deadline_str, r'\d{2}:\d{2}:\d{2}')
211
205
 
212
206
    def test_31_lock_wait_easy(self):
213
207
        """Succeed when waiting on a lock with no contention.
225
219
            lf1.unlock()
226
220
        self.assertEqual([], self._logged_reports)
227
221
 
228
 
    def test_32_lock_wait_succeed(self):
229
 
        """Succeed when trying to acquire a lock that gets released
230
 
 
231
 
        One thread holds on a lock and then releases it; another
232
 
        tries to lock it.
233
 
        """
234
 
        # This test sometimes fails like this:
235
 
        # Traceback (most recent call last):
236
 
 
237
 
        #   File "/home/pqm/bzr-pqm-workdir/home/+trunk/bzrlib/tests/
238
 
        # test_lockdir.py", line 247, in test_32_lock_wait_succeed
239
 
        #     self.assertEqual(1, len(self._logged_reports))
240
 
        # AssertionError: not equal:
241
 
        # a = 1
242
 
        # b = 0
243
 
        raise tests.TestSkipped("Test fails intermittently")
244
 
        t = self.get_transport()
245
 
        lf1 = LockDir(t, 'test_lock')
246
 
        lf1.create()
247
 
        lf1.attempt_lock()
248
 
 
249
 
        def wait_and_unlock():
250
 
            time.sleep(0.1)
251
 
            lf1.unlock()
252
 
        unlocker = Thread(target=wait_and_unlock)
253
 
        unlocker.start()
254
 
        try:
255
 
            lf2 = LockDir(t, 'test_lock')
256
 
            self.setup_log_reporter(lf2)
257
 
            before = time.time()
258
 
            # wait and then lock
259
 
            lf2.wait_lock(timeout=0.4, poll=0.1)
260
 
            after = time.time()
261
 
            self.assertTrue(after - before <= 1.0)
262
 
        finally:
263
 
            unlocker.join()
264
 
 
265
 
        # There should be only 1 report, even though it should have to
266
 
        # wait for a while
267
 
        lock_base = lf2.transport.abspath(lf2.path)
268
 
        self.assertEqual(1, len(self._logged_reports))
269
 
        self.assertEqual('%s %s\n'
270
 
                         '%s\n%s\n'
271
 
                         'Will continue to try until %s\n',
272
 
                         self._logged_reports[0][0])
273
 
        args = self._logged_reports[0][1]
274
 
        self.assertEqual('Unable to obtain', args[0])
275
 
        self.assertEqual('lock %s' % (lock_base,), args[1])
276
 
        self.assertStartsWith(args[2], 'held by ')
277
 
        self.assertStartsWith(args[3], 'locked ')
278
 
        self.assertEndsWith(args[3], ' ago')
279
 
        self.assertContainsRe(args[4], r'\d\d:\d\d:\d\d')
280
 
 
281
 
    def test_34_lock_write_waits(self):
282
 
        """LockDir.lock_write() will wait for the lock."""
283
 
        # the test suite sets the default to 0 to make deadlocks fail fast.
284
 
        # change it for this test, as we want to try a manual deadlock.
285
 
        raise tests.TestSkipped('Timing-sensitive test')
286
 
        bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 300
287
 
        t = self.get_transport()
288
 
        lf1 = LockDir(t, 'test_lock')
289
 
        lf1.create()
290
 
        lf1.attempt_lock()
291
 
 
292
 
        def wait_and_unlock():
293
 
            time.sleep(0.1)
294
 
            lf1.unlock()
295
 
        unlocker = Thread(target=wait_and_unlock)
296
 
        unlocker.start()
297
 
        try:
298
 
            lf2 = LockDir(t, 'test_lock')
299
 
            self.setup_log_reporter(lf2)
300
 
            before = time.time()
301
 
            # wait and then lock
302
 
            lf2.lock_write()
303
 
            after = time.time()
304
 
        finally:
305
 
            unlocker.join()
306
 
 
307
 
        # There should be only 1 report, even though it should have to
308
 
        # wait for a while
309
 
        lock_base = lf2.transport.abspath(lf2.path)
310
 
        self.assertEqual(1, len(self._logged_reports))
311
 
        self.assertEqual('%s %s\n'
312
 
                         '%s\n%s\n'
313
 
                         'Will continue to try until %s\n',
314
 
                         self._logged_reports[0][0])
315
 
        args = self._logged_reports[0][1]
316
 
        self.assertEqual('Unable to obtain', args[0])
317
 
        self.assertEqual('lock %s' % (lock_base,), args[1])
318
 
        self.assertStartsWith(args[2], 'held by ')
319
 
        self.assertStartsWith(args[3], 'locked ')
320
 
        self.assertEndsWith(args[3], ' ago')
321
 
        self.assertContainsRe(args[4], r'\d\d:\d\d:\d\d')
322
 
 
323
 
    def test_35_wait_lock_changing(self):
324
 
        """LockDir.wait_lock() will report if the lock changes underneath.
325
 
 
326
 
        This is the stages we want to happen:
327
 
 
328
 
        0) Synchronization locks are created and locked.
329
 
        1) Lock1 obtains the lockdir, and releases the 'check' lock.
330
 
        2) Lock2 grabs the 'check' lock, and checks the lockdir.
331
 
           It sees the lockdir is already acquired, reports the fact,
332
 
           and unsets the 'checked' lock.
333
 
        3) Thread1 blocks on acquiring the 'checked' lock, and then tells
334
 
           Lock1 to release and acquire the lockdir. This resets the 'check'
335
 
           lock.
336
 
        4) Lock2 acquires the 'check' lock, and checks again. It notices
337
 
           that the holder of the lock has changed, and so reports a new
338
 
           lock holder.
339
 
        5) Thread1 blocks on the 'checked' lock, this time, it completely
340
 
           unlocks the lockdir, allowing Lock2 to acquire the lock.
341
 
        """
342
 
 
343
 
        raise tests.KnownFailure(
344
 
            "timing dependency in lock tests (#213182)")
345
 
 
346
 
        wait_to_check_lock = Lock()
347
 
        wait_until_checked_lock = Lock()
348
 
 
349
 
        wait_to_check_lock.acquire()
350
 
        wait_until_checked_lock.acquire()
351
 
        note('locked check and checked locks')
352
 
 
353
 
        class LockDir1(LockDir):
354
 
            """Use the synchronization points for the first lock."""
355
 
 
356
 
            def attempt_lock(self):
357
 
                # Once we have acquired the lock, it is okay for
358
 
                # the other lock to check it
359
 
                try:
360
 
                    return super(LockDir1, self).attempt_lock()
361
 
                finally:
362
 
                    note('lock1: releasing check lock')
363
 
                    wait_to_check_lock.release()
364
 
 
365
 
        class LockDir2(LockDir):
366
 
            """Use the synchronization points for the second lock."""
367
 
 
368
 
            def attempt_lock(self):
369
 
                note('lock2: waiting for check lock')
370
 
                wait_to_check_lock.acquire()
371
 
                note('lock2: acquired check lock')
372
 
                try:
373
 
                    return super(LockDir2, self).attempt_lock()
374
 
                finally:
375
 
                    note('lock2: releasing checked lock')
376
 
                    wait_until_checked_lock.release()
377
 
 
378
 
        t = self.get_transport()
379
 
        lf1 = LockDir1(t, 'test_lock')
380
 
        lf1.create()
381
 
 
382
 
        lf2 = LockDir2(t, 'test_lock')
383
 
        self.setup_log_reporter(lf2)
384
 
 
385
 
        def wait_and_switch():
386
 
            lf1.attempt_lock()
387
 
            # Block until lock2 has had a chance to check
388
 
            note('lock1: waiting 1 for checked lock')
389
 
            wait_until_checked_lock.acquire()
390
 
            note('lock1: acquired for checked lock')
391
 
            note('lock1: released lockdir')
392
 
            lf1.unlock()
393
 
            note('lock1: acquiring lockdir')
394
 
            # Create a new nonce, so the lock looks different.
395
 
            lf1.nonce = osutils.rand_chars(20)
396
 
            lf1.lock_write()
397
 
            note('lock1: acquired lockdir')
398
 
 
399
 
            # Block until lock2 has peeked again
400
 
            note('lock1: waiting 2 for checked lock')
401
 
            wait_until_checked_lock.acquire()
402
 
            note('lock1: acquired for checked lock')
403
 
            # Now unlock, and let lock 2 grab the lock
404
 
            lf1.unlock()
405
 
            wait_to_check_lock.release()
406
 
 
407
 
        unlocker = Thread(target=wait_and_switch)
408
 
        unlocker.start()
409
 
        try:
410
 
            # Wait and play against the other thread
411
 
            lf2.wait_lock(timeout=20.0, poll=0.01)
412
 
        finally:
413
 
            unlocker.join()
414
 
        lf2.unlock()
415
 
 
416
 
        # There should be 2 reports, because the lock changed
417
 
        lock_base = lf2.transport.abspath(lf2.path)
418
 
        self.assertEqual(2, len(self._logged_reports))
419
 
        lock_url = lf2.transport.abspath(lf2.path)
420
 
        self.assertEqual('%s %s\n'
421
 
                         '%s\n%s\n'
422
 
                         'Will continue to try until %s, unless '
423
 
                         'you press Ctrl-C\n'
424
 
                         'If you\'re sure that it\'s not being '
425
 
                         'modified, use bzr break-lock %s',
426
 
                         self._logged_reports[0][0])
427
 
        args = self._logged_reports[0][1]
428
 
        self.assertEqual('Unable to obtain', args[0])
429
 
        self.assertEqual('lock %s' % (lock_base,), args[1])
430
 
        self.assertStartsWith(args[2], 'held by ')
431
 
        self.assertStartsWith(args[3], 'locked ')
432
 
        self.assertEndsWith(args[3], ' ago')
433
 
        self.assertContainsRe(args[4], r'\d\d:\d\d:\d\d')
434
 
 
435
 
        self.assertEqual('%s %s\n'
436
 
                         '%s\n%s\n'
437
 
                         'Will continue to try until %s, unless '
438
 
                         'you press Ctrl-C\n'
439
 
                         'If you\'re sure that it\'s not being '
440
 
                         'modified, use bzr break-lock %s',
441
 
                         self._logged_reports[1][0])
442
 
        args = self._logged_reports[1][1]
443
 
        self.assertEqual('Lock owner changed for', args[0])
444
 
        self.assertEqual('lock %s' % (lock_base,), args[1])
445
 
        self.assertStartsWith(args[2], 'held by ')
446
 
        self.assertStartsWith(args[3], 'locked ')
447
 
        self.assertEndsWith(args[3], ' ago')
448
 
        self.assertContainsRe(args[4], r'\d\d:\d\d:\d\d')
449
 
 
450
222
    def test_40_confirm_easy(self):
451
223
        """Confirm a lock that's already held"""
452
224
        t = self.get_transport()
568
340
        finally:
569
341
            bzrlib.ui.ui_factory = orig_factory
570
342
 
 
343
    def test_break_lock_corrupt_info(self):
 
344
        """break_lock works even if the info file is corrupt (and tells the UI
 
345
        that it is corrupt).
 
346
        """
 
347
        ld = self.get_lock()
 
348
        ld2 = self.get_lock()
 
349
        ld.create()
 
350
        ld.lock_write()
 
351
        ld.transport.put_bytes_non_atomic('test_lock/held/info', '\0')
 
352
        class LoggingUIFactory(bzrlib.ui.SilentUIFactory):
 
353
            def __init__(self):
 
354
                self.prompts = []
 
355
            def get_boolean(self, prompt):
 
356
                self.prompts.append(('boolean', prompt))
 
357
                return True
 
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
        class LoggingUIFactory(bzrlib.ui.SilentUIFactory):
 
376
            def __init__(self):
 
377
                self.prompts = []
 
378
            def get_boolean(self, prompt):
 
379
                self.prompts.append(('boolean', prompt))
 
380
                return True
 
381
        ui = LoggingUIFactory()
 
382
        orig_factory = bzrlib.ui.ui_factory
 
383
        bzrlib.ui.ui_factory = ui
 
384
        try:
 
385
            ld2.break_lock()
 
386
            self.assertRaises(LockBroken, ld.unlock)
 
387
            self.assertLength(0, ui.prompts)
 
388
        finally:
 
389
            bzrlib.ui.ui_factory = orig_factory
 
390
        # Suppress warnings due to ld not being unlocked
 
391
        # XXX: if lock_broken hook was invoked in this case, this hack would
 
392
        # not be necessary.  - Andrew Bennetts, 2010-09-06.
 
393
        del self._lock_actions[:]
 
394
 
571
395
    def test_create_missing_base_directory(self):
572
396
        """If LockDir.path doesn't exist, it can be created
573
397
 
579
403
        lf1 = LockDir(t, 'test_lock')
580
404
 
581
405
        lf1.create()
582
 
        self.failUnless(t.has('test_lock'))
 
406
        self.assertTrue(t.has('test_lock'))
583
407
 
584
408
        t.rmdir('test_lock')
585
 
        self.failIf(t.has('test_lock'))
 
409
        self.assertFalse(t.has('test_lock'))
586
410
 
587
411
        # This will create 'test_lock' if it needs to
588
412
        lf1.lock_write()
589
 
        self.failUnless(t.has('test_lock'))
590
 
        self.failUnless(t.has('test_lock/held/info'))
 
413
        self.assertTrue(t.has('test_lock'))
 
414
        self.assertTrue(t.has('test_lock/held/info'))
591
415
 
592
416
        lf1.unlock()
593
 
        self.failIf(t.has('test_lock/held/info'))
 
417
        self.assertFalse(t.has('test_lock/held/info'))
594
418
 
595
419
    def test__format_lock_info(self):
596
420
        ld1 = self.get_lock()
600
424
            info_list = ld1._format_lock_info(ld1.peek())
601
425
        finally:
602
426
            ld1.unlock()
603
 
        self.assertEqual('lock %s' % (ld1.transport.abspath(ld1.path),),
604
 
                         info_list[0])
605
 
        self.assertContainsRe(info_list[1],
606
 
                              r'^held by .* on host .* \[process #\d*\]$')
607
 
        self.assertContainsRe(info_list[2], r'locked \d+ seconds? ago$')
 
427
        self.assertEqual(info_list[0], u'jrandom@example.com')
 
428
        # info_list[1] is hostname. we skip this.
 
429
        self.assertContainsRe(info_list[2], '^\d+$') # pid
 
430
        self.assertContainsRe(info_list[3], r'^\d+ seconds? ago$') # time_ago
608
431
 
609
432
    def test_lock_without_email(self):
610
433
        global_config = config.GlobalConfig()
616
439
        ld1.unlock()
617
440
 
618
441
    def test_lock_permission(self):
 
442
        self.requireFeature(features.not_running_as_root)
619
443
        if not osutils.supports_posix_readonly():
620
444
            raise tests.TestSkipped('Cannot induce a permission failure')
621
445
        ld1 = self.get_lock()
669
493
        # no kibble
670
494
        check_dir(['held'])
671
495
 
 
496
    def test_no_lockdir_info(self):
 
497
        """We can cope with empty info files."""
 
498
        # This seems like a fairly common failure case - see
 
499
        # <https://bugs.launchpad.net/bzr/+bug/185103> and all its dupes.
 
500
        # Processes are often interrupted after opening the file
 
501
        # before the actual contents are committed.
 
502
        t = self.get_transport()
 
503
        t.mkdir('test_lock')
 
504
        t.mkdir('test_lock/held')
 
505
        t.put_bytes('test_lock/held/info', '')
 
506
        lf = LockDir(t, 'test_lock')
 
507
        info = lf.peek()
 
508
        formatted_info = lf._format_lock_info(info)
 
509
        self.assertEquals(
 
510
            ['<unknown>', '<unknown>', '<unknown>', '(unknown)'],
 
511
            formatted_info)
 
512
 
 
513
    def test_corrupt_lockdir_info(self):
 
514
        """We can cope with corrupt (and thus unparseable) info files."""
 
515
        # This seems like a fairly common failure case too - see
 
516
        # <https://bugs.launchpad.net/bzr/+bug/619872> for instance.
 
517
        # In particular some systems tend to fill recently created files with
 
518
        # nul bytes after recovering from a system crash.
 
519
        t = self.get_transport()
 
520
        t.mkdir('test_lock')
 
521
        t.mkdir('test_lock/held')
 
522
        t.put_bytes('test_lock/held/info', '\0')
 
523
        lf = LockDir(t, 'test_lock')
 
524
        self.assertRaises(errors.LockCorrupt, lf.peek)
 
525
        # Currently attempt_lock gives LockContention, but LockCorrupt would be
 
526
        # a reasonable result too.
 
527
        self.assertRaises(
 
528
            (errors.LockCorrupt, errors.LockContention), lf.attempt_lock)
 
529
        self.assertRaises(errors.LockCorrupt, lf.validate_token, 'fake token')
 
530
 
 
531
    def test_missing_lockdir_info(self):
 
532
        """We can cope with absent info files."""
 
533
        t = self.get_transport()
 
534
        t.mkdir('test_lock')
 
535
        t.mkdir('test_lock/held')
 
536
        lf = LockDir(t, 'test_lock')
 
537
        # In this case we expect the 'not held' result from peek, because peek
 
538
        # cannot be expected to notice that there is a 'held' directory with no
 
539
        # 'info' file.
 
540
        self.assertEqual(None, lf.peek())
 
541
        # And lock/unlock may work or give LockContention (but not any other
 
542
        # error).
 
543
        try:
 
544
            lf.attempt_lock()
 
545
        except LockContention:
 
546
            # LockContention is ok, and expected on Windows
 
547
            pass
 
548
        else:
 
549
            # no error is ok, and expected on POSIX (because POSIX allows
 
550
            # os.rename over an empty directory).
 
551
            lf.unlock()
 
552
        # Currently raises TokenMismatch, but LockCorrupt would be reasonable
 
553
        # too.
 
554
        self.assertRaises(
 
555
            (errors.TokenMismatch, errors.LockCorrupt),
 
556
            lf.validate_token, 'fake token')
 
557
 
672
558
 
673
559
class TestLockDirHooks(TestCaseWithTransport):
674
560