← 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

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2011-08-17 18:13:57 UTC
  • mfrom: (5268.7.29 transport-segments)
  • Revision ID: pqm@pqm.ubuntu.com-20110817181357-y5q5eth1hk8bl3om
(jelmer) Allow specifying the colocated branch to use in the branch URL,
 and retrieving the branch name using ControlDir._get_selected_branch.
 (Jelmer Vernooij)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_lockable_files.py
1
 
# Copyright (C) 2005, 2006, 2008 Canonical Ltd
 
1
# Copyright (C) 2005-2011 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
16
 
 
17
 
from StringIO import StringIO
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
16
 
19
17
import bzrlib
20
18
from bzrlib import (
21
19
    errors,
22
20
    lockdir,
23
21
    osutils,
 
22
    transport,
24
23
    )
25
 
from bzrlib.errors import BzrBadParameterNotString, NoSuchFile, ReadOnlyError
26
24
from bzrlib.lockable_files import LockableFiles, TransportLock
27
 
from bzrlib.symbol_versioning import (
28
 
    deprecated_in,
29
 
    )
30
25
from bzrlib.tests import (
31
26
    TestCaseInTempDir,
32
27
    TestNotApplicable,
37
32
                                 ReadOnlyTransaction,
38
33
                                 WriteTransaction,
39
34
                                 )
40
 
from bzrlib.transport import get_transport
41
35
 
42
36
 
43
37
# these tests are applied in each parameterized suite for LockableFiles
46
40
# so won't modernize them now. - mbp 20080430
47
41
class _TestLockableFiles_mixin(object):
48
42
 
49
 
    def test_read_write(self):
50
 
        self.assertRaises(NoSuchFile,
51
 
            self.applyDeprecated,
52
 
            deprecated_in((1, 5, 0)),
53
 
            self.lockable.get, 'foo')
54
 
        self.assertRaises(NoSuchFile,
55
 
            self.applyDeprecated,
56
 
            deprecated_in((1, 5, 0)),
57
 
            self.lockable.get_utf8, 'foo')
58
 
        self.lockable.lock_write()
59
 
        try:
60
 
            unicode_string = u'bar\u1234'
61
 
            self.assertEqual(4, len(unicode_string))
62
 
            byte_string = unicode_string.encode('utf-8')
63
 
            self.assertEqual(6, len(byte_string))
64
 
            self.assertRaises(UnicodeEncodeError,
65
 
                self.applyDeprecated,
66
 
                deprecated_in((1, 6, 0)),
67
 
                self.lockable.put, 'foo',
68
 
                StringIO(unicode_string))
69
 
            self.applyDeprecated(
70
 
                deprecated_in((1, 6, 0)),
71
 
                self.lockable.put,
72
 
                'foo', StringIO(byte_string))
73
 
            byte_stream = self.applyDeprecated(
74
 
                deprecated_in((1, 5, 0)),
75
 
                self.lockable.get,
76
 
                'foo')
77
 
            self.assertEqual(byte_string, byte_stream.read())
78
 
            unicode_stream = self.applyDeprecated(
79
 
                deprecated_in((1, 5, 0)),
80
 
                self.lockable.get_utf8,
81
 
                'foo')
82
 
            self.assertEqual(unicode_string,
83
 
                unicode_stream.read())
84
 
            self.assertRaises(BzrBadParameterNotString,
85
 
                self.applyDeprecated,
86
 
                deprecated_in((1, 6, 0)),
87
 
                self.lockable.put_utf8,
88
 
                'bar',
89
 
                StringIO(unicode_string))
90
 
            self.applyDeprecated(
91
 
                deprecated_in((1, 6, 0)),
92
 
                self.lockable.put_utf8,
93
 
                'bar',
94
 
                unicode_string)
95
 
            unicode_stream = self.applyDeprecated(
96
 
                deprecated_in((1, 5, 0)),
97
 
                self.lockable.get_utf8,
98
 
                'bar')
99
 
            self.assertEqual(unicode_string,
100
 
                unicode_stream.read())
101
 
            byte_stream = self.applyDeprecated(
102
 
                deprecated_in((1, 5, 0)),
103
 
                self.lockable.get,
104
 
                'bar')
105
 
            self.assertEqual(byte_string, byte_stream.read())
