← 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-03-16 16:58:03 UTC
  • mfrom: (3224.3.1 news-typo)
  • Revision ID: pqm@pqm.ubuntu.com-20080316165803-tisoc9mpob9z544o
(Matt Nordhoff) Trivial NEWS typo fix

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
        self.assertEqual('%s %s\n'
 
194
                         '%s\n%s\n'
 
195
                         'Will continue to try until %s\n',
 
196
                         self._logged_reports[0][0])
 
197
        args = self._logged_reports[0][1]
 
198
        self.assertEqual('Unable to obtain', args[0])
 
199
        self.assertEqual('lock %s' % (lock_base,), args[1])
 
200
        self.assertStartsWith(args[2], 'held by ')
 
201
        self.assertStartsWith(args[3], 'locked ')
 
202
        self.assertEndsWith(args[3], ' ago')
 
203
        self.assertContainsRe(args[4], r'\d\d:\d\d:\d\d')
202
204
 
203
205
    def test_31_lock_wait_easy(self):
204
206
        """Succeed when waiting on a lock with no contention.
216
218
            lf1.unlock()
217
219
        self.assertEqual([], self._logged_reports)
218
220
 
 
221
    def test_32_lock_wait_succeed(self):
 
222
        """Succeed when trying to acquire a lock that gets released
 
223
 
 
224
        One thread holds on a lock and then releases it; another 
 
225
        tries to lock it.
 
226
        """
 
227
        # This test sometimes fails like this:
 
228
        # Traceback (most recent call last):
 
229
 
 
230
        #   File "/home/pqm/bzr-pqm-workdir/home/+trunk/bzrlib/tests/
 
231
        # test_lockdir.py", line 247, in test_32_lock_wait_succeed
 
232
        #     self.assertEqual(1, len(self._logged_reports))
 
233
        # AssertionError: not equal:
 
234
        # a = 1
 
235
        # b = 0
 
236
        raise tests.TestSkipped("Test fails intermittently")
 
237
        t = self.get_transport()
 
238
        lf1 = LockDir(t, 'test_lock')
 
239
        lf1.create()
 
240
        lf1.attempt_lock()
 
241
 
 
242
        def wait_and_unlock():
 
243
            time.sleep(0.1)
 
244
            lf1.unlock()
 
245
        unlocker = Thread(target=wait_and_unlock)
 
246
        unlocker.start()
 
247
        try:
 
248
            lf2 = LockDir(t, 'test_lock')
 
249
            self.setup_log_reporter(lf2)
 
250
            before = time.time()
 
251
            # wait and then lock
 
252
            lf2.wait_lock(timeout=0.4, poll=0.1)
 
253
            after = time.time()
 
254
            self.assertTrue(after - before <= 1.0)
 
255
        finally:
 
256
            unlocker.join()
 
257
 
 
258
        # There should be only 1 report, even though it should have to
 
259
        # wait for a while
 
260
        lock_base = lf2.transport.abspath(lf2.path)
 
261
        self.assertEqual(1, len(self._logged_reports))
 
262
        self.assertEqual('%s %s\n'
 
263
                         '%s\n%s\n'
 
264
                         'Will continue to try until %s\n',
 
265
                         self._logged_reports[0][0])
 
266
        args = self._logged_reports[0][1]
 
267
        self.assertEqual('Unable to obtain', args[0])
 
268
        self.assertEqual('lock %s' % (lock_base,), args[1])
 
269
        self.assertStartsWith(args[2], 'held by ')
 
270
        self.assertStartsWith(args[3], 'locked ')
 
271
        self.assertEndsWith(args[3], ' ago')
 
272
        self.assertContainsRe(args[4], r'\d\d:\d\d:\d\d')
 
273
 
 
274
    def test_34_lock_write_waits(self):
 
275
        """LockDir.lock_write() will wait for the lock.""" 
 
276
        # the test suite sets the default to 0 to make deadlocks fail fast.
 
277
        # change it for this test, as we want to try a manual deadlock.
 
278
        raise tests.TestSkipped('Timing-sensitive test')
 
279
        bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 300
 
280
        t = self.get_transport()
 
281
        lf1 = LockDir(t, 'test_lock')
 
282
        lf1.create()
 
283
        lf1.attempt_lock()
 
284
 
 
285
        def wait_and_unlock():
 
286
            time.sleep(0.1)
 
287
            lf1.unlock()
 
288
        unlocker = Thread(target=wait_and_unlock)
 
289
        unlocker.start()
 
290
        try:
 
291
            lf2 = LockDir(t, 'test_lock')
 
292
            self.setup_log_reporter(lf2)
 
293
            before = time.time()
 
294
            # wait and then lock
 
295
            lf2.lock_write()
 
296
            after = time.time()
 
297
        finally:
 
298
            unlocker.join()
 
299
 
 
300
        # There should be only 1 report, even though it should have to
 
301
        # wait for a while
 
302
        lock_base = lf2.transport.abspath(lf2.path)
 
303
        self.assertEqual(1, len(self._logged_reports))
 
304
        self.assertEqual('%s %s\n'
 
305
                         '%s\n%s\n'
 
306
                         'Will continue to try until %s\n',
 
307
                         self._logged_reports[0][0])
 
308
        args = self._logged_reports[0][1]
 
309
        self.assertEqual('Unable to obtain', args[0])
 
310
        self.assertEqual('lock %s' % (lock_base,), args[1])
 
311
        self.assertStartsWith(args[2], 'held by ')
 
312
        self.assertStartsWith(args[3], 'locked ')
 
313
        self.assertEndsWith(args[3], ' ago')
 
314
        self.assertContainsRe(args[4], r'\d\d:\d\d:\d\d')
 
315
 
 
316
    def test_35_wait_lock_changing(self):
 
317
        """LockDir.wait_lock() will report if the lock changes underneath.
 
