← 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: 2009-05-12 09:05:30 UTC
  • mfrom: (4350.1.1 integration)
  • Revision ID: pqm@pqm.ubuntu.com-20090512090530-v9355ohetp61ltc1
(vila) Fix unbalanced locks in tests,
        the check is now fatal (use -Dlock to turn it into a warning).

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_lockable_files.py
56
56
            deprecated_in((1, 5, 0)),
57
57
            self.lockable.get_utf8, 'foo')
58
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()
 
59
        self.addCleanup(self.lockable.unlock)
 
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())
117
115
 
118
116
    def test_locks(self):
119
117
        self.lockable.lock_read()
120
 
        try:
121
 
            self.assertRaises(ReadOnlyError, self.lockable.put, 'foo',
122
 
                              StringIO('bar\u1234'))
123
 
        finally:
124
 
            self.lockable.unlock()
 
118
        self.addCleanup(self.lockable.unlock)
 
119
        self.assertRaises(ReadOnlyError, self.lockable.put, 'foo',
 
120
                          StringIO('bar\u1234'))
125
121
 
126
122
    def test_transactions(self):
127
123
        self.assertIs(self.lockable.get_transaction().__class__,
176
172
 
177
173
    def test_lock_write_returns_None_refuses_token(self):
178
174
        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()
 
175
        self.addCleanup(self.lockable.unlock)
 
176
        if token is not None:
 
177
            # This test does not apply, because this lockable supports
 
178
            # tokens.
 
179
            raise TestNotApplicable("%r uses tokens" % (self.lockable,))
 
180
        self.assertRaises(errors.TokenLockingNotSupported,
 
181
                          self.lockable.lock_write, token='token')
188
182
 
189
183
    def test_lock_write_returns_token_when_given_token(self):
190
184
        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()
 
185
        self.addCleanup(self.lockable.unlock)
 
186
        if token is None:
 
187
            # This test does not apply, because this lockable refuses
 
188
            # tokens.
 
189
            return
 
190
        new_lockable = self.get_lockable()
 
191
        token_from_new_lockable = new_lockable.lock_write(token=token)
 
192
        self.addCleanup(new_lockable.unlock)
 
193
        self.assertEqual(token, token_from_new_lockable)
204
194
 
205
195
    def test_lock_write_raises_on_token_mismatch(self):
206
196
        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 separate 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 separate 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()
 
197
        self.addCleanup(self.lockable.unlock)
 
198
        if token is None:
 
199
            # This test does not apply, because this lockable refuses
 
200
            # tokens.
 
201
            return
 
202
        different_token = token + 'xxx'
 
203
        # Re-using the same lockable instance with a different token will
 
204
        # raise TokenMismatch.
 
205
        self.assertRaises(errors.TokenMismatch,
 
206
                          self.lockable.lock_write, token=different_token)
 
207
        # A separate instance for the same lockable will also raise
 
208
        # TokenMismatch.
 
209
        # This detects the case where a caller claims to have a lock (via
 
210
        # the token) for an external resource, but doesn't (the token is
 
211
        # different).  Clients need a separate lock object to make sure the
 
212
        # external resource is probed, whereas the existing lock object
 
213
        # might cache.
 
214
        new_lockable = self.get_lockable()
 
215
        self.assertRaises(errors.TokenMismatch,
 
216
                          new_lockable.lock_write, token=different_token)
229
217
 
230
218
    def test_lock_write_with_matching_token(self):
231
219
        # If the token matches, so no exception is raised by lock_write.
232
220
        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()
 
221
        self.addCleanup(self.lockable.unlock)
 
222
        if token is None:
 
223
            # This test does not apply, because this lockable refuses
 
224
            # tokens.
 
225
            return
 
226
        # The same instance will accept a second lock_write if the specified
 
227
        # token matches.
 
228
        self.lockable.lock_write(token=token)
 
229
        self.lockable.unlock()
 
230
        # Calling lock_write on a new instance for the same lockable will
 
231
        # also succeed.
 
232
        new_lockable = self.get_lockable()
 
233
        new_lockable.lock_write(token=token)
 
234
        new_lockable.unlock()
249
235
 
250
236
    def test_unlock_after_lock_write_with_token(self):
251
237
        # If lock_write did not physically acquire the lock (because it was
252
238
        # passed a token), then unlock should not physically release it.
253
239
        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()
 
240
        self.addCleanup(self.lockable.unlock)
 
241
        if token is None:
 
242
            # This test does not apply, because this lockable refuses
 
243
            # tokens.
 
244
            return
 
245
        new_lockable = self.get_lockable()
 
246
        new_lockable.lock_write(token=token)
 
247
        new_lockable.unlock()
 
248
        self.assertTrue(self.lockable.get_physical_lock_status())
265
249
 
266
250
    def test_lock_write_with_token_fails_when_unlocked(self):
267
251
        # Lock and unlock to get a superficially valid token.  This mimics a
332
316
        # But should be relockable with a token.
333
317
        self.lockable.lock_write(token=token)
334
318
        self.lockable.unlock()
 
319
        # Cleanup: we should still be able to get the lock, but we restore the
 
320
        # behavior to clearing the lock when unlocking.
 
321
        self.lockable.lock_write(token=token)
 
322
        self.lockable.dont_leave_in_place()
 
323
        self.lockable.unlock()
335
324
 
336
325
    def test_dont_leave_in_place(self):
337
326
        token = self.lockable.lock_write()