106
 
            self.applyDeprecated(
107
 
                deprecated_in((1, 6, 0)),
108
 
                self.lockable.put_bytes,
109
 
                'raw', 'raw\xffbytes')
110
 
            byte_stream = self.applyDeprecated(
111
 
                deprecated_in((1, 5, 0)),
112
 
                self.lockable.get,
113
 
                'raw')
114
 
            self.assertEqual('raw\xffbytes', byte_stream.read())
115
 
        finally:
116
 
            self.lockable.unlock()
117
 
 
118
 
    def test_locks(self):
119
 
        self.lockable.lock_read()
120
 
        try:
121
 
            self.assertRaises(ReadOnlyError, self.lockable.put, 'foo',
122
 
                              StringIO('bar\u1234'))
123
 
        finally:
124
 
            self.lockable.unlock()
125
 
 
126
43
    def test_transactions(self):
127
44
        self.assertIs(self.lockable.get_transaction().__class__,
128
45
                      PassThroughTransaction)
145
62
 
146
63
    def test__escape(self):
147
64
        self.assertEqual('%25', self.lockable._escape('%'))
148
 
        
 
65
 
149
66
    def test__escape_empty(self):
150
67
        self.assertEqual('', self.lockable._escape(''))
151
68
 
161
78
        l2 = self.get_lockable()
162
79
        orig_factory = bzrlib.ui.ui_factory
163
80
        # silent ui - no need for stdout
164
 
        bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
165
 
        bzrlib.ui.ui_factory.stdin = StringIO("y\n")
 
81
        bzrlib.ui.ui_factory = bzrlib.ui.CannedInputUIFactory([True])
166
82
        try:
167
83
            l2.break_lock()
168
84
        finally:
176
92
 
177
93
    def test_lock_write_returns_None_refuses_token(self):
178
94
        token = self.lockable.lock_write()
179
 
        try:
180
 
            if token is not None:
181
 
                # This test does not apply, because this lockable supports
182
 
                # tokens.
183
 
                raise TestNotApplicable("%r uses tokens" % (self.lockable,))
184
 
            self.assertRaises(errors.TokenLockingNotSupported,
185
 
                              self.lockable.lock_write, token='token')
186
 
        finally:
187
 
            self.lockable.unlock()
 
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')
188
102
 
189
103
    def test_lock_write_returns_token_when_given_token(self):
190
104
        token = self.lockable.lock_write()
191
 
        try:
192
 
            if token is None:
193
 
                # This test does not apply, because this lockable refuses
194
 
                # tokens.
195
 
                return
196
 
            new_lockable = self.get_lockable()
197
 
            token_from_new_lockable = new_lockable.lock_write(token=token)
198
 
            try:
199
 
                self.assertEqual(token, token_from_new_lockable)
200
 
            finally:
201
 
                new_lockable.unlock()
202
 
        finally:
203
 
            self.lockable.unlock()
 
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)
204
114
 
205
115
    def test_lock_write_raises_on_token_mismatch(self):
206
116
        token = self.lockable.lock_write()
207
 
        try:
208
 
            if token is None:
209
 
                # This test does not apply, because this lockable refuses
210
 
                # tokens.
211
 
                return
212
 
            different_token = token + 'xxx'
213
 
            # Re-using the same lockable instance with a different token will
214
 
            # raise TokenMismatch.
215
 
            self.assertRaises(errors.TokenMismatch,
216
 
                              self.lockable.lock_write, token=different_token)
217
 
            # A seperate instance for the same lockable will also raise
218
 
            # TokenMismatch.
219
 
            # This detects the case where a caller claims to have a lock (via
220
 
            # the token) for an external resource, but doesn't (the token is
221
 
            # different).  Clients need a seperate lock object to make sure the
222
 
            # external resource is probed, whereas the existing lock object
223
 
            # might cache.
224
 
            new_lockable = self.get_lockable()
225
 
            self.assertRaises(errors.TokenMismatch,
226
 
                              new_lockable.lock_write, token=different_token)
227
 
        finally:
228
 
            self.lockable.unlock()
 
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)
229
137
 
230
138
    def test_lock_write_with_matching_token(self):
231
139
        # If the token matches, so no exception is raised by lock_write.
232
140
        token = self.lockable.lock_write()
233
 
        try:
234
 
            if token is None:
235
 
                # This test does not apply, because this lockable refuses
236
 
                # tokens.
237
 
                return