318
        
 
319
        This is the stages we want to happen:
 
320
 
 
321
        0) Synchronization locks are created and locked.
 
322
        1) Lock1 obtains the lockdir, and releases the 'check' lock.
 
323
        2) Lock2 grabs the 'check' lock, and checks the lockdir.
 
324
           It sees the lockdir is already acquired, reports the fact, 
 
325
           and unsets the 'checked' lock.
 
326
        3) Thread1 blocks on acquiring the 'checked' lock, and then tells
 
327
           Lock1 to release and acquire the lockdir. This resets the 'check'
 
328
           lock.
 
329
        4) Lock2 acquires the 'check' lock, and checks again. It notices
 
330
           that the holder of the lock has changed, and so reports a new 
 
331
           lock holder.
 
332
        5) Thread1 blocks on the 'checked' lock, this time, it completely
 
333
           unlocks the lockdir, allowing Lock2 to acquire the lock.
 
334
        """
 
335
 
 
336
        wait_to_check_lock = Lock()
 
337
        wait_until_checked_lock = Lock()
 
338
 
 
339
        wait_to_check_lock.acquire()
 
340
        wait_until_checked_lock.acquire()
 
341
        note('locked check and checked locks')
 
342
 
 
343
        class LockDir1(LockDir):
 
344
            """Use the synchronization points for the first lock."""
 
345
 
 
346
            def attempt_lock(self):
 
347
                # Once we have acquired the lock, it is okay for
 
348
                # the other lock to check it
 
349
                try:
 
350
                    return super(LockDir1, self).attempt_lock()
 
351
                finally:
 
352
                    note('lock1: releasing check lock')
 
353
                    wait_to_check_lock.release()
 
354
 
 
355
        class LockDir2(LockDir):
 
356
            """Use the synchronization points for the second lock."""
 
357
 
 
358
            def attempt_lock(self):
 
359
                note('lock2: waiting for check lock')
 
360
                wait_to_check_lock.acquire()
 
361
                note('lock2: acquired check lock')
 
362
                try:
 
363
                    return super(LockDir2, self).attempt_lock()
 
364
                finally:
 
365
                    note('lock2: releasing checked lock')
 
366
                    wait_until_checked_lock.release()
 
367
 
 
368
        t = self.get_transport()
 
369
        lf1 = LockDir1(t, 'test_lock')
 
370
        lf1.create()
 
371
 
 
372
        lf2 = LockDir2(t, 'test_lock')
 
373
        self.setup_log_reporter(lf2)
 
374
 
 
375
        def wait_and_switch():
 
376
            lf1.attempt_lock()
 
377
            # Block until lock2 has had a chance to check
 
378
            note('lock1: waiting 1 for checked lock')
 
379
            wait_until_checked_lock.acquire()
 
380
            note('lock1: acquired for checked lock')
 
381
            note('lock1: released lockdir')
 
382
            lf1.unlock()
 
383
            note('lock1: acquiring lockdir')
 
384
            # Create a new nonce, so the lock looks different.
 
385
            lf1.nonce = osutils.rand_chars(20)
 
386
            lf1.lock_write()
 
387
            note('lock1: acquired lockdir')
 
388
 
 
389
            # Block until lock2 has peeked again
 
390
            note('lock1: waiting 2 for checked lock')
 
391
            wait_until_checked_lock.acquire()
 
392
            note('lock1: acquired for checked lock')
 
393
            # Now unlock, and let lock 2 grab the lock
 
394
            lf1.unlock()
 
395
            wait_to_check_lock.release()
 
396
 
 
397
        unlocker = Thread(target=wait_and_switch)
 
398
        unlocker.start()
 
399
        try:
 
400
            # Wait and play against the other thread
 
401
            lf2.wait_lock(timeout=20.0, poll=0.01)
 
402
        finally:
 
403
            unlocker.join()
 
404
        lf2.unlock()
 
405
 
 
406
        # There should be 2 reports, because the lock changed
 
407
        lock_base = lf2.transport.abspath(lf2.path)
 
408
        self.assertEqual(2, len(self._logged_reports))
 
409
 
 
410
        self.assertEqual('%s %s\n'
 
411
                         '%s\n%s\n'
 
412
                         'Will continue to try until %s\n',
 
413
                         self._logged_reports[0][0])
 
414
        args = self._logged_reports[0][1]
 
415
        self.assertEqual('Unable to obtain', args[0])
 
416
        self.assertEqual('lock %s' % (lock_base,), args[1])
 
417
        self.assertStartsWith(args[2], 'held by ')
 
418
        self.assertStartsWith(args[3], 'locked ')
 
419
        self.assertEndsWith(args[3], ' ago')
 
420
        self.assertContainsRe(args[4], r'\d\d:\d\d:\d\d')
 
421
 
 
422
        self.assertEqual('%s %s\n'
 
423
                         '%s\n%s\n'
 
424
                         'Will continue to try until %s\n',
 
425
                         self._logged_reports[1][0])
 
426
        args = self._logged_reports[1][1]
 
427
        self.assertEqual('Lock owner changed for', args[0])
 
428
        self.assertEqual('lock %s' % (lock_base,), args[1])
 
429
        self.assertStartsWith(args[2], 'held by ')
 
430
        self.assertStartsWith(args[3], 'locked ')
 
431
        self.assertEndsWith(args[3], ' ago')
 
432
        self.assertContainsRe(args[4], r'\d\d:\d\d:\d\d')
 
433
 
219
434
    def test_40_confirm_easy(self):
220
435
        """Confirm a lock that's already held"""
