← 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: Ian Clatworthy
  • Date: 2007-08-13 14:16:53 UTC
  • mto: (2733.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 2734.
  • Revision ID: ian.clatworthy@internode.on.net-20070813141653-3cbrp00xowq58zv1
Added mini tutorial

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 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
20
 
import sys
 
21
from threading import Thread, Lock
21
22
import time
22
23
 
23
24
import bzrlib
24
25
from bzrlib import (
25
26
    config,
26
27
    errors,
27
 
    lock,
28
 
    lockdir,
29
28
    osutils,
30
29
    tests,
31
30
    transport,
32
31
    )
33
32
from bzrlib.errors import (
34
 
    LockBreakMismatch,
35
 
    LockBroken,
36
 
    LockContention,
37
 
    LockFailed,
38
 
    LockNotHeld,
39
 
    )
40
 
from bzrlib.lockdir import (
41
 
    LockDir,
42
 
    LockHeldInfo,
43
 
    )
44
 
from bzrlib.tests import (
45
 
    features,
46
 
    TestCase,
47
 
    TestCaseWithTransport,
48
 
    )
 
33
        LockBreakMismatch,
 
34
        LockContention, LockError, UnlockableTransport,
 
35
        LockNotHeld, LockBroken
 
36
        )
 
37
from bzrlib.lockdir import LockDir
 
38
from bzrlib.tests import TestCaseWithTransport
49
39
from bzrlib.trace import note
50
40
 
 
41
# These tests sometimes use threads to test the behaviour of lock files with
 
42
# concurrent actors.  This is not a typical (or necessarily supported) use;
 
43
# they're really meant for guarding between processes.
 
44
 
51
45
# These tests are run on the default transport provided by the test framework
52
46
# (typically a local disk transport).  That can be changed by the --transport
53
47
# option to bzr selftest.  The required properties of the transport
54
48
# implementation are tested separately.  (The main requirement is just that
55
49
# they don't allow overwriting nonempty directories.)
56
50
 
57
 
 
58
51
class TestLockDir(TestCaseWithTransport):
59
52
    """Test LockDir operations"""
60
53
 
112
105
        """Fail to create lock on readonly transport"""
113
106
        t = self.get_readonly_transport()
114
107
        lf = LockDir(t, 'test_lock')
115
 
        self.assertRaises(LockFailed, lf.create)
 
108
        self.assertRaises(UnlockableTransport, lf.create)
116
109
 
117
110
    def test_12_lock_readonly_transport(self):
118
111
        """Fail to lock on readonly transport"""
119
112
        lf = LockDir(self.get_transport(), 'test_lock')
120
113
        lf.create()
121
114
        lf = LockDir(self.get_readonly_transport(), 'test_lock')
122
 
        self.assertRaises(LockFailed, lf.attempt_lock)
 
115
        self.assertRaises(UnlockableTransport, lf.attempt_lock)
123
116
 
124
117
    def test_20_lock_contested(self):
125
118
        """Contention to get a lock"""
129
122
        lf1.attempt_lock()
130
123
        lf2 = LockDir(t, 'test_lock')
131
124
        try:
132
 
            # locking is between LockDir instances; aliases within
 
125
            # locking is between LockDir instances; aliases within 
133
126
            # a single process are not detected
134
127
            lf2.attempt_lock()
135
128
            self.fail('Failed to detect lock collision')
145
138
        lf1 = LockDir(t, 'test_lock')
146
139
        lf1.create()
147
140
        lf1.attempt_lock()
148
 
        self.addCleanup(lf1.unlock)
149
141
        # lock is held, should get some info on it
150
142
        info1 = lf1.peek()
151
 
        self.assertEqual(set(info1.info_dict.keys()),
152
 
            set(['user', 'nonce', 'hostname', 'pid', 'start_time']))
 
143
        self.assertEqual(set(info1.keys()),
 
144
                         set(['user', 'nonce', 'hostname', 'pid', 'start_time']))
153
145
        # should get the same info if we look at it through a different
154
146
        # instance
155
147
        info2 = LockDir(t, 'test_lock').peek()
