← 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: Aaron Bentley
  • Date: 2006-11-10 01:55:55 UTC
  • mto: This revision was merged to the branch mainline in revision 2127.
  • Revision ID: aaron.bentley@utoronto.ca-20061110015555-f48202744b630209
Ignore html docs (both kinds)

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 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
 
import os
 
19
from cStringIO import StringIO
 
20
from threading import Thread, Lock
20
21
import time
21
22
 
22
23
import bzrlib
23
24
from bzrlib import (
24
25
    config,
25
 
    errors,
26
 
    lock,
27
 
    lockdir,
28
26
    osutils,
29
 
    tests,
30
 
    transport,
31
27
    )
32
28
from bzrlib.errors import (
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
 
    )
 
29
        LockBreakMismatch,
 
30
        LockContention, LockError, UnlockableTransport,
 
31
        LockNotHeld, LockBroken
 
32
        )
 
33
from bzrlib.lockdir import LockDir, _DEFAULT_TIMEOUT_SECONDS
 
34
from bzrlib.tests import TestCaseWithTransport
 
35
from bzrlib.trace import note
 
36
 
 
37
# These tests sometimes use threads to test the behaviour of lock files with
 
38
# concurrent actors.  This is not a typical (or necessarily supported) use;
 
39
# they're really meant for guarding between processes.
49
40
 
50
41
# These tests are run on the default transport provided by the test framework
51
42
# (typically a local disk transport).  That can be changed by the --transport
53
44
# implementation are tested separately.  (The main requirement is just that
54
45
# they don't allow overwriting nonempty directories.)
55
46
 
56
 
 
57
47
class TestLockDir(TestCaseWithTransport):
58
48
    """Test LockDir operations"""
59
49
 
111
101
        """Fail to create lock on readonly transport"""
112
102
        t = self.get_readonly_transport()
113
103
        lf = LockDir(t, 'test_lock')
114
 
        self.assertRaises(LockFailed, lf.create)
 
104
        self.assertRaises(UnlockableTransport, lf.create)
115
105
 
116
106
    def test_12_lock_readonly_transport(self):
117
107
        """Fail to lock on readonly transport"""
118
108
        lf = LockDir(self.get_transport(), 'test_lock')
119
109
        lf.create()
120
110
        lf = LockDir(self.get_readonly_transport(), 'test_lock')
121
 
        self.assertRaises(LockFailed, lf.attempt_lock)
 
111
        self.assertRaises(UnlockableTransport, lf.attempt_lock)
122
112
 
123
113
    def test_20_lock_contested(self):
124
114
        """Contention to get a lock"""
128
118
        lf1.attempt_lock()
129
119
        lf2 = LockDir(t, 'test_lock')
130
120
        try:
131
 
            # locking is between LockDir instances; aliases within
 
121
            # locking is between LockDir instances; aliases within 
132
122
            # a single process are not detected
133
123
            lf2.attempt_lock()
134
124
            self.fail('Failed to detect lock collision')
144
134
        lf1 = LockDir(t, 'test_lock')
145
135
        lf1.create()
146
136
        lf1.attempt_lock()
147
 
        self.addCleanup(lf1.unlock)
148
137
        # lock is held, should get some info on it
149
138
        info1 = lf1.peek()
150
 
        self.assertEqual(set(info1.info_dict.keys()),
151
 
            set(['user', 'nonce', 'hostname', 'pid', 'start_time']))
 
139
        self.assertEqual(set(info1.keys()),
 
140
                         set(['user', 'nonce', 'hostname', 'pid', 'start_time']))
152
141
        # should get the same info if we look at it through a different
153
142
        # instance
154
143
        info2 = LockDir(t, 'test_lock').peek()
164
153
        lf2 = LockDir(self.get_readonly_transport(), 'test_lock')
165
154
        self.assertEqual(lf2.peek(), None)
166
155
        lf1.attempt_lock()
167
 
        self.addCleanup(lf1.unlock)
168
156
        info2 = lf2.peek()
