← 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: 2008-03-16 16:58:03 UTC
  • mfrom: (3224.3.1 news-typo)
  • Revision ID: pqm@pqm.ubuntu.com-20080316165803-tisoc9mpob9z544o
(Matt Nordhoff) Trivial NEWS typo fix

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 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,
28
 
    )
 
27
from bzrlib.tests import TestCaseInTempDir
29
28
from bzrlib.tests.test_smart import TestCaseWithSmartMedium
30
29
from bzrlib.tests.test_transactions import DummyWeave
31
30
from bzrlib.transactions import (PassThroughTransaction,
32
31
                                 ReadOnlyTransaction,
33
32
                                 WriteTransaction,
34
33
                                 )
 
34
from bzrlib.transport import get_transport
35
35
 
36
36
 
37
37
# these tests are applied in each parameterized suite for LockableFiles
38
 
#
39
 
# they use an old style of parameterization, but we want to remove this class
40
 
# so won't modernize them now. - mbp 20080430
41
38
class _TestLockableFiles_mixin(object):
42
39
 
 
40
    def test_read_write(self):
 
41
        self.assertRaises(NoSuchFile, self.lockable.get, 'foo')
 
42
        self.assertRaises(NoSuchFile, self.lockable.get_utf8, 'foo')
 
43
        self.lockable.lock_write()
 
44
        try:
 
45
            unicode_string = u'bar\u1234'
 
46
            self.assertEqual(4, len(unicode_string))
 
47
            byte_string = unicode_string.encode('utf-8')
 
48
            self.assertEqual(6, len(byte_string))
 
49
            self.assertRaises(UnicodeEncodeError, self.lockable.put, 'foo',
 
50
                              StringIO(unicode_string))
 
51
            self.lockable.put('foo', StringIO(byte_string))
 
52
            self.assertEqual(byte_string,
 
53
                             self.lockable.get('foo').read())
 
54
            self.assertEqual(unicode_string,
 
55
                             self.lockable.get_utf8('foo').read())
 
56
            self.assertRaises(BzrBadParameterNotString,
 
57
                              self.lockable.put_utf8,
 
58
                              'bar',
 
59
                              StringIO(unicode_string)
 
60
                              )
 
61
            self.lockable.put_utf8('bar', unicode_string)
 
62
            self.assertEqual(unicode_string,
 
63
                             self.lockable.get_utf8('bar').read())
 
64
            self.assertEqual(byte_string,
 
65
                             self.lockable.get('bar').read())
 
66
            self.lockable.put_bytes('raw', 'raw\xffbytes')
 
67
            self.assertEqual('raw\xffbytes',
 
68
                             self.lockable.get('raw').read())
 
69
        finally:
 
70
            self.lockable.unlock()
 
71
 
 
72
    def test_locks(self):
 
73
        self.lockable.lock_read()
 
74
        try:
 
75
            self.assertRaises(ReadOnlyError, self.lockable.put, 'foo', 
 
76
                              StringIO('bar\u1234'))
 
77
        finally:
 
78
            self.lockable.unlock()
 
79
 
43
80
    def test_transactions(self):
44
81
        self.assertIs(self.lockable.get_transaction().__class__,
45
82
                      PassThroughTransaction)
62
99
 
63
100
    def test__escape(self):
64
101
        self.assertEqual('%25', self.lockable._escape('%'))
65
 
 
 
102
        
66
103
    def test__escape_empty(self):
67
104
        self.assertEqual('', self.lockable._escape(''))
68
105
 
74
111
        except NotImplementedError:
75
112
            # this lock cannot be broken
76
113
            self.lockable.unlock()
77
 
            raise TestNotApplicable("%r is not breakable" % (self.lockable,))
 
114
            return
78
115
        l2 = self.get_lockable()
79
116
        orig_factory = bzrlib.ui.ui_factory
80
117
        # silent ui - no need for stdout
81
 
        bzrlib.ui.ui_factory = bzrlib.ui.CannedInputUIFactory([True])
 
118
        bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
 
119
        bzrlib.ui.ui_factory.stdin = StringIO("y\n")
82
120
        try:
83
121
            l2.break_lock()
84
122
        finally:
92
130
 
93
131
    def test_lock_write_returns_None_refuses_token(self):
94
132
        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')
 
133
        try:
 
134
            if token is not None:
 
135
                # This test does not apply, because this lockable supports
 
136
                # tokens.
 
137
                return
 
138
            self.assertRaises(errors.TokenLockingNotSupported,
 
139
                              self.lockable.lock_write, token='token')
 
140
        finally:
 
141
            self.lockable.unlock()
102
142
 
103
143
    def test_lock_write_returns_token_when_given_token(self):
104
144
        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)
 
145
        try:
 
146
            if token is None:
 
147
                # This test does not apply, because this lockable refuses
 
148
                # tokens.
 
149
                return
 
150
            new_lockable = self.get_lockable()
 
151
            token_from_new_lockable = new_lockable.lock_write(token=token)
 
152
            try:
 
153
                self.assertEqual(token, token_from_new_lockable)
 
154
            finally:
 
155
                new_lockable.unlock()
 
156
        finally:
 
157
            self.lockable.unlock()
114
158
 
115
159
    def test_lock_write_raises_on_token_mismatch(self):
116
160
        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)
 
161
        try:
 
162
            if token is None:
 
163
                # This test does not apply, because this lockable refuses
 
164
                # tokens.
 
165
                return
 
