← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_lockdir.py

Merge up bzr.dev.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_lockdir.py
1
 
# Copyright (C) 2006-2012, 2016 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
 
    TestCaseInTempDir,
47
 
    TestCaseWithTransport,
48
 
    )
 
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.
49
47
 
50
48
# These tests are run on the default transport provided by the test framework
51
49
# (typically a local disk transport).  That can be changed by the --transport
53
51
# implementation are tested separately.  (The main requirement is just that
54
52
# they don't allow overwriting nonempty directories.)
55
53
 
56
 
 
57
54
class TestLockDir(TestCaseWithTransport):
58
55
    """Test LockDir operations"""
59
56
 
128
125
        lf1.attempt_lock()
129
126
        lf2 = LockDir(t, 'test_lock')
130
127
        try:
131
 
            # locking is between LockDir instances; aliases within
 
128
            # locking is between LockDir instances; aliases within 
132
129
            # a single process are not detected
133
130
            lf2.attempt_lock()
134
131
            self.fail('Failed to detect lock collision')
144
141
        lf1 = LockDir(t, 'test_lock')
145
142
        lf1.create()
146
143
        lf1.attempt_lock()
147
 
        self.addCleanup(lf1.unlock)
148
144
        # lock is held, should get some info on it
149
145
        info1 = lf1.peek()
150
 
        self.assertEqual(set(info1.info_dict.keys()),
151
 
            set(['user', 'nonce', 'hostname', 'pid', 'start_time']))
 
146
        self.assertEqual(set(info1.keys()),
 
147
                         set(['user', 'nonce', 'hostname', 'pid', 'start_time']))
152
148
        # should get the same info if we look at it through a different
153
149
        # instance
154
150
        info2 = LockDir(t, 'test_lock').peek()
164
160
        lf2 = LockDir(self.get_readonly_transport(), 'test_lock')
165
161
        self.assertEqual(lf2.peek(), None)
166
162
        lf1.attempt_lock()
167
 
        self.addCleanup(lf1.unlock)
168
163
        info2 = lf2.peek()
169
164
        self.assertTrue(info2)
170
 
        self.assertEqual(info2.get('nonce'), lf1.nonce)
 
165
        self.assertEqual(info2['nonce'], lf1.nonce)
171
166
 
172
167
    def test_30_lock_wait_fail(self):
173
168
        """Wait on a lock, then fail
174
 
 
 
169
        
175
170
        We ask to wait up to 400ms; this should fail within at most one
176
171
        second.  (Longer times are more realistic but we don't want the test
177
172
        suite to take too long, and this should do for now.)
189
184
            after = time.time()
190
185
            # it should only take about 0.4 seconds, but we allow more time in
191
186
            # case the machine is heavily loaded
192
 
            self.assertTrue(after - before <= 8.0,
193
 
                "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))
194
189
        finally:
195
190
            lf1.unlock()
 
191
        lock_base = lf2.transport.abspath(lf2.path)
196
192
        self.assertEqual(1, len(self._logged_reports))
197
 
        self.assertContainsRe(self._logged_reports[0][0],
198
 
            r'Unable to obtain lock .* held by jrandom@example\.com on .*'
199
 
            r' \(process #\d+\), acquired .* ago\.\n'
200
 
            r'Will continue to try until \d{2}:\d{2}:\d{2}, unless '
201
 
            r'you press Ctrl-C.\n'
202
 
            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')
203
204
 
204
205
    def test_31_lock_wait_easy(self):
205
206
        """Succeed when waiting on a lock with no contention.
217
218
            lf1.unlock()
218
219
        self.assertEqual([], self._logged_reports)
219
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
 
220
434
    def test_40_confirm_easy(self):
221
435
        """Confirm a lock that's already held"""
222
436
        t = self.get_transport()
223
437
        lf1 = LockDir(t, 'test_lock')
224
438
        lf1.create()
225
439
        lf1.attempt_lock()
226
 
        self.addCleanup(lf1.unlock)
227
440
        lf1.confirm()
228
441
 
229
442
    def test_41_confirm_not_held(self):
241
454
        lf1.attempt_lock()
242
455
        t.move('test_lock', 'lock_gone_now')
243
456
        self.assertRaises(LockBroken, lf1.confirm)
244
 
        # Clean up
245
 
        t.move('lock_gone_now', 'test_lock')
