/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_lockdir.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2011-06-30 16:06:19 UTC
  • mfrom: (5971.1.80 bzr-gpgme)
  • Revision ID: pqm@pqm.ubuntu.com-20110630160619-3022zmfchft893nt
(jr) A new command ``bzr verify-signatures`` has been added to check that
 commits
 are correctly signed with trusted keys by GPG. This requires python-gpgme to
 be installed. ``bzr log`` has gained a ``--signatures`` option to list the
 validity of signatures for each commit. New config options
 ``acceptable_keys``
 and ``validate_signatures_in_log`` can be set to control options to these
 commands. (Jonathan Riddell)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_lockdir.py
1
 
# Copyright (C) 2006 Canonical Ltd
2
 
 
 
1
# Copyright (C) 2006-2011 Canonical Ltd
 
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
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
 
 
7
#
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
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 threading import Thread
 
19
import os
 
20
import sys
20
21
import time
21
22
 
 
23
import bzrlib
 
24
from bzrlib import (
 
25
    config,
 
26
    errors,
 
27
    lock,
 
28
    lockdir,
 
29
    osutils,
 
30
    tests,
 
31
    transport,
 
32
    )
22
33
from bzrlib.errors import (
23
 
        LockBreakMismatch,
24
 
        LockContention, LockError, UnlockableTransport,
25
 
        LockNotHeld, LockBroken
26
 
        )
27
 
from bzrlib.lockdir import LockDir
28
 
from bzrlib.tests import TestCaseWithTransport
29
 
 
30
 
# These tests sometimes use threads to test the behaviour of lock files with
31
 
# concurrent actors.  This is not a typical (or necessarily supported) use;
32
 
# they're really meant for guarding between processes.
 
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
    )
 
49
from bzrlib.trace import note
33
50
 
34
51
# These tests are run on the default transport provided by the test framework
35
52
# (typically a local disk transport).  That can be changed by the --transport
37
54
# implementation are tested separately.  (The main requirement is just that
38
55
# they don't allow overwriting nonempty directories.)
39
56
 
 
57
 
40
58
class TestLockDir(TestCaseWithTransport):
41
59
    """Test LockDir operations"""
42
60
 
 
61
    def logging_report_function(self, fmt, *args):
 
62
        self._logged_reports.append((fmt, args))
 
63
 
 
64
    def setup_log_reporter(self, lock_dir):
 
65
        self._logged_reports = []
 
66
        lock_dir._report_function = self.logging_report_function
 
67
 
43
68
    def test_00_lock_creation(self):
44
69
        """Creation of lock file on a transport"""
45
70
        t = self.get_transport()
56
81
        lf = LockDir(self.get_transport(), 'test_lock')
57
82
        self.assertEqual(lf.peek(), None)
58
83
 
 
84
    def get_lock(self):
 
85
        return LockDir(self.get_transport(), 'test_lock')
 
86
 
 
87
    def test_unlock_after_break_raises(self):
 
88
        ld = self.get_lock()
 
89
        ld2 = self.get_lock()
 
90
        ld.create()
 
91
        ld.attempt_lock()
 
92
        ld2.force_break(ld2.peek())
 
93
        self.assertRaises(LockBroken, ld.unlock)
 
94
 
59
95
    def test_03_readonly_peek(self):
60
96
        lf = LockDir(self.get_readonly_transport(), 'test_lock')
61
97
        self.assertEqual(lf.peek(), None)
76
112
        """Fail to create lock on readonly transport"""
77
113
        t = self.get_readonly_transport()
78
114
        lf = LockDir(t, 'test_lock')
79
 
        self.assertRaises(UnlockableTransport, lf.create)
 
115
        self.assertRaises(LockFailed, lf.create)
80
116
 
81
117
    def test_12_lock_readonly_transport(self):
82
118
        """Fail to lock on readonly transport"""
83
119
        lf = LockDir(self.get_transport(), 'test_lock')