169
157
        self.assertTrue(info2)
170
 
        self.assertEqual(info2.get('nonce'), lf1.nonce)
 
158
        self.assertEqual(info2['nonce'], lf1.nonce)
171
159
 
172
160
    def test_30_lock_wait_fail(self):
173
161
        """Wait on a lock, then fail
174
 
 
 
162
        
175
163
        We ask to wait up to 400ms; this should fail within at most one
176
164
        second.  (Longer times are more realistic but we don't want the test
177
165
        suite to take too long, and this should do for now.)
189
177
            after = time.time()
190
178
            # it should only take about 0.4 seconds, but we allow more time in
191
179
            # case the machine is heavily loaded
192
 
            self.assertTrue(after - before <= 8.0,
193
 
                "took %f seconds to detect lock contention" % (after - before))
 
180
            self.assertTrue(after - before <= 8.0, 
 
181
                    "took %f seconds to detect lock contention" % (after - before))
194
182
        finally:
195
183
            lf1.unlock()
 
184
        lock_base = lf2.transport.abspath(lf2.path)
196
185
        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.')
 
186
        self.assertEqual('%s %s\n'
 
187
                         '%s\n%s\n'
 
188
                         'Will continue to try until %s\n',
 
189
                         self._logged_reports[0][0])
 
190
        args = self._logged_reports[0][1]
 
191
        self.assertEqual('Unable to obtain', args[0])
 
192
        self.assertEqual('lock %s' % (lock_base,), args[1])
 
193
        self.assertStartsWith(args[2], 'held by ')
 
194
        self.assertStartsWith(args[3], 'locked ')
 
195
        self.assertEndsWith(args[3], ' ago')
 
196
        self.assertContainsRe(args[4], r'\d\d:\d\d:\d\d')
203
197
 
204
198
    def test_31_lock_wait_easy(self):
205
199
        """Succeed when waiting on a lock with no contention.
217
211
            lf1.unlock()
218
212
        self.assertEqual([], self._logged_reports)
219
213
 
 
214
    def test_32_lock_wait_succeed(self):
 
215
        """Succeed when trying to acquire a lock that gets released
 
216
 
 
217
        One thread holds on a lock and then releases it; another 
 
218
        tries to lock it.
 
219
        """
 
220
        t = self.get_transport()
 
221
        lf1 = LockDir(t, 'test_lock')
 
222
        lf1.create()
 
223
        lf1.attempt_lock()
 
224
 
 
225
        def wait_and_unlock():
 
226
            time.sleep(0.1)
 
227
            lf1.unlock()
 
228
        unlocker = Thread(target=wait_and_unlock)
 
229
        unlocker.start()
 
230
        try:
 
231
            lf2 = LockDir(t, 'test_lock')
 
232
            self.setup_log_reporter(lf2)
 
233
            before = time.time()
 
234
            # wait and then lock
 
235
            lf2.wait_lock(timeout=0.4, poll=0.1)
 
236
            after = time.time()
 
237
            self.assertTrue(after - before <= 1.0)
 
238
        finally:
 
239
            unlocker.join()
 
240
 
 
241
        # There should be only 1 report, even though it should have to
 
242
        # wait for a while
 
243
        lock_base = lf2.transport.abspath(lf2.path)
 
244
        self.assertEqual(1, len(self._logged_reports))
 
245
        self.assertEqual('%s %s\n'
 
246
                         '%s\n%s\n'
 
247
                         'Will continue to try until %s\n',
 
248
                         self._logged_reports[0][0])
 
249
        args = self._logged_reports[0][1]
 
250
        self.assertEqual('Unable to obtain', args[0])
 
251
        self.assertEqual('lock %s' % (lock_base,), args[1])
 
252
        self.assertStartsWith(args[2], 'held by ')
 
253
        self.assertStartsWith(args[3], 'locked ')
 
254
        self.assertEndsWith(args[3], ' ago')
 
255
        self.assertContainsRe(args[4], r'\d\d:\d\d:\d\d')
 
