← 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: Patch Queue Manager
  • Date: 2016-02-01 19:13:13 UTC
  • mfrom: (6614.2.2 trunk)
  • Revision ID: pqm@pqm.ubuntu.com-20160201191313-wdfvmfff1djde6oq
(vila) Release 2.7.0 (Vincent Ladeuil)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_lockdir.py
1
 
# Copyright (C) 2006 Canonical Ltd
 
1
# Copyright (C) 2006-2012, 2016 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
"""Tests for LockDir"""
18
18
 
19
 
from cStringIO import StringIO
20
19
import os
21
 
from threading import Thread, Lock
22
20
import time
23
21
 
24
22
import bzrlib
25
23
from bzrlib import (
26
24
    config,
27
25
    errors,
 
26
    lock,
 
27
    lockdir,
28
28
    osutils,
29
29
    tests,
30
30
    transport,
31
31
    )
32
32
from bzrlib.errors import (
33
 
        LockBreakMismatch,
34
 
        LockContention, LockError, UnlockableTransport,
35
 
        LockNotHeld, LockBroken
36
 
        )
37
 
from bzrlib.lockdir import LockDir
38
 
from bzrlib.tests import TestCaseWithTransport
39
 
from bzrlib.trace import note
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.
 
33
    LockBreakMismatch,
 
34
    LockBroken,
 
35
    LockContention,
 
36
    LockFailed,
 
37
    LockNotHeld,
 
38
    )
 
39
from bzrlib.lockdir import (
 
40
    LockDir,
 
41
    LockHeldInfo,
 
42
    )
 
43
from bzrlib.tests import (
 
44
    features,
 
45
    TestCase,
 
46
    TestCaseInTempDir,
 
47
    TestCaseWithTransport,
 
48
    )
44
49
 
45
50
# These tests are run on the default transport provided by the test framework
46
51
# (typically a local disk transport).  That can be changed by the --transport
48
53
# implementation are tested separately.  (The main requirement is just that
49
54
# they don't allow overwriting nonempty directories.)
50
55
 
 
56
 
51
57
class TestLockDir(TestCaseWithTransport):
52
58
    """Test LockDir operations"""
53
59
 
105
111
        """Fail to create lock on readonly transport"""
106
112
        t = self.get_readonly_transport()
107
113
        lf = LockDir(t, 'test_lock')
108
 
        self.assertRaises(UnlockableTransport, lf.create)
 
114
        self.assertRaises(LockFailed, lf.create)
109
115
 
110
116
    def test_12_lock_readonly_transport(self):
111
117
        """Fail to lock on readonly transport"""
112
118
        lf = LockDir(self.get_transport(), 'test_lock')
113
119
        lf.create()
114
120
        lf = LockDir(self.get_readonly_transport(), 'test_lock')
115
 
        self.assertRaises(UnlockableTransport, lf.attempt_lock)
 
121
        self.assertRaises(LockFailed, lf.attempt_lock)
116
122
 
117
123
    def test_20_lock_contested(self):
118
124
        """Contention to get a lock"""
122
128
        lf1.attempt_lock()
123
129
        lf2 = LockDir(t, 'test_lock')
124
130
        try:
125
 
            # locking is between LockDir instances; aliases within 
 
131
            # locking is between LockDir instances; aliases within
126
132
            # a single process are not detected
127
133
            lf2.attempt_lock()
128
134
            self.fail('Failed to detect lock collision')
138
144
        lf1 = LockDir(t, 'test_lock')
139
145
        lf1.create()
140
146
        lf1.attempt_lock()
 
147
        self.addCleanup(lf1.unlock)
141
148
        # lock is held, should get some info on it
142
149
        info1 = lf1.peek()
143
 
        self.assertEqual(set(info1.keys()),
144
 
                         set(['user', 'nonce', 'hostname', 'pid', 'start_time']))
 
150
        self.assertEqual(set(info1.info_dict.keys()),
 
151
            set(['user', 'nonce', 'hostname', 'pid', 'start_time']))
145
152
        # should get the same info if we look at it through a different
146
153
        # instance
147
154
        info2 = LockDir(t, 'test_lock').peek()