221
436
        t = self.get_transport()
222
437
        lf1 = LockDir(t, 'test_lock')
223
438
        lf1.create()
224
439
        lf1.attempt_lock()
225
 
        self.addCleanup(lf1.unlock)
226
440
        lf1.confirm()
227
441
 
228
442
    def test_41_confirm_not_held(self):
240
454
        lf1.attempt_lock()
241
455
        t.move('test_lock', 'lock_gone_now')
242
456
        self.assertRaises(LockBroken, lf1.confirm)
243
 
        # Clean up
244
 
        t.move('lock_gone_now', 'test_lock')
245
 
        lf1.unlock()
246
457
 
247
458
    def test_43_break(self):
248
459
        """Break a lock whose caller has forgotten it"""
259
470
        lf2.force_break(holder_info)
260
471
        # now we should be able to take it
261
472
        lf2.attempt_lock()
262
 
        self.addCleanup(lf2.unlock)
263
473
        lf2.confirm()
264
474
 
265
475
    def test_44_break_already_released(self):
277
487
        lf2.force_break(holder_info)
278
488
        # now we should be able to take it
279
489
        lf2.attempt_lock()
280
 
        self.addCleanup(lf2.unlock)
281
490
        lf2.confirm()
282
491
 
283
492
    def test_45_break_mismatch(self):
309
518
        """Check the on-disk representation of LockDirs is as expected.
310
519
 
311
520
        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
 
521
        When the lock is held, there should be a lockname/held directory 
313
522
        containing an info file.
314
523
        """
315
524
        t = self.get_transport()
330
539
        # do this without IO redirection to ensure it doesn't prompt.