165
157
        lf2 = LockDir(self.get_readonly_transport(), 'test_lock')
166
158
        self.assertEqual(lf2.peek(), None)
167
159
        lf1.attempt_lock()
168
 
        self.addCleanup(lf1.unlock)
169
160
        info2 = lf2.peek()
170
161
        self.assertTrue(info2)
171
 
        self.assertEqual(info2.get('nonce'), lf1.nonce)
 
162
        self.assertEqual(info2['nonce'], lf1.nonce)
172
163
 
173
164
    def test_30_lock_wait_fail(self):
174
165
        """Wait on a lock, then fail
175
 
 
 
166
        
176
167
        We ask to wait up to 400ms; this should fail within at most one
177
168
        second.  (Longer times are more realistic but we don't want the test
178
169
        suite to take too long, and this should do for now.)
190
181
            after = time.time()
191
182
            # it should only take about 0.4 seconds, but we allow more time in
192
183
            # case the machine is heavily loaded
193
 
            self.assertTrue(after - before <= 8.0,
194
 
                "took %f seconds to detect lock contention" % (after - before))
 
184
            self.assertTrue(after - before <= 8.0, 
 
185
                    "took %f seconds to detect lock contention" % (after - before))
195
186
        finally:
196
187
            lf1.unlock()
 
188
        lock_base = lf2.transport.abspath(lf2.path)
197
189
        self.assertEqual(1, len(self._logged_reports))
198
 
        self.assertContainsRe(self._logged_reports[0][0],
199
 
            r'Unable to obtain lock .* held by jrandom@example\.com on .*'
200
 
            r' \(process #\d+\), acquired .* ago\.\n'
201
 
            r'Will continue to try until \d{2}:\d{2}:\d{2}, unless '
202
 
            r'you press Ctrl-C.\n'
203
 
            r'See "bzr help break-lock" for more.')
 
190
        self.assertEqual('%s %s\n'
 
191
                         '%s\n%s\n'
 
192
                         'Will continue to try until %s\n',
 
193
                         self._logged_reports[0][0])
 
194
        args = self._logged_reports[0][1]
 
195
        self.assertEqual('Unable to obtain', args[0])
 
196
        self.assertEqual('lock %s' % (lock_base,), args[1])
 
197
        self.assertStartsWith(args[2], 'held by ')
 
198
        self.assertStartsWith(args[3], 'locked ')
 
199
        self.assertEndsWith(args[3], ' ago')
 
200
        self.assertContainsRe(args[4], r'\d\d:\d\d:\d\d')
204
201
 
205
202
    def test_31_lock_wait_easy(self):
206
203
        """Succeed when waiting on a lock with no contention.
218
215
            lf1.unlock()
219
216
        self.assertEqual([], self._logged_reports)
220
217
 
 
218
    def test_32_lock_wait_succeed(self):
 
219
        """Succeed when trying to acquire a lock that gets released
 
220
 
 
221
        One thread holds on a lock and then releases it; another 
 
222
        tries to lock it.
 
223
        """
 
224
        # This test sometimes fails like this:
 
225
        # Traceback (most recent call last):
 
226
 
 
227
        #   File "/home/pqm/bzr-pqm-workdir/home/+trunk/bzrlib/tests/
 
228
        # test_lockdir.py", line 247, in test_32_lock_wait_succeed
 
229
        #     self.assertEqual(1, len(self._logged_reports))
 
230
        # AssertionError: not equal:
 
231
        # a = 1
 
232
        # b = 0
 
233
        raise tests.TestSkipped("Test fails intermittently")
 
234
        t = self.get_transport()
 
235
        lf1 = LockDir(t, 'test_lock')
 
236
        lf1.create()
 
237
        lf1.attempt_lock()
 
238
 
 
239
        def wait_and_unlock():
 
240
            time.sleep(0.1)
 
241
            lf1.unlock()
 
242
        unlocker = Thread(target=wait_and_unlock)
 
243
        unlocker.start()
 
244
        try:
 
245
            lf2 = LockDir(t, 'test_lock')
 
