/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: Aaron Bentley
  • Date: 2007-01-17 15:39:21 UTC
  • mfrom: (1551.9.35 Aaron's mergeable stuff)
  • mto: This revision was merged to the branch mainline in revision 2239.
  • Revision ID: abentley@panoramicfeedback.com-20070117153921-6pp9ssa2r8n5izoo
Merge bzr.ab, to avoid conflicts submitting

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_lockdir.py
1
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
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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""Tests for LockDir"""
18
18
 
19
 
from threading import Thread
 
19
from cStringIO import StringIO
 
20
from threading import Thread, Lock
20
21
import time
21
22
 
 
23
import bzrlib
 
24
from bzrlib import (
 
25
    config,
 
26
    osutils,
 
27
    )
22
28
from bzrlib.errors import (
23
29
        LockBreakMismatch,
24
30
        LockContention, LockError, UnlockableTransport,
25
31
        LockNotHeld, LockBroken
26
32
        )
27
 
from bzrlib.lockdir import LockDir
 
33
from bzrlib.lockdir import LockDir, _DEFAULT_TIMEOUT_SECONDS
28
34
from bzrlib.tests import TestCaseWithTransport
 
35
from bzrlib.trace import note
29
36
 
30
37
# These tests sometimes use threads to test the behaviour of lock files with
31
38
# concurrent actors.  This is not a typical (or necessarily supported) use;
40
47
class TestLockDir(TestCaseWithTransport):
41
48
    """Test LockDir operations"""
42
49
 
 
50
    def logging_report_function(self, fmt, *args):
 
51
        self._logged_reports.append((fmt, args))
 
52
 
 
53
    def setup_log_reporter(self, lock_dir):
 
54
        self._logged_reports = []
 
55
        lock_dir._report_function = self.logging_report_function
 
56
 
43
57
    def test_00_lock_creation(self):
44
58
        """Creation of lock file on a transport"""
45
59
        t = self.get_transport()
56
70
        lf = LockDir(self.get_transport(), 'test_lock')
57
71
        self.assertEqual(lf.peek(), None)
58
72
 
 
73
    def get_lock(self):
 
74
        return LockDir(self.get_transport(), 'test_lock')
 
75
 
 
76
    def test_unlock_after_break_raises(self):
 
77
        ld = self.get_lock()
 
78
        ld2 = self.get_lock()
 
79
        ld.create()
 
80
        ld.attempt_lock()
 
81
        ld2.force_break(ld2.peek())
 
82
        self.assertRaises(LockBroken, ld.unlock)
 
83
 
59
84
    def test_03_readonly_peek(self):
60
85
        lf = LockDir(self.get_readonly_transport(), 'test_lock')
61
86
        self.assertEqual(lf.peek(), None)
143
168
        lf1 = LockDir(t, 'test_lock')
144
169
        lf1.create()
145
170
        lf2 = LockDir(t, 'test_lock')
 
171
        self.setup_log_reporter(lf2)
146
172
        lf1.attempt_lock()
147
173
        try:
148
174
            before = time.time()
149
175
            self.assertRaises(LockContention, lf2.wait_lock,
150
176
                              timeout=0.4, poll=0.1)
151
177
            after = time.time()
152
 
            self.assertTrue(after - before <= 1.0)
 
178
            # it should only take about 0.4 seconds, but we allow more time in
 
179
            # case the machine is heavily loaded
 
180
            self.assertTrue(after - before <= 8.0, 
 
181
                    "took %f seconds to detect lock contention" % (after - before))
153
182
        finally:
154
183
            lf1.unlock()
 
184
        lock_base = lf2.transport.abspath(lf2.path)
 
185
        self.assertEqual(1, len(self._logged_reports))
 
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')
155
197
 
156
198
    def test_31_lock_wait_easy(self):
157
199
        """Succeed when waiting on a lock with no contention.
159
201
        t = self.get_transport()
160
202
        lf1 = LockDir(t, 'test_lock')
161
203
        lf1.create()
 
204
        self.setup_log_reporter(lf1)
162
205
        try:
163
206
            before = time.time()
164
207
            lf1.wait_lock(timeout=0.4, poll=0.1)
166
209
            self.assertTrue(after - before <= 1.0)
167
210
        finally:
168
211
            lf1.unlock()
 
212
        self.assertEqual([], self._logged_reports)
169
213
 
170
214
    def test_32_lock_wait_succeed(self):
171
215
        """Succeed when trying to acquire a lock that gets released
185
229
        unlocker.start()
186
230
        try:
187
231
            lf2 = LockDir(t, 'test_lock')
 
232
            self.setup_log_reporter(lf2)
188
233
            before = time.time()
189
234
            # wait and then lock
190
235
            lf2.wait_lock(timeout=0.4, poll=0.1)
193
238
        finally:
194
239
            unlocker.join()
195
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
 
196
257
    def test_33_wait(self):
197
258
        """Succeed when waiting on a lock that gets released
198
259
 
220
281
        finally:
221
282
            unlocker.join()
222
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
 
223
440
    def test_40_confirm_easy(self):
224
441
        """Confirm a lock that's already held"""
225
442
        t = self.get_transport()
318
535
        self.assertTrue(t.has('test_lock/held/info'))
319
536
        lf1.unlock()
320
537
        self.assertFalse(t.has('test_lock/held/info'))
 
538
 
 
539
    def test_break_lock(self):
 
540
        # the ui based break_lock routine should Just Work (tm)
 
541
        ld1 = self.get_lock()
 
542
        ld2 = self.get_lock()
 
543
        ld1.create()
 
544
        ld1.lock_write()
 
545
        # do this without IO redirection to ensure it doesn't prompt.
 
546
        self.assertRaises(AssertionError, ld1.break_lock)
 
547
        orig_factory = bzrlib.ui.ui_factory
 
548
        # silent ui - no need for stdout
 
549
        bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
 
550
        bzrlib.ui.ui_factory.stdin = StringIO("y\n")
 
551
        try:
 
552
            ld2.break_lock()
 
553
            self.assertRaises(LockBroken, ld1.unlock)
 
554
        finally:
 
555
            bzrlib.ui.ui_factory = orig_factory
 
556
 
 
557
    def test_create_missing_base_directory(self):
 
558
        """If LockDir.path doesn't exist, it can be created
 
559
 
 
560
        Some people manually remove the entire lock/ directory trying
 
561
        to unlock a stuck repository/branch/etc. Rather than failing
 
562
        after that, just create the lock directory when needed.
 
563
        """
 
564
        t = self.get_transport()
 
565
        lf1 = LockDir(t, 'test_lock')
 
566
 
 
567
        lf1.create()
 
568
        self.failUnless(t.has('test_lock'))
 
569
 
 
570
        t.rmdir('test_lock')
 
571
        self.failIf(t.has('test_lock'))
 
572
 
 
573
        # This will create 'test_lock' if it needs to
 
574
        lf1.lock_write()
 
575
        self.failUnless(t.has('test_lock'))
 
576
        self.failUnless(t.has('test_lock/held/info'))
 
577
 
 
578
        lf1.unlock()
 
579
        self.failIf(t.has('test_lock/held/info'))
 
580
 
 
581
    def test__format_lock_info(self):
 
582
        ld1 = self.get_lock()
 
583
        ld1.create()
 
584
        ld1.lock_write()
 
585
        try:
 
586
            info_list = ld1._format_lock_info(ld1.peek())
 
587
        finally:
 
588
            ld1.unlock()
 
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$')
 
594
 
 
595
    def test_lock_without_email(self):
 
596
        global_config = config.GlobalConfig()
 
597
        # Intentionally has no email address
 
598
        global_config.set_user_option('email', 'User Identity')
 
599
        ld1 = self.get_lock()
 
600
        ld1.create()
 
601
        ld1.lock_write()
 
602
        ld1.unlock()