256
 
 
257
    def test_33_wait(self):
 
258
        """Succeed when waiting on a lock that gets released
 
259
 
 
260
        The difference from test_32_lock_wait_succeed is that the second 
 
261
        caller does not actually acquire the lock, but just waits for it
 
262
        to be released.  This is done over a readonly transport.
 
263
        """
 
264
        t = self.get_transport()
 
265
        lf1 = LockDir(t, 'test_lock')
 
266
        lf1.create()
 
267
        lf1.attempt_lock()
 
268
 
 
269
        def wait_and_unlock():
 
270
            time.sleep(0.1)
 
271
            lf1.unlock()
 
272
        unlocker = Thread(target=wait_and_unlock)
 
273
        unlocker.start()
 
274
        try:
 
275
            lf2 = LockDir(self.get_readonly_transport(), 'test_lock')
 
276
            before = time.time()
 
277
            # wait but don't lock
 
278
            lf2.wait(timeout=0.4, poll=0.1)
 
279
            after = time.time()
 
280
            self.assertTrue(after - before <= 1.0)
 
281
        finally:
 
282
            unlocker.join()
 
283
 
 
284
    def test_34_lock_write_waits(self):
 
285
        """LockDir.lock_write() will wait for the lock.""" 
 
286
        t = self.get_transport()
 
287
        lf1 = LockDir(t, 'test_lock')
 
288
        lf1.create()
 
289
        lf1.attempt_lock()
 
290
 
 
291
        def wait_and_unlock():
 
292
            time.sleep(0.1)
 
293
            lf1.unlock()
 
294
        unlocker = Thread(target=wait_and_unlock)
 
295
        unlocker.start()
 
296
        try:
 
297
            lf2 = LockDir(t, 'test_lock')
 
298
            self.setup_log_reporter(lf2)
 
299
            before = time.time()
 
300
            # wait and then lock
 
301
            lf2.lock_write()
 
302
            after = time.time()
 
303
        finally:
 
304
            unlocker.join()
 
305
 
 
306
        # There should be only 1 report, even though it should have to
 
307
        # wait for a while
 
308
        lock_base = lf2.transport.abspath(lf2.path)
 
309
        self.assertEqual(1, len(self._logged_reports))
 
310
        self.assertEqual('%s %s\n'
 
311
                         '%s\n%s\n'
 
312
                         'Will continue to try until %s\n',
 
313
                         self._logged_reports[0][0])
 
314
        args = self._logged_reports[0][1]
 
315
        self.assertEqual('Unable to obtain', args[0])
 
316
        self.assertEqual('lock %s' % (lock_base,), args[1])
 
317
        self.assertStartsWith(args[2], 'held by ')
 
318
        self.assertStartsWith(args[3], 'locked ')
 
319
        self.assertEndsWith(args[3], ' ago')
 
320
        self.assertContainsRe(args[4], r'\d\d:\d\d:\d\d')
 
321
 
 
322
    def test_35_wait_lock_changing(self):
 
323
        """LockDir.wait_lock() will report if the lock changes underneath.
 
324
        
 
325
        This is the stages we want to happen:
 
326
 
 
327
        0) Synchronization locks are created and locked.
 
328
        1) Lock1 obtains the lockdir, and releases the 'check' lock.
 
329
        2) Lock2 grabs the 'check' lock, and checks the lockdir.
 
330
           It sees the lockdir is already acquired, reports the fact, 
 
331
           and unsets the 'checked' lock.
 
332
        3) Thread1 blocks on acquiring the 'checked' lock, and then tells
 
333
           Lock1 to release and acquire the lockdir. This resets the 'check'
 
334
           lock.
 
335
        4) Lock2 acquires the 'check' lock, and checks again. It notices
 
336
           that the holder of the lock has changed, and so reports a new 
 
337
           lock holder.
 
338
        5) Thread1 blocks on the 'checked' lock, this time, it completely
 
339
           unlocks the lockdir, allowing Lock2 to acquire the lock.
 
340
        """
 