246
            self.setup_log_reporter(lf2)
 
247
            before = time.time()
 
248
            # wait and then lock
 
249
            lf2.wait_lock(timeout=0.4, poll=0.1)
 
250
            after = time.time()
 
251
            self.assertTrue(after - before <= 1.0)
 
252
        finally:
 
253
            unlocker.join()
 
254
 
 
255
        # There should be only 1 report, even though it should have to
 
256
        # wait for a while
 
257
        lock_base = lf2.transport.abspath(lf2.path)
 
258
        self.assertEqual(1, len(self._logged_reports))
 
259
        self.assertEqual('%s %s\n'
 
260
                         '%s\n%s\n'
 
261
                         'Will continue to try until %s\n',
 
262
                         self._logged_reports[0][0])
 
263
        args = self._logged_reports[0][1]
 
264
        self.assertEqual('Unable to obtain', args[0])
 
265
        self.assertEqual('lock %s' % (lock_base,), args[1])
 
266
        self.assertStartsWith(args[2], 'held by ')
 
267
        self.assertStartsWith(args[3], 'locked ')
 
268
        self.assertEndsWith(args[3], ' ago')
 
269
        self.assertContainsRe(args[4], r'\d\d:\d\d:\d\d')
 
270
 
 
271
    def test_34_lock_write_waits(self):
 
272
        """LockDir.lock_write() will wait for the lock.""" 
 
273
        # the test suite sets the default to 0 to make deadlocks fail fast.
 
274
        # change it for this test, as we want to try a manual deadlock.
 
275
        bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 300
 
276
        t = self.get_transport()
 
277
        lf1 = LockDir(t, 'test_lock')
 
278
        lf1.create()
 
279
        lf1.attempt_lock()
 
280
 
 
281
        def wait_and_unlock():
 
282
            time.sleep(0.1)
 
283
            lf1.unlock()
 
284
        unlocker = Thread(target=wait_and_unlock)
 
285
        unlocker.start()
 
286
        try:
 
287
            lf2 = LockDir(t, 'test_lock')
 
288
            self.setup_log_reporter(lf2)
 
289
            before = time.time()
 
290
            # wait and then lock
 
291
            lf2.lock_write()
 
292
            after = time.time()
 
293
        finally:
 
294
            unlocker.join()
 
295
 
 
296
        # There should be only 1 report, even though it should have to
 
297
        # wait for a while
 
298
        lock_base = lf2.transport.abspath(lf2.path)
 
299
        self.assertEqual(1, len(self._logged_reports))
 
300
        self.assertEqual('%s %s\n'
 
301
                         '%s\n%s\n'
 
302
                         'Will continue to try until %s\n',
 
303
                         self._logged_reports[0][0])
 
304
        args = self._logged_reports[0][1]
 
305
        self.assertEqual('Unable to obtain', args[0])
 
306
        self.assertEqual('lock %s' % (lock_base,), args[1])
 
307
        self.assertStartsWith(args[2], 'held by ')
 
308
        self.assertStartsWith(args[3], 'locked ')
 
309
        self.assertEndsWith(args[3], ' ago')
 
310
        self.assertContainsRe(args[4], r'\d\d:\d\d:\d\d')
 
311
 
 
312
    def test_35_wait_lock_changing(self):
 
313
        """LockDir.wait_lock() will report if the lock changes underneath.
 
314
        
 
315
        This is the stages we want to happen:
 
316
 
 
317
        0) Synchronization locks are created and locked.
 
318
        1) Lock1 obtains the lockdir, and releases the 'check' lock.
 
319
        2) Lock2 grabs the 'check' lock, and checks the lockdir.
 
320
           It sees the lockdir is already acquired, reports the fact, 
 
321
           and unsets the 'checked' lock.
 
322
        3) Thread1 blocks on acquiring the 'checked' lock, and then tells
 
323
           Lock1 to release and acquire the lockdir. This resets the 'check'
 
324
           lock.
 
325
        4) Lock2 acquires the 'check' lock, and checks again. It notices
 
326
           that the holder of the lock has changed, and so reports a new 
 
327
           lock holder.
 
328
        5) Thread1 blocks on the 'checked' lock, this time, it completely
 
329
           unlocks the lockdir, allowing Lock2 to acquire the lock.
 
330
        """
 