157
164
        lf2 = LockDir(self.get_readonly_transport(), 'test_lock')
158
165
        self.assertEqual(lf2.peek(), None)
159
166
        lf1.attempt_lock()
 
167
        self.addCleanup(lf1.unlock)
160
168
        info2 = lf2.peek()
161
169
        self.assertTrue(info2)
162
 
        self.assertEqual(info2['nonce'], lf1.nonce)
 
170
        self.assertEqual(info2.get('nonce'), lf1.nonce)
163
171
 
164
172
    def test_30_lock_wait_fail(self):
165
173
        """Wait on a lock, then fail
166
 
        
 
174
 
167
175
        We ask to wait up to 400ms; this should fail within at most one
168
176
        second.  (Longer times are more realistic but we don't want the test
169
177
        suite to take too long, and this should do for now.)
181
189
            after = time.time()
182
190
            # it should only take about 0.4 seconds, but we allow more time in
183
191
            # case the machine is heavily loaded
184
 
            self.assertTrue(after - before <= 8.0, 
185
 
                    "took %f seconds to detect lock contention" % (after - before))
 
192
            self.assertTrue(after - before <= 8.0,
 
193
                "took %f seconds to detect lock contention" % (after - before))
186
194
        finally:
187
195
            lf1.unlock()
188
 
        lock_base = lf2.transport.abspath(lf2.path)
189
196
        self.assertEqual(1, len(self._logged_reports))
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')
 
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.')
201
203
 
202
204
    def test_31_lock_wait_easy(self):
203
205
        """Succeed when waiting on a lock with no contention.
215
217
            lf1.unlock()
216
218
        self.assertEqual([], self._logged_reports)
217
219
 
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
 
        raise tests.TestSkipped('Timing-sensitive test')
276
 
        bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 300
277
 
        t = self.get_transport()
278
 
        lf1 = LockDir(t, 'test_lock')
279
 
        lf1.create()
280
 
        lf1.attempt_lock()
281
 
 
282
 
        def wait_and_unlock():
283
 
            time.sleep(0.1)
284
 
            lf1.unlock()
285
 
        unlocker = Thread(target=wait_and_unlock)
286
 
        unlocker.start()
287
 
        try:
288
 
            lf2 = LockDir(t, 'test_lock')
289
 
            self.setup_log_reporter(lf2)
290
 
            before = time.time()
291
 
            # wait and then lock
292
 
            lf2.lock_write()
293
 
            after = time.time()
294
 
        finally:
295
 
            unlocker.join()
296
 
 
297
 
        # There should be only 1 report, even though it should have to
298
 
        # wait for a while
299
 
        lock_base = lf2.transport.abspath(lf2.path)
300
 
        self.assertEqual(1, len(self._logged_reports))
301
 
        self.assertEqual('%s %s\n'
302
 
                         '%s\n%s\n'
303
 
                         'Will continue to try until %s\n',
304
 
                         self._logged_reports[0][0])
305
 
        args = self._logged_reports[0][1]
306
 
        self.assertEqual('Unable to obtain', args[0])
307
 
        self.assertEqual('lock %s' % (lock_base,), args[1])
308
 
        self.assertStartsWith(args[2], 'held by ')
309
 
        self.assertStartsWith(args[3], 'locked ')
310
 
        self.assertEndsWith(args[3], ' ago')
311
 
        self.assertContainsRe(args[4], r'\d\d:\d\d:\d\d')
312
 
 
313
 
    def test_35_wait_lock_changing(self):
314
 
        """LockDir.wait_lock() will report if the lock changes underneath.
315
 
        
316
 
        This is the stages we want to happen:
317
 
 
318
 
        0) Synchronization locks are created and locked.
319
 
        1) Lock1 obtains the lockdir, and releases the 'check' lock.
320
 
        2) Lock2 grabs the 'check' lock, and checks the lockdir.
321
 
           It sees the lockdir is already acquired, reports the fact, 
322
 
           and unsets the 'checked' lock.
323
 
        3) Thread1 blocks on acquiring the 'checked' lock, and then tells
324
 
           Lock1 to release and acquire the lockdir. This resets the 'check'
325
 
           lock.
326
 
        4) Lock2 acquires the 'check' lock, and checks again. It notices
327
 
           that the holder of the lock has changed, and so reports a new 
328
 
           lock holder.
329
 
        5) Thread1 blocks on the 'checked' lock, this time, it completely
330
 
           unlocks the lockdir, allowing Lock2 to acquire the lock.
331
 
        """