331
540
        self.assertRaises(AssertionError, ld1.break_lock)
332
541
        orig_factory = bzrlib.ui.ui_factory
333
 
        bzrlib.ui.ui_factory = bzrlib.ui.CannedInputUIFactory([True])
 
542
        # silent ui - no need for stdout
 
543
        bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
 
544
        bzrlib.ui.ui_factory.stdin = StringIO("y\n")
334
545
        try:
335
546
            ld2.break_lock()
336
547
            self.assertRaises(LockBroken, ld1.unlock)
337
548
        finally:
338
549
            bzrlib.ui.ui_factory = orig_factory
339
550
 
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
551
    def test_create_missing_base_directory(self):
399
552
        """If LockDir.path doesn't exist, it can be created
400
553
 
406
559
        lf1 = LockDir(t, 'test_lock')
407
560
 
408
561
        lf1.create()
409
 
        self.assertTrue(t.has('test_lock'))
 
562
        self.failUnless(t.has('test_lock'))
410
563
 
411
564
        t.rmdir('test_lock')
412
 
        self.assertFalse(t.has('test_lock'))
 
565
        self.failIf(t.has('test_lock'))
413
566
 
414
567
        # This will create 'test_lock' if it needs to
415
568
        lf1.lock_write()
416
 
        self.assertTrue(t.has('test_lock'))
417
 
        self.assertTrue(t.has('test_lock/held/info'))
 
569
        self.failUnless(t.has('test_lock'))
 
570
        self.failUnless(t.has('test_lock/held/info'))
418
571
 
419
572
        lf1.unlock()
420
 
        self.assertFalse(t.has('test_lock/held/info'))
 
573
        self.failIf(t.has('test_lock/held/info'))
421
574
 
422
 
    def test_display_form(self):
 
575
    def test__format_lock_info(self):
423
576
        ld1 = self.get_lock()
424
577
        ld1.create()
425
578
        ld1.lock_write()
426
579
        try:
427
 
            info_list = ld1.peek().to_readable_dict()
 
580
            info_list = ld1._format_lock_info(ld1.peek())
428
581
        finally:
429
582
            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$')
 
583
        self.assertEqual('lock %s' % (ld1.transport.abspath(ld1.path),),
 
584
                         info_list[0])
 
585
        self.assertContainsRe(info_list[1],
 
586
                              r'^held by .* on host .* \[process #\d*\]$')
 
587
        self.assertContainsRe(info_list[2], r'locked \d+ seconds? ago$')
433
588
 
434
589
    def test_lock_without_email(self):
435
590
        global_config = config.GlobalConfig()
441
596
        ld1.unlock()
442
597
 
443
598
    def test_lock_permission(self):
444
 
        self.requireFeature(features.not_running_as_root)
445
599
        if not osutils.supports_posix_readonly():
446
600
            raise tests.TestSkipped('Cannot induce a permission failure')
447
601
        ld1 = self.get_lock()
453
607
    def test_lock_by_token(self):
454
608
        ld1 = self.get_lock()
455
609
        token = ld1.lock_write()
456
 
        self.addCleanup(ld1.unlock)
457
610
        self.assertNotEqual(None, token)
458
611
        ld2 = self.get_lock()
459
612
        t2 = ld2.lock_write(token)
460
 
        self.addCleanup(ld2.unlock)
461
613
        self.assertEqual(token, t2)
462
614
 
463
615
    def test_lock_with_buggy_rename(self):
464
616
        # test that lock acquisition handles servers which pretend they
465
617
        # renamed correctly but that actually fail
466
 
        t = transport.get_transport_from_url(
467
 
            'brokenrename+' + self.get_url())
 
618
        t = transport.get_transport('brokenrename+' + self.get_url())
468
619
        ld1 = LockDir(t, 'test_lock')
469
620
        ld1.create()
470
621
        ld1.attempt_lock()
484
635
        # should be nothing before we start
485
636
        ld1.create()
486
637
        t = self.get_transport().clone('test_lock')
487
 
 
488
638
        def check_dir(a):
489
639
            self.assertEquals(a, t.list_dir('.'))
490
 
 
491
640
        check_dir([])
492
641
        # when held, that's all we see
493
642
        ld1.attempt_lock()
494
 
        self.addCleanup(ld1.unlock)
495
643
        check_dir(['held'])
496
644
        # second guy should fail
497
645
        self.assertRaises(errors.LockContention, ld2.attempt_lock)
498
646
        # no kibble
499
647
        check_dir(['held'])
500
 
 
501
 
    def test_no_lockdir_info(self):
502
 
        """We can cope with empty info files."""
503
 
        # This seems like a fairly common failure case - see
504
 
        # <https://bugs.launchpad.net/bzr/+bug/185103> and all its dupes.
505
 
        # Processes are often interrupted after opening the file
506
 
        # before the actual contents are committed.
507
 
        t = self.get_transport()
508
 
        t.mkdir('test_lock')
509
 
        t.mkdir('test_lock/held')
510
 
        t.put_bytes('test_lock/held/info', '')
511
 
        lf = LockDir(t, 'test_lock')
512
 
        info = lf.peek()
513
 
        formatted_info = info.to_readable_dict()
514
 
        self.assertEquals(
515
 
            dict(user='<unknown>', hostname='<unknown>', pid='<unknown>',
516
 
                time_ago='(unknown)'),
517
 
            formatted_info)
518
 
 
519
 
    def test_corrupt_lockdir_info(self):
520
 
        """We can cope with corrupt (and thus unparseable) info files."""
521
 
        # This seems like a fairly common failure case too - see
522
 
        # <https://bugs.launchpad.net/bzr/+bug/619872> for instance.
523
 
        # In particular some systems tend to fill recently created files with
524
 
        # nul bytes after recovering from a system crash.
525
 
        t = self.get_transport()
526
 
        t.mkdir('test_lock')
527
 
        t.mkdir('test_lock/held')
528
 
        t.put_bytes('test_lock/held/info', '\0')
529
 
        lf = LockDir(t, 'test_lock')
530
 
        self.assertRaises(errors.LockCorrupt, lf.peek)
531
 
        # Currently attempt_lock gives LockContention, but LockCorrupt would be
532
 
        # a reasonable result too.
533
 
        self.assertRaises(
534
 
            (errors.LockCorrupt, errors.LockContention), lf.attempt_lock)
535
 
        self.assertRaises(errors.LockCorrupt, lf.validate_token, 'fake token')
536
 
 
537
 
    def test_missing_lockdir_info(self):
538
 
        """We can cope with absent info files."""
539
 
        t = self.get_transport()
540
 
        t.mkdir('test_lock')
541
 
        t.mkdir('test_lock/held')
542
 
        lf = LockDir(t, 'test_lock')
543
 
        # In this case we expect the 'not held' result from peek, because peek
544
 
        # cannot be expected to notice that there is a 'held' directory with no
545
 
        # 'info' file.
546
 
        self.assertEqual(None, lf.peek())
547
 
        # And lock/unlock may work or give LockContention (but not any other
548
 
        # error).
549
 
        try:
550
 
            lf.attempt_lock()
551
 
        except LockContention:
552
 
            # LockContention is ok, and expected on Windows
553
 
            pass
554
 
        else:
555
 
            # no error is ok, and expected on POSIX (because POSIX allows
556
 
            # os.rename over an empty directory).
557
 
            lf.unlock()
558
 
        # Currently raises TokenMismatch, but LockCorrupt would be reasonable
559
 
        # too.
560
 
        self.assertRaises(
561
 
            (errors.TokenMismatch, errors.LockCorrupt),
562
 
            lf.validate_token, 'fake token')
563
 
 
564
 
 
565
 
class TestLockDirHooks(TestCaseWithTransport):
566
 
 
567
 
    def setUp(self):
568
 
        super(TestLockDirHooks, self).setUp()
569
 
        self._calls = []
570
 
 
571
 
    def get_lock(self):
572
 
        return LockDir(self.get_transport(), 'test_lock')
573
 
 
574
 
    def record_hook(self, result):
575
 
        self._calls.append(result)
576
 
 
577
 
    def test_LockDir_acquired_success(self):
578
 
        # the LockDir.lock_acquired hook fires when a lock is acquired.
579
 
        LockDir.hooks.install_named_hook('lock_acquired',
580
 
                                         self.record_hook, 'record_hook')
581
 
        ld = self.get_lock()
582
 
        ld.create()
583
 
        self.assertEqual([], self._calls)
584
 
        result = ld.attempt_lock()
585
 
        lock_path = ld.transport.abspath(ld.path)
586
 
        self.assertEqual([lock.LockResult(lock_path, result)], self._calls)
587
 
        ld.unlock()
588
 
        self.assertEqual([lock.LockResult(lock_path, result)], self._calls)
589
 
 
590
 
    def test_LockDir_acquired_fail(self):
591
 
        # the LockDir.lock_acquired hook does not fire on failure.
592
 
        ld = self.get_lock()
593
 
        ld.create()
594
 
        ld2 = self.get_lock()
595
 
        ld2.attempt_lock()
596
 
        # install a lock hook now, when the disk lock is locked
597
 
        LockDir.hooks.install_named_hook('lock_acquired',
598
 
                                         self.record_hook, 'record_hook')
599
 
        self.assertRaises(errors.LockContention, ld.attempt_lock)
600
 
        self.assertEqual([], self._calls)
601
 
        ld2.unlock()
602
 
        self.assertEqual([], self._calls)
603
 
 
604
 
    def test_LockDir_released_success(self):
605
 
        # the LockDir.lock_released hook fires when a lock is acquired.
606
 
        LockDir.hooks.install_named_hook('lock_released',
607
 
                                         self.record_hook, 'record_hook')
608
 
        ld = self.get_lock()
609
 
        ld.create()
610
 
        self.assertEqual([], self._calls)
611
 
        result = ld.attempt_lock()
612
 
        self.assertEqual([], self._calls)
613
 
        ld.unlock()
614
 
        lock_path = ld.transport.abspath(ld.path)
615
 
        self.assertEqual([lock.LockResult(lock_path, result)], self._calls)
616
 
 
617
 
    def test_LockDir_released_fail(self):
618
 
        # the LockDir.lock_released hook does not fire on failure.
619
 
        ld = self.get_lock()
620
 
        ld.create()
621
 
        ld2 = self.get_lock()
622
 
        ld.attempt_lock()
623
 
        ld2.force_break(ld2.peek())
624
 
        LockDir.hooks.install_named_hook('lock_released',
625
 
                                         self.record_hook, 'record_hook')
626
 
        self.assertRaises(LockBroken, ld.unlock)
627
 
        self.assertEqual([], self._calls)
628
 
 
629
 
    def test_LockDir_broken_success(self):
630
 
        # the LockDir.lock_broken hook fires when a lock is broken.
631
 
        ld = self.get_lock()
632
 
        ld.create()
633
 
        ld2 = self.get_lock()
634
 
        result = ld.attempt_lock()
635
 
        LockDir.hooks.install_named_hook('lock_broken',
636
 
                                         self.record_hook, 'record_hook')
637
 
        ld2.force_break(ld2.peek())
638
 
        lock_path = ld.transport.abspath(ld.path)
639
 
        self.assertEqual([lock.LockResult(lock_path, result)], self._calls)
640
 
 
641
 
    def test_LockDir_broken_failure(self):
642
 
        # the LockDir.lock_broken hook does not fires when a lock is already
643
 
        # released.
644
 
        ld = self.get_lock()
645
 
        ld.create()
646
 
        ld2 = self.get_lock()
647
 
        result = ld.attempt_lock()
648
 
        holder_info = ld2.peek()
649
 
        ld.unlock()
650
 
        LockDir.hooks.install_named_hook('lock_broken',
651
 
                                         self.record_hook, 'record_hook')
652
 
        ld2.force_break(holder_info)
653
 
        lock_path = ld.transport.abspath(ld.path)
654
 
        self.assertEqual([], self._calls)
655
 
 
656
 
 
657
 
class TestLockHeldInfo(TestCase):
658
 
    """Can get information about the lock holder, and detect whether they're
