← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_lockable_files.py

Implement version 3 of the network protocol. (Andrew Bennetts)

Show diffs side-by-side

added added

removed removed

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