/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_lockable_files.py

  • Committer: Robert Collins
  • Date: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_lockable_files.py
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
 
1
# Copyright (C) 2005-2010 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
from StringIO import StringIO
18
18
 
19
19
import bzrlib
20
 
from bzrlib.branch import Branch
21
 
import bzrlib.errors as errors
 
20
from bzrlib import (
 
21
    errors,
 
22
    lockdir,
 
23
    osutils,
 
24
    )
22
25
from bzrlib.errors import BzrBadParameterNotString, NoSuchFile, ReadOnlyError
23
26
from bzrlib.lockable_files import LockableFiles, TransportLock
24
 
from bzrlib import lockdir
25
 
from bzrlib.lockdir import LockDir
26
 
from bzrlib.tests import TestCaseInTempDir
 
27
from bzrlib.symbol_versioning import (
 
28
    deprecated_in,
 
29
    )
 
30
from bzrlib.tests import (
 
31
    TestCaseInTempDir,
 
32
    TestNotApplicable,
 
33
    )
27
34
from bzrlib.tests.test_smart import TestCaseWithSmartMedium
28
35
from bzrlib.tests.test_transactions import DummyWeave
29
36
from bzrlib.transactions import (PassThroughTransaction,
34
41
 
35
42
 
36
43
# these tests are applied in each parameterized suite for LockableFiles
 
44
#
 
45
# they use an old style of parameterization, but we want to remove this class
 
46
# so won't modernize them now. - mbp 20080430
37
47
class _TestLockableFiles_mixin(object):
38
48
 
39
 
    def setUp(self):
40
 
        self.reduceLockdirTimeout()
41
 
 
42
 
    def test_read_write(self):
43
 
        self.assertRaises(NoSuchFile, self.lockable.get, 'foo')
44
 
        self.assertRaises(NoSuchFile, self.lockable.get_utf8, 'foo')
45
 
        self.lockable.lock_write()
46
 
        try:
47
 
            unicode_string = u'bar\u1234'
48
 
            self.assertEqual(4, len(unicode_string))
49
 
            byte_string = unicode_string.encode('utf-8')
50
 
            self.assertEqual(6, len(byte_string))
51
 
            self.assertRaises(UnicodeEncodeError, self.lockable.put, 'foo',
52
 
                              StringIO(unicode_string))
53
 
            self.lockable.put('foo', StringIO(byte_string))
54
 
            self.assertEqual(byte_string,
55
 
                             self.lockable.get('foo').read())
56
 
            self.assertEqual(unicode_string,
57
 
                             self.lockable.get_utf8('foo').read())
58
 
            self.assertRaises(BzrBadParameterNotString,
59
 
                              self.lockable.put_utf8,
60
 
                              'bar',
61
 
                              StringIO(unicode_string)
62
 
                              )
63
 
            self.lockable.put_utf8('bar', unicode_string)
64
 
            self.assertEqual(unicode_string,
65
 
                             self.lockable.get_utf8('bar').read())
66
 
            self.assertEqual(byte_string,
67
 
                             self.lockable.get('bar').read())
68
 
            self.lockable.put_bytes('raw', 'raw\xffbytes')
69
 
            self.assertEqual('raw\xffbytes',
70
 
                             self.lockable.get('raw').read())
71
 
        finally:
72
 
            self.lockable.unlock()
73
 
 
74
 
    def test_locks(self):
75
 
        self.lockable.lock_read()
76
 
        try:
77
 
            self.assertRaises(ReadOnlyError, self.lockable.put, 'foo', 
78
 
                              StringIO('bar\u1234'))
79
 
        finally:
80
 
            self.lockable.unlock()
81
 
 
82
49
    def test_transactions(self):
83
50
        self.assertIs(self.lockable.get_transaction().__class__,
84
51
                      PassThroughTransaction)
101
68
 
102
69
    def test__escape(self):
103
70
        self.assertEqual('%25', self.lockable._escape('%'))
104
 
        
 
71
 
105
72
    def test__escape_empty(self):
106
73
        self.assertEqual('', self.lockable._escape(''))
107
74
 
113
80
        except NotImplementedError:
114
81
            # this lock cannot be broken
115
82
            self.lockable.unlock()
116
 
            return
 
83
            raise TestNotApplicable("%r is not breakable" % (self.lockable,))
117
84
        l2 = self.get_lockable()
118
85
        orig_factory = bzrlib.ui.ui_factory
119
86
        # silent ui - no need for stdout
120
 
        bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
121
 
        bzrlib.ui.ui_factory.stdin = StringIO("y\n")
 
87
        bzrlib.ui.ui_factory = bzrlib.ui.CannedInputUIFactory([True])
122
88
        try:
123
89
            l2.break_lock()
124
90
        finally:
132
98
 
133
99
    def test_lock_write_returns_None_refuses_token(self):
134
100
        token = self.lockable.lock_write()
135
 
        try:
136
 
            if token is not None:
137
 
                # This test does not apply, because this lockable supports
138
 
                # tokens.
139
 
                return
140
 
            self.assertRaises(errors.TokenLockingNotSupported,
141
 
                              self.lockable.lock_write, token='token')
142
 
        finally:
143
 
            self.lockable.unlock()
 
101
        self.addCleanup(self.lockable.unlock)
 
102
        if token is not None:
 
103
            # This test does not apply, because this lockable supports
 
104
            # tokens.
 
105
            raise TestNotApplicable("%r uses tokens" % (self.lockable,))
 
106
        self.assertRaises(errors.TokenLockingNotSupported,
 
107
                          self.lockable.lock_write, token='token')
144
108
 
145
109
    def test_lock_write_returns_token_when_given_token(self):
146
110
        token = self.lockable.lock_write()
147
 
        try:
148
 
            if token is None:
149
 
                # This test does not apply, because this lockable refuses
150
 
                # tokens.
151
 
                return
152
 
            new_lockable = self.get_lockable()
153
 
            token_from_new_lockable = new_lockable.lock_write(token=token)
154
 
            try:
155
 
                self.assertEqual(token, token_from_new_lockable)
156
 
            finally:
157
 
                new_lockable.unlock()
158
 
        finally:
159
 
            self.lockable.unlock()
 
111
        self.addCleanup(self.lockable.unlock)
 
112
        if token is None:
 
113
            # This test does not apply, because this lockable refuses
 
114
            # tokens.
 
115
            return
 
116
        new_lockable = self.get_lockable()
 
117
        token_from_new_lockable = new_lockable.lock_write(token=token)
 
118
        self.addCleanup(new_lockable.unlock)
 
119
        self.assertEqual(token, token_from_new_lockable)
160
120
 
161
121
    def test_lock_write_raises_on_token_mismatch(self):
162
122
        token = self.lockable.lock_write()
163
 
        try:
164
 
            if token is None:
165
 
                # This test does not apply, because this lockable refuses
166
 
                # tokens.
167
 
                return
168
 
            different_token = token + 'xxx'
169
 
            # Re-using the same lockable instance with a different token will
170
 
            # raise TokenMismatch.
171
 
            self.assertRaises(errors.TokenMismatch,
172
 
                              self.lockable.lock_write, token=different_token)
173
 
            # A seperate instance for the same lockable will also raise
174
 
            # TokenMismatch.
175
 
            # This detects the case where a caller claims to have a lock (via
176
 
            # the token) for an external resource, but doesn't (the token is
177
 
            # different).  Clients need a seperate lock object to make sure the
178
 
            # external resource is probed, whereas the existing lock object
179
 
            # might cache.
180
 
            new_lockable = self.get_lockable()
181
 
            self.assertRaises(errors.TokenMismatch,
182
 
                              new_lockable.lock_write, token=different_token)
183
 
        finally:
184
 
            self.lockable.unlock()
 
123
        self.addCleanup(self.lockable.unlock)
 
124
        if token is None:
 
125
            # This test does not apply, because this lockable refuses
 
126
            # tokens.
 
127
            return
 
128
        different_token = token + 'xxx'
 
129
        # Re-using the same lockable instance with a different token will
 
130
        # raise TokenMismatch.
 
131
        self.assertRaises(errors.TokenMismatch,
 
132
                          self.lockable.lock_write, token=different_token)
 
133
        # A separate instance for the same lockable will also raise
 
134
        # TokenMismatch.
 
135
        # This detects the case where a caller claims to have a lock (via
 
136
        # the token) for an external resource, but doesn't (the token is
 
137
        # different).  Clients need a separate lock object to make sure the
 
138
        # external resource is probed, whereas the existing lock object
 
139
        # might cache.
 
140
        new_lockable = self.get_lockable()
 
141
        self.assertRaises(errors.TokenMismatch,
 
142
                          new_lockable.lock_write, token=different_token)
185
143
 
186
144
    def test_lock_write_with_matching_token(self):
187
145
        # If the token matches, so no exception is raised by lock_write.
188
146
        token = self.lockable.lock_write()
189
 
        try:
190
 
            if token is None:
191
 
                # This test does not apply, because this lockable refuses
192
 
                # tokens.
193
 
                return
194
 
            # The same instance will accept a second lock_write if the specified
195
 
            # token matches.
196
 
            self.lockable.lock_write(token=token)
197
 
            self.lockable.unlock()
198
 
            # Calling lock_write on a new instance for the same lockable will
199
 
            # also succeed.
200
 
            new_lockable = self.get_lockable()
201
 
            new_lockable.lock_write(token=token)
202
 
            new_lockable.unlock()
203
 
        finally:
204
 
            self.lockable.unlock()
 
147
        self.addCleanup(self.lockable.unlock)
 
148
        if token is None:
 
149
            # This test does not apply, because this lockable refuses
 
150
            # tokens.
 
151
            return
 
152
        # The same instance will accept a second lock_write if the specified
 
153
        # token matches.
 
154
        self.lockable.lock_write(token=token)
 
155
        self.lockable.unlock()
 
156
        # Calling lock_write on a new instance for the same lockable will
 
157
        # also succeed.
 
158
        new_lockable = self.get_lockable()
 
159
        new_lockable.lock_write(token=token)
 
160
        new_lockable.unlock()
205
161
 
206
162
    def test_unlock_after_lock_write_with_token(self):
207
163
        # If lock_write did not physically acquire the lock (because it was
208
164
        # passed a token), then unlock should not physically release it.
209
165
        token = self.lockable.lock_write()
210
 
        try:
211
 
            if token is None:
212
 
                # This test does not apply, because this lockable refuses
213
 
                # tokens.
214
 
                return
215
 
            new_lockable = self.get_lockable()
216
 
            new_lockable.lock_write(token=token)
217
 
            new_lockable.unlock()
218
 
            self.assertTrue(self.lockable.get_physical_lock_status())
219
 
        finally:
220
 
            self.lockable.unlock()
 
166
        self.addCleanup(self.lockable.unlock)
 
167
        if token is None:
 
168
            # This test does not apply, because this lockable refuses
 
169
            # tokens.
 
170
            return
 
171
        new_lockable = self.get_lockable()
 
172
        new_lockable.lock_write(token=token)
 
173
        new_lockable.unlock()
 
174
        self.assertTrue(self.lockable.get_physical_lock_status())
221
175
 
222
176
    def test_lock_write_with_token_fails_when_unlocked(self):
223
177
        # Lock and unlock to get a superficially valid token.  This mimics a
256
210
        new_lockable.lock_write()
257
211
        new_lockable.unlock()
258
212
 
 
213
    def test_second_lock_write_returns_same_token(self):
 
214
        first_token = self.lockable.lock_write()
 
215
        try:
 
216
            if first_token is None:
 
217
                # This test does not apply, because this lockable refuses
 
218
                # tokens.
 
219
                return
 
220
            # Relock the already locked lockable.  It should return the same
 
221
            # token.
 
222
            second_token = self.lockable.lock_write()
 
223
            try:
 
224
                self.assertEqual(first_token, second_token)
 
225
            finally:
 
226
                self.lockable.unlock()
 
227
        finally:
 
228
            self.lockable.unlock()
 
229
 
259
230
    def test_leave_in_place(self):
260
231
        token = self.lockable.lock_write()
261
232
        try:
271
242
        # But should be relockable with a token.
272
243
        self.lockable.lock_write(token=token)
273
244
        self.lockable.unlock()
 
245
        # Cleanup: we should still be able to get the lock, but we restore the
 
246
        # behavior to clearing the lock when unlocking.
 
247
        self.lockable.lock_write(token=token)
 
248
        self.lockable.dont_leave_in_place()
 
249
        self.lockable.unlock()
274
250
 
275
251
    def test_dont_leave_in_place(self):
276
252
        token = self.lockable.lock_write()
295
271
        third_lockable.unlock()
296
272
 
297
273
 
298
 
# This method of adapting tests to parameters is different to 
299
 
# the TestProviderAdapters used elsewhere, but seems simpler for this 
300
 
# case.  
 
274
# This method of adapting tests to parameters is different to
 
275
# the TestProviderAdapters used elsewhere, but seems simpler for this
 
276
# case.
301
277
class TestLockableFiles_TransportLock(TestCaseInTempDir,
302
278
                                      _TestLockableFiles_mixin):
303
279
 
304
280
    def setUp(self):
305
281
        TestCaseInTempDir.setUp(self)
306
 
        _TestLockableFiles_mixin.setUp(self)
307
282
        transport = get_transport('.')
308
283
        transport.mkdir('.bzr')
309
284
        self.sub_transport = transport.clone('.bzr')
310
285
        self.lockable = self.get_lockable()
311
286
        self.lockable.create_lock()
312
287
 
313
 
    def tearDown(self):
314
 
        super(TestLockableFiles_TransportLock, self).tearDown()
 
288
    def stop_server(self):
 
289
        super(TestLockableFiles_TransportLock, self).stop_server()
315
290
        # free the subtransport so that we do not get a 5 second
316
291
        # timeout due to the SFTP connection cache.
317
 
        del self.sub_transport
 
292
        try:
 
293
            del self.sub_transport
 
294
        except AttributeError:
 
295
            pass
318
296
 
319
297
    def get_lockable(self):
320
298
        return LockableFiles(self.sub_transport, 'my-lock', TransportLock)
321
 
        
 
299
 
322
300
 
323
301
class TestLockableFiles_LockDir(TestCaseInTempDir,
324
302
                              _TestLockableFiles_mixin):
326
304
 
327
305
    def setUp(self):
328
306
        TestCaseInTempDir.setUp(self)
329
 
        _TestLockableFiles_mixin.setUp(self)
330
307
        self.transport = get_transport('.')
331
308
        self.lockable = self.get_lockable()
332
 
        # the lock creation here sets mode - test_permissions on branch 
333
 
        # tests that implicitly, but it might be a good idea to factor 
 
309
        # the lock creation here sets mode - test_permissions on branch
 
310
        # tests that implicitly, but it might be a good idea to factor
334
311
        # out the mode checking logic and have it applied to loackable files
335
312
        # directly. RBC 20060418
336
313
        self.lockable.create_lock()
337
314
 
338
315
    def get_lockable(self):
339
 
        return LockableFiles(self.transport, 'my-lock', LockDir)
 
316
        return LockableFiles(self.transport, 'my-lock', lockdir.LockDir)
340
317
 
341
318
    def test_lock_created(self):
342
319
        self.assertTrue(self.transport.has('my-lock'))
346
323
        self.assertFalse(self.transport.has('my-lock/held/info'))
347
324
        self.assertTrue(self.transport.has('my-lock'))
348
325
 
 
326
    def test__file_modes(self):
 
327
        self.transport.mkdir('readonly')
 
328
        osutils.make_readonly('readonly')
 
329
        lockable = LockableFiles(self.transport.clone('readonly'), 'test-lock',
 
330
                                 lockdir.LockDir)
 
331
        # The directory mode should be read-write-execute for the current user
 
332
        self.assertEqual(00700, lockable._dir_mode & 00700)
 
333
        # Files should be read-write for the current user
 
334
        self.assertEqual(00600, lockable._file_mode & 00700)
349
335
 
350
 
    # TODO: Test the lockdir inherits the right file and directory permissions
351
 
    # from the LockableFiles.
352
 
        
353
336
 
354
337
class TestLockableFiles_RemoteLockDir(TestCaseWithSmartMedium,
355
338
                              _TestLockableFiles_mixin):
357
340
 
358
341
    def setUp(self):
359
342
        TestCaseWithSmartMedium.setUp(self)
360
 
        _TestLockableFiles_mixin.setUp(self)
361
343
        # can only get a RemoteLockDir with some RemoteObject...
362
344
        # use a branch as thats what we want. These mixin tests test the end
363
345
        # to end behaviour, so stubbing out the backend and simulating would
364
346
        # defeat the purpose. We test the protocol implementation separately
365
347
        # in test_remote and test_smart as usual.
366
 
        self.make_branch('foo')
 
348
        b = self.make_branch('foo')
 
349
        self.addCleanup(b.bzrdir.transport.disconnect)
367
350
        self.transport = get_transport('.')
368
351
        self.lockable = self.get_lockable()
369
352
 
370
353
    def get_lockable(self):
371
354
        # getting a new lockable involves opening a new instance of the branch
372
355
        branch = bzrlib.branch.Branch.open(self.get_url('foo'))
 
356
        self.addCleanup(branch.bzrdir.transport.disconnect)
373
357
        return branch.control_files