659
 
    still alive."""
660
 
 
661
 
    def test_repr(self):
662
 
        info = LockHeldInfo.for_this_process(None)
663
 
        self.assertContainsRe(repr(info), r"LockHeldInfo\(.*\)")
664
 
 
665
 
    def test_unicode(self):
666
 
        info = LockHeldInfo.for_this_process(None)
667
 
        self.assertContainsRe(unicode(info),
668
 
            r'held by .* on .* \(process #\d+\), acquired .* ago')
669
 
 
670
 
    def test_is_locked_by_this_process(self):
671
 
        info = LockHeldInfo.for_this_process(None)
672
 
        self.assertTrue(info.is_locked_by_this_process())
673
 
 
674
 
    def test_is_not_locked_by_this_process(self):
675
 
        info = LockHeldInfo.for_this_process(None)
676
 
        info.info_dict['pid'] = '123123123123123'
677
 
        self.assertFalse(info.is_locked_by_this_process())
678
 
 
679
 
    def test_lock_holder_live_process(self):
680
 
        """Detect that the holder (this process) is still running."""
681
 
        info = LockHeldInfo.for_this_process(None)
682
 
        self.assertFalse(info.is_lock_holder_known_dead())
683
 
 
684
 
    def test_lock_holder_dead_process(self):
685
 
        """Detect that the holder (this process) is still running."""
686
 
        self.overrideAttr(lockdir, 'get_host_name',
687
 
            lambda: 'aproperhostname')
688
 
        info = LockHeldInfo.for_this_process(None)
689
 
        info.info_dict['pid'] = '123123123'
690
 
        self.assertTrue(info.is_lock_holder_known_dead())
691
 
 
692
 
    def test_lock_holder_other_machine(self):
693
 
        """The lock holder isn't here so we don't know if they're alive."""
