1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
|
#!/usr/bin/env python
# This is free and unencumbered software released into the public domain.
#
# Anyone is free to copy, modify, publish, use, compile, sell, or
# distribute this software, either in source code form or as a compiled
# binary, for any purpose, commercial or non-commercial, and by any
# means.
#
# In jurisdictions that recognize copyright laws, the author or authors
# of this software dedicate any and all copyright interest in the
# software to the public domain. We make this dedication for the benefit
# of the public at large and to the detriment of our heirs and
# successors. We intend this dedication to be an overt act of
# relinquishment in perpetuity of all present and future rights to this
# software under copyright law.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
# IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
# OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
# ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
# OTHER DEALINGS IN THE SOFTWARE.
#
# For more information, please refer to <http://unlicense.org>
"""
Some tests for the file lock.
"""
import os
import sys
import unittest
import threading
import filelock
PY2 = sys.version_info[0] == 2
PY3 = sys.version_info[0] == 3
class ExThread(threading.Thread):
def __init__(self, *args, **kargs):
threading.Thread.__init__(self, *args, **kargs)
self.ex = None
return None
def run(self):
try:
threading.Thread.run(self)
except:
self.ex = sys.exc_info()
return None
def join(self):
threading.Thread.join(self)
if self.ex is not None:
if PY3:
raise self.ex[0].with_traceback(self.ex[1], self.ex[2])
elif PY2:
wrapper_ex = self.ex[1]
raise (wrapper_ex.__class__, wrapper_ex, self.ex[2])
return None
class BaseTest(object):
"""
Base class for all filelock tests.
"""
# The filelock type (class), which is tested.
LOCK_TYPE = None
def setUp(self):
"""
Creates a new lock file:
self.lock
and asserts, that it is not locked.
"""
self.lock = self.LOCK_TYPE("test.lock")
self.assertFalse(self.lock.is_locked)
return None
def tearDown(self):
"""
Asserts that the lock file *self.lock* is not locked.
"""
self.assertFalse(self.lock.is_locked)
try:
os.remove(self.lock.lock_file)
except OSError:
pass
return None
def test_simple(self):
"""
Asserts that the lock is locked in a context statement and that the
return value of the *__enter__* method is the lock.
"""
with self.lock as l:
self.assertTrue(self.lock.is_locked)
self.assertTrue(self.lock is l)
self.assertFalse(self.lock.is_locked)
return None
def test_nested(self):
"""
Asserts, that the lock is not released before the most outer with
statement that locked the lock, is left.
"""
with self.lock as l1:
self.assertTrue(self.lock.is_locked)
self.assertTrue(self.lock is l1)
with self.lock as l2:
self.assertTrue(self.lock.is_locked)
self.assertTrue(self.lock is l2)
with self.lock as l3:
self.assertTrue(self.lock.is_locked)
self.assertTrue(self.lock is l3)
self.assertTrue(self.lock.is_locked)
self.assertTrue(self.lock.is_locked)
self.assertFalse(self.lock.is_locked)
return None
def test_nested1(self):
"""
The same as *test_nested*, but this method uses the *acquire()* method
to create the lock, rather than the implicit *__enter__* method.
"""
with self.lock.acquire() as l1:
self.assertTrue(self.lock.is_locked)
self.assertTrue(self.lock is l1)
with self.lock.acquire() as l2:
self.assertTrue(self.lock.is_locked)
self.assertTrue(self.lock is l2)
with self.lock.acquire() as l3:
self.assertTrue(self.lock.is_locked)
self.assertTrue(self.lock is l3)
self.assertTrue(self.lock.is_locked)
self.assertTrue(self.lock.is_locked)
self.assertFalse(self.lock.is_locked)
return None
def test_nested_forced_release(self):
"""
Acquires the lock using a with-statement and releases the lock
before leaving the with-statement.
"""
with self.lock:
self.assertTrue(self.lock.is_locked)
self.lock.acquire()
self.assertTrue(self.lock.is_locked)
self.lock.release(force = True)
self.assertFalse(self.lock.is_locked)
self.assertFalse(self.lock.is_locked)
return None
def test_threaded(self):
"""
Runs 250 threads, which need the filelock. The lock must be acquired
if at least one thread required it and released, as soon as all threads
stopped.
"""
def my_thread():
for i in range(100):
with self.lock:
self.assertTrue(self.lock.is_locked)
return None
NUM_THREADS = 250
threads = [ExThread(target = my_thread) for i in range(NUM_THREADS)]
for thread in threads:
thread.start()
for thread in threads:
thread.join()
self.assertFalse(self.lock.is_locked)
return None
def test_threaded1(self):
"""
Runs multiple threads, which acquire the same lock file with a different
FileLock object. When thread group 1 acquired the lock, thread group 2
must not hold their lock.
"""
def thread1():
"""
Requires lock1.
"""
for i in range(1000):
with lock1:
self.assertTrue(lock1.is_locked)
self.assertFalse(lock2.is_locked)
return None
def thread2():
"""
Requires lock2.
"""
for i in range(1000):
with lock2:
self.assertFalse(lock1.is_locked)
self.assertTrue(lock2.is_locked)
return None
NUM_THREADS = 10
lock1 = self.LOCK_TYPE(self.lock.lock_file)
lock2 = self.LOCK_TYPE(self.lock.lock_file)
threads1 = [ExThread(target = thread1) for i in range(NUM_THREADS)]
threads2 = [ExThread(target = thread2) for i in range(NUM_THREADS)]
for i in range(NUM_THREADS):
threads1[i].start()
threads2[i].start()
for i in range(NUM_THREADS):
threads1[i].join()
threads2[i].join()
self.assertFalse(lock1.is_locked)
self.assertFalse(lock2.is_locked)
return None
def test_timeout(self):
"""
Tests if the lock raises a TimeOut error, when it can not be acquired.
"""
lock1 = self.LOCK_TYPE(self.lock.lock_file)
lock2 = self.LOCK_TYPE(self.lock.lock_file)
# Acquire lock 1.
lock1.acquire()
self.assertTrue(lock1.is_locked)
self.assertFalse(lock2.is_locked)
# Try to acquire lock 2.
self.assertRaises(filelock.Timeout, lock2.acquire, timeout=1)
self.assertFalse(lock2.is_locked)
self.assertTrue(lock1.is_locked)
# Release lock 1.
lock1.release()
self.assertFalse(lock1.is_locked)
self.assertFalse(lock2.is_locked)
return None
def test_default_timeout(self):
"""
Test if the default timeout parameter works.
"""
lock1 = self.LOCK_TYPE(self.lock.lock_file)
lock2 = self.LOCK_TYPE(self.lock.lock_file, timeout = 1)
self.assertEqual(lock2.timeout, 1)
# Acquire lock 1.
lock1.acquire()
self.assertTrue(lock1.is_locked)
self.assertFalse(lock2.is_locked)
# Try to acquire lock 2.
self.assertRaises(filelock.Timeout, lock2.acquire)
self.assertFalse(lock2.is_locked)
self.assertTrue(lock1.is_locked)
lock2.timeout = 0
self.assertEqual(lock2.timeout, 0)
self.assertRaises(filelock.Timeout, lock2.acquire)
self.assertFalse(lock2.is_locked)
self.assertTrue(lock1.is_locked)
# Release lock 1.
lock1.release()
self.assertFalse(lock1.is_locked)
self.assertFalse(lock2.is_locked)
return None
def test_context(self):
"""
Tests, if the filelock is released, when an exception is thrown in
a with-statement.
"""
try:
with self.lock as lock:
self.assertIs(self.lock, lock)
self.assertTrue(self.lock.is_locked)
raise Exception()
except:
self.assertFalse(self.lock.is_locked)
return None
def test_context1(self):
"""
The same as *test_context1()*, but uses the *acquire()* method.
"""
try:
with self.lock.acquire() as lock:
self.assertIs(self.lock, lock)
self.assertTrue(self.lock.is_locked)
raise Exception()
except:
self.assertFalse(self.lock.is_locked)
return None
def test_del(self):
"""
Tests, if the lock is released, when the object is deleted.
"""
lock1 = self.LOCK_TYPE(self.lock.lock_file)
lock2 = self.LOCK_TYPE(self.lock.lock_file)
# Acquire lock 1.
lock1.acquire()
self.assertTrue(lock1.is_locked)
self.assertFalse(lock2.is_locked)
# Try to acquire lock 2.
self.assertRaises(filelock.Timeout, lock2.acquire, timeout = 1)
# Delete lock 1 and try to acquire lock 2 again.
del lock1
lock2.acquire()
self.assertTrue(lock2.is_locked)
lock2.release()
return None
class FileLockTest(BaseTest, unittest.TestCase):
"""
Tests the hard file lock, which is available on the current platform.
"""
LOCK_TYPE = filelock.FileLock
class SoftFileLockTest(BaseTest, unittest.TestCase):
"""
Tests the soft file lock, which is always available.
"""
LOCK_TYPE = filelock.SoftFileLock
if __name__ == "__main__":
unittest.main()
|