238
 
            # The same instance will accept a second lock_write if the specified
239
 
            # token matches.
240
 
            self.lockable.lock_write(token=token)
241
 
            self.lockable.unlock()
242
 
            # Calling lock_write on a new instance for the same lockable will
243
 
            # also succeed.
244
 
            new_lockable = self.get_lockable()
245
 
            new_lockable.lock_write(token=token)
246
 
            new_lockable.unlock()
247
 
        finally:
248
 
            self.lockable.unlock()
 
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()
249
155
 
250
156
    def test_unlock_after_lock_write_with_token(self):
251
157
        # If lock_write did not physically acquire the lock (because it was
252
158
        # passed a token), then unlock should not physically release it.
253
159
        token = self.lockable.lock_write()
254
 
        try:
255
 
            if token is None:
256
 
                # This test does not apply, because this lockable refuses
257
 
                # tokens.
258
 
                return
259
 
            new_lockable = self.get_lockable()
260
 
            new_lockable.lock_write(token=token)
261
 
            new_lockable.unlock()
262
 
            self.assertTrue(self.lockable.get_physical_lock_status())
263
 
        finally:
264
 
            self.lockable.unlock()
 
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())
265
169
 
266
170
    def test_lock_write_with_token_fails_when_unlocked(self):
267
171
        # Lock and unlock to get a superficially valid token.  This mimics a
332
236
        # But should be relockable with a token.
333
237
        self.lockable.lock_write(token=token)
334
238
        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()
335
244
 
336
245
    def test_dont_leave_in_place(self):
337
246
        token = self.lockable.lock_write()
356
265
        third_lockable.unlock()
357
266
 
358
267
 
359
 
# This method of adapting tests to parameters is different to 
360
 
# the TestProviderAdapters used elsewhere, but seems simpler for this 
361
 
# case.  
 
268
# This method of adapting tests to parameters is different to
 
269
# the TestProviderAdapters used elsewhere, but seems simpler for this
 
270
# case.
362
271
class TestLockableFiles_TransportLock(TestCaseInTempDir,
363
272
                                      _TestLockableFiles_mixin):
364
273
 
365
274
    def setUp(self):
366
275
        TestCaseInTempDir.setUp(self)
367
 
        transport = get_transport('.')
368
 
        transport.mkdir('.bzr')
369
 
        self.sub_transport = transport.clone('.bzr')
 
276
        t = transport.get_transport('.')
 
277
        t.mkdir('.bzr')
 
278
        self.sub_transport = t.clone('.bzr')
370
279
        self.lockable = self.get_lockable()
371
280
        self.lockable.create_lock()
372
281
 
373
 
    def tearDown(self):
374
 
        super(TestLockableFiles_TransportLock, self).tearDown()
 
282
    def stop_server(self):
 
283
        super(TestLockableFiles_TransportLock, self).stop_server()
375
284
        # free the subtransport so that we do not get a 5 second
376
285
        # timeout due to the SFTP connection cache.
377
286
        try:
381
290
 
382
291
    def get_lockable(self):
383
292
        return LockableFiles(self.sub_transport, 'my-lock', TransportLock)
384
 
        
 
293
 
385
294
 
386
295
class TestLockableFiles_LockDir(TestCaseInTempDir,
387
296
                              _TestLockableFiles_mixin):
389
298
 
390
299
    def setUp(self):
391
300
        TestCaseInTempDir.setUp(self)
392
 
        self.transport = get_transport('.')
 
301
        self.transport = transport.get_transport('.')
393
302
        self.lockable = self.get_lockable()
394
 
        # the lock creation here sets mode - test_permissions on branch 
395
 
        # tests that implicitly, but it might be a good idea to factor 
 
303
        # the lock creation here sets mode - test_permissions on branch
 
304
        # tests that implicitly, but it might be a good idea to factor
396
305
        # out the mode checking logic and have it applied to loackable files
397
306
        # directly. RBC 20060418
398
307
        self.lockable.create_lock()
432
341
        # in test_remote and test_smart as usual.
433
342
        b = self.make_branch('foo')
434
343
        self.addCleanup(b.bzrdir.transport.disconnect)
435
 
        self.transport = get_transport('.')
 
344
        self.transport = transport.get_transport('.')
436
345
        self.lockable = self.get_lockable()
437
346
 
438
347
    def get_lockable(self):