694
 
        info = LockHeldInfo.for_this_process(None)
695
 
        info.info_dict['hostname'] = 'egg.example.com'
696
 
        info.info_dict['pid'] = '123123123'
697
 
        self.assertFalse(info.is_lock_holder_known_dead())
698
 
 
699
 
    def test_lock_holder_other_user(self):
700
 
        """Only auto-break locks held by this user."""
701
 
        info = LockHeldInfo.for_this_process(None)
702
 
        info.info_dict['user'] = 'notme@example.com'
703
 
        info.info_dict['pid'] = '123123123'
704
 
        self.assertFalse(info.is_lock_holder_known_dead())
705
 
 
706
 
    def test_no_good_hostname(self):
707
 
        """Correctly handle ambiguous hostnames.
708
 
 
709
 
        If the lock's recorded with just 'localhost' we can't really trust
710
 
        it's the same 'localhost'.  (There are quite a few of them. :-)
711
 
        So even if the process is known not to be alive, we can't say that's
712
 
        known for sure.
713
 
        """
714
 
        self.overrideAttr(lockdir, 'get_host_name',
715
 
            lambda: 'localhost')
716
 
        info = LockHeldInfo.for_this_process(None)
717
 
        info.info_dict['pid'] = '123123123'
718
 
        self.assertFalse(info.is_lock_holder_known_dead())