246
 
        lf1.unlock()
247
457
 
248
458
    def test_43_break(self):
249
459
        """Break a lock whose caller has forgotten it"""
260
470
        lf2.force_break(holder_info)
261
471
        # now we should be able to take it
262
472
        lf2.attempt_lock()
263
 
        self.addCleanup(lf2.unlock)
264
473
        lf2.confirm()
265
474
 
266
475
    def test_44_break_already_released(self):
278
487
        lf2.force_break(holder_info)
279
488
        # now we should be able to take it
280
489
        lf2.attempt_lock()
281
 
        self.addCleanup(lf2.unlock)
282
490
        lf2.confirm()
283
491
 
284
492
    def test_45_break_mismatch(self):
310
518
        """Check the on-disk representation of LockDirs is as expected.
311
519
 
312
520
        There should always be a top-level directory named by the lock.
313
 
        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 
314
522
        containing an info file.
315
523
        """
316
524
        t = self.get_transport()
331
539
        # do this without IO redirection to ensure it doesn't prompt.
332
540
        self.assertRaises(AssertionError, ld1.break_lock)
333
541
        orig_factory = bzrlib.ui.ui_factory
334
 
        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")
335
545
        try:
336
546
            ld2.break_lock()
337
547
            self.assertRaises(LockBroken, ld1.unlock)
338
548
        finally:
339
549
            bzrlib.ui.ui_factory = orig_factory
340
550
 
341
 
    def test_break_lock_corrupt_info(self):
342
 
        """break_lock works even if the info file is corrupt (and tells the UI
343
 
        that it is corrupt).
344
 
        """
345
 
        ld = self.get_lock()
346
 
        ld2 = self.get_lock()
347
 
        ld.create()
348
 
        ld.lock_write()
349
 
        ld.transport.put_bytes_non_atomic('test_lock/held/info', '\0')
350
 
 
351
 
        class LoggingUIFactory(bzrlib.ui.SilentUIFactory):
352
 
            def __init__(self):
353
 
                self.prompts = []
354
 
 
355
 
            def get_boolean(self, prompt):
356
 
                self.prompts.append(('boolean', prompt))
357
 
                return True
358
 
 
359
 
        ui = LoggingUIFactory()
360
 
        self.overrideAttr(bzrlib.ui, 'ui_factory', ui)
361
 
        ld2.break_lock()
362
 
        self.assertLength(1, ui.prompts)
363
 
        self.assertEqual('boolean', ui.prompts[0][0])
364
 
        self.assertStartsWith(ui.prompts[0][1], 'Break (corrupt LockDir')
365
 
        self.assertRaises(LockBroken, ld.unlock)
366
 
 
367
 
    def test_break_lock_missing_info(self):
368
 
        """break_lock works even if the info file is missing (and tells the UI
369
 
        that it is corrupt).
370
 
        """
371
 
        ld = self.get_lock()
372
 
        ld2 = self.get_lock()
373
 
        ld.create()
374
 
        ld.lock_write()
375
 
        ld.transport.delete('test_lock/held/info')
376
 
 
377
 
        class LoggingUIFactory(bzrlib.ui.SilentUIFactory):
378
 
            def __init__(self):
379
 
                self.prompts = []
380
 
 
381
 
            def get_boolean(self, prompt):
382
 
                self.prompts.append(('boolean', prompt))
383
 
                return True
384
 
 
385
 
        ui = LoggingUIFactory()
386
 
        orig_factory = bzrlib.ui.ui_factory
387
 
        bzrlib.ui.ui_factory = ui
388
 
        try:
389
 
            ld2.break_lock()
390
 
            self.assertRaises(LockBroken, ld.unlock)
391
 
            self.assertLength(0, ui.prompts)
392
 
        finally:
393
 
            bzrlib.ui.ui_factory = orig_factory
394
 
        # Suppress warnings due to ld not being unlocked
395
 
        # XXX: if lock_broken hook was invoked in this case, this hack would
396
 
        # not be necessary.  - Andrew Bennetts, 2010-09-06.
397
 
        del self._lock_actions[:]
398
 
 
399
551
    def test_create_missing_base_directory(self):