341
 
 
342
        wait_to_check_lock = Lock()
 
343
        wait_until_checked_lock = Lock()
 
344
 
 
345
        wait_to_check_lock.acquire()
 
346
        wait_until_checked_lock.acquire()
 
347
        note('locked check and checked locks')
 
348
 
 
349
        class LockDir1(LockDir):
 
350
            """Use the synchronization points for the first lock."""
 
351
 
 
352
            def attempt_lock(self):
 
353
                # Once we have acquired the lock, it is okay for
 
354
                # the other lock to check it
 
355
                try:
 
356
                    return super(LockDir1, self).attempt_lock()
 
357
                finally:
 
358
                    note('lock1: releasing check lock')
 
359
                    wait_to_check_lock.release()
 
360
 
 
361
        class LockDir2(LockDir):
 
362
            """Use the synchronization points for the second lock."""
 
363
 
 
364
            def attempt_lock(self):
 
365
                note('lock2: waiting for check lock')
 
366
                wait_to_check_lock.acquire()
 
367
                note('lock2: acquired check lock')
 
368
                try:
 
369
                    return super(LockDir2, self).attempt_lock()
 
370
                finally:
 
371
                    note('lock2: releasing checked lock')
 
372
                    wait_until_checked_lock.release()
 
373
 
 
374
        t = self.get_transport()
 
375
        lf1 = LockDir1(t, 'test_lock')
 
376
        lf1.create()
 
377
 
 
378
        lf2 = LockDir2(t, 'test_lock')
 
379
        self.setup_log_reporter(lf2)
 
380
 
 
381
        def wait_and_switch():
 
382
            lf1.attempt_lock()
 
383
            # Block until lock2 has had a chance to check
 
384
            note('lock1: waiting 1 for checked lock')
 
385
            wait_until_checked_lock.acquire()
 
386
            note('lock1: acquired for checked lock')
 
387
            note('lock1: released lockdir')
 
388
            lf1.unlock()
 
389
            note('lock1: acquiring lockdir')
 
390
            # Create a new nonce, so the lock looks different.
 
391
            lf1.nonce = osutils.rand_chars(20)
 
392
            lf1.lock_write()
 
393
            note('lock1: acquired lockdir')
 
394
 
 
395
            # Block until lock2 has peeked again
 
396
            note('lock1: waiting 2 for checked lock')
 
397
            wait_until_checked_lock.acquire()
 
398
            note('lock1: acquired for checked lock')
 
399
            # Now unlock, and let lock 2 grab the lock
 
400
            lf1.unlock()
 
401
            wait_to_check_lock.release()
 
402
 
 
403
        unlocker = Thread(target=wait_and_switch)
 
404
        unlocker.start()
 
405
        try:
 
406
            # Wait and play against the other thread
 
407
            lf2.wait_lock(timeout=1.0, poll=0.01)
 
408
        finally:
 
409
            unlocker.join()
 
410
        lf2.unlock()
 
411
 
 
412
        # There should be 2 reports, because the lock changed
 
413
        lock_base = lf2.transport.abspath(lf2.path)
 
414
        self.assertEqual(2, len(self._logged_reports))
 
415
 
 
416
        self.assertEqual('%s %s\n'
 
417
                         '%s\n%s\n'
 
418
                         'Will continue to try until %s\n',
 
419
                         self._logged_reports[0][0])
 
420
        args = self._logged_reports[0][1]
 
421
        self.assertEqual('Unable to obtain', args[0])
 
422
        self.assertEqual('lock %s' % (lock_base,), args[1])
 
423
        self.assertStartsWith(args[2], 'held by ')
 
424
        self.assertStartsWith(args[3], 'locked ')
 
425
        self.assertEndsWith(args[3], ' ago')
 
426
        self.assertContainsRe(args[4], r'\d\d:\d\d:\d\d')
 
427
 
 
428
        self.assertEqual('%s %s\n'
 
429
                         '%s\n%s\n'
 
430
                         'Will continue to try until %s\n',
 
431
                         self._logged_reports[1][0])
 