719
 
 
720
 
 
721
 
class TestStaleLockDir(TestCaseWithTransport):
722
 
    """Can automatically break stale locks.
723
 
 
724
 
    :see: https://bugs.launchpad.net/bzr/+bug/220464
725
 
    """
726
 
 
727
 
    def test_auto_break_stale_lock(self):
728
 
        """Locks safely known to be stale are just cleaned up.
729
 
 
730
 
        This generates a warning but no other user interaction.
731
 
        """
732
 
        self.overrideAttr(lockdir, 'get_host_name',
733
 
            lambda: 'aproperhostname')
734
 
        # This is off by default at present; see the discussion in the bug.
735
 
        # If you change the default, don't forget to update the docs.
736
 
        config.GlobalConfig().set_user_option('locks.steal_dead', True)
737
 
        # Create a lock pretending to come from a different nonexistent
738
 
        # process on the same machine.
739
 
        l1 = LockDir(self.get_transport(), 'a',
740
 
            extra_holder_info={'pid': '12312313'})
741
 
        token_1 = l1.attempt_lock()
742
 
        l2 = LockDir(self.get_transport(), 'a')
743
 
        token_2 = l2.attempt_lock()
744
 
        # l1 will notice its lock was stolen.
745
 
        self.assertRaises(errors.LockBroken,
746
 
            l1.unlock)
747
 
        l2.unlock()
748
 
 
749
 
    def test_auto_break_stale_lock_configured_off(self):
750
 
        """Automatic breaking can be turned off"""
751
 
        l1 = LockDir(self.get_transport(), 'a',
752
 
            extra_holder_info={'pid': '12312313'})
753
 
        token_1 = l1.attempt_lock()
754
 
        self.addCleanup(l1.unlock)
755
 
        l2 = LockDir(self.get_transport(), 'a')
756
 
        # This fails now, because dead lock breaking is off by default.
757
 
        self.assertRaises(LockContention,
758
 
            l2.attempt_lock)
759
 
        # and it's in fact not broken
760
 
        l1.confirm()