400
552
        """If LockDir.path doesn't exist, it can be created
401
553
 
407
559
        lf1 = LockDir(t, 'test_lock')
408
560
 
409
561
        lf1.create()
410
 
        self.assertTrue(t.has('test_lock'))
 
562
        self.failUnless(t.has('test_lock'))
411
563
 
412
564
        t.rmdir('test_lock')
413
 
        self.assertFalse(t.has('test_lock'))
 
565
        self.failIf(t.has('test_lock'))
414
566
 
415
567
        # This will create 'test_lock' if it needs to
416
568
        lf1.lock_write()
417
 
        self.assertTrue(t.has('test_lock'))
418
 
        self.assertTrue(t.has('test_lock/held/info'))
 
569
        self.failUnless(t.has('test_lock'))
 
570
        self.failUnless(t.has('test_lock/held/info'))
419
571
 
420
572
        lf1.unlock()
421
 
        self.assertFalse(t.has('test_lock/held/info'))
 
573
        self.failIf(t.has('test_lock/held/info'))
422
574
 
423
 
    def test_display_form(self):
 
575
    def test__format_lock_info(self):
424
576
        ld1 = self.get_lock()
425
577
        ld1.create()
426
578
        ld1.lock_write()
427
579
        try:
428
 
            info_list = ld1.peek().to_readable_dict()
 
580
            info_list = ld1._format_lock_info(ld1.peek())
429
581
        finally:
430
582
            ld1.unlock()
431
 
        self.assertEqual(info_list['user'], u'jrandom@example.com')
432
 
        self.assertContainsRe(info_list['pid'], '^\d+$')
433
 
        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$')
434
588
 
435
589
    def test_lock_without_email(self):
436
 
        global_config = config.GlobalStack()
 
590
        global_config = config.GlobalConfig()
437
591
        # Intentionally has no email address
438
 
        global_config.set('email', 'User Identity')
 
592
        global_config.set_user_option('email', 'User Identity')
439
593
        ld1 = self.get_lock()
440
594
        ld1.create()
441
595
        ld1.lock_write()
442
596
        ld1.unlock()
443
597
 
444
598
    def test_lock_permission(self):
445
 
        self.requireFeature(features.not_running_as_root)
446
599
        if not osutils.supports_posix_readonly():
447
600
            raise tests.TestSkipped('Cannot induce a permission failure')
448
601
        ld1 = self.get_lock()
454
607
    def test_lock_by_token(self):
455
608
        ld1 = self.get_lock()
456
609
        token = ld1.lock_write()
457
 
        self.addCleanup(ld1.unlock)
458
610
        self.assertNotEqual(None, token)
459
611
        ld2 = self.get_lock()
460
612
        t2 = ld2.lock_write(token)
461
 
        self.addCleanup(ld2.unlock)
462
613
        self.assertEqual(token, t2)
463
614
 
464
615
    def test_lock_with_buggy_rename(self):
465
616
        # test that lock acquisition handles servers which pretend they
466
617
        # renamed correctly but that actually fail
467
 
        t = transport.get_transport_from_url(
468
 
            'brokenrename+' + self.get_url())
 
618
        t = transport.get_transport('brokenrename+' + self.get_url())
469
619
        ld1 = LockDir(t, 'test_lock')
470
620
        ld1.create()
471
621
        ld1.attempt_lock()
475
625
        # now the original caller should succeed in unlocking
476
626
        ld1.unlock()
477
627
        # and there should be nothing left over
478
 
        self.assertEqual([], t.list_dir('test_lock'))
 
628
        self.assertEquals([], t.list_dir('test_lock'))
479
629
 
480
630
    def test_failed_lock_leaves_no_trash(self):
481
631
        # if we fail to acquire the lock, we don't leave pending directories
485
635
        # should be nothing before we start
486
636
        ld1.create()
487
637
        t = self.get_transport().clone('test_lock')
488
 
 
489
638
        def check_dir(a):
490
 
            self.assertEqual(a, t.list_dir('.'))
491
 
 
 
639
            self.assertEquals(a, t.list_dir('.'))
492
640
        check_dir([])
493
641
        # when held, that's all we see
494
642
        ld1.attempt_lock()
495
 
        self.addCleanup(ld1.unlock)
496
643
        check_dir(['held'])
497
644
        # second guy should fail
498
645
        self.assertRaises(errors.LockContention, ld2.attempt_lock)
499
646
        # no kibble
500
647
        check_dir(['held'])
501
 
 
502
 
    def test_no_lockdir_info(self):
503
 
        """We can cope with empty info files."""
504
 
        # This seems like a fairly common failure case - see
505
 
        # <https://bugs.launchpad.net/bzr/+bug/185103> and all its dupes.
506
 
        # Processes are often interrupted after opening the file
507
 
        # before the actual contents are committed.
508
 
        t = self.get_transport()
509
 
        t.mkdir('test_lock')
510
 
        t.mkdir('test_lock/held')
511
 
        t.put_bytes('test_lock/held/info', '')
512
 
        lf = LockDir(t, 'test_lock')
513
 
        info = lf.peek()
514
 
        formatted_info = info.to_readable_dict()
515
 
        self.assertEqual(
516
 
            dict(user='<unknown>', hostname='<unknown>', pid='<unknown>',
517
 
                time_ago='(unknown)'),
518
 
            formatted_info)
519
 
 
520
 
    def test_corrupt_lockdir_info(self):
521
 
        """We can cope with corrupt (and thus unparseable) info files."""
522
 
        # This seems like a fairly common failure case too - see
523
 
        # <https://bugs.launchpad.net/bzr/+bug/619872> for instance.
524
 
        # In particular some systems tend to fill recently created files with
525
 
        # nul bytes after recovering from a system crash.
526
 
        t = self.get_transport()
527
 
        t.mkdir('test_lock')
528
 
        t.mkdir('test_lock/held')
529
 
        t.put_bytes('test_lock/held/info', '\0')
530
 
        lf = LockDir(t, 'test_lock')
531
 
        self.assertRaises(errors.LockCorrupt, lf.peek)
532
 
        # Currently attempt_lock gives LockContention, but LockCorrupt would be
533
 
        # a reasonable result too.
534
 
        self.assertRaises(
535
 
            (errors.LockCorrupt, errors.LockContention), lf.attempt_lock)
536
 
        self.assertRaises(errors.LockCorrupt, lf.validate_token, 'fake token')
537
 
 
538
 
    def test_missing_lockdir_info(self):
539
 
        """We can cope with absent info files."""
540
 
        t = self.get_transport()
541
 
        t.mkdir('test_lock')
542
 
        t.mkdir('test_lock/held')
543
 
        lf = LockDir(t, 'test_lock')
544
 
        # In this case we expect the 'not held' result from peek, because peek
545
 
        # cannot be expected to notice that there is a 'held' directory with no
546
 
        # 'info' file.
547
 
        self.assertEqual(None, lf.peek())
548
 
        # And lock/unlock may work or give LockContention (but not any other
549
 
        # error).
550
 
        try:
551
 
            lf.attempt_lock()
552
 
        except LockContention:
553
 
            # LockContention is ok, and expected on Windows
554
 
            pass
555
 
        else:
556
 
            # no error is ok, and expected on POSIX (because POSIX allows
557
 
            # os.rename over an empty directory).
558
 
            lf.unlock()
559
 
        # Currently raises TokenMismatch, but LockCorrupt would be reasonable
560
 
        # too.
561
 
        self.assertRaises(
562
 
            (errors.TokenMismatch, errors.LockCorrupt),
563
 
            lf.validate_token, 'fake token')
564
 
 
565
 
 
566
 
class TestLockDirHooks(TestCaseWithTransport):
567
 
 
568
 
    def setUp(self):
569
 
        super(TestLockDirHooks, self).setUp()
570
 
        self._calls = []
571
 
 
572
 
    def get_lock(self):
573
 
        return LockDir(self.get_transport(), 'test_lock')
574
 
 
575
 
    def record_hook(self, result):
576
 
        self._calls.append(result)
577
 
 
578
 
    def test_LockDir_acquired_success(self):
579
 
        # the LockDir.lock_acquired hook fires when a lock is acquired.
580
 
        LockDir.hooks.install_named_hook('lock_acquired',
581
 
                                         self.record_hook, 'record_hook')
582
 
        ld = self.get_lock()
583
 
        ld.create()
584
 
        self.assertEqual([], self._calls)
585
 
        result = ld.attempt_lock()
586
 
        lock_path = ld.transport.abspath(ld.path)
587
 
        self.assertEqual([lock.LockResult(lock_path, result)], self._calls)
588
 
        ld.unlock()
589
 
        self.assertEqual([lock.LockResult(lock_path, result)], self._calls)
590
 
 
591
 
    def test_LockDir_acquired_fail(self):
592
 
        # the LockDir.lock_acquired hook does not fire on failure.
593
 
        ld = self.get_lock()
594
 
        ld.create()
595
 
        ld2 = self.get_lock()
596
 
        ld2.attempt_lock()
597
 
        # install a lock hook now, when the disk lock is locked
598
 
        LockDir.hooks.install_named_hook('lock_acquired',
599
 
                                         self.record_hook, 'record_hook')
600
 
        self.assertRaises(errors.LockContention, ld.attempt_lock)
601
 
        self.assertEqual([], self._calls)
602
 
        ld2.unlock()
603
 
        self.assertEqual([], self._calls)
604
 
 
605
 
    def test_LockDir_released_success(self):
606
 
        # the LockDir.lock_released hook fires when a lock is acquired.
607
 
        LockDir.hooks.install_named_hook('lock_released',
608
 
                                         self.record_hook, 'record_hook')
609
 
        ld = self.get_lock()
610
 
        ld.create()
611
 
        self.assertEqual([], self._calls)
612
 
        result = ld.attempt_lock()
613
 
        self.assertEqual([], self._calls)
614
 
        ld.unlock()
615
 
        lock_path = ld.transport.abspath(ld.path)
616
 
        self.assertEqual([lock.LockResult(lock_path, result)], self._calls)
617
 
 
618
 
    def test_LockDir_released_fail(self):
619
 
        # the LockDir.lock_released hook does not fire on failure.
620
 
        ld = self.get_lock()
621
 
        ld.create()
622
 
        ld2 = self.get_lock()
623
 
        ld.attempt_lock()
624
 
        ld2.force_break(ld2.peek())
625
 
        LockDir.hooks.install_named_hook('lock_released',
626
 
                                         self.record_hook, 'record_hook')
627
 
        self.assertRaises(LockBroken, ld.unlock)
628
 
        self.assertEqual([], self._calls)
629
 
 
630
 
    def test_LockDir_broken_success(self):
631
 
        # the LockDir.lock_broken hook fires when a lock is broken.
632
 
        ld = self.get_lock()
633
 
        ld.create()
634
 
        ld2 = self.get_lock()
635
 
        result = ld.attempt_lock()
636
 
        LockDir.hooks.install_named_hook('lock_broken',
637
 
                                         self.record_hook, 'record_hook')
638
 
        ld2.force_break(ld2.peek())
639
 
        lock_path = ld.transport.abspath(ld.path)
640
 
        self.assertEqual([lock.LockResult(lock_path, result)], self._calls)
641
 
 
642
 
    def test_LockDir_broken_failure(self):
643
 
        # the LockDir.lock_broken hook does not fires when a lock is already
644
 
        # released.
645
 
        ld = self.get_lock()
646
 
        ld.create()
647
 
        ld2 = self.get_lock()
648
 
        result = ld.attempt_lock()
649
 
        holder_info = ld2.peek()
650
 
        ld.unlock()
651
 
        LockDir.hooks.install_named_hook('lock_broken',
652
 
                                         self.record_hook, 'record_hook')
653
 
        ld2.force_break(holder_info)
654
 
        lock_path = ld.transport.abspath(ld.path)
655
 
        self.assertEqual([], self._calls)
656
 
 
657
 
 
658
 
class TestLockHeldInfo(TestCaseInTempDir):
659
 
    """Can get information about the lock holder, and detect whether they're