84
120
        lf.create()
85
121
        lf = LockDir(self.get_readonly_transport(), 'test_lock')
86
 
        self.assertRaises(UnlockableTransport, lf.attempt_lock)
 
122
        self.assertRaises(LockFailed, lf.attempt_lock)
87
123
 
88
124
    def test_20_lock_contested(self):
89
125
        """Contention to get a lock"""
93
129
        lf1.attempt_lock()
94
130
        lf2 = LockDir(t, 'test_lock')
95
131
        try:
96
 
            # locking is between LockDir instances; aliases within 
 
132
            # locking is between LockDir instances; aliases within
97
133
            # a single process are not detected
98
134
            lf2.attempt_lock()
99
135
            self.fail('Failed to detect lock collision')
109
145
        lf1 = LockDir(t, 'test_lock')
110
146
        lf1.create()
111
147
        lf1.attempt_lock()
 
148
        self.addCleanup(lf1.unlock)
112
149
        # lock is held, should get some info on it
113
150
        info1 = lf1.peek()
114
 
        self.assertEqual(set(info1.keys()),
115
 
                         set(['user', 'nonce', 'hostname', 'pid', 'start_time']))
 
151
        self.assertEqual(set(info1.info_dict.keys()),
 
152
            set(['user', 'nonce', 'hostname', 'pid', 'start_time']))
116
153
        # should get the same info if we look at it through a different
117
154
        # instance
118
155
        info2 = LockDir(t, 'test_lock').peek()
128
165
        lf2 = LockDir(self.get_readonly_transport(), 'test_lock')
129
166
        self.assertEqual(lf2.peek(), None)
130
167
        lf1.attempt_lock()
 
168
        self.addCleanup(lf1.unlock)
131
169
        info2 = lf2.peek()
132
170
        self.assertTrue(info2)
133
 
        self.assertEqual(info2['nonce'], lf1.nonce)
 
171
        self.assertEqual(info2.get('nonce'), lf1.nonce)
134
172
 
135
173
    def test_30_lock_wait_fail(self):
136
174
        """Wait on a lock, then fail
137
 
        
 
175
 
138
176
        We ask to wait up to 400ms; this should fail within at most one
139
177
        second.  (Longer times are more realistic but we don't want the test
140
178
        suite to take too long, and this should do for now.)
143
181
        lf1 = LockDir(t, 'test_lock')
144
182
        lf1.create()
145
183
        lf2 = LockDir(t, 'test_lock')
 
184
        self.setup_log_reporter(lf2)
146
185
        lf1.attempt_lock()
147
186
        try:
148
187
            before = time.time()
149
188
            self.assertRaises(LockContention, lf2.wait_lock,
150
189
                              timeout=0.4, poll=0.1)
151
190
            after = time.time()
152
 
            self.assertTrue(after - before <= 1.0)
 
191
            # it should only take about 0.4 seconds, but we allow more time in
 
192
            # case the machine is heavily loaded
 
193
            self.assertTrue(after - before <= 8.0,
 
194
                "took %f seconds to detect lock contention" % (after - before))
153
195
        finally:
154
196
            lf1.unlock()
 
197
        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.')
155
204
 
156
205
    def test_31_lock_wait_easy(self):
157
206
        """Succeed when waiting on a lock with no contention.
159
208
        t = self.get_transport()
160
209
        lf1 = LockDir(t, 'test_lock')
161
210
        lf1.create()
 
211
        self.setup_log_reporter(lf1)
162
212
        try:
163
213
            before = time.time()
164
214
            lf1.wait_lock(timeout=0.4, poll=0.1)
166
216
            self.assertTrue(after - before <= 1.0)
167
217
        finally:
168
218
            lf1.unlock()
169
 
 
170
 
    def test_32_lock_wait_succeed(self):