331
 
 
332
        wait_to_check_lock = Lock()
 
333
        wait_until_checked_lock = Lock()
 
334
 
 
335
        wait_to_check_lock.acquire()
 
336
        wait_until_checked_lock.acquire()
 
337
        note('locked check and checked locks')
 
338
 
 
339
        class LockDir1(LockDir):
 
340
            """Use the synchronization points for the first lock."""
 
341
 
 
342
            def attempt_lock(self):
 
343
                # Once we have acquired the lock, it is okay for
 
344
                # the other lock to check it
 
345
                try:
 
346
                    return super(LockDir1, self).attempt_lock()
 
347
                finally:
 
348
                    note('lock1: releasing check lock')
 
349
                    wait_to_check_lock.release()
 
350
 
 
351
        class LockDir2(LockDir):
 
352
            """Use the synchronization points for the second lock."""
 
353
 
 
354
            def attempt_lock(self):
 
355
                note('lock2: waiting for check lock')
 
356
                wait_to_check_lock.acquire()
 
357
                note('lock2: acquired check lock')
 
358
                try:
 
359
                    return super(LockDir2, self).attempt_lock()
 
360
                finally:
 
361
                    note('lock2: releasing checked lock')
 
362
                    wait_until_checked_lock.release()
 
363
 
 
364
        t = self.get_transport()
 
365
        lf1 = LockDir1(t, 'test_lock')
 
366
        lf1.create()
 
367
 
 
368
        lf2 = LockDir2(t, 'test_lock')
 
369
        self.setup_log_reporter(lf2)
 
370
 
 
371
        def wait_and_switch():
 
372
            lf1.attempt_lock()
 
373
            # Block until lock2 has had a chance to check
 
374
            note('lock1: waiting 1 for checked lock')
 
375
            wait_until_checked_lock.acquire()
 
376
            note('lock1: acquired for checked lock')
 
377
            note('lock1: released lockdir')
 
378
            lf1.unlock()
 
379
            note('lock1: acquiring lockdir')
 
380
            # Create a new nonce, so the lock looks different.
 
381
            lf1.nonce = osutils.rand_chars(20)
 
382
            lf1.lock_write()
 
383
            note('lock1: acquired lockdir')
 
384
 
 
385
            # Block until lock2 has peeked again
 
386
            note('lock1: waiting 2 for checked lock')
 
387
            wait_until_checked_lock.acquire()
 
388
            note('lock1: acquired for checked lock')
 
389
            # Now unlock, and let lock 2 grab the lock
 
390
            lf1.unlock()
 
391
            wait_to_check_lock.release()
 
392
 
 
393
        unlocker = Thread(target=wait_and_switch)
 
394
        unlocker.start()
 
395
        try:
 
396
            # Wait and play against the other thread
 
397
            lf2.wait_lock(timeout=1.0, poll=0.01)
 
398
        finally:
 
399
            unlocker.join()
 
400
        lf2.unlock()
 
401
 
 
402
        # There should be 2 reports, because the lock changed
 
403
        lock_base = lf2.transport.abspath(lf2.path)
 
404
        self.assertEqual(2, len(self._logged_reports))
 
405
 
 
406
        self.assertEqual('%s %s\n'
 
407
                         '%s\n%s\n'
 
408
                         'Will continue to try until %s\n',
 
409
                         self._logged_reports[0][0])
 
410
        args = self._logged_reports[0][1]
 
411
        self.assertEqual('Unable to obtain', args[0])
 
412
        self.assertEqual('lock %s' % (lock_base,), args[1])
 
413
        self.assertStartsWith(args[2], 'held by ')
 
414
        self.assertStartsWith(args[3], 'locked ')
 
415
        self.assertEndsWith(args[3], ' ago')
 
416
        self.assertContainsRe(args[4], r'\d\d:\d\d:\d\d')
 