332
 
 
333
 
        wait_to_check_lock = Lock()
334
 
        wait_until_checked_lock = Lock()
335
 
 
336
 
        wait_to_check_lock.acquire()
337
 
        wait_until_checked_lock.acquire()
338
 
        note('locked check and checked locks')
339
 
 
340
 
        class LockDir1(LockDir):
341
 
            """Use the synchronization points for the first lock."""
342
 
 
343
 
            def attempt_lock(self):
344
 
                # Once we have acquired the lock, it is okay for
345
 
                # the other lock to check it
346
 
                try:
347
 
                    return super(LockDir1, self).attempt_lock()
348
 
                finally:
349
 
                    note('lock1: releasing check lock')
350
 
                    wait_to_check_lock.release()
351
 
 
352
 
        class LockDir2(LockDir):
353
 
            """Use the synchronization points for the second lock."""
354
 
 
355
 
            def attempt_lock(self):
356
 
                note('lock2: waiting for check lock')
357
 
                wait_to_check_lock.acquire()
358
 
                note('lock2: acquired check lock')
359
 
                try:
360
 
                    return super(LockDir2, self).attempt_lock()
361
 
                finally:
362
 
                    note('lock2: releasing checked lock')
363
 
                    wait_until_checked_lock.release()
364
 
 
365
 
        t = self.get_transport()
366
 
        lf1 = LockDir1(t, 'test_lock')
367
 
        lf1.create()
368
 
 
369
 
        lf2 = LockDir2(t, 'test_lock')
370
 
        self.setup_log_reporter(lf2)
371
 
 
372
 
        def wait_and_switch():
373
 
            lf1.attempt_lock()
374
 
            # Block until lock2 has had a chance to check
375
 
            note('lock1: waiting 1 for checked lock')
376
 
            wait_until_checked_lock.acquire()
377
 
            note('lock1: acquired for checked lock')
378
 
            note('lock1: released lockdir')
379
 
            lf1.unlock()
380
 
            note('lock1: acquiring lockdir')
381
 
            # Create a new nonce, so the lock looks different.
382
 
            lf1.nonce = osutils.rand_chars(20)
383
 
            lf1.lock_write()
384
 
            note('lock1: acquired lockdir')
385
 
 
386
 
            # Block until lock2 has peeked again
387
 
            note('lock1: waiting 2 for checked lock')
388
 
            wait_until_checked_lock.acquire()
389
 
            note('lock1: acquired for checked lock')
390
 
            # Now unlock, and let lock 2 grab the lock
391
 
            lf1.unlock()
392
 
            wait_to_check_lock.release()
393
 
 
394
 
        unlocker = Thread(target=wait_and_switch)
395
 
        unlocker.start()
396
 
        try:
397
 
            # Wait and play against the other thread
398
 
            lf2.wait_lock(timeout=20.0, poll=0.01)
399
 
        finally:
400
 
            unlocker.join()
401
 
        lf2.unlock()
402
 
 
403
 
        # There should be 2 reports, because the lock changed
404
 
        lock_base = lf2.transport.abspath(lf2.path)
405
 
        self.assertEqual(2, len(self._logged_reports))
406
 
 
407
 
        self.assertEqual('%s %s\n'
408
 
                         '%s\n%s\n'
409
 
                         'Will continue to try until %s\n',
410
 
                         self._logged_reports[0][0])
411
 
        args = self._logged_reports[0][1]
412
 
        self.assertEqual('Unable to obtain', args[0])
413
 
        self.assertEqual('lock %s' % (lock_base,), args[1])
414
 
        self.assertStartsWith(args[2], 'held by ')
415
 
        self.assertStartsWith(args[3], 'locked ')
416
 
        self.assertEndsWith(args[3], ' ago')