171
 
        """Succeed when trying to acquire a lock that gets released
172
 
 
173
 
        One thread holds on a lock and then releases it; another 
174
 
        tries to lock it.
175
 
        """
176
 
        t = self.get_transport()
177
 
        lf1 = LockDir(t, 'test_lock')
178
 
        lf1.create()
179
 
        lf1.attempt_lock()
180
 
 
181
 
        def wait_and_unlock():
182
 
            time.sleep(0.1)
183
 
            lf1.unlock()
184
 
        unlocker = Thread(target=wait_and_unlock)
185
 
        unlocker.start()
186
 
        try:
187
 
            lf2 = LockDir(t, 'test_lock')
188
 
            before = time.time()
189
 
            # wait and then lock
190
 
            lf2.wait_lock(timeout=0.4, poll=0.1)
191
 
            after = time.time()
192
 
            self.assertTrue(after - before <= 1.0)
193
 
        finally:
194
 
            unlocker.join()
195
 
 
196
 
    def test_33_wait(self):
197
 
        """Succeed when waiting on a lock that gets released
198
 
 
199
 
        The difference from test_32_lock_wait_succeed is that the second 
200
 
        caller does not actually acquire the lock, but just waits for it
201
 
        to be released.  This is done over a readonly transport.
202
 
        """
203
 
        t = self.get_transport()
204
 
        lf1 = LockDir(t, 'test_lock')
205
 
        lf1.create()
206
 
        lf1.attempt_lock()
207
 
 
208
 
        def wait_and_unlock():
209
 
            time.sleep(0.1)
210
 
            lf1.unlock()
211
 
        unlocker = Thread(target=wait_and_unlock)
212
 
        unlocker.start()
213
 
        try:
214
 
            lf2 = LockDir(self.get_readonly_transport(), 'test_lock')
215
 
            before = time.time()
216
 
            # wait but don't lock
217
 
            lf2.wait(timeout=0.4, poll=0.1)
218
 
            after = time.time()
219
 
            self.assertTrue(after - before <= 1.0)
220
 
        finally:
221
 
            unlocker.join()
 
219
        self.assertEqual([], self._logged_reports)
222
220
 
223
221
    def test_40_confirm_easy(self):
224
222
        """Confirm a lock that's already held"""
226
224
        lf1 = LockDir(t, 'test_lock')
227
225
        lf1.create()
228
226
        lf1.attempt_lock()
 
227
        self.addCleanup(lf1.unlock)
229
228
        lf1.confirm()
230
229
 
231
230
    def test_41_confirm_not_held(self):
243
242
        lf1.attempt_lock()
244
243
        t.move('test_lock', 'lock_gone_now')
245
244
        self.assertRaises(LockBroken, lf1.confirm)
 
245
        # Clean up
 
246
        t.move('lock_gone_now', 'test_lock')
 
247
        lf1.unlock()
246
248
 
247
249
    def test_43_break(self):
248
250
        """Break a lock whose caller has forgotten it"""
259
261
        lf2.force_break(holder_info)
260
262
        # now we should be able to take it
261
263
        lf2.attempt_lock()
 
264
        self.addCleanup(lf2.unlock)
262
265
        lf2.confirm()
263
266
 
264
267
    def test_44_break_already_released(self):
276
279
        lf2.force_break(holder_info)
277
280
        # now we should be able to take it
278
281
        lf2.attempt_lock()
 
282
        self.addCleanup(lf2.unlock)
279
283
        lf2.confirm()
280
284
 
281
285
    def test_45_break_mismatch(self):
307
311
        """Check the on-disk representation of LockDirs is as expected.
308
312
 
309
313
        There should always be a top-level directory named by the lock.
310
 
        When the lock is held, there should be a lockname/held directory 
 
314
        When the lock is held, there should be a lockname/held directory
311
315
        containing an info file.
312
316
        """
313
317
        t = self.get_transport()
318
322
        self.assertTrue(t.has('test_lock/held/info'))