417
 
 
418
        self.assertEqual('%s %s\n'
 
419
                         '%s\n%s\n'
 
420
                         'Will continue to try until %s\n',
 
421
                         self._logged_reports[1][0])
 
422
        args = self._logged_reports[1][1]
 
423
        self.assertEqual('Lock owner changed for', args[0])
 
424
        self.assertEqual('lock %s' % (lock_base,), args[1])
 
425
        self.assertStartsWith(args[2], 'held by ')
 
426
        self.assertStartsWith(args[3], 'locked ')
 
427
        self.assertEndsWith(args[3], ' ago')
 
428
        self.assertContainsRe(args[4], r'\d\d:\d\d:\d\d')
 
429
 
221
430
    def test_40_confirm_easy(self):
222
431
        """Confirm a lock that's already held"""
223
432
        t = self.get_transport()
224
433
        lf1 = LockDir(t, 'test_lock')
225
434
        lf1.create()
226
435
        lf1.attempt_lock()
227
 
        self.addCleanup(lf1.unlock)
228
436
        lf1.confirm()
229
437
 
230
438
    def test_41_confirm_not_held(self):
242
450
        lf1.attempt_lock()
243
451
        t.move('test_lock', 'lock_gone_now')
244
452
        self.assertRaises(LockBroken, lf1.confirm)
245
 
        # Clean up
246
 
        t.move('lock_gone_now', 'test_lock')
247
 
        lf1.unlock()
248
453
 
249
454
    def test_43_break(self):
250
455
        """Break a lock whose caller has forgotten it"""
261
466
        lf2.force_break(holder_info)
262
467
        # now we should be able to take it
263
468
        lf2.attempt_lock()
264
 
        self.addCleanup(lf2.unlock)
265
469
        lf2.confirm()
266
470
 
267
471
    def test_44_break_already_released(self):
279
483
        lf2.force_break(holder_info)
280
484
        # now we should be able to take it
281
485
        lf2.attempt_lock()
282
 
        self.addCleanup(lf2.unlock)
283
486
        lf2.confirm()
284
487
 
285
488
    def test_45_break_mismatch(self):
311
514
        """Check the on-disk representation of LockDirs is as expected.
312
515
 
313
516
        There should always be a top-level directory named by the lock.
314
 
        When the lock is held, there should be a lockname/held directory
 
517
        When the lock is held, there should be a lockname/held directory 
315
518
        containing an info file.
316
519
        """
317
520
        t = self.get_transport()
332
535
        # do this without IO redirection to ensure it doesn't prompt.
333
536
        self.assertRaises(AssertionError, ld1.break_lock)
334
537
        orig_factory = bzrlib.ui.ui_factory
335
 
        bzrlib.ui.ui_factory = bzrlib.ui.CannedInputUIFactory([True])
 
538
        # silent ui - no need for stdout
 
539
        bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
 
540
        bzrlib.ui.ui_factory.stdin = StringIO("y\n")
336
541
        try:
337
542
            ld2.break_lock()
338
543
            self.assertRaises(LockBroken, ld1.unlock)
339
544
        finally:
340
545
            bzrlib.ui.ui_factory = orig_factory
341
546
 
342
 
    def test_break_lock_corrupt_info(self):
343
 
        """break_lock works even if the info file is corrupt (and tells the UI
344
 
        that it is corrupt).
345
 
        """
346
 
        ld = self.get_lock()
347
 
        ld2 = self.get_lock()
348
 
        ld.create()
349
 
        ld.lock_write()
350
 
        ld.transport.put_bytes_non_atomic('test_lock/held/info', '\0')
351
 
 
352
 
        class LoggingUIFactory(bzrlib.ui.SilentUIFactory):
353
 
            def __init__(self):
354
 
                self.prompts = []
355
 
 
356
 
            def get_boolean(self, prompt):
357
 
                self.prompts.append(('boolean', prompt))
358
 
                return True
359
 
 
360
 
        ui = LoggingUIFactory()
361
 
        self.overrideAttr(bzrlib.ui, 'ui_factory', ui)
362
 
        ld2.break_lock()