417
 
        self.assertContainsRe(args[4], r'\d\d:\d\d:\d\d')
418
 
 
419
 
        self.assertEqual('%s %s\n'
420
 
                         '%s\n%s\n'
421
 
                         'Will continue to try until %s\n',
422
 
                         self._logged_reports[1][0])
423
 
        args = self._logged_reports[1][1]
424
 
        self.assertEqual('Lock owner changed for', args[0])
425
 
        self.assertEqual('lock %s' % (lock_base,), args[1])
426
 
        self.assertStartsWith(args[2], 'held by ')
427
 
        self.assertStartsWith(args[3], 'locked ')
428
 
        self.assertEndsWith(args[3], ' ago')
429
 
        self.assertContainsRe(args[4], r'\d\d:\d\d:\d\d')
430
 
 
431
220
    def test_40_confirm_easy(self):
432
221
        """Confirm a lock that's already held"""
433
222
        t = self.get_transport()
434
223
        lf1 = LockDir(t, 'test_lock')
435
224
        lf1.create()
436
225
        lf1.attempt_lock()
 
226
        self.addCleanup(lf1.unlock)
437
227
        lf1.confirm()
438
228
 
439
229
    def test_41_confirm_not_held(self):
451
241
        lf1.attempt_lock()
452
242
        t.move('test_lock', 'lock_gone_now')
453
243
        self.assertRaises(LockBroken, lf1.confirm)
 
244
        # Clean up
 
245
        t.move('lock_gone_now', 'test_lock')
 
246
        lf1.unlock()
454
247
 
455
248
    def test_43_break(self):
456
249
        """Break a lock whose caller has forgotten it"""
467
260
        lf2.force_break(holder_info)
468
261
        # now we should be able to take it
469
262
        lf2.attempt_lock()
 
263
        self.addCleanup(lf2.unlock)
470
264
        lf2.confirm()
471
265
 
472
266
    def test_44_break_already_released(self):
484
278
        lf2.force_break(holder_info)
485
279
        # now we should be able to take it
486
280
        lf2.attempt_lock()
 
281
        self.addCleanup(lf2.unlock)
487
282
        lf2.confirm()
488
283
 
489
284
    def test_45_break_mismatch(self):
515
310
        """Check the on-disk representation of LockDirs is as expected.
516
311
 
517
312
        There should always be a top-level directory named by the lock.
518
 
        When the lock is held, there should be a lockname/held directory 
 
313
        When the lock is held, there should be a lockname/held directory
519
314
        containing an info file.
520
315
        """
521
316
        t = self.get_transport()
536
331
        # do this without IO redirection to ensure it doesn't prompt.
537
332
        self.assertRaises(AssertionError, ld1.break_lock)
538
333
        orig_factory = bzrlib.ui.ui_factory
539
 
        # silent ui - no need for stdout
540
 
        bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
541
 
        bzrlib.ui.ui_factory.stdin = StringIO("y\n")
 
334
        bzrlib.ui.ui_factory = bzrlib.ui.CannedInputUIFactory([True])
542
335
        try:
543
336
            ld2.break_lock()
544
337
            self.assertRaises(LockBroken, ld1.unlock)
545
338
        finally:
546
339
            bzrlib.ui.ui_factory = orig_factory
547
340
 
 
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
 
548
399
    def test_create_missing_base_directory(self):
