forked from tox-dev/filelock
-
Notifications
You must be signed in to change notification settings - Fork 0
/
test_filelock.py
384 lines (294 loc) · 12.4 KB
/
test_filelock.py
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
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
from __future__ import annotations
import logging
import sys
import threading
from contextlib import contextmanager
from inspect import getframeinfo, stack
from pathlib import Path, PurePath
from stat import S_IWGRP, S_IWOTH, S_IWUSR
from types import TracebackType
from typing import Callable, Iterator, Tuple, Type, Union
import pytest
from _pytest.logging import LogCaptureFixture
from filelock import BaseFileLock, FileLock, SoftFileLock, Timeout
@pytest.mark.parametrize(
("lock_type", "path_type"),
[
(FileLock, str),
(FileLock, PurePath),
(FileLock, Path),
(SoftFileLock, str),
(SoftFileLock, PurePath),
(SoftFileLock, Path),
],
)
def test_simple(
lock_type: type[BaseFileLock], path_type: type[str] | type[Path], tmp_path: Path, caplog: LogCaptureFixture
) -> None:
caplog.set_level(logging.DEBUG)
# test lock creation by passing a `str`
lock_path = tmp_path / "a"
lock = lock_type(path_type(lock_path))
with lock as locked:
assert lock.is_locked
assert lock is locked
assert not lock.is_locked
assert caplog.messages == [
f"Attempting to acquire lock {id(lock)} on {lock_path}",
f"Lock {id(lock)} acquired on {lock_path}",
f"Attempting to release lock {id(lock)} on {lock_path}",
f"Lock {id(lock)} released on {lock_path}",
]
assert [r.levelno for r in caplog.records] == [logging.DEBUG, logging.DEBUG, logging.DEBUG, logging.DEBUG]
assert [r.name for r in caplog.records] == ["filelock", "filelock", "filelock", "filelock"]
assert logging.getLogger("filelock").level == logging.NOTSET
@contextmanager
def make_ro(path: Path) -> Iterator[None]:
write = S_IWUSR | S_IWGRP | S_IWOTH
path.chmod(path.stat().st_mode & ~write)
yield
path.chmod(path.stat().st_mode | write)
@pytest.fixture()
def tmp_path_ro(tmp_path: Path) -> Iterator[Path]:
with make_ro(tmp_path):
yield tmp_path
@pytest.mark.parametrize("lock_type", [FileLock, SoftFileLock])
@pytest.mark.skipif(sys.platform == "win32", reason="Windows does not have read only folders")
def test_ro_folder(lock_type: type[BaseFileLock], tmp_path_ro: Path) -> None:
lock = lock_type(str(tmp_path_ro / "a"))
with pytest.raises(PermissionError, match="Permission denied"):
lock.acquire()
@pytest.fixture()
def tmp_file_ro(tmp_path: Path) -> Iterator[Path]:
filename = tmp_path / "a"
filename.write_text("")
with make_ro(filename):
yield filename
@pytest.mark.parametrize("lock_type", [FileLock, SoftFileLock])
def test_ro_file(lock_type: type[BaseFileLock], tmp_file_ro: Path) -> None:
lock = lock_type(str(tmp_file_ro))
with pytest.raises(PermissionError, match="Permission denied"):
lock.acquire()
@pytest.mark.parametrize("lock_type", [FileLock, SoftFileLock])
def test_missing_directory(lock_type: type[BaseFileLock], tmp_path_ro: Path) -> None:
lock_path = tmp_path_ro / "a" / "b"
lock = lock_type(str(lock_path))
with pytest.raises(OSError, match="No such file or directory:"):
lock.acquire()
@pytest.mark.parametrize("lock_type", [FileLock, SoftFileLock])
def test_nested_context_manager(lock_type: type[BaseFileLock], tmp_path: Path) -> None:
# lock is not released before the most outer with statement that locked the lock, is left
lock_path = tmp_path / "a"
lock = lock_type(str(lock_path))
with lock as lock_1:
assert lock.is_locked
assert lock is lock_1
with lock as lock_2:
assert lock.is_locked
assert lock is lock_2
with lock as lock_3:
assert lock.is_locked
assert lock is lock_3
assert lock.is_locked
assert lock.is_locked
assert not lock.is_locked
@pytest.mark.parametrize("lock_type", [FileLock, SoftFileLock])
def test_nested_acquire(lock_type: type[BaseFileLock], tmp_path: Path) -> None:
# lock is not released before the most outer with statement that locked the lock, is left
lock_path = tmp_path / "a"
lock = lock_type(str(lock_path))
with lock.acquire() as lock_1:
assert lock.is_locked
assert lock is lock_1
with lock.acquire() as lock_2:
assert lock.is_locked
assert lock is lock_2
with lock.acquire() as lock_3:
assert lock.is_locked
assert lock is lock_3
assert lock.is_locked
assert lock.is_locked
assert not lock.is_locked
@pytest.mark.parametrize("lock_type", [FileLock, SoftFileLock])
def test_nested_forced_release(lock_type: type[BaseFileLock], tmp_path: Path) -> None:
# acquires the lock using a with-statement and releases the lock before leaving the with-statement
lock_path = tmp_path / "a"
lock = lock_type(str(lock_path))
with lock:
assert lock.is_locked
lock.acquire()
assert lock.is_locked
lock.release(force=True)
assert not lock.is_locked
assert not lock.is_locked
_ExcInfoType = Union[Tuple[Type[BaseException], BaseException, TracebackType], Tuple[None, None, None]]
class ExThread(threading.Thread):
def __init__(self, target: Callable[[], None], name: str) -> None:
super().__init__(target=target, name=name)
self.ex: _ExcInfoType | None = None
def run(self) -> None:
try:
super().run()
except Exception: # pragma: no cover
self.ex = sys.exc_info() # pragma: no cover
def join(self, timeout: float | None = None) -> None:
super().join(timeout=timeout)
if self.ex is not None:
print(f"fail from thread {self.name}") # pragma: no cover
raise RuntimeError from self.ex[1] # pragma: no cover
@pytest.mark.parametrize("lock_type", [FileLock, SoftFileLock])
def test_threaded_shared_lock_obj(lock_type: type[BaseFileLock], tmp_path: Path) -> None:
# Runs 100 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.
lock_path = tmp_path / "a"
lock = lock_type(str(lock_path))
def thread_work() -> None:
for _ in range(100):
with lock:
assert lock.is_locked
threads = [ExThread(target=thread_work, name=f"t{i}") for i in range(100)]
for thread in threads:
thread.start()
for thread in threads:
thread.join()
assert not lock.is_locked
@pytest.mark.parametrize("lock_type", [FileLock, SoftFileLock])
@pytest.mark.skipif(hasattr(sys, "pypy_version_info") and sys.platform == "win32", reason="deadlocks randomly")
def test_threaded_lock_different_lock_obj(lock_type: type[BaseFileLock], tmp_path: Path) -> None:
# 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 t_1() -> None:
for _ in range(1000):
with lock_1:
assert lock_1.is_locked
assert not lock_2.is_locked
def t_2() -> None:
for _ in range(1000):
with lock_2:
assert not lock_1.is_locked
assert lock_2.is_locked
lock_path = tmp_path / "a"
lock_1, lock_2 = lock_type(str(lock_path)), lock_type(str(lock_path))
threads = [(ExThread(t_1, f"t1_{i}"), ExThread(t_2, f"t2_{i}")) for i in range(10)]
for thread_1, thread_2 in threads:
thread_1.start()
thread_2.start()
for thread_1, thread_2 in threads:
thread_1.join()
thread_2.join()
assert not lock_1.is_locked
assert not lock_2.is_locked
@pytest.mark.parametrize("lock_type", [FileLock, SoftFileLock])
def test_timeout(lock_type: type[BaseFileLock], tmp_path: Path) -> None:
# raises Timeout error when the lock cannot be acquired
lock_path = tmp_path / "a"
lock_1, lock_2 = lock_type(str(lock_path)), lock_type(str(lock_path))
# acquire lock 1
lock_1.acquire()
assert lock_1.is_locked
assert not lock_2.is_locked
# try to acquire lock 2
with pytest.raises(Timeout, match="The file lock '.*' could not be acquired."):
lock_2.acquire(timeout=0.1)
assert not lock_2.is_locked
assert lock_1.is_locked
# release lock 1
lock_1.release()
assert not lock_1.is_locked
assert not lock_2.is_locked
@pytest.mark.parametrize("lock_type", [FileLock, SoftFileLock])
def test_default_timeout(lock_type: type[BaseFileLock], tmp_path: Path) -> None:
# test if the default timeout parameter works
lock_path = tmp_path / "a"
lock_1, lock_2 = lock_type(str(lock_path)), lock_type(str(lock_path), timeout=0.1)
assert lock_2.timeout == 0.1
# acquire lock 1
lock_1.acquire()
assert lock_1.is_locked
assert not lock_2.is_locked
# try to acquire lock 2
with pytest.raises(Timeout, match="The file lock '.*' could not be acquired."):
lock_2.acquire()
assert not lock_2.is_locked
assert lock_1.is_locked
lock_2.timeout = 0
assert lock_2.timeout == 0
with pytest.raises(Timeout, match="The file lock '.*' could not be acquired."):
lock_2.acquire()
assert not lock_2.is_locked
assert lock_1.is_locked
# release lock 1
lock_1.release()
assert not lock_1.is_locked
assert not lock_2.is_locked
@pytest.mark.parametrize("lock_type", [FileLock, SoftFileLock])
def test_context_release_on_exc(lock_type: type[BaseFileLock], tmp_path: Path) -> None:
# lock is released when an exception is thrown in a with-statement
lock_path = tmp_path / "a"
lock = lock_type(str(lock_path))
try:
with lock as lock_1:
assert lock is lock_1
assert lock.is_locked
raise Exception
except Exception:
assert not lock.is_locked
@pytest.mark.parametrize("lock_type", [FileLock, SoftFileLock])
def test_acquire_release_on_exc(lock_type: type[BaseFileLock], tmp_path: Path) -> None:
# lock is released when an exception is thrown in a acquire statement
lock_path = tmp_path / "a"
lock = lock_type(str(lock_path))
try:
with lock.acquire() as lock_1:
assert lock is lock_1
assert lock.is_locked
raise Exception
except Exception:
assert not lock.is_locked
@pytest.mark.skipif(hasattr(sys, "pypy_version_info"), reason="del() does not trigger GC in PyPy")
@pytest.mark.parametrize("lock_type", [FileLock, SoftFileLock])
def test_del(lock_type: type[BaseFileLock], tmp_path: Path) -> None:
# lock is released when the object is deleted
lock_path = tmp_path / "a"
lock_1, lock_2 = lock_type(str(lock_path)), lock_type(str(lock_path))
# acquire lock 1
lock_1.acquire()
assert lock_1.is_locked
assert not lock_2.is_locked
# try to acquire lock 2
with pytest.raises(Timeout, match="The file lock '.*' could not be acquired."):
lock_2.acquire(timeout=0.1)
# delete lock 1 and try to acquire lock 2 again
del lock_1
lock_2.acquire()
assert lock_2.is_locked
lock_2.release()
def test_cleanup_soft_lock(tmp_path: Path) -> None:
# tests if the lock file is removed after use
lock_path = tmp_path / "a"
lock = SoftFileLock(str(lock_path))
with lock:
assert lock_path.exists()
assert not lock_path.exists()
@pytest.mark.parametrize("lock_type", [FileLock, SoftFileLock])
def test_poll_intervall_deprecated(lock_type: type[BaseFileLock], tmp_path: Path) -> None:
lock_path = tmp_path / "a"
lock = lock_type(str(lock_path))
with pytest.deprecated_call(match="use poll_interval instead of poll_intervall") as checker:
lock.acquire(poll_intervall=0.05) # the deprecation warning will be captured by the checker
frameinfo = getframeinfo(stack()[0][0]) # get frameinfo of current file and lineno (+1 than the above lineno)
for warning in checker:
if warning.filename == frameinfo.filename and warning.lineno + 1 == frameinfo.lineno: # pragma: no cover
break
else: # pragma: no cover
pytest.fail("No warnings of stacklevel=2 matching.")
@pytest.mark.parametrize("lock_type", [FileLock, SoftFileLock])
def test_context_decorator(lock_type: type[BaseFileLock], tmp_path: Path) -> None:
lock_path = tmp_path / "a"
lock = lock_type(str(lock_path))
@lock
def decorated_method() -> None:
assert lock.is_locked
assert not lock.is_locked
decorated_method()
assert not lock.is_locked