363
 
        self.assertLength(1, ui.prompts)
364
 
        self.assertEqual('boolean', ui.prompts[0][0])
365
 
        self.assertStartsWith(ui.prompts[0][1], 'Break (corrupt LockDir')
366
 
        self.assertRaises(LockBroken, ld.unlock)
367
 
 
368
 
    def test_break_lock_missing_info(self):
369
 
        """break_lock works even if the info file is missing (and tells the UI
370
 
        that it is corrupt).
371
 
        """
372
 
        ld = self.get_lock()
373
 
        ld2 = self.get_lock()
374
 
        ld.create()
375
 
        ld.lock_write()
376
 
        ld.transport.delete('test_lock/held/info')
377
 
 
378
 
        class LoggingUIFactory(bzrlib.ui.SilentUIFactory):
379
 
            def __init__(self):
380
 
                self.prompts = []
381
 
 
382
 
            def get_boolean(self, prompt):
383
 
                self.prompts.append(('boolean', prompt))
384
 
                return True
385
 
 
386
 
        ui = LoggingUIFactory()
387
 
        orig_factory = bzrlib.ui.ui_factory
388
 
        bzrlib.ui.ui_factory = ui
389
 
        try:
390
 
            ld2.break_lock()
391
 
            self.assertRaises(LockBroken, ld.unlock)
392
 
            self.assertLength(0, ui.prompts)
393
 
        finally:
394
 
            bzrlib.ui.ui_factory = orig_factory
395
 
        # Suppress warnings due to ld not being unlocked
396
 
        # XXX: if lock_broken hook was invoked in this case, this hack would
397
 
        # not be necessary.  - Andrew Bennetts, 2010-09-06.
398
 
        del self._lock_actions[:]
399
 
 
400
547
    def test_create_missing_base_directory(self):
401
548
        """If LockDir.path doesn't exist, it can be created
402
549
 
408
555
        lf1 = LockDir(t, 'test_lock')
409
556
 
410
557
        lf1.create()
411
 
        self.assertTrue(t.has('test_lock'))
 
558
        self.failUnless(t.has('test_lock'))
412
559
 
413
560
        t.rmdir('test_lock')
414
 
        self.assertFalse(t.has('test_lock'))
 
561
        self.failIf(t.has('test_lock'))
415
562
 
416
563
        # This will create 'test_lock' if it needs to
417
564
        lf1.lock_write()
418
 
        self.assertTrue(t.has('test_lock'))
419
 
        self.assertTrue(t.has('test_lock/held/info'))
 
565
        self.failUnless(t.has('test_lock'))
 
566
        self.failUnless(t.has('test_lock/held/info'))
420
567
 
421
568
        lf1.unlock()
422
 
        self.assertFalse(t.has('test_lock/held/info'))
 
569
        self.failIf(t.has('test_lock/held/info'))
423
570
 
424
 
    def test_display_form(self):
 
571
    def test__format_lock_info(self):
425
572
        ld1 = self.get_lock()
426
573
        ld1.create()
427
574
        ld1.lock_write()
428
575
        try:
429
 
            info_list = ld1.peek().to_readable_dict()
 
576
            info_list = ld1._format_lock_info(ld1.peek())
430
577
        finally:
431
578
            ld1.unlock()
432
 
        self.assertEqual(info_list['user'], u'jrandom@example.com')
433
 
        self.assertContainsRe(info_list['pid'], '^\d+$')
434
 
        self.assertContainsRe(info_list['time_ago'], r'^\d+ seconds? ago$')
 
579
        self.assertEqual('lock %s' % (ld1.transport.abspath(ld1.path),),
 
580
                         info_list[0])
 
581
        self.assertContainsRe(info_list[1],
 
582
                              r'^held by .* on host .* \[process #\d*\]$')
 
583
        self.assertContainsRe(info_list[2], r'locked \d+ seconds? ago$')
435
584
 
436
585
    def test_lock_without_email(self):
437
586
        global_config = config.GlobalConfig()
443
592
        ld1.unlock()
444
593
 
445
594
    def test_lock_permission(self):
446
 
        self.requireFeature(features.not_running_as_root)
447
595
        if not osutils.supports_posix_readonly():
448
596
            raise tests.TestSkipped('Cannot induce a permission failure')
449
597
        ld1 = self.get_lock()
450
598
        lock_path = ld1.transport.local_abspath('test_lock')
451
599
        os.mkdir(lock_path)
452
600
        osutils.make_readonly(lock_path)
453
 
        self.assertRaises(errors.LockFailed, ld1.attempt_lock)
 
601
        self.assertRaises(errors.PermissionDenied, ld1.attempt_lock)
454
602
 
455
603
    def test_lock_by_token(self):
456
604
        ld1 = self.get_lock()
457
605
        token = ld1.lock_write()
458
 
        self.addCleanup(ld1.unlock)
459
606
        self.assertNotEqual(None, token)
460
607
        ld2 = self.get_lock()
461
608
        t2 = ld2.lock_write(token)
462
 
        self.addCleanup(ld2.unlock)
463
609
        self.assertEqual(token, t2)
464
610
 
465
611
    def test_lock_with_buggy_rename(self):
485
631
        # should be nothing before we start
486
632
        ld1.create()
487
633
        t = self.get_transport().clone('test_lock')
488
 
 
489
634
        def check_dir(a):
490
635
            self.assertEquals(a, t.list_dir('.'))
491
 
 
492
636
        check_dir([])
493
637
        # when held, that's all we see
494
638
        ld1.attempt_lock()
495
 
        self.addCleanup(ld1.unlock)
496
639
        check_dir(['held'])
497
640
        # second guy should fail
498
641
        self.assertRaises(errors.LockContention, ld2.attempt_lock)
499
642
        # no kibble
500
643
        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.assertEquals(
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(TestCase):
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
 
        info = LockHeldInfo.for_this_process(None)
688
 
        info.info_dict['pid'] = '123123123'
689
 
        if sys.platform == 'win32':
690
 
            self.knownFailure(
691
 
                'live lock holder detection not implemented yet on win32')
692
 
        self.assertTrue(info.is_lock_holder_known_dead())
693
 
 
694
 
    def test_lock_holder_other_machine(self):
695
 
        """The lock holder isn't here so we don't know if they're alive."""