660
 
    still alive."""
661
 
 
662
 
    def test_repr(self):
663
 
        info = LockHeldInfo.for_this_process(None)
664
 
        self.assertContainsRe(repr(info), r"LockHeldInfo\(.*\)")
665
 
 
666
 
    def test_unicode(self):
667
 
        info = LockHeldInfo.for_this_process(None)
668
 
        self.assertContainsRe(unicode(info),
669
 
            r'held by .* on .* \(process #\d+\), acquired .* ago')
670
 
 
671
 
    def test_is_locked_by_this_process(self):
672
 
        info = LockHeldInfo.for_this_process(None)
673
 
        self.assertTrue(info.is_locked_by_this_process())
674
 
 
675
 
    def test_is_not_locked_by_this_process(self):
676
 
        info = LockHeldInfo.for_this_process(None)
677
 
        info.info_dict['pid'] = '123123123123123'
678
 
        self.assertFalse(info.is_locked_by_this_process())
679
 
 
680
 
    def test_lock_holder_live_process(self):
681
 
        """Detect that the holder (this process) is still running."""
682
 
        info = LockHeldInfo.for_this_process(None)
683
 
        self.assertFalse(info.is_lock_holder_known_dead())
684
 
 
685
 
    def test_lock_holder_dead_process(self):
686
 
        """Detect that the holder (this process) is still running."""
687
 
        self.overrideAttr(lockdir, 'get_host_name',
688
 
            lambda: 'aproperhostname')
689
 
        info = LockHeldInfo.for_this_process(None)
690
 
        info.info_dict['pid'] = '123123123'
691
 
        self.assertTrue(info.is_lock_holder_known_dead())
692
 
 
693
 
    def test_lock_holder_other_machine(self):
694
 
        """The lock holder isn't here so we don't know if they're alive."""