319
323
        lf1.unlock()
320
324
        self.assertFalse(t.has('test_lock/held/info'))
 
325
 
 
326
    def test_break_lock(self):
 
327
        # the ui based break_lock routine should Just Work (tm)
 
328
        ld1 = self.get_lock()
 
329
        ld2 = self.get_lock()
 
330
        ld1.create()
 
331
        ld1.lock_write()
 
332
        # do this without IO redirection to ensure it doesn't prompt.
 
333
        self.assertRaises(AssertionError, ld1.break_lock)
 
334
        orig_factory = bzrlib.ui.ui_factory
 
335
        bzrlib.ui.ui_factory = bzrlib.ui.CannedInputUIFactory([True])
 
336
        try:
 
337
            ld2.break_lock()
 
338
            self.assertRaises(LockBroken, ld1.unlock)
 
339
        finally:
 
340
            bzrlib.ui.ui_factory = orig_factory
 
341
 
 
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
    def test_create_missing_base_directory(self):
 
401
        """If LockDir.path doesn't exist, it can be created
 
402
 
 
403
        Some people manually remove the entire lock/ directory trying
 
404
        to unlock a stuck repository/branch/etc. Rather than failing
 
405
        after that, just create the lock directory when needed.
 
406
        """
 
407
        t = self.get_transport()
 
408
        lf1 = LockDir(t, 'test_lock')
 
409
 
 
410
        lf1.create()
 
411
        self.assertTrue(t.has('test_lock'))
 
412
 
 
413
        t.rmdir('test_lock')
 
414
        self.assertFalse(t.has('test_lock'))
 
415
 
 
416
        # This will create 'test_lock' if it needs to
 
417
        lf1.lock_write()
 
418
        self.assertTrue(t.has('test_lock'))
 
419
        self.assertTrue(t.has('test_lock/held/info'))
 
420
 
 
421
        lf1.unlock()
 
422
        self.assertFalse(t.has('test_lock/held/info'))
 
423
 
 
424
    def test_display_form(self):
 
425
        ld1 = self.get_lock()
 
426
        ld1.create()
 
427
        ld1.lock_write()
 
428
        try:
 
429
            info_list = ld1.peek().to_readable_dict()
 
430
        finally:
 
431
            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$')
 
435
 
 
436
    def test_lock_without_email(self):
 
437
        global_config = config.GlobalConfig()
 
438
        # Intentionally has no email address
 
439
        global_config.set_user_option('email', 'User Identity')
 
440
        ld1 = self.get_lock()
 
441
        ld1.create()
 
442
        ld1.lock_write()
 
443
        ld1.unlock()
 
444
 
 
445
    def test_lock_permission(self):
 
446
        self.requireFeature(features.not_running_as_root)
 
447
        if not osutils.supports_posix_readonly():
 
448
            raise tests.TestSkipped('Cannot induce a permission failure')
 
449
        ld1 = self.get_lock()
 
450
        lock_path = ld1.transport.local_abspath('test_lock')
 
451
        os.mkdir(lock_path)
 
452
        osutils.make_readonly(lock_path)
 
453
        self.assertRaises(errors.LockFailed, ld1.attempt_lock)
 
454
 
 
455
    def test_lock_by_token(self):
 
456
        ld1 = self.get_lock()
 
457
        token = ld1.lock_write()
 
458
        self.addCleanup(ld1.unlock)
 
459
        self.assertNotEqual(None, token)
 
460
        ld2 = self.get_lock()
 
461
        t2 = ld2.lock_write(token)
 
462
        self.addCleanup(ld2.unlock)
 
463
        self.assertEqual(token, t2)
 
464
 
 
465
    def test_lock_with_buggy_rename(self):
 
466
        # test that lock acquisition handles servers which pretend they
 
467
        # renamed correctly but that actually fail
 
468
        t = transport.get_transport('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.assertEquals([], 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.assertEquals(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.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()