696
 
        info = LockHeldInfo.for_this_process(None)
697
 
        info.info_dict['hostname'] = 'egg.example.com'
698
 
        info.info_dict['pid'] = '123123123'
699
 
        self.assertFalse(info.is_lock_holder_known_dead())
700
 
 
701
 
    def test_lock_holder_other_user(self):
702
 
        """Only auto-break locks held by this user."""
703
 
        info = LockHeldInfo.for_this_process(None)
704
 
        info.info_dict['user'] = 'notme@example.com'
705
 
        info.info_dict['pid'] = '123123123'
706
 
        self.assertFalse(info.is_lock_holder_known_dead())
707
 
 
708
 
    def test_no_good_hostname(self):
709
 
        """Correctly handle ambiguous hostnames.
710
 
 
711
 
        If the lock's recorded with just 'localhost' we can't really trust
712
 
        it's the same 'localhost'.  (There are quite a few of them. :-)
713
 
        So even if the process is known not to be alive, we can't say that's
714
 
        known for sure.
715
 
        """
716
 
        self.overrideAttr(lockdir, 'get_host_name',
717
 
            lambda: 'localhost')
718
 
        info = LockHeldInfo.for_this_process(None)
719
 
        info.info_dict['pid'] = '123123123'
720
 
        self.assertFalse(info.is_lock_holder_known_dead())
721
 
 
722
 
 
723
 
class TestStaleLockDir(TestCaseWithTransport):
724
 
    """Can automatically break stale locks.
725
 
 
726
 
    :see: https://bugs.launchpad.net/bzr/+bug/220464
727
 
    """
728
 
 
729
 
    def test_auto_break_stale_lock(self):
730
 
        """Locks safely known to be stale are just cleaned up.
731
 
 
732
 
        This generates a warning but no other user interaction.
733
 
        """
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()