549
400
        """If LockDir.path doesn't exist, it can be created
550
401
 
556
407
        lf1 = LockDir(t, 'test_lock')
557
408
 
558
409
        lf1.create()
559
 
        self.failUnless(t.has('test_lock'))
 
410
        self.assertTrue(t.has('test_lock'))
560
411
 
561
412
        t.rmdir('test_lock')
562
 
        self.failIf(t.has('test_lock'))
 
413
        self.assertFalse(t.has('test_lock'))
563
414
 
564
415
        # This will create 'test_lock' if it needs to
565
416
        lf1.lock_write()
566
 
        self.failUnless(t.has('test_lock'))
567
 
        self.failUnless(t.has('test_lock/held/info'))
 
417
        self.assertTrue(t.has('test_lock'))
 
418
        self.assertTrue(t.has('test_lock/held/info'))
568
419
 
569
420
        lf1.unlock()
570
 
        self.failIf(t.has('test_lock/held/info'))
 
421
        self.assertFalse(t.has('test_lock/held/info'))
571
422
 
572
 
    def test__format_lock_info(self):
 
423
    def test_display_form(self):
573
424
        ld1 = self.get_lock()
574
425
        ld1.create()
575
426
        ld1.lock_write()
576
427
        try:
577
 
            info_list = ld1._format_lock_info(ld1.peek())
 
428
            info_list = ld1.peek().to_readable_dict()
578
429
        finally:
579
430
            ld1.unlock()
580
 
        self.assertEqual('lock %s' % (ld1.transport.abspath(ld1.path),),
581
 
                         info_list[0])
582
 
        self.assertContainsRe(info_list[1],
583
 
                              r'^held by .* on host .* \[process #\d*\]$')
584
 
        self.assertContainsRe(info_list[2], r'locked \d+ seconds? ago$')
 
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$')
585
434
 
586
435
    def test_lock_without_email(self):
587
 
        global_config = config.GlobalConfig()
 
436
        global_config = config.GlobalStack()
588
437
        # Intentionally has no email address
589
 
        global_config.set_user_option('email', 'User Identity')
 
438
        global_config.set('email', 'User Identity')
590
439
        ld1 = self.get_lock()
591
440
        ld1.create()
592
441
        ld1.lock_write()
593
442
        ld1.unlock()
594
443
 
595
444
    def test_lock_permission(self):
 
445
        self.requireFeature(features.not_running_as_root)
596
446
        if not osutils.supports_posix_readonly():
597
447
            raise tests.TestSkipped('Cannot induce a permission failure')
598
448
        ld1 = self.get_lock()
599
449
        lock_path = ld1.transport.local_abspath('test_lock')
600
450
        os.mkdir(lock_path)
601
451
        osutils.make_readonly(lock_path)
602
 
        self.assertRaises(errors.PermissionDenied, ld1.attempt_lock)
 
452
        self.assertRaises(errors.LockFailed, ld1.attempt_lock)
603
453
 
604
454
    def test_lock_by_token(self):
605
455
        ld1 = self.get_lock()
606
456
        token = ld1.lock_write()
 
457
        self.addCleanup(ld1.unlock)
607
458
        self.assertNotEqual(None, token)
608
459
        ld2 = self.get_lock()
609
460
        t2 = ld2.lock_write(token)
 
461
        self.addCleanup(ld2.unlock)
610
462
        self.assertEqual(token, t2)
611
463
 
612
464
    def test_lock_with_buggy_rename(self):
613
465
        # test that lock acquisition handles servers which pretend they
614
466
        # renamed correctly but that actually fail
615
 
        t = transport.get_transport('brokenrename+' + self.get_url())
 
467
        t = transport.get_transport_from_url(
 
468
            'brokenrename+' + self.get_url())
616
469
        ld1 = LockDir(t, 'test_lock')
617
470
        ld1.create()
618
471
        ld1.attempt_lock()
622
475
        # now the original caller should succeed in unlocking
623
476
        ld1.unlock()
624
477
        # and there should be nothing left over
625
 
        self.assertEquals([], t.list_dir('test_lock'))
 
478
        self.assertEqual([], t.list_dir('test_lock'))
626
479
 
627
480
    def test_failed_lock_leaves_no_trash(self):
628
481
        # if we fail to acquire the lock, we don't leave pending directories
632
485
        # should be nothing before we start
633
486
        ld1.create()
634
487
        t = self.get_transport().clone('test_lock')
 
488
 
635
489
        def check_dir(a):
636
 
            self.assertEquals(a, t.list_dir('.'))
 
490
            self.assertEqual(a, t.list_dir('.'))
 
491
 
637
492
        check_dir([])
638
493
        # when held, that's all we see
639
494
        ld1.attempt_lock()
 
495
        self.addCleanup(ld1.unlock)
640
496
        check_dir(['held'])
641
497
        # second guy should fail
642
498
        self.assertRaises(errors.LockContention, ld2.attempt_lock)
643
499
        # no kibble
644
500
        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()