695
 
        info = LockHeldInfo.for_this_process(None)
696
 
        info.info_dict['hostname'] = 'egg.example.com'
697
 
        info.info_dict['pid'] = '123123123'
698
 
        self.assertFalse(info.is_lock_holder_known_dead())
699
 
 
700
 
    def test_lock_holder_other_user(self):
701
 
        """Only auto-break locks held by this user."""
702
 
        info = LockHeldInfo.for_this_process(None)
703
 
        info.info_dict['user'] = 'notme@example.com'
704
 
        info.info_dict['pid'] = '123123123'
705
 
        self.assertFalse(info.is_lock_holder_known_dead())
706
 
 
707
 
    def test_no_good_hostname(self):
708
 
        """Correctly handle ambiguous hostnames.
709
 
 
710
 
        If the lock's recorded with just 'localhost' we can't really trust
711
 
        it's the same 'localhost'.  (There are quite a few of them. :-)
712
 
        So even if the process is known not to be alive, we can't say that's
713
 
        known for sure.
714
 
        """
715
 
        self.overrideAttr(lockdir, 'get_host_name',
716
 
            lambda: 'localhost')
717
 
        info = LockHeldInfo.for_this_process(None)
718
 
        info.info_dict['pid'] = '123123123'
719
 
        self.assertFalse(info.is_lock_holder_known_dead())
