← 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: Robert Collins
  • Date: 2010-04-08 04:34:03 UTC
  • mfrom: (5138 +trunk)
  • mto: This revision was merged to the branch mainline in revision 5139.
  • Revision ID: robertc@robertcollins.net-20100408043403-56z0d07vdqrx7f3t
Update bugfix for 528114 to trunk.

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-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
 
27
27
from bzrlib.symbol_versioning import (
28
28
    deprecated_in,
29
29
    )
30
 
from bzrlib.tests import TestCaseInTempDir
 
30
from bzrlib.tests import (
 
31
    TestCaseInTempDir,
 
32
    TestNotApplicable,
 
33
    )
31
34
from bzrlib.tests.test_smart import TestCaseWithSmartMedium
32
35
from bzrlib.tests.test_transactions import DummyWeave
33
36
from bzrlib.transactions import (PassThroughTransaction,
43
46
# so won't modernize them now. - mbp 20080430
44
47
class _TestLockableFiles_mixin(object):
45
48
 
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
 
 
97
49
    def test_transactions(self):
98
50
        self.assertIs(self.lockable.get_transaction().__class__,
99
51
                      PassThroughTransaction)
116
68
 
117
69
    def test__escape(self):
118
70
        self.assertEqual('%25', self.lockable._escape('%'))
119
 
        
 
71
 
120
72
    def test__escape_empty(self):
121
73
        self.assertEqual('', self.lockable._escape(''))
122
74
 
128
80
        except NotImplementedError:
129
81
            # this lock cannot be broken
130
82
            self.lockable.unlock()
131
 
            return
 
83
            raise TestNotApplicable("%r is not breakable" % (self.lockable,))
132
84
        l2 = self.get_lockable()
133
85
        orig_factory = bzrlib.ui.ui_factory
134
86
        # silent ui - no need for stdout
135
 
        bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
136
 
        bzrlib.ui.ui_factory.stdin = StringIO("y\n")
 
87
        bzrlib.ui.ui_factory = bzrlib.ui.CannedInputUIFactory([True])
137
88
        try:
138
89
            l2.break_lock()
139
90
        finally:
147
98
 
148
99
    def test_lock_write_returns_None_refuses_token(self):
149
100
        token = self.lockable.lock_write()
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()
 
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')
159
108
 
160
109
    def test_lock_write_returns_token_when_given_token(self):
161
110
        token = self.lockable.lock_write()
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()
 
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)
175
120
 
176
121
    def test_lock_write_raises_on_token_mismatch(self):
177
122
        token = self.lockable.lock_write()
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()
 
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)
200
143
 
201
144
    def test_lock_write_with_matching_token(self):
202
145
        # If the token matches, so no exception is raised by lock_write.
203
146
        token = self.lockable.lock_write()
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()
 
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()
220
161
 
221
162
    def test_unlock_after_lock_write_with_token(self):
222
163
        # If lock_write did not physically acquire the lock (because it was
223
164
        # passed a token), then unlock should not physically release it.
224
165
        token = self.lockable.lock_write()
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()
 
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())
236
175
 
237
176
    def test_lock_write_with_token_fails_when_unlocked(self):
238
177
        # Lock and unlock to get a superficially valid token.  This mimics a
303
242
        # But should be relockable with a token.
304
243
        self.lockable.lock_write(token=token)
305
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()
306
250
 
307
251
    def test_dont_leave_in_place(self):
308
252
        token = self.lockable.lock_write()
327
271
        third_lockable.unlock()
328
272
 
329
273
 
330
 
# This method of adapting tests to parameters is different to 
331
 
# the TestProviderAdapters used elsewhere, but seems simpler for this 
332
 
# case.  
 
274
# This method of adapting tests to parameters is different to
 
275
# the TestProviderAdapters used elsewhere, but seems simpler for this
 
276
# case.
333
277
class TestLockableFiles_TransportLock(TestCaseInTempDir,
334
278
                                      _TestLockableFiles_mixin):
335
279
 
341
285
        self.lockable = self.get_lockable()
342
286
        self.lockable.create_lock()
343
287
 
344
 
    def tearDown(self):
345
 
        super(TestLockableFiles_TransportLock, self).tearDown()
 
288
    def stop_server(self):
 
289
        super(TestLockableFiles_TransportLock, self).stop_server()
346
290
        # free the subtransport so that we do not get a 5 second
347
291
        # timeout due to the SFTP connection cache.
348
 
        del self.sub_transport
 
292
        try:
 
293
            del self.sub_transport
 
294
        except AttributeError:
 
295
            pass
349
296
 
350
297
    def get_lockable(self):
351
298
        return LockableFiles(self.sub_transport, 'my-lock', TransportLock)
352
 
        
 
299
 
353
300
 
354
301
class TestLockableFiles_LockDir(TestCaseInTempDir,
355
302
                              _TestLockableFiles_mixin):
359
306
        TestCaseInTempDir.setUp(self)
360
307
        self.transport = get_transport('.')
361
308
        self.lockable = self.get_lockable()
362
 
        # the lock creation here sets mode - test_permissions on branch 
363
 
        # 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
364
311
        # out the mode checking logic and have it applied to loackable files
365
312
        # directly. RBC 20060418
366
313
        self.lockable.create_lock()