432
        args = self._logged_reports[1][1]
 
433
        self.assertEqual('Lock owner changed for', args[0])
 
434
        self.assertEqual('lock %s' % (lock_base,), args[1])
 
435
        self.assertStartsWith(args[2], 'held by ')
 
436
        self.assertStartsWith(args[3], 'locked ')
 
437
        self.assertEndsWith(args[3], ' ago')
 
438
        self.assertContainsRe(args[4], r'\d\d:\d\d:\d\d')
 
439
 
220
440
    def test_40_confirm_easy(self):
221
441
        """Confirm a lock that's already held"""
222
442
        t = self.get_transport()
223
443
        lf1 = LockDir(t, 'test_lock')
224
444
        lf1.create()
225
445
        lf1.attempt_lock()
226
 
        self.addCleanup(lf1.unlock)
227
446
        lf1.confirm()
228
447
 
229
448
    def test_41_confirm_not_held(self):
241
460
        lf1.attempt_lock()
242
461
        t.move('test_lock', 'lock_gone_now')
243
462
        self.assertRaises(LockBroken, lf1.confirm)
244
 
        # Clean up
245
 
        t.move('lock_gone_now', 'test_lock')
246
 
        lf1.unlock()
247
463
 
248
464
    def test_43_break(self):
249
465
        """Break a lock whose caller has forgotten it"""
260
476
        lf2.force_break(holder_info)
261
477
        # now we should be able to take it
262
478
        lf2.attempt_lock()
263
 
        self.addCleanup(lf2.unlock)
264
479
        lf2.confirm()
265
480
 
266
481
    def test_44_break_already_released(self):
278
493
        lf2.force_break(holder_info)
279
494
        # now we should be able to take it
280
495
        lf2.attempt_lock()
281
 
        self.addCleanup(lf2.unlock)
282
496
        lf2.confirm()
283
497
 
284
498
    def test_45_break_mismatch(self):
310
524
        """Check the on-disk representation of LockDirs is as expected.
311
525
 
312
526
        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
 
527
        When the lock is held, there should be a lockname/held directory 
314
528
        containing an info file.
315
529
        """
316
530
        t = self.get_transport()
331
545
        # do this without IO redirection to ensure it doesn't prompt.
332
546
        self.assertRaises(AssertionError, ld1.break_lock)
333
547
        orig_factory = bzrlib.ui.ui_factory
334
 
        bzrlib.ui.ui_factory = bzrlib.ui.CannedInputUIFactory([True])
 
548
        # silent ui - no need for stdout
 
549
        bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
 
550
        bzrlib.ui.ui_factory.stdin = StringIO("y\n")
335
551
        try:
336
552
            ld2.break_lock()
337
553
            self.assertRaises(LockBroken, ld1.unlock)
338
554
        finally:
339
555
            bzrlib.ui.ui_factory = orig_factory
340
556
 
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
557
    def test_create_missing_base_directory(self):