720
 
 
721
 
 
722
 
class TestStaleLockDir(TestCaseWithTransport):
723
 
    """Can automatically break stale locks.
724
 
 
725
 
    :see: https://bugs.launchpad.net/bzr/+bug/220464
726
 
    """
727
 
 
728
 
    def test_auto_break_stale_lock(self):
729
 
        """Locks safely known to be stale are just cleaned up.
730
 
 
731
 
        This generates a warning but no other user interaction.
732
 
        """
733
 
        self.overrideAttr(lockdir, 'get_host_name',
734
 
            lambda: 'aproperhostname')
735
 
        # This is off by default at present; see the discussion in the bug.
736
 
        # If you change the default, don't forget to update the docs.
737
 
        config.GlobalStack().set('locks.steal_dead', True)
738
 
        # Create a lock pretending to come from a different nonexistent
739
 
        # process on the same machine.
740
 
        l1 = LockDir(self.get_transport(), 'a',
741
 
            extra_holder_info={'pid': '12312313'})
742
 
        token_1 = l1.attempt_lock()
743
 
        l2 = LockDir(self.get_transport(), 'a')
744
 
        token_2 = l2.attempt_lock()
745
 
        # l1 will notice its lock was stolen.
746
 
        self.assertRaises(errors.LockBroken,
747
 
            l1.unlock)
748
 
        l2.unlock()
749
 
 
750
 
    def test_auto_break_stale_lock_configured_off(self):
751
 
        """Automatic breaking can be turned off"""
752
 
        l1 = LockDir(self.get_transport(), 'a',
753
 
            extra_holder_info={'pid': '12312313'})
754
 
        token_1 = l1.attempt_lock()
755
 
        self.addCleanup(l1.unlock)
756
 
        l2 = LockDir(self.get_transport(), 'a')
757
 
        # This fails now, because dead lock breaking is off by default.
758
 
        self.assertRaises(LockContention,
759
 
            l2.attempt_lock)
760
 
        # and it's in fact not broken
761
 
        l1.confirm()