166
            different_token = token + 'xxx'
 
167
            # Re-using the same lockable instance with a different token will
 
168
            # raise TokenMismatch.
 
169
            self.assertRaises(errors.TokenMismatch,
 
170
                              self.lockable.lock_write, token=different_token)
 
171
            # A seperate instance for the same lockable will also raise
 
172
            # TokenMismatch.
 
173
            # This detects the case where a caller claims to have a lock (via
 
174
            # the token) for an external resource, but doesn't (the token is
 
175
            # different).  Clients need a seperate lock object to make sure the
 
176
            # external resource is probed, whereas the existing lock object
 
177
            # might cache.
 
178
            new_lockable = self.get_lockable()
 
179
            self.assertRaises(errors.TokenMismatch,
 
180
                              new_lockable.lock_write, token=different_token)
 
181
        finally:
 
182
            self.lockable.unlock()
137
183
 
138
184
    def test_lock_write_with_matching_token(self):
139
185
        # If the token matches, so no exception is raised by lock_write.
140
186
        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()
 
187
        try:
 
188
            if token is None:
 
189
                # This test does not apply, because this lockable refuses
 
190
                # tokens.
 
191
                return
 
192
            # The same instance will accept a second lock_write if the specified
 
193
            # token matches.
 
194
            self.lockable.lock_write(token=token)
 
195
            self.lockable.unlock()
 
196
            # Calling lock_write on a new instance for the same lockable will
 
197
            # also succeed.
 
198
            new_lockable = self.get_lockable()
 
199
            new_lockable.lock_write(token=token)
 
200
            new_lockable.unlock()
 
201
        finally:
 
202
            self.lockable.unlock()
155
203
 
156
204
    def test_unlock_after_lock_write_with_token(self):
157
205
        # If lock_write did not physically acquire the lock (because it was
158
206
        # passed a token), then unlock should not physically release it.
159
207
        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())
 
208
        try:
 
209
            if token is None:
 
210
                # This test does not apply, because this lockable refuses
 
211
                # tokens.
 
212
                return
 
213
            new_lockable = self.get_lockable()
 
214
            new_lockable.lock_write(token=token)
 
215
            new_lockable.unlock()
 
216
            self.assertTrue(self.lockable.get_physical_lock_status())
 
217
        finally:
 
218
            self.lockable.unlock()
169
219
 
170
220
    def test_lock_write_with_token_fails_when_unlocked(self):
171
221
        # Lock and unlock to get a superficially valid token.  This mimics a
236
286
        # But should be relockable with a token.
237
287
        self.lockable.lock_write(token=token)
238
288
        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
289
 
245
290
    def test_dont_leave_in_place(self):
246
291
        token = self.lockable.lock_write()
265
310
        third_lockable.unlock()
266
311
 
267
312
 
268
 
# This method of adapting tests to parameters is different to
269
 
# the TestProviderAdapters used elsewhere, but seems simpler for this
270
 
# case.
 
313
# This method of adapting tests to parameters is different to 
 
314
# the TestProviderAdapters used elsewhere, but seems simpler for this 
 
315
# case.  
271
316
class TestLockableFiles_TransportLock(TestCaseInTempDir,
272
317
                                      _TestLockableFiles_mixin):
273
318
 
274
319
    def setUp(self):
275
320
        TestCaseInTempDir.setUp(self)
276
 
        t = transport.get_transport_from_path('.')
277
 
        t.mkdir('.bzr')
278
 
        self.sub_transport = t.clone('.bzr')
 
321
        transport = get_transport('.')
 
322
        transport.mkdir('.bzr')
 
323
        self.sub_transport = transport.clone('.bzr')
279
324
        self.lockable = self.get_lockable()
280
325
        self.lockable.create_lock()
281
326
 
282
 
    def stop_server(self):
283
 
        super(TestLockableFiles_TransportLock, self).stop_server()
 
327
    def tearDown(self):
 
328
        super(TestLockableFiles_TransportLock, self).tearDown()
284
329
        # free the subtransport so that we do not get a 5 second
285
330
        # timeout due to the SFTP connection cache.
286
 
        try:
287
 
            del self.sub_transport
288
 
        except AttributeError:
289
 
            pass
 
331
        del self.sub_transport
290
332
 
291
333
    def get_lockable(self):
292
334
        return LockableFiles(self.sub_transport, 'my-lock', TransportLock)
293
 
 
 
335
        
294
336
 
295
337
class TestLockableFiles_LockDir(TestCaseInTempDir,
296
338
                              _TestLockableFiles_mixin):
298
340
 
299
341
    def setUp(self):
300
342
        TestCaseInTempDir.setUp(self)
301
 
        self.transport = transport.get_transport_from_path('.')
 
343
        self.transport = get_transport('.')
302
344
        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
 
345
        # the lock creation here sets mode - test_permissions on branch 
 
346
        # tests that implicitly, but it might be a good idea to factor 
305
347
        # out the mode checking logic and have it applied to loackable files
306
348
        # directly. RBC 20060418
307
349
        self.lockable.create_lock()
341
383
        # in test_remote and test_smart as usual.
342
384
        b = self.make_branch('foo')
343
385
        self.addCleanup(b.bzrdir.transport.disconnect)
344
 
        self.transport = transport.get_transport_from_path('.')
 
386
        self.transport = get_transport('.')
345
387
        self.lockable = self.get_lockable()
346
388
 
347
389
    def get_lockable(self):