400
558
        """If LockDir.path doesn't exist, it can be created
401
559
 
407
565
        lf1 = LockDir(t, 'test_lock')
408
566
 
409
567
        lf1.create()
410
 
        self.assertTrue(t.has('test_lock'))
 
568
        self.failUnless(t.has('test_lock'))
411
569
 
412
570
        t.rmdir('test_lock')
413
 
        self.assertFalse(t.has('test_lock'))
 
571
        self.failIf(t.has('test_lock'))
414
572
 
415
573
        # This will create 'test_lock' if it needs to
416
574
        lf1.lock_write()
417
 
        self.assertTrue(t.has('test_lock'))
418
 
        self.assertTrue(t.has('test_lock/held/info'))
 
575
        self.failUnless(t.has('test_lock'))
 
576
        self.failUnless(t.has('test_lock/held/info'))
419
577
 
420
578
        lf1.unlock()
421
 
        self.assertFalse(t.has('test_lock/held/info'))
 
579
        self.failIf(t.has('test_lock/held/info'))
422
580
 
423
 
    def test_display_form(self):
 
581
    def test__format_lock_info(self):
424
582
        ld1 = self.get_lock()
425
583
        ld1.create()
426
584
        ld1.lock_write()
427
585
        try:
428
 
            info_list = ld1.peek().to_readable_dict()
 
586
            info_list = ld1._format_lock_info(ld1.peek())
429
587
        finally:
430
588
            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$')
 
589
        self.assertEqual('lock %s' % (ld1.transport.abspath(ld1.path),),
 
590
                         info_list[0])
 
591
        self.assertContainsRe(info_list[1],
 
592
                              r'^held by .* on host .* \[process #\d*\]$')
 
593
        self.assertContainsRe(info_list[2], r'locked \d+ seconds? ago$')
434
594
 
435
595
    def test_lock_without_email(self):
436
 
        global_config = config.GlobalStack()
 
596
        global_config = config.GlobalConfig()
437
597
        # Intentionally has no email address
438
 
        global_config.set('email', 'User Identity')
 
598
        global_config.set_user_option('email', 'User Identity')
439
599
        ld1 = self.get_lock()
440
600
        ld1.create()
441
601
        ld1.lock_write()
442
602
        ld1.unlock()
443
 
 
444
 
    def test_lock_permission(self):
445
 
        self.requireFeature(features.not_running_as_root)
446
 
        if not osutils.supports_posix_readonly():
447
 
            raise tests.TestSkipped('Cannot induce a permission failure')
448
 
        ld1 = self.get_lock()
449
 
        lock_path = ld1.transport.local_abspath('test_lock')
450
 
        os.mkdir(lock_path)
451
 
        osutils.make_readonly(lock_path)
452
 
        self.assertRaises(errors.LockFailed, ld1.attempt_lock)
453
 
 
454
 
    def test_lock_by_token(self):
455
 
        ld1 = self.get_lock()
456
 
        token = ld1.lock_write()
457
 
        self.addCleanup(ld1.unlock)
458
 
        self.assertNotEqual(None, token)
459
 
        ld2 = self.get_lock()
460
 
        t2 = ld2.lock_write(token)
461
 
        self.addCleanup(ld2.unlock)
462
 
        self.assertEqual(token, t2)
463
 
 
464
 
    def test_lock_with_buggy_rename(self):
465
 
        # test that lock acquisition handles servers which pretend they
466
 
        # renamed correctly but that actually fail
467
 
        t = transport.get_transport_from_url(
468
 
            'brokenrename+' + self.get_url())
469
 
        ld1 = LockDir(t, 'test_lock')
470
 
        ld1.create()
471
 
        ld1.attempt_lock()
472
 
        ld2 = LockDir(t, 'test_lock')
473
 
        # we should fail to lock
474
 
        e = self.assertRaises(errors.LockContention, ld2.attempt_lock)
475
 
        # now the original caller should succeed in unlocking
476
 
        ld1.unlock()
477
 
        # and there should be nothing left over
478
 
        self.assertEqual([], t.list_dir('test_lock'))
479
 
 
480
 
    def test_failed_lock_leaves_no_trash(self):
481
 
        # if we fail to acquire the lock, we don't leave pending directories
482
 
        # behind -- https://bugs.launchpad.net/bzr/+bug/109169
483
 
        ld1 = self.get_lock()
484
 
        ld2 = self.get_lock()
485
 
        # should be nothing before we start
486
 
        ld1.create()
487
 
        t = self.get_transport().clone('test_lock')
488
 
 
489
 
        def check_dir(a):
490
 
            self.assertEqual(a, t.list_dir('.'))
491
 
 
492
 
        check_dir([])
493
 
        # when held, that's all we see
494
 
        ld1.attempt_lock()
495
 
        self.addCleanup(ld1.unlock)
496
 
        check_dir(['held'])
497
 
        # second guy should fail
498
 
        self.assertRaises(errors.LockContention, ld2.attempt_lock)
499
 
        # no kibble
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()